Public Member Functions | |
interpolationLookUpTable () | |
Construct null. More... | |
interpolationLookUpTable (const fileName &, const word &instance, const objectRegistry &) | |
Construct given the name of the file containing the table of data. More... | |
interpolationLookUpTable (const dictionary &) | |
Construct from dictionary. More... | |
interpolationLookUpTable (const interpolationLookUpTable &) | |
Construct copy. More... | |
bool | found (const word &fieldName) const |
Return true if the field exists in the table. More... | |
const List< scalar > & | lookUp (const scalar) |
Return the output list given a single input scalar. More... | |
void | write (Ostream &, const fileName &, const word &instance, const objectRegistry &) const |
Write lookup table to filename. More... | |
label | findFieldIndex (const word &fieldName) const |
Return the index of a field by name. More... | |
const List< dictionary > & | output () const |
Return const access to the output dictionaries. More... | |
const List< dictionary > & | entries () const |
Return const access tp the dictionary entries. More... | |
const List< scalar > & | min () const |
Return const access to the list of min dimensions. More... | |
const List< label > & | dim () const |
Return const access to the list of dimensions. More... | |
const List< scalar > & | delta () const |
Return const access to the deltas in each dimension. More... | |
const List< scalar > & | max () const |
Return const access to the list of max dimensions. More... | |
word | tableName () const |
Return const access to the table name. More... | |
const scalarField & | operator[] (const label) const |
Return an element. More... | |
scalarField & | operator[] (const label) |
Return an element. More... | |
Public Member Functions inherited from List< scalarField > | |
List () | |
Null constructor. More... | |
List (const label) | |
Construct with given size. More... | |
List (const label, const scalarField &) | |
Construct with given size and value for all elements. More... | |
List (const label, const zero) | |
Construct with given size initialising all elements to zero. More... | |
List (const List< scalarField > &) | |
Copy constructor. More... | |
List (const UList< T2 > &) | |
Copy constructor from list containing another type. More... | |
List (List< scalarField > &&) | |
Move constructor. More... | |
List (List< scalarField > &, bool reuse) | |
Construct as copy or reuse as specified. More... | |
List (const UList< scalarField > &, const labelUList &mapAddressing) | |
Construct as subset. More... | |
List (InputIterator first, InputIterator last) | |
Construct given start and end iterators. More... | |
List (const FixedList< scalarField, Size > &) | |
Construct as copy of FixedList<T, Size> More... | |
List (const PtrList< scalarField > &) | |
Construct as copy of PtrList<T> More... | |
List (const SLList< scalarField > &) | |
Construct as copy of SLList<T> More... | |
List (const UIndirectList< scalarField > &) | |
Construct as copy of UIndirectList<T> More... | |
List (const BiIndirectList< scalarField > &) | |
Construct as copy of BiIndirectList<T> More... | |
List (std::initializer_list< scalarField >) | |
Construct from an initialiser list. More... | |
List (Istream &) | |
Construct from Istream. More... | |
label | size () const |
Return the number of elements in the UList. More... | |
autoPtr< List< scalarField > > | clone () const |
Clone. More... | |
~List () | |
Destructor. More... | |
void | resize (const label) |
Alias for setSize(const label) More... | |
void | resize (const label, const scalarField &) |
Alias for setSize(const label, const T&) More... | |
void | setSize (const label) |
Reset size of List. More... | |
void | setSize (const label, const scalarField &) |
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 scalarField &) |
Append an element at the end of the list. More... | |
void | append (const UList< scalarField > &) |
Append a List at the end of this list. More... | |
void | append (const UIndirectList< scalarField > &) |
Append a UIndirectList at the end of this list. More... | |
void | transfer (List< scalarField > &) |
Transfer the contents of the argument List into this list. More... | |
void | transfer (DynamicList< scalarField, SizeInc, SizeMult, SizeDiv > &) |
Transfer the contents of the argument List into this list. More... | |
void | transfer (SortableList< scalarField > &) |
Transfer the contents of the argument List into this list. More... | |
scalarField & | newElmt (const label) |
Return subscript-checked element of UList. More... | |
void | shallowCopy (const UList< scalarField > &)=delete |
Disallow implicit shallowCopy. More... | |
void | operator= (const UList< scalarField > &) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const List< scalarField > &) |
Assignment operator. Takes linear time. More... | |
void | operator= (List< scalarField > &&) |
Move assignment operator. More... | |
void | operator= (const SLList< scalarField > &) |
Assignment to SLList operator. Takes linear time. More... | |
void | operator= (const UIndirectList< scalarField > &) |
Assignment to UIndirectList operator. Takes linear time. More... | |
void | operator= (const BiIndirectList< scalarField > &) |
Assignment to BiIndirectList operator. Takes linear time. More... | |
void | operator= (std::initializer_list< scalarField >) |
Assignment to an initialiser list. More... | |
void | operator= (const scalarField &) |
Assignment of all entries to the given value. More... | |
void | operator= (const zero) |
Assignment of all entries to zero. More... | |
Public Member Functions inherited from UList< T > | |
UList () | |
Null constructor. More... | |
UList (T *__restrict__ v, label size) | |
Construct from components. More... | |
UList (const UList< T > &)=default | |
Copy construct. 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 T * | cdata () const |
Return a const pointer to the first data element,. More... | |
T * | data () |
Return a pointer to the first data element,. More... | |
T & | first () |
Return the first element of the list. More... | |
const T & | first () const |
Return first element of the list. More... | |
T & | last () |
Return the last element of the list. More... | |
const T & | last () 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 | shallowCopy (const UList< T > &) |
Copy the pointer held by the given UList. More... | |
void | deepCopy (const UList< T > &) |
Copy elements of the given UList. More... | |
T & | operator[] (const label) |
Return element of UList. More... | |
const T & | operator[] (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... | |
void | operator= (const zero) |
Assignment of all entries to zero. 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... | |
const bool & | operator[] (const label i) const |
Additional Inherited Members | |
Public Types inherited from List< scalarField > | |
typedef SubList< scalarField > | subList |
Declare type of subList. More... | |
Public Types inherited from UList< T > | |
typedef T | value_type |
Type of values the UList contains. More... | |
typedef T & | reference |
Type that can be used for storing into. More... | |
typedef const T & | const_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 T * | iterator |
Random access iterator for traversing UList. More... | |
typedef const T * | const_iterator |
Random access iterator for traversing UList. More... | |
typedef std::reverse_iterator< iterator > | reverse_iterator |
Reverse iterator for reverse traversal of UList. More... | |
typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
Reverse iterator for reverse traversal of constant UList. More... | |
Static Public Member Functions inherited from List< scalarField > | |
static const List< scalarField > & | 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< scalarField > | |
void | size (const label) |
Override size to be inconsistent with allocated storage. More... | |
Definition at line 61 of file interpolationLookUpTable.H.
Construct null.
Definition at line 233 of file interpolationLookUpTable.C.
interpolationLookUpTable | ( | const fileName & | fn, |
const word & | instance, | ||
const objectRegistry & | obr | ||
) |
Construct given the name of the file containing the table of data.
Definition at line 241 of file interpolationLookUpTable.C.
interpolationLookUpTable | ( | const dictionary & | dict | ) |
Construct from dictionary.
Definition at line 285 of file interpolationLookUpTable.C.
interpolationLookUpTable | ( | const interpolationLookUpTable & | interpTable | ) |
Construct copy.
Definition at line 265 of file interpolationLookUpTable.C.
bool found | ( | const word & | fieldName | ) | const |
Return true if the field exists in the table.
Definition at line 439 of file interpolationLookUpTable.C.
const Foam::scalarList & lookUp | ( | const scalar | retvals | ) |
Return the output list given a single input scalar.
Definition at line 450 of file interpolationLookUpTable.C.
void write | ( | Ostream & | os, |
const fileName & | fn, | ||
const word & | instance, | ||
const objectRegistry & | obr | ||
) | const |
Write lookup table to filename.
Definition at line 341 of file interpolationLookUpTable.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, IOobject::NO_READ, IOobject::NO_WRITE, Foam::writeEntry(), and IOobject::writeHeader().
|
inline |
Return the index of a field by name.
Definition at line 27 of file interpolationLookUpTableI.H.
|
inline |
Return const access to the output dictionaries.
Definition at line 38 of file interpolationLookUpTableI.H.
|
inline |
Return const access tp the dictionary entries.
Definition at line 46 of file interpolationLookUpTableI.H.
|
inline |
Return const access to the list of min dimensions.
Definition at line 54 of file interpolationLookUpTableI.H.
|
inline |
Return const access to the list of dimensions.
Definition at line 62 of file interpolationLookUpTableI.H.
|
inline |
Return const access to the deltas in each dimension.
Definition at line 70 of file interpolationLookUpTableI.H.
|
inline |
Return const access to the list of max dimensions.
Definition at line 78 of file interpolationLookUpTableI.H.
|
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.
Definition at line 409 of file interpolationLookUpTable.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, n, Foam::nl, and UList< T >::operator[]().
Foam::scalarField & operator[] | ( | const label | i | ) |
Return an element.
Definition at line 380 of file interpolationLookUpTable.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, n, Foam::nl, and UList< T >::operator[]().