Templated table container data entry where data is 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 Istream. More...

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

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

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

word	boundsHandlingToWord (const boundsHandling &bound) const
	Return the out-of-bounds handling as a word. More...

boundsHandling	wordToBoundsHandling (const word &bound) const
	Return the out-of-bounds handling as an enumeration. More...

boundsHandling	outOfBounds (const boundsHandling &bound)
	Set the out-of-bounds handling from enum, return previous setting. 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 dimensioned< Type >	dimValue (const scalar x) const
	Return dimensioned constant value. More...

virtual dimensioned< Type >	dimIntegrate (const scalar x1, const scalar x2) const
	Integrate between two values and return dimensioned type. 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. Used for non-inline. More...

Public Member Functions inherited from DataEntry< Type >
	TypeName ("DataEntry") declareRunTimeSelectionTable(autoPtr
	Runtime type information. More...

	DataEntry (const word &entryName)
	Construct from entry name. More...

	DataEntry (const DataEntry< Type > &de)
	Copy constructor. More...

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

virtual tmp< Field< dimensioned< Type > > >	dimValue (const scalarField &x) const
	Return dimensioned type as a function of (scalar) More...

virtual tmp< Field< dimensioned< Type > > >	dimIntegrate (const scalarField &x1, const scalarField &x2) const
	Integrate between two scalar fields and return a field of. More...

Public Member Functions inherited from refCount
	refCount ()
	Construct null with zero count. More...

int	count () const
	Return the reference count. More...

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

void	resetRefCount ()
	Reset the reference count to 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< Type >
enum	boundsHandling { ERROR, WARN, CLAMP, REPEAT }
	Enumeration for handling out-of-bound values. More...

Static Public Member Functions inherited from DataEntry< Type >
static autoPtr< DataEntry< Type > >	New (const word &entryName, const dictionary &dict)
	Selector. More...

Public Attributes inherited from DataEntry< Type >
	DataEntry

	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 > &)
	Disallow default bitwise assignment. More...

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

const boundsHandling	boundsHandling_
	Enumeration for handling out-of-bound values. More...

const word	interpolationScheme_
	Interpolation type. More...

List< Tuple2< scalar, Type > >	table_
	Table data. More...

dimensionSet	dimensions_
	The dimension set. 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 DataEntry< Type >
const word	name_
	Name of entry. More...

Detailed Description

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

Templated table container data entry where data is read from file.

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

Items are stored in a list of Tuple2's. First column is always stored as scalar entries. Data is 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 68 of file TableFile.H.

Constructor & Destructor Documentation

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

Construct from entry name and Istream.

Definition at line 31 of file TableFile.C.

References TableBase< Type >::check(), TableBase< Type >::dimensions_, Foam::exit(), string::expand(), Foam::FatalIOError, FatalIOErrorIn, dictionary::lookup(), dictionary::subDict(), and TableBase< Type >::table_.

Here is the call graph for this function:

TableFile ( const TableFile< Type > & tbl )

Copy constructor.

Definition at line 63 of file TableFile.C.

~TableFile ( )

virtual

Destructor.

Definition at line 73 of file TableFile.C.

Referenced by TableFile< Type >::clone().

Here is the caller graph for this function:

Member Function Documentation

TypeName ( "tableFile" )

Runtime type information.

virtual tmp<DataEntry<Type> > clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented from DataEntry< Type >.

Definition at line 113 of file TableFile.H.

References TableFile< Type >::writeData(), and TableFile< Type >::~TableFile().

Here is the call graph for this function:

void writeData ( Ostream & os ) const

virtual

Write in dictionary format.

Reimplemented from TableBase< Type >.

Definition at line 31 of file TableFileIO.C.

References Foam::decrIndent(), Foam::endl(), Foam::incrIndent(), Foam::indent(), Foam::name(), Foam::nl, writeData(), and Ostream::writeKeyword().

Referenced by TableFile< Type >::clone().

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/primitives/functions/DataEntry/TableFile/TableFile.H
src/OpenFOAM/primitives/functions/DataEntry/TableFile/TableFile.C
src/OpenFOAM/primitives/functions/DataEntry/TableFile/TableFileIO.C

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

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