2D table interpolation. The data must be in ascending order in both dimensions x and y. More...

Inheritance diagram for interpolation2DTable< Type >:

Collaboration diagram for interpolation2DTable< Type >:

Public Types
enum	boundsHandling { ERROR, WARN, CLAMP }
	Enumeration for handling out-of-bound values. More...

typedef List< Tuple2< scalar, List< Tuple2< scalar, Type > > > >	table
	Cconvenience typedef. More...

Public Types inherited from List< Tuple2< scalar, List< Tuple2< scalar, Type > > > >
typedef SubList< Tuple2< scalar, List< Tuple2< scalar, Type > > > >	subList
	Declare type of subList. More...

Public Types inherited from UList< T >
typedef T	value_type
	Type of values the UList contains. More...

typedef T &	reference
	Type that can be used for storing into. More...

typedef const T &	const_reference
	Type that can be used for storing into. More...

typedef label	difference_type
	The type that can represent the difference between any two. More...

typedef label	size_type
	The type that can represent the size of a UList. More...

typedef T *	iterator
	Random access iterator for traversing UList. More...

typedef const T *	const_iterator
	Random access iterator for traversing UList. More...

typedef T *	reverse_iterator
	Reverse iterator for reverse traversal of UList. More...

typedef const T *	const_reverse_iterator
	Reverse iterator for reverse traversal of constant UList. More...

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

	interpolation2DTable (const List< Tuple2< scalar, List< Tuple2< scalar, Type >>>> &values, const boundsHandling bounds, const fileName &fName)
	Construct from components. More...

	interpolation2DTable (const fileName &fName)
	Construct given the name of the file containing the table of data. More...

	interpolation2DTable (const dictionary &dict)
	Construct by reading the fileName and boundsHandling from dictionary. More...

	interpolation2DTable (const interpolation2DTable &interpTable)
	Construct copy. More...

word	boundsHandlingToWord (const boundsHandling &bound) const
	Return the out-of-bounds handling as a word. More...

boundsHandling	wordToBoundsHandling (const word &bound) const
	Return the out-of-bounds handling as an enumeration. More...

boundsHandling	outOfBounds (const boundsHandling &bound)
	Set the out-of-bounds handling from enum, return previous setting. More...

void	checkOrder () const
	Check that list is monotonically increasing. More...

void	write (Ostream &os) const
	Write. More...

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

Type	operator() (const scalar, const scalar) const
	Return an interpolated value. More...

template<class BinaryOp >
Foam::label	Xi (const BinaryOp &bop, const scalar valueX, const bool reverse) const

Public Member Functions inherited from List< Tuple2< scalar, List< Tuple2< scalar, Type > > > >
	List ()
	Null constructor. More...

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

	List (const label, const Tuple2< scalar, List< Tuple2< scalar, Type > > > &)
	Construct with given size and value for all elements. More...

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

	List (const List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)
	Copy constructor. More...

	List (const List< T2 > &)
	Copy constructor from list containing another type. More...

	List (List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &&)
	Move constructor. More...

	List (List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &, const labelUList &mapAddressing)
	Construct as subset. More...

	List (InputIterator first, InputIterator last)
	Construct given start and end iterators. More...

	List (const FixedList< Tuple2< scalar, List< Tuple2< scalar, Type > > >, Size > &)
	Construct as copy of FixedList<T, Size> More...

	List (const PtrList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)
	Construct as copy of PtrList<T> More...

	List (const SLList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)
	Construct as copy of SLList<T> More...

	List (const UIndirectList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)
	Construct as copy of UIndirectList<T> More...

	List (const BiIndirectList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)
	Construct as copy of BiIndirectList<T> More...

	List (std::initializer_list< Tuple2< scalar, List< Tuple2< scalar, Type > > > >)
	Construct from an initializer list. More...

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

label	size () const
	Return the number of elements in the UList. More...

autoPtr< List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

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

void	resize (const label, const Tuple2< scalar, List< Tuple2< scalar, Type > > > &)
	Alias for setSize(const label, const T&) More...

void	setSize (const label)
	Reset size of List. More...

void	setSize (const label, const Tuple2< scalar, List< Tuple2< scalar, Type > > > &)
	Reset size of List and value for new elements. More...

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

void	append (const Tuple2< scalar, List< Tuple2< scalar, Type > > > &)
	Append an element at the end of the list. More...

void	append (const UList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)
	Append a List at the end of this list. More...

void	append (const UIndirectList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)
	Append a UIndirectList at the end of this list. More...

void	transfer (List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (DynamicList< Tuple2< scalar, List< Tuple2< scalar, Type > > >, SizeInc, SizeMult, SizeDiv > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (SortableList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)
	Transfer the contents of the argument List into this list. More...

Tuple2< scalar, List< Tuple2< scalar, Type > > > &	newElmt (const label)
	Return subscript-checked element of UList. More...

void	shallowCopy (const UList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)=delete
	Disallow implicit shallowCopy. More...

void	operator= (const UList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)
	Assignment operator. Takes linear time. More...

void	operator= (List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &&)
	Move assignment operator. More...

void	operator= (const SLList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const UIndirectList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)
	Assignment to UIndirectList operator. Takes linear time. More...

void	operator= (const BiIndirectList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)
	Assignment to BiIndirectList operator. Takes linear time. More...

void	operator= (std::initializer_list< Tuple2< scalar, List< Tuple2< scalar, Type > > > >)
	Assignment to an initializer list. More...

void	operator= (const Tuple2< scalar, List< Tuple2< scalar, Type > > > &)
	Assignment of all entries to the given value. More...

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

Public Member Functions inherited from UList< T >
	UList ()
	Null constructor. More...

	UList (T *__restrict__ v, label size)
	Construct from components. More...

label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index. More...

label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index. More...

std::streamsize	byteSize () const
	Return the binary size in number of characters of the UList. More...

const T *	cdata () const
	Return a const pointer to the first data element,. More...

T *	data ()
	Return a pointer to the first data element,. More...

T &	first ()
	Return the first element of the list. More...

const T &	first () const
	Return first element of the list. More...

T &	last ()
	Return the last element of the list. More...

const T &	last () const
	Return the last element of the list. More...

void	checkStart (const label start) const
	Check start is within valid range (0 ... size-1) More...

void	checkSize (const label size) const
	Check size is within valid range (0 ... size) More...

void	checkIndex (const label i) const
	Check index i is within valid range (0 ... size-1) More...

void	shallowCopy (const UList< T > &)
	Copy the pointer held by the given UList. More...

void	deepCopy (const UList< T > &)
	Copy elements of the given UList. More...

T &	operator[] (const label)
	Return element of UList. More...

const T &	operator[] (const label) const
	Return element of constant UList. More...

	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&. More...

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

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

iterator	begin ()
	Return an iterator to begin traversing the UList. More...

iterator	end ()
	Return an iterator to end traversing the UList. More...

const_iterator	cbegin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const
	Return const_iterator to end traversing the constant UList. More...

const_iterator	begin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	end () const
	Return const_iterator to end traversing the constant UList. More...

reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList. More...

reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

label	size () const
	Return the number of elements in the UList. More...

label	max_size () const
	Return size of the largest possible UList. More...

bool	empty () const
	Return true if the UList is empty (ie, size() is zero) More...

void	swap (UList< T > &)
	Swap two ULists of the same type in constant time. More...

bool	operator== (const UList< T > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< T > &) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< T > &) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< T > &) const
	Return true if !(a < b). Takes linear time. More...

template<>
const bool &	operator[] (const label i) const

Additional Inherited Members
Static Public Member Functions inherited from List< Tuple2< scalar, List< Tuple2< scalar, Type > > > >
static const List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &	null ()
	Return a null List. More...

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

Protected Member Functions inherited from List< Tuple2< scalar, List< Tuple2< scalar, Type > > > >
void	size (const label)
	Override size to be inconsistent with allocated storage. More...

Detailed Description

template<class Type>
class Foam::interpolation2DTable< Type >

2D table interpolation. The data must be in ascending order in both dimensions x and y.

Source files

Definition at line 52 of file interpolation2DTable.H.

Member Typedef Documentation

◆ table

typedef List<Tuple2<scalar, List<Tuple2<scalar, Type> > > > table

Cconvenience typedef.

Definition at line 69 of file interpolation2DTable.H.

Member Enumeration Documentation

◆ boundsHandling

enum boundsHandling

Enumeration for handling out-of-bound values.

Enumerator
ERROR	Exit with a FatalError.
WARN	Issue warning and clamp value (default)
CLAMP	Clamp value to the start/end value.

Definition at line 61 of file interpolation2DTable.H.

Constructor & Destructor Documentation

◆ interpolation2DTable() [1/5]

interpolation2DTable ( )

Construct null.

Definition at line 31 of file interpolation2DTable.C.

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

Here is the caller graph for this function:

◆ interpolation2DTable() [2/5]

interpolation2DTable	(	const List< Tuple2< scalar, List< Tuple2< scalar, Type >>>> &	values,
		const boundsHandling	bounds,
		const fileName &	fName
	)

Construct from components.

Definition at line 42 of file interpolation2DTable.C.

◆ interpolation2DTable() [3/5]

interpolation2DTable ( const fileName & fName )

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

Definition at line 56 of file interpolation2DTable.C.

◆ interpolation2DTable() [4/5]

interpolation2DTable ( const dictionary & dict )

Construct by reading the fileName and boundsHandling from dictionary.

Definition at line 69 of file interpolation2DTable.C.

◆ interpolation2DTable() [5/5]

interpolation2DTable ( const interpolation2DTable< Type > & interpTable )

Construct copy.

Definition at line 83 of file interpolation2DTable.C.

Member Function Documentation

◆ boundsHandlingToWord()

Foam::word boundsHandlingToWord ( const boundsHandling & bound ) const

Return the out-of-bounds handling as a word.

Definition at line 329 of file interpolation2DTable.C.

Referenced by interpolation2DTable< scalar >::operator()().

Here is the caller graph for this function:

◆ wordToBoundsHandling()

Foam::interpolation2DTable< Type >::boundsHandling wordToBoundsHandling ( const word & bound ) const

Return the out-of-bounds handling as an enumeration.

Definition at line 361 of file interpolation2DTable.C.

Referenced by interpolation2DTable< scalar >::boundsHandlingToWord().

Here is the caller graph for this function:

◆ outOfBounds()

Foam::interpolation2DTable< Type >::boundsHandling outOfBounds ( const boundsHandling & bound )

Set the out-of-bounds handling from enum, return previous setting.

Definition at line 390 of file interpolation2DTable.C.

Referenced by interpolation2DTable< scalar >::wordToBoundsHandling().

Here is the caller graph for this function:

◆ checkOrder()

void checkOrder ( ) const

Check that list is monotonically increasing.

Exit with a FatalError if there is a problem

Definition at line 401 of file interpolation2DTable.C.

◆ write()

void write ( Ostream & os ) const

Write.

Definition at line 426 of file interpolation2DTable.C.

◆ operator[]()

const List<Tuple2<scalar, Type> >& operator[] ( const label ) const

Return an element of constant Tuple2<scalar, Type>

◆ operator()()

Type operator()	(	const scalar	valueX,
		const scalar	valueY
	)		const

Return an interpolated value.

Definition at line 276 of file interpolation2DTable.C.

◆ Xi()

Foam::label Xi	(	const BinaryOp &	bop,
		const scalar	valueX,
		const bool	reverse
	)		const

Definition at line 203 of file interpolation2DTable.C.

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

src/OpenFOAM/interpolations/interpolation2DTable/interpolation2DTable.H
src/OpenFOAM/interpolations/interpolation2DTable/interpolation2DTable.C

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::interpolation2DTable< Type >

Member Typedef Documentation

◆ table

Member Enumeration Documentation

◆ boundsHandling

Constructor & Destructor Documentation

◆ interpolation2DTable() [1/5]

◆ interpolation2DTable() [2/5]

◆ interpolation2DTable() [3/5]

◆ interpolation2DTable() [4/5]

◆ interpolation2DTable() [5/5]

Member Function Documentation

◆ boundsHandlingToWord()

◆ wordToBoundsHandling()

◆ outOfBounds()

◆ checkOrder()

◆ write()

◆ operator[]()

◆ operator()()

◆ Xi()

template<class Type>
class Foam::interpolation2DTable< Type >