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

#include <interpolation2DTable.H>

Inheritance diagram for interpolation2DTable< Type >:

[legend]

Collaboration diagram for interpolation2DTable< Type >:

Public Types
typedef Tuple2< scalar, List< Tuple2< scalar, Type > > >	value_type
	The element data type.
typedef List< Tuple2< scalar, List< Tuple2< scalar, Type > > > >	table
	Convenience typedef.
Public Types inherited from List< Tuple2< scalar, List< Tuple2< scalar, Type > > > >
typedef SubList< Tuple2< scalar, List< Tuple2< scalar, Type > > > >	subList
	Declare type of subList.
Public Types inherited from UList< T >
typedef T	value_type
	The value type the list contains.
typedef T *	pointer
	The pointer type for non-const access to value_type items.
typedef const T *	const_pointer
	The pointer type for const access to value_type items.
typedef T &	reference
	The type used for storing into value_type objects.
typedef const T &	const_reference
	The type used for reading from constant value_type objects.
typedef T *	iterator
	Random access iterator for traversing a UList.
typedef const T *	const_iterator
	Random access iterator for traversing a UList.
typedef label	size_type
	The type to represent the size of a UList.
typedef label	difference_type
	The difference between iterator objects.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access).
using	is_List = void
	Have unique tag.

Public Member Functions
	interpolation2DTable ()
	Default construct.
	interpolation2DTable (const List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &values, const bounds::normalBounding bounding, const fileName &fName)
	Construct from components.
	interpolation2DTable (const fileName &fName)
	Construct given the name of the file containing the table of data.
	interpolation2DTable (const dictionary &dict)
	Construct by reading file name and outOfBounds from dictionary.
	interpolation2DTable (const interpolation2DTable &tbl)
	Copy construct.
void	check () const
	Check that list is monotonically increasing.
void	write (Ostream &os) const
	Write.
void	operator= (const interpolation2DTable< Type > &rhs)
	Copy assignment.
Type	operator() (const scalar valueX, const scalar valueY) const
	Return an interpolated value.
void	checkOrder () const
	Deprecated(2019-08) check list is monotonically increasing.
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.
	List (const label len)
	Construct with given size.
	List (const label len, const Tuple2< scalar, List< Tuple2< scalar, Type > > > &val)
	Construct with given size and value for all elements.
	List (const label len, Foam::zero)
	Construct with given size initializing all elements to zero.
	List (Foam::one, const Tuple2< scalar, List< Tuple2< scalar, Type > > > &val)
	Construct with length=1, copying the value as the only content.
	List (Foam::one, Tuple2< scalar, List< Tuple2< scalar, Type > > > &&val)
	Construct with length=1, moving the value as the only content.
	List (Foam::one, Foam::zero)
	Construct with length=1, initializing content to zero.
	List (const List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &list)
	Copy construct from list.
	List (const UList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &list)
	Copy construct contents from list.
	List (List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &list, bool reuse)
	Construct as copy or re-use as specified.
	List (const UList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &list, const labelUList &indices)
	Copy construct subset of list.
	List (const UList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &list, const FixedList< label, N > &indices)
	Copy construct subset of list.
	List (const FixedList< Tuple2< scalar, List< Tuple2< scalar, Type > > >, N > &list)
	Construct as copy of FixedList<T, N>.
	List (const UPtrList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &list)
	Construct as copy of UPtrList<T> content.
	List (const IndirectListBase< Tuple2< scalar, List< Tuple2< scalar, Type > > >, Addr > &list)
	Construct as copy of IndirectList contents.
	List (std::initializer_list< Tuple2< scalar, List< Tuple2< scalar, Type > > > > list)
	Construct from an initializer list.
	List (List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &&list) noexcept
	Move construct from List.
	List (DynamicList< Tuple2< scalar, List< Tuple2< scalar, Type > > >, SizeMin > &&list)
	Move construct from DynamicList.
	List (Istream &is)
	Construct from Istream.
autoPtr< List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > >	clone () const
	Clone.
	~List ()
	Destructor.
void	clear ()
	Clear the list, i.e. set size to zero.
void	resize (const label len)
	Adjust allocated size of list.
void	resize (const label len, const Tuple2< scalar, List< Tuple2< scalar, Type > > > &val)
	Adjust allocated size of list and set val for new elements.
void	resize_copy (label count, const label len)
	Change allocated size of list, retaining the first count elements.
void	resize_fill (const label len, const Tuple2< scalar, List< Tuple2< scalar, Type > > > &val)
	Adjust allocated size of list and set val for all elements.
void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily.
void	transfer (List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &list)
	Transfer the contents of the argument List into this list and annul the argument list.
void	transfer (DynamicList< Tuple2< scalar, List< Tuple2< scalar, Type > > >, SizeMin > &list)
	Transfer the contents of the argument List into this list and annul the argument list.
Tuple2< scalar, List< Tuple2< scalar, Type > > > &	newElmt (const label i)
	Return subscript-checked element of UList and resizing the list if required.
Tuple2< scalar, List< Tuple2< scalar, Type > > > &	emplace_back (Args &&... args)
	Construct an element at the end of the list, return reference to the new list element.
void	push_back (const Tuple2< scalar, List< Tuple2< scalar, Type > > > &val)
	Append an element at the end of the list.
void	push_back (Tuple2< scalar, List< Tuple2< scalar, Type > > > &&val)
	Move append an element at the end of the list.
void	push_back (const UList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &list)
	Append a List to the end of this list.
void	push_back (const IndirectListBase< Tuple2< scalar, List< Tuple2< scalar, Type > > >, Addr > &list)
	Append IndirectList contents at the end of this list.
label	push_uniq (const Tuple2< scalar, List< Tuple2< scalar, Type > > > &val)
	Append an element if not already in the list.
void	pop_back (label n=1)
	Reduce size by 1 or more elements. Can be called on an empty list.
void	operator= (const UList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &list)
	Assignment to UList operator. Takes linear time.
void	operator= (const List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &list)
	Assignment operator. Takes linear time.
void	operator= (const IndirectListBase< Tuple2< scalar, List< Tuple2< scalar, Type > > >, Addr > &list)
	Assignment from IndirectList. Takes linear time.
void	operator= (const FixedList< Tuple2< scalar, List< Tuple2< scalar, Type > > >, N > &list)
	Copy assignment from FixedList.
void	operator= (std::initializer_list< Tuple2< scalar, List< Tuple2< scalar, Type > > > > list)
	Assignment to an initializer list.
void	operator= (const Tuple2< scalar, List< Tuple2< scalar, Type > > > &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
void	operator= (List< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &&list)
	Move assignment. Takes constant time.
void	operator= (DynamicList< Tuple2< scalar, List< Tuple2< scalar, Type > > >, SizeMin > &&list)
	Move assignment. Takes constant time.
Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List.
void	shallowCopy (const UList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &)=delete
	No shallowCopy permitted.
bool	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool.
void	append (const Tuple2< scalar, List< Tuple2< scalar, Type > > > &val)
	Append an element at the end of the list.
void	append (Tuple2< scalar, List< Tuple2< scalar, Type > > > &&val)
	Move append an element at the end of the list.
void	append (const UList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &list)
	Append a List to the end of this list.
void	append (const IndirectListBase< Tuple2< scalar, List< Tuple2< scalar, Type > > >, Addr > &list)
	Append IndirectList contents at the end of this list.
label	appendUniq (const Tuple2< scalar, List< Tuple2< scalar, Type > > > &val)
	Same as push_uniq().
void	setSize (label n)
	Alias for resize().
void	setSize (label n, const Tuple2< scalar, List< Tuple2< scalar, Type > > > &val)
	Alias for resize().
	List (const Expression::ListExpression< E > &expr)
	Construct from value expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
void	resize (const label len)
Public Member Functions inherited from UList< T >
	UList (const UList< T > &) noexcept=default
	Copy construct, shallow copy.
	UList (UList< T > &&) noexcept=default
	Move construct, shallow copy.
UList< T > &	operator= (const UList< T > &)=delete
	No copy assignment (default: shallow copy).
UList< T > &	operator= (UList< T > &&) noexcept=default
	Move assignment, shallow copy.
constexpr	UList () noexcept
	Default construct, zero-sized and nullptr.
	UList (T *__restrict__ ptr, const label len) noexcept
	Construct from components.
	UList (SubList< T > &&) noexcept
	Move construct from a SubList, shallow copy.
label	fcIndex (const label i) const noexcept
	The forward circular index. The next index in the list which returns to the first at the end of the list.
label	rcIndex (const label i) const noexcept
	The reverse circular index. The previous index in the list which returns to the last at the beginning of the list.
const T &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
T &	fcValue (const label i)
	Return forward circular value (ie, next value in the list).
const T &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
T &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list).
const T *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
T *	data () noexcept
	Return pointer to the underlying array serving as data storage.
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,.
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,.
T &	front ()
	Access first element of the list, position [0].
const T &	front () const
	Access first element of the list.
T &	back ()
	Access last element of the list, position [size()-1].
const T &	back () const
	Access last element of the list, position [size()-1].
std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data.
std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous.
void	checkStart (const label start) const
	Check start is within valid range [0,size).
void	checkSize (const label size) const
	Check size is within valid range [0,size].
void	checkRange (const label start, const label len) const
	Check that start and length define a valid range.
void	checkIndex (const label i) const
	Check index is within valid range [0,size).
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
bool	contains (const T &val) const
	True if the value is contained in the list.
bool	contains (const T &val, label pos, label len=-1) const
	Is the value contained in the list?
label	find (const T &val) const
	Find index of the first occurrence of the value.
label	find (const T &val, label pos, label len=-1) const
	Find index of the first occurrence of the value.
label	rfind (const T &val, label pos=-1) const
	Find index of the last occurrence of the value.
void	moveFirst (const label i)
	Move element to the first position.
void	moveLast (const label i)
	Move element to the last position.
void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list.
void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list.
void	shallowCopy (T *__restrict__ ptr, const label len) noexcept
	Copy the pointer and size.
void	shallowCopy (std::nullptr_t) noexcept
	Copy nullptr and zero size.
void	shallowCopy (const UList< T > &list) noexcept
	Copy the pointer and size held by the given UList.
void	deepCopy (const UList< T > &list)
	Copy elements of the given UList. Sizes must match!
template<class Addr>
void	deepCopy (const IndirectListBase< T, Addr > &list)
	Copy elements of the given indirect list. Sizes must match!
SubList< T >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking.
const SubList< T >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking.
SubList< T >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking.
const SubList< T >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking.
T &	operator[] (const label i)
	Return element of UList.
const T &	operator[] (const label i) const
	Return element of constant UList.
	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&.
void	operator= (const T &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
iterator	begin () noexcept
	Return an iterator to begin traversing the UList.
iterator	end () noexcept
	Return an iterator to end traversing the UList.
iterator	begin (const label i) noexcept
	Return iterator at offset i from begin, clamped to [0,size] range.
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	cbegin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
const_iterator	begin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList.
reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList.
bool	empty () const noexcept
	True if List is empty (ie, size() is zero).
label	size () const noexcept
	The number of elements in the container.
label	capacity () const noexcept
	Size of the underlying storage.
void	swap (UList< T > &list) noexcept
	Swap content with another UList of the same type in constant time.
bool	operator== (const UList< T > &list) const
	Equality operation on ULists of the same type.
bool	operator!= (const UList< T > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const UList< T > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator> (const UList< T > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator<= (const UList< T > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const UList< T > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read List contents from Istream.
void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	all () const
	True if all entries are 'true' or if the list is empty.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	any () const
	True if any entries are 'true'.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	none () const
	True if no entries are 'true'.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	test (const label i) const
	Test `bool` value at specified position, always false for out-of-range access.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	get (const label i) const
	Return `bool` value at specified position, always false for out-of-range access.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	unset (const label i)
	Unset the `bool` entry at specified position, always false for out-of-range access.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_char_v<TypeT>>>
std::string_view	view () const
	Return a string_view of the charList. Content is non-modifiable.
T &	first ()
	Access first element of the list, position [0].
const T &	first () const
	Access first element of the list.
T &	last ()
	Access last element of the list, position [size()-1].
const T &	last () const
	Access last element of the list, position [size()-1].
bool	found (const T &val, label pos=0) const
	Same as contains().
auto	expr () const
	Wrap value as expression.
template<typename E>
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.

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 () noexcept
	Return a null List (reference to a nullObject). Behaves like an empty List.
Static Public Member Functions inherited from UList< T >
static const UList< T > &	null () noexcept
	Return a null UList (reference to a nullObject). Behaves like an empty UList.
static constexpr label	max_size () noexcept
	The size of the largest possible UList.
Protected Member Functions inherited from UList< T >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage.
void	size (const label n)
	Older name for setAddressableSize.
void	writeEntry (Ostream &os) const
	Write the UList with its compound type.
labelRange	validateRange (const labelRange &requestedRange) const
	Return a validated (start,size) subset range, which means that it always addresses a valid section of the list.
void	fill_uniform (const T &val)
	Assign all entries to the given value.
void	fill_uniform (Foam::zero)
	Assign all entries to zero.

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

Member Typedef Documentation

◆ value_type

template<class Type>

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

The element data type.

Definition at line 106 of file interpolation2DTable.H.

◆ table

template<class Type>

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

Convenience typedef.

Definition at line 111 of file interpolation2DTable.H.

Constructor & Destructor Documentation

◆ interpolation2DTable() [1/5]

template<class Type>

interpolation2DTable ( )

Default construct.

Definition at line 50 of file interpolation2DTable.C.

Referenced by interpolation2DTable(), and operator=().

Here is the caller graph for this function:

◆ interpolation2DTable() [2/5]

template<class Type>

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

Construct from components.

Definition at line 60 of file interpolation2DTable.C.

◆ interpolation2DTable() [3/5]

template<class Type>

interpolation2DTable ( const fileName & fName )

explicit

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

Definition at line 75 of file interpolation2DTable.C.

◆ interpolation2DTable() [4/5]

template<class Type>

interpolation2DTable ( const dictionary & dict )

explicit

Construct by reading file name and outOfBounds from dictionary.

Definition at line 87 of file interpolation2DTable.C.

References dict, UList< T >::get(), and Foam::New().

Here is the call graph for this function:

◆ interpolation2DTable() [5/5]

template<class Type>

interpolation2DTable ( const interpolation2DTable< Type > & tbl )

Copy construct.

Definition at line 108 of file interpolation2DTable.C.

References List< Tuple2< scalar, List< Tuple2< scalar, Type > > > >::clone(), and interpolation2DTable().

Here is the call graph for this function:

Member Function Documentation

◆ check()

template<class Type>

void check ( ) const

Check that list is monotonically increasing.

Exit with a FatalError if there is a problem

Definition at line 281 of file interpolation2DTable.C.

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

Referenced by checkOrder().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

template<class Type>

void write ( Ostream & os ) const

Write.

Definition at line 307 of file interpolation2DTable.C.

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

Here is the call graph for this function:

◆ operator=()

template<class Type>

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

Copy assignment.

Definition at line 215 of file interpolation2DTable.C.

References interpolation2DTable(), and Foam::rhs().

Here is the call graph for this function:

◆ operator()()

template<class Type>

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

Return an interpolated value.

Definition at line 233 of file interpolation2DTable.C.

References UList< T >::first(), Foam::nl, UList< T >::size(), WarningInFunction, Foam::y0(), Foam::y1(), and Foam::Zero.

Here is the call graph for this function:

◆ checkOrder()

template<class Type>

void checkOrder ( ) const

inline

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

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

Definition at line 182 of file interpolation2DTable.H.

References check().

Here is the call graph for this function:

◆ Xi()

template<class Type>

template<class BinaryOp>

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

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

Member Typedef Documentation

◆ value_type

◆ table

Constructor & Destructor Documentation

◆ interpolation2DTable() [1/5]

◆ interpolation2DTable() [2/5]

◆ interpolation2DTable() [3/5]

◆ interpolation2DTable() [4/5]

◆ interpolation2DTable() [5/5]

Member Function Documentation

◆ check()

◆ write()

◆ operator=()

◆ operator()()

◆ checkOrder()

◆ Xi()