Table with uniform interval in independent 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... | |
Switch | log10 () const noexcept |
Return the log10(x) flag. More... | |
Switch | bound () const noexcept |
Return the bound flag. More... | |
scalar & | x0 () |
Return the lower limit. More... | |
scalar & | dx () |
Return the fixed interval. More... | |
Switch & | log10 () noexcept |
Return the log10(x) flag. More... | |
Switch & | bound () noexcept |
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") | |
Declare type-name, virtual type (with debug switch) More... | |
IOobject (const IOobject &)=default | |
Copy construct. More... | |
virtual | ~IOobject ()=default |
Destructor. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from path, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Copy construct, resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Copy construct, resetting name. More... | |
IOobject (const IOobject &io, const word &name, const fileName &local) | |
Copy construct, resetting name and local component. More... | |
IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
Copy construct, resetting register option. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
const objectRegistry & | db () const noexcept |
Return the local objectRegistry. More... | |
const Time & | time () const noexcept |
Return Time associated with the objectRegistry. More... | |
const word & | name () const noexcept |
Return the object name. More... | |
const word & | headerClassName () const noexcept |
Return name of the class name read from header. More... | |
word & | headerClassName () noexcept |
Return non-constant access to the class name read from header. More... | |
const string & | note () const noexcept |
Return the optional note. More... | |
string & | note () noexcept |
Modifiable access to the optional note. More... | |
virtual void | rename (const word &newName) |
Rename the object. More... | |
unsigned | labelByteSize () const noexcept |
The sizeof (label) in bytes, possibly read from the header. More... | |
unsigned | scalarByteSize () const noexcept |
The sizeof (scalar) in bytes, possibly read from the header. More... | |
void | resetHeader (const word &newName=word::null) |
Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. More... | |
bool | hasHeaderClass () const noexcept |
True if headerClassName() is non-empty (after reading) More... | |
template<class Type > | |
bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName. More... | |
template<class Type > | |
bool | isHeaderClassName () const |
Same as isHeaderClass() More... | |
virtual const dictionary * | findMetaData () const noexcept |
Return pointer to meta-data (if any) or nullptr. More... | |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const noexcept |
Return the Time::rootPath() More... | |
const fileName & | caseName () const noexcept |
Return the Time::caseName() More... | |
const fileName & | globalCaseName () const noexcept |
Return the Time::globalCaseName() More... | |
const fileName & | instance () const noexcept |
Read access to instance path component. More... | |
fileName & | instance () noexcept |
Write access to instance path component. More... | |
const fileName & | local () const noexcept |
Read access to local path component. More... | |
fileName | path () const |
The complete path for the object (with instance, local,...). More... | |
fileName | globalPath () const |
The complete global path for the object (with instance, local,...) More... | |
fileName | path (const word &instance, const fileName &local=fileName::null) const |
The complete path with alternative instance and local. More... | |
fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
The complete global path with alternative instance and local. More... | |
fileName | objectPath () const |
The complete path + object name. More... | |
fileName | globalObjectPath () const |
The complete global path + object name. More... | |
fileName | objectRelPath () const |
The object path relative to the root. More... | |
fileName | localFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching up if in parallel. More... | |
IOstreamOption | parseHeader (const dictionary &headerDict) |
Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More... | |
bool | readHeader (Istream &is) |
Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
bool | readHeader (dictionary &headerDict, Istream &is) |
Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
Read header (respects is_globalIOobject trait) and check its info. More... | |
template<class Type > | |
fileName | typeFilePath (const bool search=true) const |
Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &os) const |
Write header with current type() More... | |
bool | writeHeader (Ostream &os, const word &objectType) const |
Write header with override of type. More... | |
void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
Write header into a dictionary with current type() and given output format. More... | |
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
Write header into a dictionary with override of type and given output format. More... | |
bool | good () const noexcept |
Did last readHeader() succeed? More... | |
bool | bad () const noexcept |
Did last readHeader() fail? More... | |
InfoProxy< IOobject > | info () const noexcept |
Return info proxy, for printing information to a stream. More... | |
void | operator= (const IOobject &io) |
Copy assignment, copies all values (except the registry) More... | |
template<> | |
bool | isHeaderClass () const |
Specialization for void always returns true (no headerClassName check). More... | |
template<class StringType > | |
Foam::word | groupName (StringType base, const word &group) |
template<class Type > | |
Foam::fileName | typeFilePath (const bool search) const |
Public Member Functions inherited from IOobjectOption | |
constexpr | IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. More... | |
constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_WRITE with specified read/register options. More... | |
constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_READ with specified write/register options. More... | |
constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option. More... | |
constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
Construct from components with specified register option as bool. More... | |
constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option as bool. More... | |
readOption | readOpt () const noexcept |
Get the read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Set the read option. More... | |
writeOption | writeOpt () const noexcept |
Get the write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Set the write option. More... | |
bool | registerObject () const noexcept |
Should objects created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference. More... | |
bool | globalObject () const noexcept |
True if object is treated the same for all processors. More... | |
bool | globalObject (bool on) noexcept |
Change global-object status. More... | |
bool | isAnyRead () const noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
bool | isReadRequired () const noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
bool | isReadOptional () const noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
readOption & | readOpt () noexcept |
Access to the read option. More... | |
writeOption & | writeOpt () noexcept |
Access to the write option. More... | |
bool & | registerObject () noexcept |
Access to the register object option. More... | |
bool & | globalObject () noexcept |
Access to the global object option. More... | |
Public Member Functions inherited from List< Type > | |
constexpr | List () noexcept |
Default construct. More... | |
List (const label len) | |
Construct with given size. More... | |
List (const label len, const 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 Type &val) | |
Construct with length=1, copying the value as the only content. More... | |
List (const Foam::one, 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< Type > &list) | |
Copy construct from list. More... | |
List (const UList< Type > &list) | |
Copy construct contents from list. More... | |
List (List< Type > &list, bool reuse) | |
Construct as copy or re-use as specified. More... | |
List (const UList< Type > &list, const labelUList &indices) | |
Copy construct subset of list. More... | |
List (const UList< Type > &list, const FixedList< label, N > &indices) | |
Copy construct subset of list. More... | |
List (const FixedList< Type, N > &list) | |
Construct as copy of FixedList<T, N> More... | |
List (const PtrList< Type > &list) | |
Construct as copy of PtrList<T> More... | |
List (const IndirectListBase< Type, Addr > &list) | |
Construct as copy of IndirectList contents. More... | |
List (std::initializer_list< Type > list) | |
Construct from an initializer list. More... | |
List (List< Type > &&list) noexcept | |
Move construct from List. More... | |
List (DynamicList< Type, SizeMin > &&list) | |
Move construct from DynamicList. More... | |
List (Istream &is) | |
Construct from Istream. More... | |
List (const SLList< Type > &list) | |
Copy construct from SLList. More... | |
autoPtr< List< 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 Type &val) |
Adjust allocated size of list and set val for new elements. More... | |
void | resize (const label newLen) |
void | resize_fill (const label len, const Type &val) |
Adjust allocated size of list and set val for all elements. More... | |
void | resize_nocopy (const label len) |
Adjust allocated size of list without necessarily. More... | |
void | resize_unsafe (const label len) noexcept |
Change the addressed list size directly without affecting any memory management (advanced usage). More... | |
void | setSize (const label n) |
Alias for resize() More... | |
void | setSize (const label n, const Type &val) |
Alias for resize() More... | |
void | transfer (List< Type > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
void | transfer (DynamicList< Type, SizeMin > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
Type & | newElmt (const label i) |
Return subscript-checked element of UList and resizing the list if required. More... | |
Type & | emplace_back (Args &&... args) |
Construct an element at the end of the list, return reference to the new list element. More... | |
void | push_back (const Type &val) |
Append an element at the end of the list. More... | |
void | push_back (Type &&val) |
Move append an element at the end of the list. More... | |
void | push_back (const UList< Type > &list) |
Append a List to the end of this list. More... | |
void | push_back (const IndirectListBase< Type, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | push_uniq (const Type &val) |
Append an element if not already in the list. More... | |
void | pop_back (label n=1) |
Reduce size by 1 or more elements. Can be called on an empty list. More... | |
void | operator= (const UList< Type > &list) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const List< Type > &list) |
Assignment operator. Takes linear time. More... | |
void | operator= (const IndirectListBase< Type, Addr > &list) |
Assignment from IndirectList. Takes linear time. More... | |
void | operator= (const FixedList< Type, N > &list) |
Copy assignment from FixedList. More... | |
void | operator= (std::initializer_list< Type > list) |
Assignment to an initializer list. More... | |
void | operator= (const 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< Type > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (DynamicList< Type, SizeMin > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (const SLList< Type > &list) |
Copy assign from SLList in linear time. More... | |
Istream & | readList (Istream &is) |
Read List from Istream, discarding contents of existing List. More... | |
void | shallowCopy (const UList< 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... | |
void | append (const Type &val) |
Append an element at the end of the list. More... | |
void | append (Type &&val) |
Move append an element at the end of the list. More... | |
void | append (const UList< Type > &list) |
Append a List to the end of this list. More... | |
void | append (const IndirectListBase< Type, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | appendUniq (const Type &val) |
Same as push_uniq() More... | |
Public Member Functions inherited from UList< Type > | |
label | size () const noexcept |
The number of elements in the container. More... | |
void | writeEntry (const word &keyword, Ostream &os) const |
Write the List as a dictionary entry with keyword. More... | |
void | operator= (const Type &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
UList (const UList< Type > &)=default | |
Copy construct. More... | |
constexpr | UList () noexcept |
Default construct, zero-sized and nullptr. More... | |
UList (Type *__restrict__ v, const label len) noexcept | |
Construct from components. More... | |
label | fcIndex (const label i) const noexcept |
The forward circular index. The next index in the list which returns to the first at the end of the list. More... | |
label | rcIndex (const label i) const noexcept |
The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More... | |
const Type & | fcValue (const label i) const |
Return forward circular value (ie, next value in the list) More... | |
Type & | fcValue (const label i) |
Return forward circular value (ie, next value in the list) More... | |
const Type & | rcValue (const label i) const |
Return reverse circular value (ie, previous value in the list) More... | |
Type & | rcValue (const label i) |
Return reverse circular value (ie, previous value in the list) More... | |
const Type * | cdata () const noexcept |
Return pointer to the underlying array serving as data storage. More... | |
Type * | data () 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... | |
Type & | front () |
Access first element of the list, position [0]. More... | |
const Type & | front () const |
Access first element of the list. More... | |
Type & | back () |
Access last element of the list, position [size()-1]. More... | |
const Type & | back () const |
Access last element of the list, position [size()-1]. More... | |
std::streamsize | size_bytes () const noexcept |
Number of contiguous bytes for the List data. More... | |
std::streamsize | byteSize () const |
Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More... | |
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... | |
bool | contains (const Type &val) const |
True if the value is contained in the list. More... | |
bool | contains (const Type &val, label pos, label len=-1) const |
Is the value contained in the list? More... | |
label | find (const Type &val) const |
Find index of the first occurrence of the value. More... | |
label | find (const Type &val, label pos, label len=-1) const |
Find index of the first occurrence of the value. More... | |
label | rfind (const Type &val, label pos=-1) const |
Find index of the last occurrence of the value. 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 (Type *__restrict__ ptr, const label len) noexcept |
Copy the pointer and size. More... | |
void | shallowCopy (std::nullptr_t) noexcept |
Copy nullptr and zero size. More... | |
void | shallowCopy (const UList< Type > &list) noexcept |
Copy the pointer and size held by the given UList. More... | |
void | deepCopy (const UList< Type > &list) |
Copy elements of the given UList. Sizes must match! More... | |
void | deepCopy (const IndirectListBase< Type, Addr > &list) |
Copy elements of the given indirect list. Sizes must match! More... | |
SubList< Type > | slice (const label pos, label len=-1) |
Return SubList slice (non-const access) - no range checking. More... | |
const SubList< Type > | slice (const label pos, label len=-1) const |
Return SubList slice (const access) - no range checking. More... | |
SubList< Type > | slice (const labelRange &range) |
Return SubList slice (non-const access) - with range checking. More... | |
const SubList< Type > | slice (const labelRange &range) const |
Return SubList slice (const access) - with range checking. More... | |
Type & | operator[] (const label i) |
Return element of UList. More... | |
const Type & | operator[] (const label i) const |
Return element of constant UList. More... | |
const bool & | operator[] (const label i) const |
UPstream::commsStruct & | operator[] (const label procID) |
const UPstream::commsStruct & | operator[] (const label procID) const |
Foam::UPstream::commsStruct & | operator[] (const label procID) |
const Foam::UPstream::commsStruct & | operator[] (const label procID) const |
operator const Foam::List< Type > & () const | |
Allow cast to a const List<T>&. More... | |
iterator | begin () noexcept |
Return an iterator to begin traversing the UList. More... | |
iterator | begin (const label i) noexcept |
Return iterator at offset i from begin, clamped to [0,size] range. More... | |
const_iterator | begin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | begin (const label i) const noexcept |
Return const_iterator at offset i from begin, clamped to [0,size] range. More... | |
iterator | end () noexcept |
Return an iterator to end traversing the UList. More... | |
const_iterator | end () const noexcept |
Return const_iterator to end traversing the constant UList. More... | |
const_iterator | cbegin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | cbegin (const label i) const noexcept |
Return const_iterator at offset i from begin, clamped to [0,size] range. More... | |
const_iterator | cend () 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... | |
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... | |
bool | empty () const noexcept |
True if List is empty (ie, size() is zero) More... | |
label | capacity () const noexcept |
Size of the underlying storage. More... | |
void | swap (UList< Type > &list) noexcept |
Swap content with another UList of the same type in constant time. More... | |
bool | operator== (const UList< Type > &list) const |
Equality operation on ULists of the same type. More... | |
bool | operator!= (const UList< Type > &list) const |
The opposite of the equality operation. Takes linear time. More... | |
bool | operator< (const UList< Type > &list) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator> (const UList< Type > &list) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator<= (const UList< Type > &list) const |
Return true if !(a > b). Takes linear time. More... | |
bool | operator>= (const UList< Type > &list) const |
Return true if !(a < b). Takes linear time. More... | |
Istream & | readList (Istream &is) |
Read List contents from Istream. More... | |
Ostream & | writeList (Ostream &os, const label shortLen=0) const |
Write List, with line-breaks in ASCII when length exceeds shortLen. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | test (const label i) const |
Test bool value at specified position, always false for out-of-range access. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | get (const label i) const |
Return bool value at specified position, always false for out-of-range access. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | unset (const label i) |
Unset the bool entry at specified position, always false for out-of-range access. More... | |
Type & | first () |
Access first element of the list, position [0]. More... | |
const Type & | first () const |
Access first element of the list. More... | |
Type & | last () |
Access last element of the list, position [size()-1]. More... | |
const Type & | last () const |
Access last element of the list, position [size()-1]. More... | |
bool | found (const Type &val, label pos=0) const |
Same as contains() More... | |
Additional Inherited Members | |
Public Types inherited from IOobject | |
enum | objectState : char { GOOD, BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
Enumeration defining the file checking options. More... | |
Public Types inherited from IOobjectOption | |
enum | readOption : unsigned char { NO_READ = 0, MUST_READ = 0x1, READ_MODIFIED = 0x3, MUST_READ_IF_MODIFIED = 0x3, LAZY_READ = 0x4, READ_IF_PRESENT = 0x4 } |
Enumeration defining read preferences. More... | |
enum | writeOption : unsigned char { NO_WRITE = 0, AUTO_WRITE = 0x10 } |
Enumeration defining write preferences. More... | |
enum | registerOption : unsigned char { NO_REGISTER = 0, REGISTER = 1, LEGACY_REGISTER = 2 } |
Enumeration for use with registerObject(). Values map to bool (false/true) 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 |
The value type the list contains. More... | |
typedef Type * | pointer |
The pointer type for non-const access to value_type items. More... | |
typedef const Type * | const_pointer |
The pointer type for const access to value_type items. More... | |
typedef Type & | reference |
The type used for storing into value_type objects. More... | |
typedef const Type & | const_reference |
The type used for reading from constant value_type objects. More... | |
typedef Type * | iterator |
Random access iterator for traversing a UList. More... | |
typedef const Type * | const_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< iterator > | reverse_iterator |
Reverse iterator (non-const access) More... | |
typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
Reverse iterator (const access) More... | |
Static Public Member Functions inherited from IOobject | |
static bool | bannerEnabled () noexcept |
Status of output file banner. More... | |
static bool | bannerEnabled (bool on) noexcept |
Enable/disable output file banner. More... | |
static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
Split path into instance, local, name components. More... | |
template<class StringType > | |
static word | groupName (StringType base, const word &group) |
Create dot-delimited name.group string. More... | |
static word | group (const word &name) |
Return group (extension part of name) More... | |
static word | member (const word &name) |
Return member (name without the extension) More... | |
static word | scopedName (const std::string &scope, const word &name) |
Create scope:name or scope_name string. More... | |
static word | scopedName (const std::string &scope, const word &name1, const word &name2) |
Create scope:name1:name2 or scope_name1_name2 string. More... | |
static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
Return the IOobject, but also consider an alternative file name. More... | |
static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
static Ostream & | writeDivider (Ostream &os) |
Write the standard file section divider. More... | |
static Ostream & | writeEndDivider (Ostream &os) |
Write the standard end file divider. More... | |
Static Public Member Functions inherited from IOobjectOption | |
static bool | isAnyRead (readOption opt) noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
static bool | isReadRequired (readOption opt) noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
static bool | isReadOptional (readOption opt) noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
static readOption | lazierRead (readOption opt) noexcept |
Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More... | |
Static Public Member Functions inherited from List< Type > | |
static const List< Type > & | null () noexcept |
Return a null List (reference to a nullObject). Behaves like an empty List. More... | |
Static Public Member Functions inherited from UList< Type > | |
static const UList< Type > & | null () noexcept |
Return a null UList (reference to a nullObject). Behaves like an empty UList. More... | |
static constexpr label | max_size () noexcept |
The size of the largest possible UList. More... | |
Static Public Attributes inherited from IOobject | |
static const Enum< fileCheckTypes > | fileCheckTypesNames |
Names for the fileCheckTypes. More... | |
static char | scopeSeparator |
Character for scoping object names (':' or '_') More... | |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
static float | fileModificationSkew |
Time skew (seconds) for file modification checks. More... | |
static int | maxFileModificationPolls |
Max number of times to poll for file modification changes. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &s) |
Set the object state to bad. More... | |
Protected Member Functions inherited from UList< Type > | |
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... | |
void | writeEntry (Ostream &os) const |
Character list writeEntry. More... | |
void | writeEntry (Ostream &os) const |
labelRange | validateRange (const labelRange &requestedRange) const |
Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. More... | |
void | fill_uniform (const Type &val) |
Assign all entries to the given value. More... | |
void | fill_uniform (const Foam::zero) |
Assign all entries to zero. More... | |
UList< Type > & | operator= (const UList< Type > &)=delete |
No copy assignment (default: shallow copy) More... | |
void | operator= (const Foam::zero) |
Character list assign zero - avoids Foam::zero casting ambiguities. More... | |
void | operator= (const Foam::zero) |
Static Protected Member Functions inherited from IOobject | |
static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
Helper: write content for FoamFile IOobject header with optional meta information. More... | |
static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
Helper: write dictionary content for FoamFile header with optional meta information. More... | |
Table with uniform interval in independent 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 68 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 47 of file uniformInterpolationTable.C.
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 76 of file uniformInterpolationTable.C.
uniformInterpolationTable | ( | const uniformInterpolationTable< Type > & | uit | ) |
Construct as copy.
Definition at line 116 of file uniformInterpolationTable.C.
Destructor.
Definition at line 134 of file uniformInterpolationTable.C.
|
inline |
Return the lower limit.
Definition at line 23 of file uniformInterpolationTable.H.
|
inline |
Return the fixed interval.
Definition at line 30 of file uniformInterpolationTable.H.
|
inlinenoexcept |
Return the log10(x) flag.
Definition at line 37 of file uniformInterpolationTable.H.
|
inlinenoexcept |
Return the bound flag.
Definition at line 44 of file uniformInterpolationTable.H.
|
inline |
Return the lower limit.
Definition at line 51 of file uniformInterpolationTable.H.
|
inline |
Return the fixed interval.
Definition at line 58 of file uniformInterpolationTable.H.
|
inlinenoexcept |
Return the log10(x) flag.
Definition at line 65 of file uniformInterpolationTable.H.
|
inlinenoexcept |
Return the bound flag.
Definition at line 72 of file uniformInterpolationTable.H.
|
inline |
Return the minimum x value.
Definition at line 79 of file uniformInterpolationTable.H.
|
inline |
Return the maximum x value.
Definition at line 86 of file uniformInterpolationTable.H.
Type interpolate | ( | scalar | x | ) | const |
Interpolate.
Definition at line 141 of file uniformInterpolationTable.C.
Type interpolateLog10 | ( | scalar | x | ) | const |
Interpolate - takes log10 flag into account.
Definition at line 186 of file uniformInterpolationTable.C.
void write | ( | ) | const |
Write.
Definition at line 214 of file uniformInterpolationTable.C.