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
typedef Tuple2< scalar, List< Tuple2< scalar, Type > > >	value_type
	The element data type. More...

typedef List< Tuple2< scalar, List< Tuple2< scalar, Type > > > >	table
	Convenience 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 Member Functions
	interpolation2DTable ()
	Default construct. More...

	interpolation2DTable (const List< Tuple2< scalar, List< Tuple2< scalar, Type >>>> &values, const bounds::normalBounding bounding, 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 file name and outOfBounds from dictionary. More...

	interpolation2DTable (const interpolation2DTable &tbl)
	Copy construct. More...

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

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

void	operator= (const interpolation2DTable< Type > &rhs)
	Copy assignment. More...

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

void	checkOrder () const
	Deprecated(2019-08) check list is monotonically increasing. 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 > > > >
constexpr	List () noexcept
	Default construct. More...

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

	List (const label len, const Tuple2< scalar, List< Tuple2< scalar, Type > > > &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 Tuple2< scalar, List< Tuple2< scalar, Type > > > &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, Tuple2< scalar, List< Tuple2< scalar, Type > > > &&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< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &a)
	Copy construct from list. More...

	List (const UList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &a)
	Copy construct contents from list. More...

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

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

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

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

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

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

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

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

	List (List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &&list)
	Move construct from List. More...

	List (DynamicList< Tuple2< scalar, List< Tuple2< scalar, Type > > >, SizeMin > &&list)
	Move construct from DynamicList. More...

	List (SortableList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &&list)
	Move construct from SortableList. More...

	List (SLList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &&list)
	Move construct from SLList. More...

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

autoPtr< List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > >	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 Tuple2< scalar, List< Tuple2< scalar, Type > > > &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 Tuple2< scalar, List< Tuple2< scalar, Type > > > &val)
	Alias for resize() More...

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

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

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

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

label	appendUniq (const Tuple2< scalar, List< Tuple2< scalar, Type > > > &val)
	Append an element if not already in the list. More...

void	transfer (List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &list)

void	transfer (DynamicList< Tuple2< scalar, List< Tuple2< scalar, Type > > >, SizeMin > &list)

void	transfer (SortableList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &list)

Tuple2< scalar, List< Tuple2< scalar, Type > > > &	newElmt (const label i)

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

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

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

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

void	operator= (const FixedList< Tuple2< scalar, List< Tuple2< scalar, Type > > >, N > &list)
	Copy assignment from FixedList. More...

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

void	operator= (const Tuple2< scalar, List< Tuple2< scalar, Type > > > &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< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &&list)
	Move assignment. Takes constant time. More...

void	operator= (DynamicList< Tuple2< scalar, List< Tuple2< scalar, Type > > >, SizeMin > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SortableList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &&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< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)=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
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...

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 53 of file interpolation2DTable.H.

Member Typedef Documentation

◆ value_type

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

The element data type.

Definition at line 96 of file interpolation2DTable.H.

◆ table

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

Convenience typedef.

Definition at line 99 of file interpolation2DTable.H.

Constructor & Destructor Documentation

◆ interpolation2DTable() [1/5]

interpolation2DTable ( )

Default construct.

Definition at line 57 of file interpolation2DTable.C.

◆ interpolation2DTable() [2/5]

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

Construct from components.

Definition at line 68 of file interpolation2DTable.C.

◆ interpolation2DTable() [3/5]

interpolation2DTable ( const fileName & fName )

explicit

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

Definition at line 82 of file interpolation2DTable.C.

◆ interpolation2DTable() [4/5]

interpolation2DTable ( const dictionary & dict )

explicit

Construct by reading file name and outOfBounds from dictionary.

Definition at line 94 of file interpolation2DTable.C.

◆ interpolation2DTable() [5/5]

interpolation2DTable ( const interpolation2DTable< Type > & tbl )

Copy construct.

Definition at line 116 of file interpolation2DTable.C.

Member Function Documentation

◆ check()

void check ( ) const

Check that list is monotonically increasing.

Exit with a FatalError if there is a problem

Definition at line 288 of file interpolation2DTable.C.

◆ write()

void write ( Ostream & os ) const

Write.

Definition at line 314 of file interpolation2DTable.C.

◆ operator=()

void operator= ( const interpolation2DTable< Type > & rhs )

Copy assignment.

Definition at line 223 of file interpolation2DTable.C.

◆ operator()()

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

Return an interpolated value.

Definition at line 241 of file interpolation2DTable.C.

◆ checkOrder()

void checkOrder ( ) const

inline

Deprecated(2019-08) check list is monotonically increasing.

Deprecated:: (2019-08) - older name for check() method

Definition at line 148 of file interpolation2DTable.H.

◆ Xi()

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

Definition at line 148 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