interpolation2DTable< Type > Class Template Reference

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
typedef List< Tuple2< scalar, List< Tuple2< scalar, Type > > > >	table
Public Types inherited from List< Tuple2< scalar, List< Tuple2< scalar, Type > > > >
typedef SubList< T >	subList

Public Member Functions
	interpolation2DTable ()
	interpolation2DTable (const List< Tuple2< scalar, List< Tuple2< scalar, Type >>>> &values, const bounds::normalBounding bounding, const fileName &fName)
	interpolation2DTable (const fileName &fName)
	interpolation2DTable (const dictionary &dict)
	interpolation2DTable (const interpolation2DTable &tbl)
void	check () const
void	write (Ostream &os) const
void	operator= (const interpolation2DTable< Type > &rhs)
Type	operator() (const scalar valueX, const scalar valueY) const
void	checkOrder () const
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
	List (const label len)
	List (const label len, const T &val)
	List (const label len, const Foam::zero)
	List (const Foam::one, const T &val)
	List (const Foam::one, T &&val)
	List (const Foam::one, const Foam::zero)
	List (const List< T > &a)
	List (const UList< T > &a)
	List (List< T > &a, bool reuse)
	List (const UList< T > &list, const labelUList &indices)
	List (const UList< T > &list, const FixedList< label, N > &indices)
	List (const FixedList< T, N > &list)
	List (const PtrList< T > &list)
	List (const SLList< T > &list)
	List (const IndirectListBase< T, Addr > &list)
	List (std::initializer_list< T > list)
	List (List< T > &&list)
	List (DynamicList< T, SizeMin > &&list)
	List (SortableList< T > &&list)
	List (SLList< T > &&list)
	List (Istream &is)
	List (const label len)
	List (const label len, const T &val)
	List (const label len, const Foam::zero)
	List (const Foam::one, const T &val)
	List (const Foam::one, T &&val)
	List (const Foam::one, const Foam::zero)
	List (const UList< T > &a)
	List (const List< T > &a)
	List (List< T > &a, bool reuse)
	List (const UList< T > &list, const labelUList &indices)
	List (const PtrList< T > &list)
	List (const SLList< T > &list)
	List (std::initializer_list< T > list)
	List (List< T > &&list)
	List (SortableList< T > &&list)
	List (SLList< T > &&list)
constexpr	List () noexcept
	List (Istream &is)
autoPtr< List< T > >	clone () const
	~List ()
void	clear ()
void	resize (const label len)
void	resize (const label len, const T &val)
void	resize (const label newLen)
void	resize_nocopy (const label len)
void	setSize (const label n)
void	setSize (const label n, const T &val)
void	append (const T &val)
void	append (T &&val)
void	append (const UList< T > &list)
void	append (const IndirectListBase< T, Addr > &list)
void	append (const T &val)
void	append (T &&val)
void	append (const UList< T > &list)
label	appendUniq (const T &val)
void	transfer (List< T > &list)
void	transfer (DynamicList< T, SizeMin > &list)
void	transfer (SortableList< T > &list)
void	transfer (List< T > &list)
void	transfer (SortableList< T > &list)
T &	newElmt (const label i)
void	operator= (const UList< T > &a)
void	operator= (const List< T > &list)
void	operator= (const SLList< T > &list)
void	operator= (const IndirectListBase< T, Addr > &list)
void	operator= (const FixedList< T, N > &list)
void	operator= (std::initializer_list< T > list)
void	operator= (const T &val)
void	operator= (const Foam::zero)
void	operator= (List< T > &&list)
void	operator= (DynamicList< T, SizeMin > &&list)
void	operator= (SortableList< T > &&list)
void	operator= (SLList< T > &&list)
void	operator= (const UList< T > &a)
void	operator= (const List< T > &list)
void	operator= (const SLList< T > &list)
void	operator= (std::initializer_list< T > list)
void	operator= (List< T > &&list)
void	operator= (SortableList< T > &&list)
void	operator= (SLList< T > &&list)
void	operator= (const T &val)
void	operator= (const Foam::zero)
Istream &	readList (Istream &is)
Istream &	readList (Istream &is)
Istream &	readList (Istream &is)
void	shallowCopy (const UList< T > &)=delete
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)

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

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

• interpolation2DTable.H
• interpolation2DTable.C

Definition at line 49 of file interpolation2DTable.H.

Member Typedef Documentation

value_type

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

Definition at line 92 of file interpolation2DTable.H.

table

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

Definition at line 95 of file interpolation2DTable.H.

Constructor & Destructor Documentation

interpolation2DTable() [1/5]

interpolation2DTable

Definition at line 50 of file interpolation2DTable.C.

interpolation2DTable() [2/5]

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

Definition at line 61 of file interpolation2DTable.C.

interpolation2DTable() [3/5]

interpolation2DTable ( const fileName &  fName )

explicit

Definition at line 75 of file interpolation2DTable.C.

interpolation2DTable() [4/5]

interpolation2DTable ( const dictionary &  dict )

explicit

Definition at line 87 of file interpolation2DTable.C.

interpolation2DTable() [5/5]

interpolation2DTable

(

const interpolation2DTable< Type > &

tbl

)

Definition at line 109 of file interpolation2DTable.C.

Member Function Documentation

check()

void check

Definition at line 281 of file interpolation2DTable.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Referenced by interpolation2DTable< Type >::checkOrder().

Here is the call graph for this function:

Here is the caller graph for this function:

write()

void write

(

Ostream &

os

)

const

Definition at line 307 of file interpolation2DTable.C.

References Foam::bounds::normalBoundingNames, os(), and Ostream::writeEntry().

Here is the call graph for this function:

operator=()

void operator=

(

const interpolation2DTable< Type > &

rhs

)

Definition at line 216 of file interpolation2DTable.C.

operator()()

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

Definition at line 234 of file interpolation2DTable.C.

References Foam::nl, WarningInFunction, Foam::y0(), Foam::y1(), and Foam::Zero.

Here is the call graph for this function:

checkOrder()

void checkOrder ( ) const

inline

Definition at line 144 of file interpolation2DTable.H.

References interpolation2DTable< Type >::check().

Here is the call graph for this function:

Xi()

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

Definition at line 141 of file interpolation2DTable.C.

References Foam::abort(), Foam::bounds::CLAMP, Foam::bounds::ERROR, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, Foam::reverse(), Foam::bounds::WARN, and WarningInFunction.

Here is the call graph for this function:

---

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

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