Embedded< Type > Class Template Reference

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

Inheritance diagram for Embedded< Type >:
Collaboration diagram for Embedded< Type >:

Public Member Functions

 TypeName ("embedded")
 Runtime type information. More...
 
 Embedded (const word &name, const dictionary &dict, List< Tuple2< scalar, Type >> &table)
 Construct from dictionary. More...
 
virtual autoPtr< TableReader< Type > > clone () const
 Construct and return a copy. More...
 
virtual ~Embedded ()
 Destructor. More...
 
virtual void write (Ostream &os, const List< Tuple2< scalar, Type >> &table) const
 Write the table values. More...
 
- Public Member Functions inherited from TableReader< Type >
 TypeName ("TableReader")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, TableReader, dictionary,(const word &name, const dictionary &dict, List< Tuple2< scalar, Type >> &table),(name, dict, table))
 
 TableReader (const dictionary &dict)
 Construct from dictionary. 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 dictionary &dict, List< Tuple2< scalar, Type >> &table)
 

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()

Embedded ( const word name,
const dictionary dict,
List< Tuple2< scalar, Type >> &  table 
)

Construct from dictionary.

Definition at line 32 of file EmbeddedTableReader.C.

References dictionary::found(), and dictionary::lookup().

Here is the call graph for this function:

◆ ~Embedded()

~Embedded ( )
virtual

Destructor.

Definition at line 63 of file EmbeddedTableReader.C.

References Embedded< Type >::write().

Referenced by Embedded< Type >::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

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 85 of file EmbeddedTableReader.H.

References Embedded< Type >::write(), and Embedded< Type >::~Embedded().

Here is the call graph for this function:

◆ write()

void write ( Ostream os,
const List< Tuple2< scalar, Type >> &  table 
) const
virtual

Write the table values.

Reimplemented from TableReader< Type >.

Definition at line 71 of file EmbeddedTableReader.C.

References Foam::writeEntry().

Referenced by Embedded< Type >::clone(), and Embedded< Type >::~Embedded().

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: