A list of lists. Interpolates based on the first dimension. The values must be positive and monotonically increasing in each dimension. More...

Inheritance diagram for interpolationLookUpTable< Type >:

[legend]

Collaboration diagram for interpolationLookUpTable< Type >:

[legend]

Public Member Functions
	interpolationLookUpTable ()
	Construct null. More...

	interpolationLookUpTable (const fileName &, const word &instance, const objectRegistry &)
	Construct given the name of the file containing the table of data. More...

	interpolationLookUpTable (const dictionary &)
	Construct from dictionary. More...

	interpolationLookUpTable (const interpolationLookUpTable &)
	Construct copy. More...

bool	found (const word &fieldName) const
	Return true if the field exists in the table. More...

const List< scalar > &	lookUp (const scalar)
	Return the output list given a single input scalar. More...

void	write (Ostream &, const fileName &, const word &instance, const objectRegistry &) const
	Write lookup table to filename. More...

label	findFieldIndex (const word &fieldName) const
	Return the index of a field by name. More...

const List< dictionary > &	output () const
	Return const access to the output dictionaries. More...

const List< dictionary > &	entries () const
	Return const access tp the dictionary entries. More...

const List< scalar > &	min () const
	Return const access to the list of min dimensions. More...

const List< label > &	dim () const
	Return const access to the list of dimensions. More...

const List< scalar > &	delta () const
	Return const access to the deltas in each dimension. More...

const List< scalar > &	max () const
	Return const access to the list of max dimensions. More...

word	tableName () const
	Return const access to the table name. More...

const scalarField &	operator[] (const label) const
	Return an element of constant List<scalar, Type> More...

scalarField &	operator[] (const label)
	Return an element of List<scalar, Type> More...

Public Member Functions inherited from List< scalarField >
constexpr	List () noexcept
	Default construct. More...

	List (const label len)
	Construct with given size. More...

	List (const label len, const scalarField &val)
	Construct with given size and value for all elements. More...

	List (const label len, const Foam::zero)
	Construct with given size initializing all elements to zero. More...

	List (const Foam::one, const scalarField &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, scalarField &&val)
	Construct with length=1, moving the value as the only content. More...

	List (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...

	List (const List< scalarField > &a)
	Copy construct from list. More...

	List (const UList< scalarField > &a)
	Copy construct contents from list. More...

	List (List< scalarField > &a, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< scalarField > &list, const labelUList &indices)
	Copy construct subset of list. More...

	List (const UList< scalarField > &list, const FixedList< label, N > &indices)
	Copy construct subset of list. More...

	List (const FixedList< scalarField, N > &list)
	Construct as copy of FixedList<T, N> More...

	List (const PtrList< scalarField > &list)
	Construct as copy of PtrList<T> More...

	List (const SLList< scalarField > &list)
	Construct as copy of SLList<T> More...

	List (const IndirectListBase< scalarField, Addr > &list)
	Construct as copy of IndirectList contents. More...

	List (std::initializer_list< scalarField > list)
	Construct from an initializer list. More...

	List (List< scalarField > &&list)
	Move construct from List. More...

	List (DynamicList< scalarField, SizeMin > &&list)
	Move construct from DynamicList. More...

	List (SortableList< scalarField > &&list)
	Move construct from SortableList. More...

	List (SLList< scalarField > &&list)
	Move construct from SLList. More...

	List (Istream &is)
	Construct from Istream. More...

autoPtr< List< scalarField > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

void	clear ()
	Clear the list, i.e. set size to zero. More...

void	resize (const label len)
	Adjust allocated size of list. More...

void	resize (const label len, const scalarField &val)
	Adjust allocated size of list and set val for new elements. More...

void	resize (const label newLen)

void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily. More...

void	setSize (const label n)
	Alias for resize() More...

void	setSize (const label n, const scalarField &val)
	Alias for resize() More...

void	append (const scalarField &val)
	Append an element at the end of the list. More...

void	append (scalarField &&val)
	Move append an element at the end of the list. More...

void	append (const UList< scalarField > &list)
	Append a List to the end of this list. More...

void	append (const IndirectListBase< scalarField, Addr > &list)
	Append IndirectList contents at the end of this list. More...

label	appendUniq (const scalarField &val)
	Append an element if not already in the list. More...

void	transfer (List< scalarField > &list)

void	transfer (DynamicList< scalarField, SizeMin > &list)

void	transfer (SortableList< scalarField > &list)

scalarField &	newElmt (const label i)

void	operator= (const UList< scalarField > &a)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< scalarField > &list)
	Assignment operator. Takes linear time. More...

void	operator= (const SLList< scalarField > &list)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const IndirectListBase< scalarField, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...

void	operator= (const FixedList< scalarField, N > &list)
	Copy assignment from FixedList. More...

void	operator= (std::initializer_list< scalarField > list)
	Assignment to an initializer list. More...

void	operator= (const scalarField &val)
	Assignment of all entries to the given value. More...

void	operator= (const Foam::zero)
	Assignment of all entries to zero. More...

void	operator= (List< scalarField > &&list)
	Move assignment. Takes constant time. More...

void	operator= (DynamicList< scalarField, SizeMin > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SortableList< scalarField > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< scalarField > &&list)
	Move assignment. Takes constant time. More...

Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List. More...

Istream &	readList (Istream &is)

Istream &	readList (Istream &is)

void	shallowCopy (const UList< scalarField > &)=delete
	No shallowCopy permitted. More...

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool. More...

Additional Inherited Members
Public Types inherited from List< scalarField >
typedef SubList< scalarField >	subList
	Declare type of subList. More...

Static Public Member Functions inherited from List< scalarField >
static const List< scalarField > &	null ()
	Return a null List. More...

Detailed Description

template<class Type>
class Foam::interpolationLookUpTable< Type >

A list of lists. Interpolates based on the first dimension. The values must be positive and monotonically increasing in each dimension.

Note

Accessing an empty list results in an error.
Accessing a list with a single element always returns the same value.

Source files

Definition at line 63 of file interpolationLookUpTable.H.

Constructor & Destructor Documentation

◆ interpolationLookUpTable() [1/4]

interpolationLookUpTable ( )

Construct null.

Definition at line 231 of file interpolationLookUpTable.C.

◆ interpolationLookUpTable() [2/4]

interpolationLookUpTable	(	const fileName &	fn,
		const word &	instance,
		const objectRegistry &	obr
	)

Construct given the name of the file containing the table of data.

Definition at line 240 of file interpolationLookUpTable.C.

◆ interpolationLookUpTable() [3/4]

interpolationLookUpTable ( const dictionary & dict )

Construct from dictionary.

Definition at line 284 of file interpolationLookUpTable.C.

◆ interpolationLookUpTable() [4/4]

interpolationLookUpTable ( const interpolationLookUpTable< Type > & interpTable )

Construct copy.

Definition at line 264 of file interpolationLookUpTable.C.

Member Function Documentation

◆ found()

bool found ( const word & fieldName ) const

Return true if the field exists in the table.

Definition at line 427 of file interpolationLookUpTable.C.

◆ lookUp()

const Foam::scalarList & lookUp ( const scalar retvals )

Return the output list given a single input scalar.

Definition at line 435 of file interpolationLookUpTable.C.

◆ write()

void write	(	Ostream &	os,
		const fileName &	fn,
		const word &	instance,
		const objectRegistry &	obr
	)		const

Write lookup table to filename.

Definition at line 338 of file interpolationLookUpTable.C.

◆ findFieldIndex()

Foam::label findFieldIndex ( const word & fieldName ) const

inline

Return the index of a field by name.

Definition at line 31 of file interpolationLookUpTableI.H.

◆ output()

const Foam::List< Foam::dictionary > & output ( ) const

inline

Return const access to the output dictionaries.

Definition at line 41 of file interpolationLookUpTableI.H.

◆ entries()

const Foam::List< Foam::dictionary > & entries ( ) const

inline

Return const access tp the dictionary entries.

Definition at line 49 of file interpolationLookUpTableI.H.

◆ min()

const Foam::List< Foam::scalar > & min ( ) const

inline

Return const access to the list of min dimensions.

Definition at line 57 of file interpolationLookUpTableI.H.

◆ dim()

const Foam::List< Foam::label > & dim ( ) const

inline

Return const access to the list of dimensions.

Definition at line 65 of file interpolationLookUpTableI.H.

◆ delta()

const Foam::List< Foam::scalar > & delta ( ) const

inline

Return const access to the deltas in each dimension.

Definition at line 73 of file interpolationLookUpTableI.H.

◆ max()

const Foam::List< Foam::scalar > & max ( ) const

inline

Return const access to the list of max dimensions.

Definition at line 81 of file interpolationLookUpTableI.H.

◆ tableName()

Foam::word tableName ( ) const

inline

Return const access to the table name.

Definition at line 88 of file interpolationLookUpTableI.H.

◆ operator[]() [1/2]

const Foam::scalarField & operator[] ( const label i ) const

Return an element of constant List<scalar, Type>

Definition at line 401 of file interpolationLookUpTable.C.

◆ operator[]() [2/2]

Foam::scalarField & operator[] ( const label i )

Return an element of List<scalar, Type>

Definition at line 375 of file interpolationLookUpTable.C.

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

src/OpenFOAM/interpolations/interpolationLookUpTable/interpolationLookUpTable.H
src/OpenFOAM/interpolations/interpolationLookUpTable/interpolationLookUpTable.C
src/OpenFOAM/interpolations/interpolationLookUpTable/interpolationLookUpTableI.H

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::interpolationLookUpTable< Type >

Constructor & Destructor Documentation

◆ interpolationLookUpTable() [1/4]

◆ interpolationLookUpTable() [2/4]

◆ interpolationLookUpTable() [3/4]

◆ interpolationLookUpTable() [4/4]

Member Function Documentation

◆ found()

◆ lookUp()

◆ write()

◆ findFieldIndex()

◆ output()

◆ entries()

◆ min()

◆ dim()

◆ delta()

◆ max()

◆ tableName()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

template<class Type>
class Foam::interpolationLookUpTable< Type >