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 >:
[legend]
Collaboration diagram for interpolation2DTable< Type >:
[legend]

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 Types inherited from UList< T >
typedef T value_type
 The value type the list contains. More...
 
typedef Tpointer
 The pointer type for non-const access to value_type items. More...
 
typedef const Tconst_pointer
 The pointer type for const access to value_type items. More...
 
typedef Treference
 The type used for storing into value_type objects. More...
 
typedef const Tconst_reference
 The type used for reading from constant value_type objects. More...
 
typedef Titerator
 Random access iterator for traversing a UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing a UList. More...
 
typedef label size_type
 The type to represent the size of a UList. More...
 
typedef label difference_type
 The difference between iterator objects. More...
 
typedef std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator (non-const access) More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator (const access) 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 (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)
 
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= (SLList< Tuple2< scalar, List< Tuple2< scalar, Type > > > > &&list)
 Move assignment. Takes constant time. More...
 
IstreamreadList (Istream &is)
 Read List from Istream, discarding contents of existing List. More...
 
IstreamreadList (Istream &is)
 
IstreamreadList (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...
 
- Public Member Functions inherited from UList< T >
 UList (const UList< T > &)=default
 Copy construct. More...
 
constexpr UList () noexcept
 Default construct, zero-sized and nullptr. More...
 
 UList (T *__restrict__ v, const label len) noexcept
 Construct from components. More...
 
label fcIndex (const label i) const noexcept
 
label rcIndex (const label i) const noexcept
 
const TfcValue (const label i) const
 Return forward circular value (ie, next value in the list) More...
 
TfcValue (const label i)
 Return forward circular value (ie, next value in the list) More...
 
const TrcValue (const label i) const
 Return reverse circular value (ie, previous value in the list) More...
 
TrcValue (const label i)
 Return reverse circular value (ie, previous value in the list) More...
 
const Tcdata () const noexcept
 Return pointer to the underlying array serving as data storage. More...
 
Tdata () noexcept
 Return pointer to the underlying array serving as data storage. More...
 
const char * cdata_bytes () const noexcept
 Return pointer to the underlying array serving as data storage,. More...
 
char * data_bytes () noexcept
 Return pointer to the underlying array serving as data storage,. More...
 
Tfirst ()
 Return the first element of the list. More...
 
const Tfirst () const
 Return first element of the list. More...
 
Tlast ()
 Return the last element of the list. More...
 
const Tlast () const
 Return the last element of the list. More...
 
std::streamsize size_bytes () const noexcept
 Number of contiguous bytes for the List data. More...
 
std::streamsize byteSize () const
 
void checkStart (const label start) const
 Check start is within valid range [0,size) More...
 
void checkSize (const label size) const
 Check size is within valid range [0,size]. More...
 
void checkRange (const label start, const label len) const
 Check that start and length define a valid range. More...
 
void checkIndex (const label i) const
 Check index is within valid range [0,size) More...
 
bool uniform () const
 True if all entries have identical values, and list is non-empty. More...
 
label find (const T &val, label pos=0) const
 Find index of the first occurrence of the value. More...
 
label rfind (const T &val, label pos=-1) const
 Find index of the last occurrence of the value. More...
 
bool found (const T &val, label pos=0) const
 True if the value if found in the list. More...
 
void moveFirst (const label i)
 Move element to the first position. More...
 
void moveLast (const label i)
 Move element to the last position. More...
 
void swapFirst (const label i)
 Swap element with the first element. Fatal on an empty list. More...
 
void swapLast (const label i)
 Swap element with the last element. Fatal on an empty list. More...
 
void shallowCopy (const UList< T > &list)
 Copy the pointer and size held by the given UList. More...
 
void deepCopy (const UList< T > &list)
 Copy elements of the given UList. Sizes must match! More...
 
template<class Addr >
void deepCopy (const IndirectListBase< T, Addr > &list)
 Copy elements of the given indirect list. Sizes must match! More...
 
SubList< Tslice (const label pos, label len=-1)
 Return SubList slice (non-const access) - no range checking. More...
 
const SubList< Tslice (const label pos, label len=-1) const
 Return SubList slice (const access) - no range checking. More...
 
SubList< Tslice (const labelRange &range)
 Return SubList slice (non-const access) - with range checking. More...
 
const SubList< Tslice (const labelRange &range) const
 Return SubList slice (const access) - with range checking. More...
 
Toperator[] (const label i)
 Return element of UList. More...
 
const Toperator[] (const label i) 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 &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
iterator begin () noexcept
 Return an iterator to begin traversing the UList. More...
 
iterator end () noexcept
 Return an iterator to end traversing the UList. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cend () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator begin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator end () const noexcept
 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 noexcept
 The number of elements in the UList. More...
 
bool empty () const noexcept
 True if the UList is empty (ie, size() is zero) More...
 
void swap (UList< T > &list)
 Swap content with another UList of the same type in constant time. More...
 
bool operator== (const UList< T > &a) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< T > &a) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< T > &list) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< T > &a) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< T > &a) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< T > &a) const
 Return true if !(a < b). Takes linear time. More...
 
IstreamreadList (Istream &is)
 Read List contents from Istream. More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the List as a dictionary entry with keyword. More...
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write List, with line-breaks in ASCII when length exceeds shortLen. More...
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type test (const label i) const
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type get (const label i) const
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type unset (const label i)
 
IstreamreadList (Istream &is)
 
OstreamwriteList (Ostream &os, const label) const
 
const booloperator[] (const label i) const
 
Foam::UPstream::commsStructoperator[] (const label procID)
 
const Foam::UPstream::commsStructoperator[] (const label procID) const
 
UPstream::commsStructoperator[] (const label procID)
 
const UPstream::commsStructoperator[] (const label procID) const
 
OstreamwriteList (Ostream &os, const label) const
 
IstreamreadList (Istream &is)
 

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 UList reference to a nullObject. More...
 
static constexpr label max_size () noexcept
 The size of the largest possible UList. More...
 
- Protected Member Functions inherited from UList< T >
void setAddressableSize (const label n) noexcept
 Set addressed size to be inconsistent with allocated storage. More...
 
void size (const label n)
 Older name for setAddressableSize. More...
 
void writeEntry (Ostream &os) const
 Write the UList with its compound type. More...
 
labelRange validateRange (const labelRange &requestedRange) const
 
UList< T > & operator= (const UList< T > &)=delete
 No copy assignment (default: shallow copy) More...
 
void writeEntry (Ostream &os) const
 
void writeEntry (Ostream &os) const
 

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]

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 67 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 115 of file interpolation2DTable.C.

Member Function Documentation

◆ check()

void check

Check that list is monotonically increasing.

Exit with a FatalError if there is a problem

Definition at line 288 of file interpolation2DTable.C.

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

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const

Write.

Definition at line 314 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)

Copy assignment.

Definition at line 222 of file interpolation2DTable.C.

◆ operator()()

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

Return an interpolated value.

Definition at line 240 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()

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 147 of file interpolation2DTable.C.

References Foam::abort(), Foam::bounds::CLAMP, Foam::bounds::ERROR, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, Foam::reverse(), UList< T >::size(), Foam::bounds::WARN, and WarningInFunction.

Here is the call graph for this function:

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