FreeFOAM The Cross-Platform CFD Toolkit
interpolationLookUpTable< Type > Class Template Reference

A list of lists. Interpolates based on the first dimension. The values must be positive and monotonically increasing in each dimension. More...

#include <radiation/interpolationLookUpTable.H>


Detailed Description

template<class Type>
class Foam::interpolationLookUpTable< Type >

A list of lists. Interpolates based on the first dimension. The values must be positive and monotonically increasing in each dimension.

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 60 of file interpolationLookUpTable.H.

+ Inheritance diagram for interpolationLookUpTable< Type >:
+ Collaboration diagram for interpolationLookUpTable< Type >:

List of all members.

Public Member Functions

 interpolationLookUpTable ()
 Construct null.
 interpolationLookUpTable (const fileName &fn, const word &instance, const fvMesh &mesh)
 Construct given the name of the file containing the table of data.
 interpolationLookUpTable (const dictionary &dict)
 Construct from dictionary.
 interpolationLookUpTable (const interpolationLookUpTable &interpTable)
 Construct copy.
bool found (const word &fieldName) const
 Return true if the filed exists in the table.
const List< scalar > & lookUp (const scalar)
 Return the output list given a single input scalar.
void write (Ostream &os, const fileName &fn, const word &instance, const fvMesh &mesh) const
 Write Look Up Table to filename.
label findFieldIndex (const word &fieldName) const
 Return the index of a field by name.
const List< dictionary > & output () const
 Return const access to the output dictionaries.
const List< dictionary > & entries () const
 Return const access tp the dictionary entries.
const List< scalar > & min () const
 Return const access to the list of min dimensions.
const List< label > & dim () const
 Return const access to the list of dimensions.
const List< scalar > & delta () const
 Return const access to the deltas in each dimension.
const List< scalar > & max () const
 Return const access to the list of max dimensions.
word tableName () const
 Return const access to the table name.
const scalarFieldoperator[] (const label) const
 Return an element of constant List<scalar, Type>
scalarFieldoperator[] (const label)
 Return an element of List<scalar, Type>
- Public Member Functions inherited from List< scalarField >
label size () const
 Return the number of elements in the UList.
 List ()
 Null constructor.
 List (const label)
 Construct with given size.
 List (const label, const scalarField &)
 Construct with given size and value for all elements.
 List (const List< scalarField > &)
 Copy constructor.
 List (const Xfer< List< scalarField > > &)
 Construct by transferring the parameter contents.
 List (List< scalarField > &, bool reUse)
 Construct as copy or re-use as specified.
 List (const UList< scalarField > &, const unallocLabelList &mapAddressing)
 Construct as subset.
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators.
 List (const FixedList< scalarField, Size > &)
 Construct as copy of FixedList<T, Size>
 List (const PtrList< scalarField > &)
 Construct as copy of PtrList<T>
 List (const SLList< scalarField > &)
 Construct as copy of SLList<T>
 List (const IndirectList< scalarField > &)
 Construct as copy of IndirectList<T>
 List (const UIndirectList< scalarField > &)
 Construct as copy of UIndirectList<T>
 List (const BiIndirectList< scalarField > &)
 Construct as copy of BiIndirectList<T>
 List (Istream &)
 Construct from Istream.
autoPtr< List< scalarField > > clone () const
 Clone.
 ~List ()
void resize (const label)
 Reset size of List.
void resize (const label, const scalarField &)
 Reset size of List and value for new elements.
void setSize (const label)
 Reset size of List.
void setSize (const label, const scalarField &)
 Reset size of List and value for new elements.
void clear ()
 Clear the list, i.e. set size to zero.
void append (const UList< scalarField > &)
 Append a List at the end of this list.
void append (const UIndirectList< scalarField > &)
 Append a UIndirectList at the end of this list.
void transfer (List< scalarField > &)
 Transfer the contents of the argument List into this list.
void transfer (DynamicList< scalarField, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list.
void transfer (SortableList< scalarField > &)
 Transfer the contents of the argument List into this list.
Xfer< List< scalarField > > xfer ()
 Transfer contents to the Xfer container.
scalarFieldnewElmt (const label)
 Return subscript-checked element of UList.
void operator= (const UList< scalarField > &)
 Assignment from UList operator. Takes linear time.
void operator= (const List< scalarField > &)
 Assignment operator. Takes linear time.
void operator= (const SLList< scalarField > &)
 Assignment from SLList operator. Takes linear time.
void operator= (const IndirectList< scalarField > &)
 Assignment from IndirectList operator. Takes linear time.
void operator= (const UIndirectList< scalarField > &)
 Assignment from UIndirectList operator. Takes linear time.
void operator= (const BiIndirectList< scalarField > &)
 Assignment from BiIndirectList operator. Takes linear time.
void operator= (const scalarField &)
 Assignment of all entries to the given value.
- Public Member Functions inherited from UList< scalarField >
 UList ()
 Null constructor.
 UList (scalarField *__restrict__ v, label size)
 Construct from components.
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index.
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index.
label byteSize () const
 Return the binary size in number of characters of the UList.
const scalarFieldcdata () const
 Return a const pointer to the first data element,.
scalarFielddata ()
 Return a pointer to the first data element,.
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1).
void checkSize (const label size) const
 Check size is within valid range (0 ... size).
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1).
void writeEntry (Ostream &) const
 Write the UList as a dictionary entry.
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword.
void assign (const UList< scalarField > &)
 Assign elements to those from UList.
 operator const Foam::List< scalarField > & () const
 Allow cast to a const List<T>&.
iterator begin ()
 Return an iterator to begin traversing the UList.
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList.
iterator end ()
 Return an iterator to end traversing the UList.
const_iterator end () const
 Return const_iterator to end traversing the constant UList.
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList.
const_iterator cend () const
 Return const_iterator to end traversing the constant UList.
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator rend () const
 Return const_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.
label max_size () const
 Return size of the largest possible UList.
bool empty () const
 Return true if the UList is empty (ie, size() is zero).
void swap (UList< scalarField > &)
 Swap two ULists of the same type in constant time.
bool operator== (const UList< scalarField > &) const
 Equality operation on ULists of the same type.
bool operator!= (const UList< scalarField > &) const
 The opposite of the equality operation. Takes linear time.
bool operator< (const UList< scalarField > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator> (const UList< scalarField > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator<= (const UList< scalarField > &) const
 Return true if !(a > b). Takes linear time.
bool operator>= (const UList< scalarField > &) const
 Return true if !(a < b). Takes linear time.

Additional Inherited Members

- Public Types inherited from List< scalarField >
typedef SubList< scalarFieldsubList
 Declare type of subList.
- Public Types inherited from UList< scalarField >
typedef scalarField value_type
 Type of values the UList contains.
typedef scalarFieldreference
 Type that can be used for storing into.
typedef const scalarFieldconst_reference
 Type that can be used for storing into.
typedef label difference_type
 The type that can represent the difference between any two.
typedef label size_type
 The type that can represent the size of a UList.
typedef scalarFielditerator
 Random access iterator for traversing UList.
typedef const scalarFieldconst_iterator
 Random access iterator for traversing UList.
typedef scalarFieldreverse_iterator
 Reverse iterator for reverse traversal of UList.
typedef const scalarFieldconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList.
- Static Public Member Functions inherited from List< scalarField >
static const List< scalarField > & null ()
 Return a null List.
- Protected Member Functions inherited from List< scalarField >
void size (const label)
 Override size to be inconsistent with allocated storage.

Constructor & Destructor Documentation

Construct null.

Definition at line 239 of file interpolationLookUpTable.C.

interpolationLookUpTable ( const fileName fn,
const word instance,
const fvMesh mesh 
)

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

Definition at line 248 of file interpolationLookUpTable.C.

Construct from dictionary.

Definition at line 290 of file interpolationLookUpTable.C.

interpolationLookUpTable ( const interpolationLookUpTable< Type > &  interpTable)

Construct copy.

Definition at line 270 of file interpolationLookUpTable.C.


Member Function Documentation

bool found ( const word fieldName) const

Return true if the filed exists in the table.

Definition at line 459 of file interpolationLookUpTable.C.

References interpolationLookUpTable< Type >::found().

Referenced by interpolationLookUpTable< Type >::found().

const Foam::scalarList & lookUp ( const scalar  retvals)

Return the output list given a single input scalar.

Definition at line 467 of file interpolationLookUpTable.C.

void write ( Ostream os,
const fileName fn,
const word instance,
const fvMesh mesh 
) const
Foam::label findFieldIndex ( const word fieldName) const
inline

Return the index of a field by name.

Definition at line 29 of file interpolationLookUpTableI.H.

const Foam::List< Foam::dictionary > & output ( ) const
inline

Return const access to the output dictionaries.

Definition at line 39 of file interpolationLookUpTableI.H.

const Foam::List< Foam::dictionary > & entries ( ) const
inline

Return const access tp the dictionary entries.

Definition at line 47 of file interpolationLookUpTableI.H.

const Foam::List< Foam::scalar > & min ( ) const
inline

Return const access to the list of min dimensions.

Definition at line 55 of file interpolationLookUpTableI.H.

const Foam::List< Foam::label > & dim ( ) const
inline

Return const access to the list of dimensions.

Definition at line 63 of file interpolationLookUpTableI.H.

const Foam::List< Foam::scalar > & delta ( ) const
inline

Return const access to the deltas in each dimension.

Definition at line 71 of file interpolationLookUpTableI.H.

const Foam::List< Foam::scalar > & max ( ) const
inline

Return const access to the list of max dimensions.

Definition at line 79 of file interpolationLookUpTableI.H.

Foam::word tableName ( ) const
inline

Return const access to the table name.

Definition at line 86 of file interpolationLookUpTableI.H.

const Foam::scalarField & operator[] ( const label  i) const

Return an element of constant List<scalar, Type>

Reimplemented from UList< scalarField >.

Definition at line 422 of file interpolationLookUpTable.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::nl, and UList< T >::operator[]().

Foam::scalarField & operator[] ( const label  i)

Return an element of List<scalar, Type>

Reimplemented from UList< scalarField >.

Definition at line 389 of file interpolationLookUpTable.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::nl, and UList< T >::operator[]().


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