Templated table container function where data is read from file. Data is stored as a list of Tuple2's. The first column is scalar. Data is read in the form specified by the format entry, which defaults to the native OpenFOAM format. 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 dictionary. More...

	TableFile (const TableFile< Type > &tbl)
	Copy constructor. More...

virtual	~TableFile ()
	Destructor. More...

const fileName &	fName () const
	Return the file name. More...

virtual void	writeEntries (Ostream &os) const
	Write entries only in dictionary format. More...

void	operator= (const TableFile< Type > &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from TableBase< Type, TableFile< Type > >
	TableBase (const word &name, const dictionary &dict)
	Construct from dictionary. Table is not populated. More...

	TableBase (const word &name, const tableBase::boundsHandling boundsHandling, const word &interpolationScheme, const List< Tuple2< scalar, Type >> &table)
	Construct from components. More...

	TableBase (const TableBase< Type, TableFile< Type > > &tbl)
	Copy constructor. Note: Steals interpolator and tableSamples. More...

virtual	~TableBase ()
	Destructor. 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	writeData (Ostream &os) const
	Write all table data in dictionary format. More...

void	operator= (const TableBase< Type, TableFile< Type > > &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from tableBase
	tableBase ()
	Construct null. More...

virtual	~tableBase ()
	Destructor. More...

Public Member Functions inherited from FieldFunction1< Type, TableFile< Type > >
	FieldFunction1 (const word &entryName)
	Construct from entry name. More...

	FieldFunction1 (const FieldFunction1< Type, TableFile< Type > > &ff1)
	Copy constructor. More...

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

virtual	~FieldFunction1 ()
	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...

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 > &f1)
	Copy constructor. More...

virtual	~Function1 ()
	Destructor. More...

const word &	name () const
	Return the name of the entry. More...

void	operator= (const Function1< Type > &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from refCount
int	count () const
	Return the current reference count. More...

bool	unique () const
	Return true if the reference count is zero. More...

void	operator++ ()
	Increment the reference count. More...

void	operator++ (int)
	Increment the reference count. More...

void	operator-- ()
	Decrement the reference count. More...

void	operator-- (int)
	Decrement the reference count. More...

Additional Inherited Members
Public Types inherited from tableBase
enum	boundsHandling { error, warn, clamp, repeat }
	Enumeration for handling out-of-bound values. More...

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

Static Public Attributes inherited from tableBase
static const NamedEnum< boundsHandling, 4 >	boundsHandlingNames_
	Enumeration names for handling out-of-bound values. More...

Protected Member Functions inherited from TableBase< Type, TableFile< Type > >
const interpolationWeights &	interpolator () const
	Return (demand driven) interpolator. More...

void	check () const
	Check the table for size and consistency. More...

scalar	bound (const scalar x) const
	Bound the argument to the table. Errors or warns, or shifts the. More...

Protected Member Functions inherited from refCount
	refCount ()
	Construct null initializing count to 0. More...

Protected Attributes inherited from TableBase< Type, TableFile< Type > >
const word	name_
	Table name. More...

const tableBase::boundsHandling	boundsHandling_
	Enumeration for handling 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	indices_
	Cached indices. More...

scalarField	weights_
	Cached weights. More...

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

Detailed Description

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

Templated table container function where data is read from file. Data is stored as a list of Tuple2's. The first column is scalar. Data is read in the form specified by the format entry, which defaults to the native OpenFOAM format.

Usage:

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

Source files

See also: FoamTableReader.C CsvTableReader.C

Definition at line 71 of file TableFile.H.

Constructor & Destructor Documentation

◆ TableFile() [1/2]

TableFile	(	const word &	entryName,
		const dictionary &	dict
	)

Construct from entry name and dictionary.

Definition at line 32 of file TableFile.C.

◆ TableFile() [2/2]

TableFile ( const TableFile< Type > & tbl )

Copy constructor.

Definition at line 59 of file TableFile.C.

◆ ~TableFile()

~TableFile ( )

virtual

Destructor.

Definition at line 70 of file TableFile.C.

Member Function Documentation

◆ TypeName()

TypeName ( "tableFile" )

Runtime type information.

◆ fName()

const fileName& fName ( ) const

inline

Return the file name.

Definition at line 106 of file TableFile.H.

◆ writeEntries()

void writeEntries ( Ostream & os ) const

virtual

Write entries only in dictionary format.

Reimplemented from TableBase< Type, TableFile< Type > >.

Definition at line 77 of file TableFile.C.

Referenced by TableFile< scalar >::fName().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const TableFile< Type > & )

delete

Disallow default bitwise assignment.