Public Types | Public Member Functions | List of all members
interpolationTable< Type > Class Template Reference

An interpolation/look-up table of scalar vs <Type> values. The reference scalar values must be monotonically increasing. More...

Inheritance diagram for interpolationTable< Type >:
Inheritance graph
[legend]
Collaboration diagram for interpolationTable< Type >:
Collaboration graph
[legend]

Public Types

enum  boundsHandling { ERROR, WARN, CLAMP, REPEAT }
 Enumeration for handling out-of-bound values. More...
 
- Public Types inherited from List< Tuple2< scalar, Type > >
typedef SubList< 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 Treference
 Type that can be used for storing into. More...
 
typedef const Tconst_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 Titerator
 Random access iterator for traversing UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing UList. More...
 
typedef Treverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef const Tconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. More...
 

Public Member Functions

 interpolationTable ()
 Construct null. More...
 
 interpolationTable (const List< Tuple2< scalar, Type > > &values, const boundsHandling bounds, const fileName &fName)
 Construct from components. More...
 
 interpolationTable (const fileName &fName)
 Construct given the name of the file containing the table of data. More...
 
 interpolationTable (const dictionary &dict)
 Construct by reading the fileName and boundsHandling from dictionary. More...
 
 interpolationTable (const interpolationTable &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 check () const
 Check that list is monotonically increasing. More...
 
void write (Ostream &os) const
 Write. More...
 
Type rateOfChange (const scalar) const
 Return the rate of change at the interpolation location. More...
 
const Tuple2< scalar, Type > & operator[] (const label) const
 Return an element of constant Tuple2<scalar, Type> More...
 
Type operator() (const scalar) const
 Return an interpolated value. More...
 
- Public Member Functions inherited from List< Tuple2< scalar, Type > >
label size () const
 Return the number of elements in the UList. More...
 
 List ()
 Null constructor. More...
 
 List (const label)
 Construct with given size. More...
 
 List (const label, const Tuple2< scalar, Type > &)
 Construct with given size and value for all elements. More...
 
 List (const List< Tuple2< scalar, Type > > &)
 Copy constructor. More...
 
 List (const Xfer< List< Tuple2< scalar, Type > > > &)
 Construct by transferring the parameter contents. More...
 
 List (List< Tuple2< scalar, Type > > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< 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, Type >, Size > &)
 Construct as copy of FixedList<T, Size> More...
 
 List (const PtrList< Tuple2< scalar, Type > > &)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< Tuple2< scalar, Type > > &)
 Construct as copy of SLList<T> More...
 
 List (const UIndirectList< Tuple2< scalar, Type > > &)
 Construct as copy of UIndirectList<T> More...
 
 List (const BiIndirectList< Tuple2< scalar, Type > > &)
 Construct as copy of BiIndirectList<T> More...
 
 List (Istream &)
 Construct from Istream. More...
 
autoPtr< 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, 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, 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, Type > &)
 Append an element at the end of the list. More...
 
void append (const UList< Tuple2< scalar, Type > > &)
 Append a List at the end of this list. More...
 
void append (const UIndirectList< Tuple2< scalar, Type > > &)
 Append a UIndirectList at the end of this list. More...
 
void transfer (List< Tuple2< scalar, Type > > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (DynamicList< Tuple2< scalar, Type >, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (SortableList< Tuple2< scalar, Type > > &)
 Transfer the contents of the argument List into this list. More...
 
Xfer< List< Tuple2< scalar, Type > > > xfer ()
 Transfer contents to the Xfer container. More...
 
Tuple2< scalar, Type > & newElmt (const label)
 Return subscript-checked element of UList. More...
 
void operator= (const UList< Tuple2< scalar, Type > > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const List< Tuple2< scalar, Type > > &)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< Tuple2< scalar, Type > > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< Tuple2< scalar, Type > > &)
 Assignment from UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< Tuple2< scalar, Type > > &)
 Assignment from BiIndirectList operator. Takes linear time. More...
 
void operator= (const Tuple2< scalar, Type > &)
 Assignment of all entries to the given value. 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 Tcdata () const
 Return a const pointer to the first data element,. More...
 
Tdata ()
 Return a pointer to the first data element,. 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...
 
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 writeEntry (Ostream &) const
 Write the UList as a dictionary entry. More...
 
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword. More...
 
void assign (const UList< T > &)
 Assign elements to those from UList. More...
 
Toperator[] (const label)
 Return element of UList. More...
 
const Toperator[] (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...
 
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, Type > >
static const 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, Type > >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 

Detailed Description

template<class Type>
class Foam::interpolationTable< Type >

An interpolation/look-up table of scalar vs <Type> values. The reference scalar values must be monotonically increasing.

The handling of out-of-bounds values depends on the current setting of outOfBounds.

If REPEAT is chosen for the out-of-bounds handling, the final time value is treated as being equivalent to time=0 for the following periods.

The construct from dictionary reads a filename from a dictionary and has an optional readerType. Default is to read OpenFOAM format. The only other format is csv (comma separated values):

Read csv format: readerType csv; fileName "$FOAM_CASE/constant/p0vsTime.csv"; hasHeaderLine true; // skip first line timeColumn 0; // time is in column 0 valueColumns (1); // value starts in column 1

Note
  • Accessing an empty list results in an error.
  • Accessing a list with a single element always returns the same value.
Source files

Definition at line 77 of file interpolationTable.H.

Member Enumeration Documentation

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

REPEAT 

Treat as a repeating list

Definition at line 86 of file interpolationTable.H.

Constructor & Destructor Documentation

Construct null.

Definition at line 61 of file interpolationTable.C.

Referenced by interpolationTable< Type >::interpolationTable().

Here is the caller graph for this function:

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

Construct from components.

Definition at line 72 of file interpolationTable.C.

interpolationTable ( const fileName fName)

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

Definition at line 86 of file interpolationTable.C.

interpolationTable ( const dictionary dict)

Construct by reading the fileName and boundsHandling from dictionary.

and read the table from that file. This is a specialised constructor used by patchFields

Definition at line 98 of file interpolationTable.C.

References interpolationTable< Type >::interpolationTable().

Here is the call graph for this function:

interpolationTable ( const interpolationTable< Type > &  interpTable)

Construct copy.

Definition at line 111 of file interpolationTable.C.

References interpolationTable< Type >::boundsHandlingToWord().

Here is the call graph for this function:

Member Function Documentation

Foam::word boundsHandlingToWord ( const boundsHandling bound) const

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

Definition at line 127 of file interpolationTable.C.

References interpolationTable< Type >::CLAMP, interpolationTable< Type >::ERROR, interpolationTable< Type >::REPEAT, interpolationTable< Type >::WARN, and interpolationTable< Type >::wordToBoundsHandling().

Referenced by interpolationTable< Type >::interpolationTable(), and interpolationTable< Type >::write().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Definition at line 164 of file interpolationTable.C.

References interpolationTable< Type >::CLAMP, Foam::endl(), interpolationTable< Type >::ERROR, interpolationTable< Type >::outOfBounds(), interpolationTable< Type >::REPEAT, interpolationTable< Type >::WARN, and WarningIn.

Referenced by interpolationTable< Type >::boundsHandlingToWord().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::interpolationTable< Type >::boundsHandling outOfBounds ( const boundsHandling bound)

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

Definition at line 199 of file interpolationTable.C.

References Foam::bound().

Referenced by interpolationTable< Type >::wordToBoundsHandling().

Here is the call graph for this function:

Here is the caller graph for this function:

void check ( ) const

Check that list is monotonically increasing.

Exit with a FatalError if there is a problem

Definition at line 210 of file interpolationTable.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, UList< T >::first(), n, Foam::nl, UList< T >::operator, and List< Tuple2< scalar, Type > >::size().

Here is the call graph for this function:

void write ( Ostream os) const

Write.

Definition at line 236 of file interpolationTable.C.

References interpolationTable< Type >::boundsHandlingToWord(), token::END_STATEMENT, Foam::nl, and Ostream::writeKeyword().

Here is the call graph for this function:

Type rateOfChange ( const scalar  value) const
const Foam::Tuple2< Foam::scalar, Type > & operator[] ( const label  i) const
Type operator() ( const scalar  value) const

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