Loading...
Searching...
No Matches
tableReader< Type > Class Template Referenceabstract

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

#include <tableReader.H>

Inheritance diagram for tableReader< Type >:

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

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

Base class to read table data for the interpolationTable.

Source files

Definition at line 56 of file tableReader.H.

Constructor & Destructor Documentation

◆ tableReader() [1/2]

template<class Type>
tableReader ( )
default

Default construct.

References dict.

Referenced by csvTableReader< Type >::csvTableReader(), declareRunTimeSelectionTable(), and openFoamTableReader< Type >::openFoamTableReader().

Here is the caller graph for this function:

◆ tableReader() [2/2]

template<class Type>
tableReader ( const dictionary & dict)

Construct from dictionary.

Definition at line 58 of file tableReader.C.

◆ ~tableReader()

template<class Type>
virtual ~tableReader ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

template<class Type>
TypeName ( "tableReader< Type >" )

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

◆ declareRunTimeSelectionTable()

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

References dict, and tableReader().

Here is the call graph for this function:

◆ clone()

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

Construct and return a clone.

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

◆ New()

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

Return a reference to the selected tableReader.

Definition at line 27 of file tableReader.C.

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

Here is the call graph for this function:

◆ operator()() [1/2]

template<class Type>
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]

template<class Type>
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 >.

References os().

Here is the call graph for this function:

◆ write()

template<class Type>
void write ( Ostream & os) const
virtual

Write additional information.

Reimplemented in csvTableReader< Type >.

Definition at line 65 of file tableReader.C.

References os().

Referenced by csvTableReader< 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:
  • src/OpenFOAM/interpolations/interpolationTable/tableReaders/tableReader.H
  • src/OpenFOAM/interpolations/interpolationTable/tableReaders/tableReader.C