tableReader< Type > Class Template Referenceabstract

Base class to read table data for the interpolationTable. More...

Inheritance diagram for tableReader< Type >:
[legend]

Public Member Functions

 TypeName ("tableReader")
 Declare type-name, virtual type (with debug switch) More...
 
 declareRunTimeSelectionTable (autoPtr, tableReader, dictionary,(const dictionary &dict),(dict))
 
 tableReader ()=default
 Default construct. More...
 
 tableReader (const dictionary &dict)
 Construct from dictionary. More...
 
virtual autoPtr< tableReader< Type > > clone () const =0
 Construct and return a clone. More...
 
virtual ~tableReader ()=default
 Destructor. More...
 
virtual void operator() (const fileName &fName, List< Tuple2< scalar, Type > > &data)=0
 Read 1D table. More...
 
virtual void operator() (const fileName &fName, List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &tbl)=0
 Read 2D table. More...
 
virtual void write (Ostream &os) const
 Write additional information. More...
 

Static Public Member Functions

static autoPtr< tableReaderNew (const dictionary &spec)
 Return a reference to the selected tableReader. More...
 

Detailed Description

template<class Type>
class Foam::tableReader< Type >

Base class to read table data for the interpolationTable.

Source files

Definition at line 60 of file tableReader.H.

Constructor & Destructor Documentation

◆ tableReader() [1/2]

tableReader ( )
default

Default construct.

◆ tableReader() [2/2]

tableReader ( const dictionary dict)

Construct from dictionary.

Definition at line 65 of file tableReader.C.

◆ ~tableReader()

virtual ~tableReader ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "tableReader< Type >"  )

Declare type-name, virtual type (with debug switch)

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
tableReader< Type >  ,
dictionary  ,
(const dictionary &dict ,
(dict  
)

◆ clone()

virtual autoPtr< tableReader< Type > > clone ( ) const
pure virtual

Construct and return a clone.

Implemented in csvTableReader< Type >, and openFoamTableReader< Type >.

◆ New()

Foam::autoPtr< Foam::tableReader< Type > > New ( const dictionary spec)
static

Return a reference to the selected tableReader.

Definition at line 34 of file tableReader.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and dictionary::getOrDefault().

Here is the call graph for this function:

◆ operator()() [1/2]

virtual void operator() ( const fileName fName,
List< Tuple2< scalar, Type > > &  data 
)
pure virtual

Read 1D table.

Implemented in csvTableReader< Type >, and openFoamTableReader< Type >.

◆ operator()() [2/2]

virtual void operator() ( const fileName fName,
List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &  tbl 
)
pure virtual

Read 2D table.

Implemented in csvTableReader< Type >, and openFoamTableReader< Type >.

◆ write()

void write ( Ostream os) const
virtual

Write additional information.

Reimplemented in csvTableReader< Type >.

Definition at line 72 of file tableReader.C.

References os().

Here is the call graph for this function:

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