Public Member Functions | Protected Member Functions | List of all members
TableFileReader< Type > Class Template Referenceabstract

Base class to read table data for tables. More...

Inheritance diagram for TableFileReader< Type >:
Inheritance graph
[legend]
Collaboration diagram for TableFileReader< Type >:
Collaboration graph
[legend]

Public Member Functions

 TableFileReader (const Function1s::unitConversions &defaultUnits, const dictionary &dict)
 Construct from dictionary. More...
 
 TableFileReader (const TableFileReader< Type > &)
 Copy construct. More...
 
virtual ~TableFileReader ()
 Destructor. More...
 
virtual List< Tuple2< scalar, Type > > read (const Function1s::unitConversions &units, const dictionary &dict, const word &valuesKeyword=word::null) const
 Read values. More...
 
virtual void write (Ostream &os, const Function1s::unitConversions &units, const List< Tuple2< scalar, Type >> &table, const word &valuesKeyword=word::null) const
 Write additional information. More...
 
- Public Member Functions inherited from TableReader< Type >
 TypeName ("TableReader")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, TableReader, dictionary,(const word &name, const Function1s::unitConversions &units, const dictionary &dict),(name, units, dict))
 
 TableReader ()
 Default construct. More...
 
virtual autoPtr< TableReader< Type > > clone () const =0
 Construct and return a clone. More...
 
virtual ~TableReader ()
 Destructor. More...
 

Protected Member Functions

void read (const Function1s::unitConversions &defaultUnits, const dictionary &dict, List< Tuple2< scalar, Type >> &) const
 Read a 1D table. More...
 
- Protected Member Functions inherited from TableReader< Type >
void convertRead (const Function1s::unitConversions &units, List< Tuple2< scalar, Type >> &table) const
 Do unit conversions on input data. More...
 
List< Tuple2< scalar, Type > > convertRead (const Function1s::unitConversions &units, const List< Tuple2< scalar, Type >> &table) const
 Do unit conversions on input data. More...
 
List< Tuple2< scalar, Type > > convertWrite (const Function1s::unitConversions &units, const List< Tuple2< scalar, Type >> &table) const
 Do unit conversions in order to output data. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from TableReader< Type >
static autoPtr< TableReader< Type > > New (const word &name, const Function1s::unitConversions &units, const dictionary &dict)
 

Detailed Description

template<class Type>
class Foam::TableFileReader< Type >

Base class to read table data for tables.

Source files

Definition at line 49 of file TableFileReader.H.

Constructor & Destructor Documentation

◆ TableFileReader() [1/2]

TableFileReader ( const Function1s::unitConversions &  defaultUnits,
const dictionary &  dict 
)

Construct from dictionary.

Definition at line 100 of file TableFileReader.C.

◆ TableFileReader() [2/2]

TableFileReader ( const TableFileReader< Type > &  tfr)

Copy construct.

Definition at line 113 of file TableFileReader.C.

◆ ~TableFileReader()

~TableFileReader
virtual

Destructor.

Definition at line 127 of file TableFileReader.C.

Member Function Documentation

◆ read() [1/2]

void read ( const Function1s::unitConversions &  defaultUnits,
const dictionary &  dict,
List< Tuple2< scalar, Type >> &  table 
) const
protected

Read a 1D table.

Definition at line 56 of file TableFileReader.C.

References Foam::exit(), string::expand(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::fileHandler(), IOstream::good(), Foam::nl, Foam::blockMeshTools::read(), and Foam::unitsPtr_().

Here is the call graph for this function:

◆ read() [2/2]

Foam::List< Foam::Tuple2< Foam::scalar, Type > > read ( const Function1s::unitConversions &  units,
const dictionary &  dict,
const word &  valuesKeyword = word::null 
) const
virtual

Read values.

Implements TableReader< Type >.

Definition at line 135 of file TableFileReader.C.

References dict, Foam::read(), and Foam::units().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os,
const Function1s::unitConversions &  units,
const List< Tuple2< scalar, Type >> &  table,
const word &  valuesKeyword = word::null 
) const
virtual

Write additional information.

Implements TableReader< Type >.

Reimplemented in Foam< Type >, and Csv< Type >.

Definition at line 149 of file TableFileReader.C.

References Foam::type(), Foam::unitsPtr_(), and Foam::writeEntry().

Referenced by Csv< Type >::write(), and Foam< Type >::write().

Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following files: