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

Inheritance diagram for TableFile< Type >:

Collaboration diagram for TableFile< Type >:

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 constructor. 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< scalarField >	x () 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 Function1< Type > &rhs)
	Copy constructor. More...

virtual tmp< Function1< Type > >	clone () const =0
	Construct and return a clone. More...

virtual	~Function1 ()=default
	Destructor. More...

const word &	name () const
	Return the name of the entry. 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...

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=word::null)
	Selector. More...

Public Attributes inherited from Function1< Type >
	Function1

	dictionary

const word &	entryName

const word const dictionary &	dict

const word const dictionary	entryName

const word const dictionary	dict

Protected Member Functions inherited from TableBase< Type >
const interpolationWeights &	interpolator () 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 word	name_
	Table name. More...

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< scalarField >	tableSamplesPtr_
	Extracted values. More...

autoPtr< interpolationWeights >	interpolatorPtr_
	Interpolator method. More...

labelList	currentIndices_
	Cached indices and weights. More...

scalarField	currentWeights_

Protected Attributes inherited from Function1< Type >
const word	name_
	Name of entry. More...

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 76 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 constructor.

Definition at line 64 of file TableFile.C.

◆ ~TableFile()

virtual ~TableFile ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "tableFile" )

Runtime type information.

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