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

#include <TableFile.H>

Inheritance diagram for TableFile< Type >:

Collaboration diagram for TableFile< Type >:

Public Member Functions
	TypeName ("tableFile")
	Runtime type information.
	TableFile (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name and "file" found in dictionary.
	TableFile (const TableFile< Type > &tbl)
	Copy construct.
virtual tmp< Function1< Type > >	clone () const
	Return a clone.
virtual	~TableFile ()=default
	Destructor.
virtual void	writeData (Ostream &os) const
	Write in dictionary format.
const::Foam::word	typeName (Function1Types::TableFile< scalar >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::TableFile< scalar >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::TableFile< vector >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::TableFile< vector >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::TableFile< sphericalTensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::TableFile< sphericalTensor >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::TableFile< symmTensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::TableFile< symmTensor >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::TableFile< tensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::TableFile< tensor >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::TableFile< scalarField >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::TableFile< scalarField >::typeName_(), 0))
Public Member Functions inherited from TableBase< Type >
	TableBase (const word &name, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from dictionary - note table is not populated.
	TableBase (const TableBase< Type > &tbl)
	Copy constructor. Note: steals interpolator, tableSamples.
virtual	~TableBase ()=default
	Destructor.
void	initialise ()
	Check the table for size and consistency.
bool	checkMinBounds (const scalar x, scalar &xDash) const
	Check minimum table bounds.
bool	checkMaxBounds (const scalar x, scalar &xDash) const
	Check maximum table bounds.
virtual void	userTimeToTime (const Time &t)
	Convert time.
virtual Type	value (const scalar x) const
	Return Table value.
virtual Type	integrate (const scalar x1, const scalar x2) const
	Integrate between two (scalar) values.
virtual tmp< scalarField >	x () const
	Return the reference values.
virtual tmp< Field< Type > >	y () const
	Return the dependent values.
virtual void	writeEntries (Ostream &os) const
	Write keywords only in dictionary format.
Public Member Functions inherited from Function1< Type >
virtual const word &	type () const
	Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name.
	Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, (unused) dictionary and optional registry.
	Function1 (const Function1< Type > &rhs)
	Copy construct.
virtual	~Function1 ()=default
	Destructor.
virtual bool	constant () const
	Is value constant (i.e. independent of x).
virtual bool	good () const
	Can function be evaluated?
virtual tmp< Field< Type > >	value (const scalarField &x) const
	Return value as a function of (scalar) independent variable.
virtual tmp< Field< Type > >	integrate (const scalarField &x1, const scalarField &x2) const
	Integrate between two (scalar) values.
const::Foam::word	typeName (Function1< label >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< label >::typeName_(), 0))
Function1< label >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< label >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< label >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< label >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< scalar >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< scalar >::typeName_(), 0))
Function1< scalar >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< scalar >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< scalar >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< scalar >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< vector >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< vector >::typeName_(), 0))
Function1< vector >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< vector >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< vector >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< vector >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< sphericalTensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< sphericalTensor >::typeName_(), 0))
Function1< sphericalTensor >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< sphericalTensor >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< sphericalTensor >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< sphericalTensor >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< symmTensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< symmTensor >::typeName_(), 0))
Function1< symmTensor >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< symmTensor >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< symmTensor >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< symmTensor >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< tensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< tensor >::typeName_(), 0))
Function1< tensor >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< tensor >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< tensor >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< tensor >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< scalarField >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< scalarField >::typeName_(), 0))
Function1< scalarField >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< scalarField >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< scalarField >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< scalarField >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
Public Member Functions inherited from function1Base
	function1Base (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name and optional registry.
	function1Base (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary (unused) and optional registry.
	function1Base (const function1Base &rhs)
	Copy construct.
virtual	~function1Base ()
	Destructor.
const word &	name () const noexcept
	The name of the entry.
const objectRegistry *	whichDb () const noexcept
	Return the associated registry or nullptr.
void	resetDb (const objectRegistry *obrPtr=nullptr) noexcept
	Reset the associated objectRegistry.
void	resetDb (const objectRegistry &db) noexcept
	Reset the associated objectRegistry.
const objectRegistry &	obr () const
	Return the object registry.
bool	isTime () const noexcept
	Return true if this function was created with the time database.
const Time &	time () const
	Return the time database.
template<class MeshType>
const MeshType &	mesh (const word &regionName=word::null) const
	Return the mesh database if this Function1 was created using a mesh.
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.

Additional Inherited Members
Public Types inherited from Function1< Type >
typedef Type	returnType
	The return type.
typedef autoPtr< Function1 >(*	dictionaryConstructorPtr) (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr)
	Declare runtime constructor selection table.
typedef ::Foam::HashTable< dictionaryConstructorPtr, ::Foam::word, ::Foam::Hash<::Foam::word > >	dictionaryConstructorTableType
typedef ::Foam::HashTable< std::pair<::Foam::word, int >, ::Foam::word, ::Foam::Hash<::Foam::word > >	dictionaryConstructorCompatTableType
Static Public Member Functions inherited from Function1< Type >
static const char *	typeName_ ()
	Runtime type information.
static dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
static void	dictionaryConstructorTablePtr_construct (bool load)
static dictionaryConstructorPtr	dictionaryConstructorTable (const ::Foam::word &k)
template<class Derived>
static tmp< Function1< Type > >	Clone (const Derived &fun)
	Clone a Function1.
static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const word &redirectType, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, with fallback redirection.
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 objectRegistry obrPtr=nullptr, const bool mandatory=true)
	Compatibility selector, with fallback redirection.
static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, without fallback redirection.
static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType, const objectRegistry *obrPtr=nullptr)
	An optional selector, with fallback redirection.
static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	An optional selector, without fallback redirection.
static refPtr< Function1< Type > >	New (HashPtrTable< Function1< Type > > &cache, const word &entryName, const dictionary &dict, enum keyType::option matchOpt=keyType::LITERAL, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector with external storage of Function1. This also allows wildcard matches in a dictionary.
Static Public Attributes inherited from Function1< Type >
static const ::Foam::word	typeName
static int	debug
static dictionaryConstructorTableType *	dictionaryConstructorTablePtr_
static std::unique_ptr< dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_
Protected Member Functions inherited from TableBase< Type >
const interpolationWeights &	interpolator () const
	Return (demand driven) interpolator.
void	operator= (const TableBase< Type > &)=delete
	No copy assignment.
Protected Member Functions inherited from Function1< Type >
void	operator= (const Function1< Type > &)=delete
	No copy assignment.
Protected Member Functions inherited from function1Base
void	operator= (const function1Base &)=delete
	No copy assignment.
Protected Attributes inherited from TableBase< Type >
const bounds::repeatableBounding	bounding_
	Handling for out-of-bound values.
const word	interpolationScheme_
	Interpolation type.
List< Tuple2< scalar, Type > >	table_
	Table data.
autoPtr< scalarField >	tableSamplesPtr_
	Extracted values.
autoPtr< interpolationWeights >	interpolatorPtr_
	Interpolator method.
labelList	currentIndices_
	Cached indices and weights.
scalarField	currentWeights_
Protected Attributes inherited from function1Base
const word	name_
	Name of entry.
const objectRegistry *	obrPtr_
	Pointer to an object registry.

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

See also: Foam::Function1Types::Table

Source files

Definition at line 74 of file TableFile.H.

Constructor & Destructor Documentation

◆ TableFile() [1/2]

template<class Type>

TableFile	(	const word &	entryName,
		const dictionary &	dict,
		const objectRegistry *	obrPtr = nullptr )

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

Definition at line 27 of file TableFile.C.

References dict, Foam::exit(), string::expand(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::fileHandler, IOstream::good(), TableBase< Type >::initialise(), Foam::nl, TableBase< Type >::table_, and TableBase< Type >::TableBase().

Referenced by TableFile(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TableFile() [2/2]

template<class Type>

TableFile ( const TableFile< Type > & tbl )

explicit

Copy construct.

Definition at line 58 of file TableFile.C.

References TableBase< Type >::TableBase(), and TableFile().

Here is the call graph for this function:

◆ ~TableFile()

template<class Type>

virtual ~TableFile ( )

virtualdefault

Destructor.

References os().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

template<class Type>

TypeName ( "tableFile" )

Runtime type information.

References dict, and TableFile().

Here is the call graph for this function:

◆ clone()

template<class Type>

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

inlinevirtual

Return a clone.

Implements Function1< Type >.

Definition at line 122 of file TableFile.H.

References Function1< Type >::Clone().

Here is the call graph for this function:

◆ writeData()

template<class Type>

void writeData ( Ostream & os ) const

virtual

Write in dictionary format.

Reimplemented from TableBase< Type >.

Definition at line 68 of file TableFile.C.

References name, os(), Function1< Type >::writeData(), and TableBase< Type >::writeEntries().

Here is the call graph for this function:

◆ typeName() [1/6]

const::Foam::word typeName ( Function1Types::TableFile< scalar > ::typeName_() )

◆ debug() [1/6]

int debug ( ::Foam::debug::debugSwitch(Function1Types::TableFile< scalar >::typeName_(), 0) )

◆ typeName() [2/6]

const::Foam::word typeName ( Function1Types::TableFile< vector > ::typeName_() )

◆ debug() [2/6]

int debug ( ::Foam::debug::debugSwitch(Function1Types::TableFile< vector >::typeName_(), 0) )

◆ typeName() [3/6]

const::Foam::word typeName ( Function1Types::TableFile< sphericalTensor > ::typeName_() )

◆ debug() [3/6]

int debug ( ::Foam::debug::debugSwitch(Function1Types::TableFile< sphericalTensor >::typeName_(), 0) )

◆ typeName() [4/6]

const::Foam::word typeName ( Function1Types::TableFile< symmTensor > ::typeName_() )

◆ debug() [4/6]

int debug ( ::Foam::debug::debugSwitch(Function1Types::TableFile< symmTensor >::typeName_(), 0) )

◆ typeName() [5/6]

const::Foam::word typeName ( Function1Types::TableFile< tensor > ::typeName_() )

◆ debug() [5/6]

int debug ( ::Foam::debug::debugSwitch(Function1Types::TableFile< tensor >::typeName_(), 0) )

◆ typeName() [6/6]

const::Foam::word typeName ( Function1Types::TableFile< scalarField > ::typeName_() )

◆ debug() [6/6]

int debug ( ::Foam::debug::debugSwitch(Function1Types::TableFile< scalarField >::typeName_(), 0) )

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

src/OpenFOAM/primitives/functions/Function1/TableFile/TableFile.H
src/OpenFOAM/primitives/functions/Function1/TableFile/TableFile.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TableFile() [1/2]

◆ TableFile() [2/2]

◆ ~TableFile()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ writeData()

◆ typeName() [1/6]

◆ debug() [1/6]

◆ typeName() [2/6]

◆ debug() [2/6]

◆ typeName() [3/6]

◆ debug() [3/6]

◆ typeName() [4/6]

◆ debug() [4/6]

◆ typeName() [5/6]

◆ debug() [5/6]

◆ typeName() [6/6]

◆ debug() [6/6]