TableFile< Type > Class Template Reference

Templated table container function where data are read from file. More...

Inheritance diagram for TableFile< Type >:
[legend]
Collaboration diagram for TableFile< Type >:
[legend]

Public Member Functions

 TypeName ("tableFile")
 Runtime type information. More...
 
 TableFile (const word &entryName, const dictionary &dict)
 Construct from entry name and "file" found in dictionary. More...
 
 TableFile (const TableFile< Type > &tbl)
 Copy construct. More...
 
virtual tmp< Function1< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~TableFile ()=default
 Destructor. More...
 
virtual void writeData (Ostream &os) const
 Write in dictionary format. More...
 
- Public Member Functions inherited from TableBase< Type >
 TableBase (const word &name, const dictionary &dict)
 Construct from dictionary - note table is not populated. More...
 
 TableBase (const TableBase< Type > &tbl)
 Copy constructor. Note: steals interpolator, tableSamples. More...
 
virtual ~TableBase ()
 Destructor. More...
 
void check () const
 Check the table for size and consistency. More...
 
bool checkMinBounds (const scalar x, scalar &xDash) const
 Check minimum table bounds. More...
 
bool checkMaxBounds (const scalar x, scalar &xDash) const
 Check maximum table bounds. More...
 
virtual void convertTimeBase (const Time &t)
 Convert time. More...
 
virtual Type value (const scalar x) const
 Return Table value. More...
 
virtual Type integrate (const scalar x1, const scalar x2) const
 Integrate between two (scalar) values. More...
 
virtual tmp< scalarFieldx () const
 Return the reference values. More...
 
virtual tmp< Field< Type > > y () const
 Return the dependent values. More...
 
virtual void writeEntries (Ostream &os) const
 Write keywords only in dictionary format. More...
 
- Public Member Functions inherited from Function1< Type >
 TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
 Runtime type information. More...
 
 Function1 (const word &entryName)
 Construct from entry name. More...
 
 Function1 (const word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
 Function1 (const Function1< Type > &rhs)
 Copy construct. More...
 
virtual ~Function1 ()=default
 Destructor. More...
 
virtual tmp< Field< Type > > value (const scalarField &x) const
 Return value as a function of (scalar) independent variable. More...
 
virtual tmp< Field< Type > > integrate (const scalarField &x1, const scalarField &x2) const
 Integrate between two (scalar) values. More...
 
void writeEntries (Ostream &os) const
 Write coefficient entries in dictionary format. More...
 

Additional Inherited Members

- Public Types inherited from Function1< Type >
typedef Type returnType
 
- Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > > New (const word &entryName, const dictionary &dict, const word &redirectType, const bool mandatory=true)
 Selector, with fallback redirection. More...
 
static autoPtr< Function1< Type > > NewCompat (const word &entryName, std::initializer_list< std::pair< const char *, int >> compat, const dictionary &dict, const word &redirectType=word::null, const bool mandatory=true)
 Compatibility selector, with fallback redirection. More...
 
static autoPtr< Function1< Type > > New (const word &entryName, const dictionary &dict, const bool mandatory=true)
 Selector, without fallback redirection. More...
 
static autoPtr< Function1< Type > > NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType=word::null)
 An optional selector. More...
 
- Public Attributes inherited from Function1< Type >
 Function1
 
 dictionary
 
const wordentryName
 
const word const dictionarydict
 
const word const dictionary entryName
 
const word const dictionary dict
 
- Protected Member Functions inherited from TableBase< Type >
const interpolationWeightsinterpolator () const
 Return (demand driven) interpolator. More...
 
void operator= (const TableBase< Type > &)=delete
 No copy assignment. More...
 
- Protected Member Functions inherited from Function1< Type >
void operator= (const Function1< Type > &)=delete
 No copy assignment. More...
 
- Protected Attributes inherited from TableBase< Type >
const bounds::repeatableBounding bounding_
 Handling for out-of-bound values. More...
 
const word interpolationScheme_
 Interpolation type. More...
 
List< Tuple2< scalar, Type > > table_
 Table data. More...
 
autoPtr< scalarFieldtableSamplesPtr_
 Extracted values. More...
 
autoPtr< interpolationWeightsinterpolatorPtr_
 Interpolator method. More...
 
labelList currentIndices_
 Cached indices and weights. More...
 
scalarField currentWeights_
 

Detailed Description

template<class Type>
class Foam::Function1Types::TableFile< Type >

Templated table container function where data are read from file.

Usage:

    <entryName> tableFile;
    <entryName>Coeffs
    {
        file                dataFile;    // name of data file
        outOfBounds         clamp;       // optional out-of-bounds handling
        interpolationScheme linear;      // optional interpolation method
    }

Data are stored as a list of Tuple2's. First column is always stored as scalar entries. Data are read in the form, e.g. for an entry <entryName> that is (scalar, vector):

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

Definition at line 75 of file TableFile.H.

Constructor & Destructor Documentation

◆ TableFile() [1/2]

TableFile ( const word entryName,
const dictionary dict 
)

Construct from entry name and "file" found in dictionary.

Definition at line 35 of file TableFile.C.

References dict, Foam::exit(), string::expand(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::fileHandler(), IOstream::good(), and Foam::nl.

Here is the call graph for this function:

◆ TableFile() [2/2]

TableFile ( const TableFile< Type > &  tbl)
explicit

Copy construct.

Definition at line 64 of file TableFile.C.

◆ ~TableFile()

virtual ~TableFile ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "tableFile"  )

Runtime type information.

◆ clone()

virtual tmp<Function1<Type> > clone ( ) const
inlinevirtual

Construct and return a clone.

Implements Function1< Type >.

Definition at line 106 of file TableFile.H.

◆ writeData()

void writeData ( Ostream os) const
virtual

Write in dictionary format.

Reimplemented from TableBase< Type >.

Definition at line 74 of file TableFile.C.

References Ostream::beginBlock(), Ostream::endBlock(), Ostream::endEntry(), Foam::name(), Function1< Type >::writeData(), TableBase< Type >::writeEntries(), and Ostream::writeEntry().

Here is the call graph for this function:

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