Templated table container function. More...

Inheritance diagram for Table< Type >:

Collaboration diagram for Table< Type >:

Public Member Functions
	TypeName ("table")
	Runtime type information. More...

	Table (const word &entryName, const dictionary &dict)
	Construct from entry name and Istream. More...

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

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

virtual	~Table ()
	Destructor. More...

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

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

Public Member Functions inherited from TableBase< Type, Table< 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, Table< 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, Table< 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, Table< Type > >
	FieldFunction1 (const word &entryName)
	Construct from entry name. More...

	FieldFunction1 (const FieldFunction1< Type, Table< 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, Table< 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, Table< 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::Table< Type >

Templated table container function.

Items are stored in a list of Tuple2's. First column is always stored as scalar entries. Data is read in Tuple2 form.

Usage:

    <entryName>   table
    (
        (0.0 (1 2 3))
        (1.0 (4 5 6))
    );

Source files

Definition at line 63 of file Table.H.

Constructor & Destructor Documentation

◆ Table() [1/3]

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

Construct from entry name and Istream.

Definition at line 32 of file Table.C.

Referenced by Table< scalar >::Table().

Here is the caller graph for this function:

◆ Table() [2/3]

Table	(	const word &	name,
		const tableBase::boundsHandling	boundsHandling,
		const word &	interpolationScheme,
		const List< Tuple2< scalar, Type >> &	table
	)

Construct from components.

Definition at line 63 of file Table.C.

◆ Table() [3/3]

Table ( const Table< Type > & tbl )

Copy constructor.

Definition at line 81 of file Table.C.

◆ ~Table()

~Table ( )

virtual

Destructor.

Definition at line 90 of file Table.C.

Member Function Documentation

◆ TypeName()

TypeName ( "table" )

Runtime type information.

◆ writeEntries()

void writeEntries ( Ostream & os ) const

virtual

Write entries only in dictionary format.

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

Definition at line 97 of file Table.C.

◆ operator=()

void operator= ( const Table< Type > & )

delete

Disallow default bitwise assignment.

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

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

Public Member Functions

Additional Inherited Members