Table with uniform interval in independant variable, with linear interpolation. More...
Public Member Functions | |
| uniformInterpolationTable (const IOobject &, const bool readFields) | |
| Construct from IOobject and readFields flag. More... | |
| uniformInterpolationTable (const word &tableName, const objectRegistry &, const dictionary &, const bool initialiseOnly=false) | |
| Construct from name, objectRegistry and dictionary. More... | |
| uniformInterpolationTable (const uniformInterpolationTable &) | |
| Construct as copy. More... | |
| ~uniformInterpolationTable () | |
| Destructor. More... | |
| scalar | x0 () const |
| Return the lower limit. More... | |
| scalar | dx () const |
| Return the fixed interval. More... | |
| const Switch & | log10 () const |
| Return the log10(x) flag. More... | |
| const Switch & | bound () const |
| Return the bound flag. More... | |
| scalar & | x0 () |
| Return the lower limit. More... | |
| scalar & | dx () |
| Return the fixed interval. More... | |
| Switch & | log10 () |
| Return the log10(x) flag. More... | |
| Switch & | bound () |
| Return the bound flag. More... | |
| scalar | xMin () const |
| Return the minimum x value. More... | |
| scalar | xMax () const |
| Return the maximum x value. More... | |
| Type | interpolate (scalar x) const |
| Interpolate. More... | |
| Type | interpolateLog10 (scalar x) const |
| Interpolate - takes log10 flag into account. More... | |
| void | write () const |
| Write. More... | |
 Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Runtime type information. More... | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from name, instance, registry, io options. More... | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from name, instance, local, registry, io options. More... | |
| IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from path, registry, io options. More... | |
| Foam::autoPtr< IOobject > | clone () const |
| Clone. More... | |
| virtual | ~IOobject () |
| Destructor. More... | |
| const Time & | time () const |
| Return time. More... | |
| const objectRegistry & | db () const |
| Return the local objectRegistry. More... | |
| const word & | name () const |
| Return name. More... | |
| const word & | headerClassName () const |
| Return name of the class name read from header. More... | |
| string & | note () |
| Return non-constant access to the optional note. More... | |
| const string & | note () const |
| Return the optional note. More... | |
| virtual void | rename (const word &newName) |
| Rename. More... | |
| bool & | registerObject () |
| Register object created from this IOobject with registry if true. More... | |
| bool | registerObject () const |
| Register object created from this IOobject with registry if true. More... | |
| readOption | readOpt () const |
| readOption & | readOpt () |
| writeOption | writeOpt () const |
| writeOption & | writeOpt () |
| word | group () const |
| Return group (extension part of name) More... | |
| word | member () const |
| Return member (name without the extension) More... | |
| const fileName & | rootPath () const |
| const fileName & | caseName () const |
| const fileName & | instance () const |
| fileName & | instance () |
| const fileName & | local () const |
| fileName | path () const |
| Return complete path. More... | |
| fileName | path (const word &instance, const fileName &local="") const |
| Return complete path with alternative instance and local. More... | |
| fileName | objectPath () const |
| Return complete path + object name. More... | |
| fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
| bool | readHeader (Istream &) |
| Read header. More... | |
| bool | headerOk () |
| Read and check header info. More... | |
| bool | writeHeader (Ostream &) const |
| Write header. More... | |
| bool | writeHeader (Ostream &, const word &objectType) const |
| Write header. Allow override of type. More... | |
| bool | good () const |
| bool | bad () const |
| InfoProxy< IOobject > | info () const |
| Return info proxy. More... | |
| void | operator= (const IOobject &) |
| template<class Name > | |
| Foam::word | groupName (Name name, const word &group) |
| Public Member Functions inherited from List< 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 Type &) | |
| Construct with given size and value for all elements. More... | |
| List (const label, const zero) | |
| Construct with given size initializing all elements to zero. More... | |
| List (const List< Type > &) | |
| Copy constructor. More... | |
| List (const Xfer< List< Type >> &) | |
| Construct by transferring the parameter contents. More... | |
| List (List< Type > &, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| List (const UList< Type > &, const labelUList &mapAddressing) | |
| Construct as subset. More... | |
| List (const FixedList< Type, Size > &) | |
| Construct as copy of FixedList<T, Size> More... | |
| List (const PtrList< Type > &) | |
| Construct as copy of PtrList<T> More... | |
| List (const SLList< Type > &) | |
| Construct as copy of SLList<T> More... | |
| List (const UIndirectList< Type > &) | |
| Construct as copy of UIndirectList<T> More... | |
| List (const BiIndirectList< Type > &) | |
| Construct as copy of BiIndirectList<T> More... | |
| List (Istream &) | |
| Construct from Istream. More... | |
| autoPtr< List< Type > > | clone () const |
| Clone. More... | |
| ~List () | |
| Destructor. More... | |
| void | resize (const label) |
| Alias for setSize(const label) More... | |
| void | resize (const label, const Type &) |
| Alias for setSize(const label, const T&) More... | |
| void | setSize (const label) |
| Reset size of List. More... | |
| void | setSize (const label, const 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 Type &) |
| Append an element at the end of the list. More... | |
| void | append (const UList< Type > &) |
| Append a List at the end of this list. More... | |
| void | append (const UIndirectList< Type > &) |
| Append a UIndirectList at the end of this list. More... | |
| void | transfer (List< Type > &) |
| Transfer the contents of the argument List into this list. More... | |
| void | transfer (DynamicList< Type, SizeInc, SizeMult, SizeDiv > &) |
| Transfer the contents of the argument List into this list. More... | |
| void | transfer (SortableList< Type > &) |
| Transfer the contents of the argument List into this list. More... | |
| Xfer< List< Type > > | xfer () |
| Transfer contents to the Xfer container. More... | |
| Type & | newElmt (const label) |
| Return subscript-checked element of UList. More... | |
| void | shallowCopy (const UList< Type > &)=delete |
| Disallow implicit shallowCopy. More... | |
| void | operator= (const UList< Type > &) |
| Assignment from UList operator. Takes linear time. More... | |
| void | operator= (const List< Type > &) |
| Assignment operator. Takes linear time. More... | |
| void | operator= (const SLList< Type > &) |
| Assignment from SLList operator. Takes linear time. More... | |
| void | operator= (const UIndirectList< Type > &) |
| Assignment from UIndirectList operator. Takes linear time. More... | |
| void | operator= (const BiIndirectList< Type > &) |
| Assignment from BiIndirectList operator. Takes linear time. More... | |
| void | operator= (const Type &) |
| 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< Type > | |
| void | operator= (const Type &) |
| Assignment of all entries to the given value. More... | |
| void | operator= (const zero) |
| Assignment of all entries to zero. More... | |
| UList () | |
| Null constructor. More... | |
| UList (Type *__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 Type * | cdata () const |
| Return a const pointer to the first data element,. More... | |
| Type * | data () |
| Return a pointer to the first data element,. More... | |
| Type & | first () |
| Return the first element of the list. More... | |
| const Type & | first () const |
| Return first element of the list. More... | |
| Type & | last () |
| Return the last element of the list. More... | |
| const Type & | 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< Type > &) |
| Copy the pointer held by the given UList. More... | |
| void | deepCopy (const UList< Type > &) |
| Copy elements of the given UList. 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... | |
| Type & | operator[] (const label) |
| Return element of UList. More... | |
| const Type & | operator[] (const label) const |
| Return element of constant UList. More... | |
| operator const Foam::List< Type > & () const | |
| Allow cast to a const List<T>&. More... | |
| iterator | begin () |
| Return an iterator to begin traversing the UList. More... | |
| const_iterator | begin () const |
| Return const_iterator to begin traversing the constant UList. More... | |
| iterator | end () |
| Return an iterator to end traversing the UList. More... | |
| const_iterator | end () const |
| Return const_iterator to end traversing the constant 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... | |
| reverse_iterator | rbegin () |
| Return reverse_iterator to begin reverse traversing the UList. More... | |
| const_reverse_iterator | rbegin () const |
| Return const_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 | rend () const |
| Return const_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... | |
| 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< Type > &) |
| Swap two ULists of the same type in constant time. More... | |
| bool | operator== (const UList< Type > &) const |
| Equality operation on ULists of the same type. More... | |
| bool | operator!= (const UList< Type > &) const |
| The opposite of the equality operation. Takes linear time. More... | |
| bool | operator< (const UList< Type > &) const |
| Compare two ULists lexicographically. Takes linear time. More... | |
| bool | operator> (const UList< Type > &) const |
| Compare two ULists lexicographically. Takes linear time. More... | |
| bool | operator<= (const UList< Type > &) const |
| Return true if !(a > b). Takes linear time. More... | |
| bool | operator>= (const UList< Type > &) const |
| Return true if !(a < b). Takes linear time. More... | |
Additional Inherited Members | |
| Public Types inherited from IOobject | |
| enum | objectState { GOOD, BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
| Enumeration defining the read options. More... | |
| enum | writeOption { AUTO_WRITE = 0, NO_WRITE = 1 } |
| Enumeration defining the write options. More... | |
| Public Types inherited from List< Type > | |
| typedef SubList< Type > | subList |
| Declare type of subList. More... | |
| Public Types inherited from UList< Type > | |
| typedef Type | value_type |
| Type of values the UList contains. More... | |
| typedef Type & | reference |
| Type that can be used for storing into. More... | |
| typedef const Type & | 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 Type * | iterator |
| Random access iterator for traversing UList. More... | |
| typedef const Type * | const_iterator |
| Random access iterator for traversing UList. More... | |
| typedef Type * | reverse_iterator |
| Reverse iterator for reverse traversal of UList. More... | |
| typedef const Type * | const_reverse_iterator |
| Reverse iterator for reverse traversal of constant UList. More... | |
| Static Public Member Functions inherited from IOobject | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. More... | |
| template<class Name > | |
| static word | groupName (Name name, const word &group) |
| template<class Stream > | |
| static Stream & | writeBanner (Stream &os, bool noHint=false) |
| Write the standard OpenFOAM file/dictionary banner. More... | |
| template<class Stream > | |
| static Stream & | writeDivider (Stream &os) |
| Write the standard file section divider. More... | |
| template<class Stream > | |
| static Stream & | writeEndDivider (Stream &os) |
| Write the standard end file divider. More... | |
| Static Public Member Functions inherited from List< Type > | |
| static const List< Type > & | null () |
| Return a null List. More... | |
| Static Public Member Functions inherited from UList< Type > | |
| static const UList< Type > & | null () |
| Return a null UList. More... | |
| Protected Member Functions inherited from IOobject | |
| Istream * | objectStream () |
| Construct and return an IFstream for the object. More... | |
| Istream * | objectStream (const fileName &) |
| Construct and return an IFstream for the object given the. More... | |
| void | setBad (const string &) |
| Set the object state to bad. More... | |
| Protected Member Functions inherited from List< Type > | |
| void | size (const label) |
| Override size to be inconsistent with allocated storage. More... | |
Table with uniform interval in independant variable, with linear interpolation.
Example usage (scalar): values specified within a dictionary:
{
x0 0; // lower limit
dx 0.2; // fixed interval
log10 true; // take log(10) when interpolating?
data // list of dependent data values
(
7870 // value at x0
7870 // value at x0 + dx
...
7870 // value at x0 + n*dx
);
}
Definition at line 70 of file uniformInterpolationTable.H.
| uniformInterpolationTable | ( | const IOobject & | io, |
| const bool | readFields | ||
| ) |
Construct from IOobject and readFields flag.
Creates a null object if readFields = false
Definition at line 49 of file uniformInterpolationTable.C.
References dict, dictionary::lookup(), Foam::readFields(), and dictionary::readIfPresent().
Referenced by uniformInterpolationTable< Type >::uniformInterpolationTable().
| uniformInterpolationTable | ( | const word & | tableName, |
| const objectRegistry & | db, | ||
| const dictionary & | dict, | ||
| const bool | initialiseOnly = false |
||
| ) |
Construct from name, objectRegistry and dictionary.
If initialiseOnly flag is set, control parameters are read from the dictionary, but not the data table
Definition at line 78 of file uniformInterpolationTable.C.
References dictionary::lookup(), nIntervals(), readScalar, setSize(), uniformInterpolationTable< Type >::uniformInterpolationTable(), and xMax.
| uniformInterpolationTable | ( | const uniformInterpolationTable< Type > & | uit | ) |
Construct as copy.
Definition at line 117 of file uniformInterpolationTable.C.
Destructor.
Definition at line 135 of file uniformInterpolationTable.C.
|
inline |
Return the lower limit.
Definition at line 28 of file uniformInterpolationTable.H.
|
inline |
Return the fixed interval.
Definition at line 35 of file uniformInterpolationTable.H.
|
inline |
Return the log10(x) flag.
Definition at line 42 of file uniformInterpolationTable.H.
|
inline |
Return the bound flag.
Definition at line 49 of file uniformInterpolationTable.H.
|
inline |
Return the lower limit.
Definition at line 56 of file uniformInterpolationTable.H.
|
inline |
Return the fixed interval.
Definition at line 63 of file uniformInterpolationTable.H.
|
inline |
Return the log10(x) flag.
Definition at line 70 of file uniformInterpolationTable.H.
|
inline |
Return the bound flag.
Definition at line 77 of file uniformInterpolationTable.H.
|
inline |
Return the minimum x value.
Definition at line 84 of file uniformInterpolationTable.H.
|
inline |
Return the maximum x value.
Definition at line 91 of file uniformInterpolationTable.H.
| Type interpolate | ( | scalar | x | ) | const |
Interpolate.
Definition at line 142 of file uniformInterpolationTable.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, uniformInterpolationTable< Type >::interpolateLog10(), Foam::max(), Foam::min(), Foam::name(), Foam::nl, and xMax.
| Type interpolateLog10 | ( | scalar | x | ) | const |
Interpolate - takes log10 flag into account.
Definition at line 187 of file uniformInterpolationTable.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::MULES::interpolate(), Foam::log10(), Foam::name(), and Foam::nl.
Referenced by nutUTabulatedWallFunctionFvPatchScalarField::calcUPlus(), and uniformInterpolationTable< Type >::interpolate().
| void write | ( | ) | const |
Write.
Definition at line 215 of file uniformInterpolationTable.C.
References dictionary::add(), and dict.
1.8.11