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

Reads an interpolation table from the values entry in OpenFOAM-format. More...

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

Public Member Functions

 TypeName ("embedded")
 Runtime type information. More...
 
 Embedded ()
 Default construct. More...
 
 Embedded (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 ~Embedded ()
 Destructor. More...
 
virtual List< Tuple2< scalar, Type > > read (const Function1s::unitConversions &units, const dictionary &dict, const word &valuesKeyword="values") const
 Read values. More...
 
List< Tuple2< scalar, Type > > read (const Function1s::unitConversions &units, Istream &is)
 Read values. More...
 
virtual void write (Ostream &os, const Function1s::unitConversions &units, const List< Tuple2< scalar, Type >> &table, const word &valuesKeyword="values") const
 Write settings and values. 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 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::Embedded< Type >

Reads an interpolation table from the values entry 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
    values
    (
        (0.0 (1 2 3))
        (1.0 (4 5 6))
    );
Source files

Definition at line 63 of file EmbeddedTableReader.H.

Constructor & Destructor Documentation

◆ Embedded() [1/2]

Embedded

Default construct.

Definition at line 31 of file EmbeddedTableReader.C.

◆ Embedded() [2/2]

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

Construct from name and dictionary.

Definition at line 38 of file EmbeddedTableReader.C.

◆ ~Embedded()

~Embedded
virtual

Destructor.

Definition at line 52 of file EmbeddedTableReader.C.

Member Function Documentation

◆ TypeName()

TypeName ( "embedded"  )

Runtime type information.

◆ clone()

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

Construct and return a copy.

Implements TableReader< Type >.

Definition at line 87 of file EmbeddedTableReader.H.

◆ read() [1/2]

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

Read values.

Implements TableReader< Type >.

Definition at line 60 of file EmbeddedTableReader.C.

References TableReader< Type >::convertRead(), dict, and Foam::units().

Here is the call graph for this function:

◆ read() [2/2]

Foam::List< Foam::Tuple2< Foam::scalar, Type > > read ( const Function1s::unitConversions &  units,
Istream &  is 
)

Read values.

Definition at line 75 of file EmbeddedTableReader.C.

References TableReader< Type >::convertRead(), 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 = "values" 
) const
virtual

Write settings and values.

Implements TableReader< Type >.

Definition at line 86 of file EmbeddedTableReader.C.

References Foam::units(), and Foam::writeEntry().

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