Public Member Functions | List of all members
Foam< Type > Class Template Reference

Reads an interpolation table from a file in OpenFOAM-format. This is a list of Tuple2's where the first (x) column is scalar, and the second (y) column is the type to be interpolated. More...

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

Public Member Functions

 TypeName ("foam")
 Runtime type information. More...
 
 Foam (const word &name, const Function1s::unitConversions &units, const dictionary &dict)
 Construct from name and dictionary. More...
 
virtual autoPtr< TableReader< Type > > clone () const
 Construct and return a copy. More...
 
virtual ~Foam ()
 Destructor. More...
 
- Public Member Functions inherited from TableFileReader< Type >
 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
 Read values. More...
 
virtual void write (Ostream &os, const Function1s::unitConversions &units, const List< Tuple2< scalar, Type >> &table) 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 ~TableReader ()
 Destructor. 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)
 
- Protected Member Functions inherited from TableFileReader< Type >
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...
 

Detailed Description

template<class Type>
class Foam::TableReaders::Foam< Type >

Reads an interpolation table from a file in OpenFOAM-format. This is a list of Tuple2's where the first (x) column is scalar, and the second (y) column is the type to be interpolated.

Usage
    (
        (0.0 (1 2 3))
        (1.0 (4 5 6))
    );
Source files

Definition at line 61 of file FoamTableReader.H.

Constructor & Destructor Documentation

◆ Foam()

Foam ( const word &  name,
const Function1s::unitConversions &  units,
const dictionary &  dict 
)

Construct from name and dictionary.

Definition at line 44 of file FoamTableReader.C.

◆ ~Foam()

~Foam
virtual

Destructor.

Definition at line 58 of file FoamTableReader.C.

Member Function Documentation

◆ TypeName()

TypeName ( "foam"  )

Runtime type information.

◆ clone()

virtual autoPtr<TableReader<Type> > clone ( ) const
inlinevirtual

Construct and return a copy.

Implements TableReader< Type >.

Definition at line 88 of file FoamTableReader.H.

The documentation for this class was generated from the following files: