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

Collaboration diagram for TableFile:

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

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

Private Attributes
fileName	fName_
	File name for csv table (optional) More...

Detailed Description

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() [1/2]

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

Construct from entry name and Istream.

Definition at line 31 of file TableFile.C.

References TableBase::check(), dict, Foam::exit(), string::expand(), Foam::FatalIOError, FatalIOErrorInFunction, TableFile::fName_, dictionary::found(), IOstream::good(), and dictionary::lookup().

Here is the call graph for this function:

◆ TableFile() [2/2]

TableFile ( const TableFile< Type > & tbl )

Copy constructor.

Definition at line 62 of file TableFile.C.

◆ ~TableFile()

~TableFile ( )

virtual

Destructor.

Definition at line 72 of file TableFile.C.

Member Function Documentation

◆ operator=()

void operator= ( const TableFile< Type > & )

private

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "tableFile" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Definition at line 113 of file TableFile.H.

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write in dictionary format.

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

Here is the call graph for this function:

Field Documentation

◆ fName_

fileName fName_

private

File name for csv table (optional)

Definition at line 89 of file TableFile.H.

Referenced by TableFile::TableFile().

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

Private Member Functions

Private Attributes