Base class for table with bounds handling, interpolation and integration. More...

Inheritance diagram for TableBase< Type, Function1Type >:

[legend]

Collaboration diagram for TableBase< Type, Function1Type >:

[legend]

Public Member Functions
	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, Function1Type > &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	writeEntries (Ostream &os) const
	Write entries only in dictionary format. More...

virtual void	writeData (Ostream &os) const
	Write all table data in dictionary format. More...

void	operator= (const TableBase< Type, Function1Type > &)=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, Function1Type >
	FieldFunction1 (const word &entryName)
	Construct from entry name. More...

	FieldFunction1 (const FieldFunction1< Type, Function1Type > &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...

Protected Member Functions
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
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...

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

Detailed Description

template<class Type, class Function1Type>
class Foam::Function1s::TableBase< Type, Function1Type >

Base class for table with bounds handling, interpolation and integration.

Source files

Definition at line 56 of file TableBase.H.

Constructor & Destructor Documentation

◆ TableBase() [1/3]

TableBase	(	const word &	name,
		const dictionary &	dict
	)

Construct from dictionary. Table is not populated.

Definition at line 138 of file TableBase.C.

Referenced by TableBase< scalar, TableFile< scalar > >::bound(), and TableBase< scalar, TableFile< scalar > >::TableBase().

Here is the caller graph for this function:

◆ TableBase() [2/3]

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

Construct from components.

Definition at line 166 of file TableBase.C.

◆ TableBase() [3/3]

TableBase ( const TableBase< Type, Function1Type > & tbl )

Copy constructor. Note: Steals interpolator and tableSamples.

Definition at line 184 of file TableBase.C.

◆ ~TableBase()

~TableBase ( )

virtual

Destructor.

Definition at line 202 of file TableBase.C.

Member Function Documentation

◆ interpolator()

const Foam::interpolationWeights & interpolator ( ) const

protected

Return (demand driven) interpolator.

Definition at line 34 of file TableBase.C.

◆ check()

void check ( ) const

protected

Check the table for size and consistency.

Definition at line 57 of file TableBase.C.

◆ bound()

Foam::scalar bound ( const scalar x ) const

protected

Bound the argument to the table. Errors or warns, or shifts the.

value if the table repeats. Does not clamp to the ends of the table as the interpolator already performs that function.

Definition at line 87 of file TableBase.C.

Referenced by TableBase< scalar, TableFile< scalar > >::check().

Here is the caller graph for this function:

◆ value()

Type value ( const scalar x ) const

virtual

Return Table value.

Implements FieldFunction1< Type, Function1Type >.

Definition at line 210 of file TableBase.C.

Referenced by TableBase< scalar, TableFile< scalar > >::~TableBase().

Here is the caller graph for this function:

◆ integrate()

Type integrate	(	const scalar	x1,
		const scalar	x2
	)		const

virtual

Integrate between two (scalar) values.

Implements FieldFunction1< Type, Function1Type >.

Definition at line 230 of file TableBase.C.

Referenced by TableBase< scalar, TableFile< scalar > >::value().

Here is the caller graph for this function:

◆ x()

Foam::tmp< Foam::scalarField > x ( ) const

virtual

Return the reference values.

Definition at line 272 of file TableBase.C.

◆ y()

Foam::tmp< Foam::Field< Type > > y ( ) const

virtual

Return the dependent values.

Definition at line 288 of file TableBase.C.

◆ writeEntries()

void writeEntries ( Ostream & os ) const

virtual

Write entries only in dictionary format.

Reimplemented in TableFile< Type >, TableFile< scalar >, Table< Type >, and Table< scalar >.

Definition at line 304 of file TableBase.C.

Referenced by TableBase< scalar, TableFile< scalar > >::y().

Here is the caller graph for this function:

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write all table data in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 328 of file TableBase.C.

Referenced by TableBase< scalar, TableFile< scalar > >::writeEntries().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const TableBase< Type, Function1Type > & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ name_

const word name_

protected

Table name.

Definition at line 66 of file TableBase.H.

◆ boundsHandling_

const tableBase::boundsHandling boundsHandling_

protected

Enumeration for handling out-of-bound values.

Definition at line 69 of file TableBase.H.

◆ interpolationScheme_

const word interpolationScheme_

protected

Interpolation type.

Definition at line 72 of file TableBase.H.

◆ table_

List<Tuple2<scalar, Type> > table_

protected

Table data.

Definition at line 75 of file TableBase.H.

◆ tableSamplesPtr_

autoPtr<scalarField> tableSamplesPtr_

mutableprotected

Extracted values.

Definition at line 78 of file TableBase.H.

◆ interpolatorPtr_

autoPtr<interpolationWeights> interpolatorPtr_

mutableprotected

Interpolator method.

Definition at line 81 of file TableBase.H.

◆ indices_

labelList indices_

mutableprotected

Cached indices.

Definition at line 84 of file TableBase.H.

◆ weights_

scalarField weights_

mutableprotected

Cached weights.

Definition at line 87 of file TableBase.H.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Type, class Function1Type> class Foam::Function1s::TableBase< Type, Function1Type >

Constructor & Destructor Documentation

◆ TableBase() [1/3]

◆ TableBase() [2/3]

◆ TableBase() [3/3]

◆ ~TableBase()

Member Function Documentation

◆ interpolator()

◆ check()

◆ bound()

◆ value()

◆ integrate()

◆ x()

◆ y()

◆ writeEntries()

◆ writeData()

◆ operator=()

Member Data Documentation

◆ name_

◆ boundsHandling_

◆ interpolationScheme_

◆ table_

◆ tableSamplesPtr_

◆ interpolatorPtr_

◆ indices_

◆ weights_

template<class Type, class Function1Type>
class Foam::Function1s::TableBase< Type, Function1Type >