|
| | incompressibleThreePhaseMixture (const volVectorField &U, const surfaceScalarField &phi) |
| | Construct from components.
|
| | ~incompressibleThreePhaseMixture () |
| | Destructor.
|
| const word | phase1Name () const |
| const word | phase2Name () const |
| const word | phase3Name () const |
| const volScalarField & | alpha1 () const |
| volScalarField & | alpha1 () |
| const volScalarField & | alpha2 () const |
| volScalarField & | alpha2 () |
| const volScalarField & | alpha3 () const |
| volScalarField & | alpha3 () |
| const dimensionedScalar & | rho1 () const |
| | Return const-access to phase1 density.
|
| const dimensionedScalar & | rho2 () const |
| | Return const-access to phase2 density.
|
| const dimensionedScalar & | rho3 () const |
| | Return const-access to phase3 density.
|
| const volVectorField & | U () const |
| | Return the velocity.
|
| const surfaceScalarField & | phi () const |
| | Return the flux.
|
| const viscosityModel & | nuModel1 () const |
| | Return const-access to phase1 viscosityModel.
|
| const viscosityModel & | nuModel2 () const |
| | Return const-access to phase2 viscosityModel.
|
| const viscosityModel & | nuModel3 () const |
| | Return const-access to phase3 viscosityModel.
|
| tmp< volScalarField > | mu () const |
| | Return the dynamic laminar viscosity.
|
| tmp< surfaceScalarField > | muf () const |
| | Return the face-interpolated dynamic laminar viscosity.
|
| tmp< volScalarField > | nu () const |
| | Return the kinematic laminar viscosity.
|
| tmp< scalarField > | nu (const label patchi) const |
| | Return the laminar viscosity for patch.
|
| tmp< surfaceScalarField > | nuf () const |
| | Return the face-interpolated dynamic laminar viscosity.
|
| void | correct () |
| | Correct the laminar viscosity.
|
| bool | read () |
| | Read base transportProperties dictionary.
|
| | IOdictionary (const IOobject &io, const dictionary *fallback=nullptr) |
| | Construct given an IOobject and optional fallback dictionary content.
|
| | IOdictionary (const IOobject &io, const dictionary &dict) |
| | Construct given an IOobject and fallback dictionary content.
|
| | IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr) |
| | Construct given an IOobject, wanted typeName and optional fallback dictionary content.
|
| | IOdictionary (const IOobject &io, Istream &is) |
| | Construct given an IOobject and Istream.
|
| virtual | ~IOdictionary ()=default |
| | Destructor.
|
| virtual bool | global () const |
| | The object is global.
|
| virtual fileName | filePath () const |
| | Return complete path + object name if the file exists either in the case/processor or case otherwise null.
|
| | TypeName ("dictionary") |
| | Declare type-name, virtual type (with debug switch).
|
| | baseIOdictionary (const baseIOdictionary &)=default |
| | Copy construct.
|
| | baseIOdictionary (baseIOdictionary &&)=default |
| | Move construct.
|
| virtual | ~baseIOdictionary ()=default |
| | Destructor.
|
| | baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr) |
| | Construct given an IOobject and optional fallback dictionary content (ununsed).
|
| | baseIOdictionary (const IOobject &io, const dictionary &dict) |
| | Construct given an IOobject and fallback dictionary content (ununsed).
|
| | baseIOdictionary (const IOobject &io, Istream &is) |
| | Construct given an IOobject and Istream (ununsed).
|
| const word & | name () const |
| | Name function is needed to disambiguate those inherited from regIOobject and dictionary.
|
| virtual bool | readData (Istream &) |
| | The readData function required by regIOobject read operation.
|
| virtual bool | writeData (Ostream &) const |
| | The writeData function required by regIOobject write operation.
|
| void | operator= (const baseIOdictionary &rhs) |
| | Copy assignment of dictionary entries.
|
| void | operator= (baseIOdictionary &&rhs) |
| | Move assignment of dictionary entries.
|
| void | operator= (const dictionary &rhs) |
| | Copy assignment of dictionary entries.
|
| void | operator= (const regIOobject &)=delete |
| | No copy assignment.
|
| | TypeName ("regIOobject") |
| | Runtime type information.
|
| | regIOobject (const IOobject &io, const bool isTimeObject=false) |
| | Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time).
|
| | regIOobject (const regIOobject &rio) |
| | Copy construct.
|
| | regIOobject (const regIOobject &rio, bool registerCopy) |
| | Copy construct, transferring registry registration to the copy if registerCopy is true.
|
| | regIOobject (const word &newName, const regIOobject &, bool registerCopy) |
| | Copy construct with new name, transferring registry registration to the copy if registerCopy is true.
|
| | regIOobject (const IOobject &io, const regIOobject &rio) |
| | Copy construct with new IO parameters.
|
| virtual | ~regIOobject () |
| | Destructor.
|
| bool | checkIn () |
| | Add object to registry, if not already registered.
|
| bool | checkOut () |
| | Remove object from registry, and remove all file watches.
|
| virtual void | addWatch () |
| | Add file watch on object (if registered and READ_IF_MODIFIED).
|
| bool | registered () const noexcept |
| | Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference.
|
| bool | ownedByRegistry () const noexcept |
| | Is this object owned by the registry?
|
| bool | store () |
| | Register object with its registry and transfer ownership to the registry.
|
| void | release (const bool unregister=false) noexcept |
| | Set object as not ownedByRegistry.
|
| label | eventNo () const noexcept |
| | Event number at last update.
|
| label & | eventNo () noexcept |
| | Event number at last update.
|
| bool | upToDate (const regIOobject &) const |
| | Return true if up-to-date with respect to given object.
|
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| | Return true if up-to-date with respect to given objects.
|
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| | Return true if up-to-date with respect to given objects.
|
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| | Return true if up-to-date with respect to given objects.
|
| void | setUpToDate () |
| | Set as up-to-date.
|
| virtual void | rename (const word &newName) |
| | Rename.
|
| const dictionary * | findMetaData () const noexcept |
| | Return pointer to meta-data or nullptr.
|
| dictionary & | getMetaData () noexcept |
| | Get or create meta-data.
|
| void | removeMetaData () |
| | Remove meta-data.
|
| virtual void | updateMetaData () |
| | Update internal meta-data (eg, prior to writing).
|
| bool | headerOk () |
| | Read and check header info. Does not check the headerClassName.
|
| Istream & | readStream (const word &, const bool readOnProc=true) |
| | Return Istream and check object type against that given.
|
| void | close () |
| | Close Istream.
|
| virtual label | addWatch (const fileName &) |
| | Add file watch for fileName on object if not yet watched.
|
| const labelList & | watchIndices () const noexcept |
| | Read access to file-monitoring handles.
|
| labelList & | watchIndices () noexcept |
| | Write access to file-monitoring handles.
|
| virtual bool | modified () const |
| | Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time).
|
| virtual bool | readIfModified () |
| | Read object if modified (as set by call to modified).
|
| virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
| | Write using stream options.
|
| virtual bool | write (const bool writeOnProc=true) const |
| | Write using setting from DB.
|
| void | operator= (const IOobject &io) |
| | Copy assignment.
|
| virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const |
| | Write using given format, version and compression.
|
| | TypeName ("IOobject") |
| | Declare type-name, virtual type (with debug switch).
|
| | IOobject (const IOobject &)=default |
| | Copy construct.
|
| virtual | ~IOobject ()=default |
| | Destructor.
|
| | IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) |
| | Construct from name, instance, registry, io options.
|
| | IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) |
| | Construct from name, instance, local, registry, io options.
|
| | IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) |
| | Construct from path, registry, io options.
|
| | 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.
|
| | 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.
|
| | 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.
|
| | IOobject (const IOobject &io, const objectRegistry ®istry) |
| | Copy construct, resetting registry.
|
| | IOobject (const IOobject &io, const word &name) |
| | Copy construct, resetting name.
|
| | IOobject (const IOobject &io, const word &name, const fileName &local) |
| | Copy construct, resetting name and local component.
|
| | IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) |
| | Copy construct, resetting read/write options.
|
| | IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) |
| | Copy construct, resetting register option.
|
| autoPtr< IOobject > | clone () const |
| | Clone.
|
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| | Clone resetting registry.
|
| const objectRegistry & | db () const noexcept |
| | Return the local objectRegistry.
|
| const Time & | time () const noexcept |
| | Return Time associated with the objectRegistry.
|
| const word & | name () const noexcept |
| | Return the object name.
|
| const word & | headerClassName () const noexcept |
| | Return name of the class name read from header.
|
| word & | headerClassName () noexcept |
| | Modifiable access to the class name read from header.
|
| const string & | note () const noexcept |
| | Return the optional note.
|
| string & | note () noexcept |
| | Modifiable access to the optional note.
|
| unsigned | labelByteSize () const noexcept |
| | The sizeof (label) in bytes, possibly read from the header.
|
| unsigned | scalarByteSize () const noexcept |
| | The sizeof (scalar) in bytes, possibly read from the header.
|
| void | resetHeader (const word &newName=word::null) |
| | Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file.
|
| bool | hasHeaderClass () const noexcept |
| | True if headerClassName() is non-empty (after reading).
|
| bool | isHeaderClass (const word &expectedType) const |
| | Check if headerClassName() equals the expected type. Always true if the expected type is empty.
|
| template<class Type> |
| bool | isHeaderClass () const |
| | Check if headerClassName() equals Type::typeName Always true for a void type.
|
| word | group () const |
| | Return group (extension part of name).
|
| word | member () const |
| | Return member (name without the extension).
|
| const fileName & | rootPath () const noexcept |
| | Return the Time::rootPath().
|
| const fileName & | caseName () const noexcept |
| | Return the Time::caseName().
|
| const fileName & | globalCaseName () const noexcept |
| | Return the Time::globalCaseName().
|
| const fileName & | caseName (IOobjectOption::Layout) const noexcept |
| | Return the Time::caseName() - normal or global.
|
| const fileName & | instance () const noexcept |
| | Read access to instance path component.
|
| fileName & | instance () noexcept |
| | Modifiable access to instance path component.
|
| scalar | instanceValue () const |
| | Return the scalar value of the instance component (or 0), which often corresponds to a time index/value.
|
| const fileName & | local () const noexcept |
| | Read access to local path component.
|
| fileName & | local () noexcept |
| | Modifiable access to the local path component.
|
| fileName | path () const |
| | The complete path for the object (with instance, local,...).
|
| fileName | globalPath () const |
| | The complete global path for the object (with instance, local,...).
|
| fileName | path (IOobjectOption::Layout) const |
| | The complete path (normal or global) for the object.
|
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| | The complete path with alternative instance and local.
|
| fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
| | The complete global path with alternative instance and local.
|
| fileName | path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const |
| | The complete path (normal or global) with alternative instance and local.
|
| fileName | objectPath () const |
| | The complete path + object name.
|
| fileName | globalObjectPath () const |
| | The complete global path + object name.
|
| fileName | objectPath (IOobjectOption::Layout) const |
| | The complete path (normal or global) + object name.
|
| fileName | objectPath (IOobjectOption::Layout, const word &instance) const |
| | The complete path (normal or global) + object name with alternative instance.
|
| fileName | objectPath (const word &instance) const |
| | The complete path + object name with alternative instance.
|
| fileName | globalObjectPath (const word &instance) const |
| | The complete global path + object name with alternative instance.
|
| fileName | objectRelPath () const |
| | The object path relative to the case.
|
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| | Redirect to fileHandler filePath, searching locally.
|
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| | Redirect to fileHandler filePath, searching up if in parallel.
|
| IOstreamOption | parseHeader (const dictionary &headerDict) |
| | Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics.
|
| bool | readHeader (Istream &is) |
| | Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics.
|
| bool | readHeader (dictionary &headerDict, Istream &is) |
| | Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics.
|
| 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. A void type suppresses trait and type-name checks.
|
| template<class Type, bool Searching> |
| bool | typeHeaderOk (const bool checkType=true, const bool verbose=true) |
| | Forwards to single-parameter version with the specified search type. A void type suppresses trait and type-name checks.
|
| template<class Type> |
| fileName | typeFilePath (const bool search=true) const |
| | Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait.
|
| template<class Type> |
| void | warnNoRereading () const |
| | Helper: warn that type does not support re-reading.
|
| bool | writeHeader (Ostream &os) const |
| | Write header with current type().
|
| bool | writeHeader (Ostream &os, const word &objectType) const |
| | Write header with override of type.
|
| void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
| | Write header into a dictionary with current type() and given output format.
|
| void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
| | Write header into a dictionary with override of type and given output format.
|
| bool | good () const noexcept |
| | Did last readHeader() succeed?
|
| bool | bad () const noexcept |
| | Did last readHeader() fail?
|
| InfoProxy< IOobject > | info () const noexcept |
| | Return info proxy, for printing information to a stream.
|
| void | operator= (const IOobject &io) |
| | Copy assignment, copies all values (except the registry).
|
| template<class Type> |
| bool | isHeaderClassName () const |
| | Same as isHeaderClass().
|
| template<class StringType> |
| Foam::word | groupName (StringType base, const word &group) |
| template<class Type> |
| Foam::fileName | typeFilePath (const bool search) const |
| 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.
|
| constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| | Construct NO_WRITE with specified read/register options.
|
| constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| | Construct NO_READ with specified write/register options.
|
| constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
| | Construct (NO_READ, NO_WRITE) with specified register option.
|
| constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
| | Construct from components with specified register option as bool.
|
| constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
| | Construct (NO_READ, NO_WRITE) with specified register option as bool.
|
| readOption | readOpt () const noexcept |
| | Get the read option.
|
| readOption | readOpt (readOption opt) noexcept |
| | Set the read option.
|
| writeOption | writeOpt () const noexcept |
| | Get the write option.
|
| writeOption | writeOpt (writeOption opt) noexcept |
| | Set the write option.
|
| bool | registerObject () const noexcept |
| | Should objects created with this IOobject be registered?
|
| bool | registerObject (bool on) noexcept |
| | Change registration preference.
|
| bool | globalObject () const noexcept |
| | True if object is treated the same for all processors.
|
| bool | globalObject (bool on) noexcept |
| | Change global-object status.
|
| bool | isAnyRead () const noexcept |
| | True if any reading may be required (ie, != NO_READ).
|
| bool | isReadRequired () const noexcept |
| | True if (MUST_READ | READ_MODIFIED) bits are set.
|
| bool | isReadOptional () const noexcept |
| | True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
|
| readOption & | readOpt () noexcept |
| | Access to the read option.
|
| writeOption & | writeOpt () noexcept |
| | Access to the write option.
|
| bool & | registerObject () noexcept |
| | Access to the register object option.
|
| bool & | globalObject () noexcept |
| | Access to the global object option.
|
| | ClassName ("dictionary") |
| | dictionary () |
| | Default construct, a top-level empty dictionary.
|
| | dictionary (const fileName &name) |
| | Construct top-level empty dictionary with given name.
|
| | dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false) |
| | Construct given the entry name, parent dictionary and Istream, reading entries until EOF, optionally keeping the header.
|
| | dictionary (Istream &is) |
| | Construct top-level dictionary from Istream (discards the header). Reads entries until EOF or when the first token is a '{' character, it will stop reading at the matching '}' character.
|
| | dictionary (Istream &is, bool keepHeader) |
| | Construct top-level dictionary from Istream, reading entries until EOF, optionally keeping the header.
|
| | dictionary (const dictionary &parentDict, const dictionary &dict) |
| | Copy construct given the parent dictionary.
|
| | dictionary (const dictionary &dict) |
| | Copy construct top-level dictionary.
|
| | dictionary (const dictionary *dict) |
| | Construct top-level dictionary as copy from pointer to dictionary.
|
| | dictionary (const dictionary &parentDict, dictionary &&dict) |
| | Move construct for given parent dictionary.
|
| | dictionary (dictionary &&dict) |
| | Move construct top-level dictionary.
|
| autoPtr< dictionary > | clone () const |
| | Construct and return clone.
|
| virtual | ~dictionary () |
| | Destructor.
|
| const fileName & | name () const noexcept |
| | The dictionary name.
|
| fileName & | name () noexcept |
| | The dictionary name for modification (use with caution).
|
| word | dictName () const |
| | The local dictionary name (final part of scoped name).
|
| fileName | relativeName (const bool caseTag=false) const |
| | The dictionary name relative to the case.
|
| bool | isNullDict () const noexcept |
| | The dictionary is actually dictionary::null (root dictionary).
|
| const dictionary & | parent () const noexcept |
| | Return the parent dictionary.
|
| const dictionary & | topDict () const |
| | Return the top of the tree.
|
| label | startLineNumber () const |
| | Return line number of first token in dictionary.
|
| label | endLineNumber () const |
| | Return line number of last token in dictionary.
|
| SHA1Digest | digest () const |
| | Return the SHA1 digest of the dictionary contents.
|
| tokenList | tokens () const |
| | Return the dictionary as a list of tokens.
|
| const entry * | findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find an entry (const access) with the given keyword.
|
| entry * | findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| | Find an entry (non-const access) with the given keyword.
|
| bool | found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find an entry (const access) with the given keyword.
|
| const entry * | findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Search for a scoped entry (const access) with the given keyword.
|
| const dictionary * | findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a sub-dictionary pointer if present (and it is a dictionary) otherwise return nullptr.
|
| dictionary * | findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| | Find and return a sub-dictionary pointer if present (and it is a dictionary) otherwise return nullptr.
|
| ITstream * | findStream (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return an entry stream if present (and it is a stream) otherwise return nullptr.
|
| const entry & | lookupEntry (const word &keyword, enum keyType::option matchOpt) const |
| | Search for an entry (const access) with the given keyword.
|
| ITstream & | lookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return an entry data stream. FatalIOError if not found, or not a stream.
|
| template<class T> |
| T | get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a T. FatalIOError if not found, or if the number of tokens is incorrect.
|
| template<class T> |
| T | getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect.
|
| template<class T> |
| T | getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) |
| | Find and return a T, or return the given default value and add it to dictionary. FatalIOError if it is found and the number of tokens is incorrect.
|
| template<class T> |
| bool | readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const |
| | Find entry and assign to T val. FatalIOError if it is found and the number of tokens is incorrect, or it is mandatory and not found.
|
| template<class T> |
| bool | readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find an entry if present, and assign to T val. FatalIOError if it is found and the number of tokens is incorrect.
|
| template<class T, class Predicate> |
| T | getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a T with additional checking FatalIOError if not found, or if the number of tokens is incorrect.
|
| template<class T, class Predicate> |
| T | getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect.
|
| template<class T, class Predicate> |
| T | getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) |
| | Find and return a T, or return the given default value and add it to dictionary. FatalIOError if it is found and the number of tokens is incorrect.
|
| template<class T, class Predicate> |
| bool | readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const |
| | Find entry and assign to T val. FatalIOError if it is found and the number of tokens is incorrect, or it is mandatory and not found.
|
| template<class T, class Predicate> |
| bool | readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find an entry if present, and assign to T val. FatalIOError if it is found and the number of tokens is incorrect.
|
| const dictionary & | subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a sub-dictionary.
|
| dictionary & | subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| | Find and return a sub-dictionary for manipulation.
|
| dictionary & | subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| | Find and return a sub-dictionary for manipulation.
|
| dictionary | subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const |
| | Find and return a sub-dictionary as a copy, otherwise return an empty dictionary.
|
| const dictionary & | optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a sub-dictionary, otherwise return this dictionary.
|
| wordList | toc () const |
| | Return the table of contents.
|
| wordList | sortedToc () const |
| | Return the sorted table of contents.
|
| template<class Compare> |
| wordList | sortedToc (const Compare &comp) const |
| | Return table of contents sorted using the specified comparator.
|
| List< keyType > | keys (bool patterns=false) const |
| | Return the list of available keys or patterns.
|
| bool | substituteKeyword (const word &keyword, bool mergeEntry=false) |
| | Substitute the given keyword (which is prefixed by '$').
|
| bool | substituteScopedKeyword (const word &keyword, bool mergeEntry=false) |
| | Substitute the given scoped keyword (which is prefixed by '$').
|
| entry * | add (entry *entryPtr, bool mergeEntry=false) |
| | Add a new entry.
|
| entry * | add (const entry &e, bool mergeEntry=false) |
| | Add an entry.
|
| entry * | add (const keyType &k, const word &v, bool overwrite=false) |
| | Add a word entry.
|
| entry * | add (const keyType &k, const string &v, bool overwrite=false) |
| | Add a string entry.
|
| entry * | add (const keyType &k, const label v, bool overwrite=false) |
| | Add a label entry.
|
| entry * | add (const keyType &k, const scalar v, bool overwrite=false) |
| | Add a scalar entry.
|
| entry * | add (const keyType &k, const dictionary &d, bool mergeEntry=false) |
| | Add a dictionary entry.
|
| template<class T> |
| entry * | add (const keyType &k, const T &v, bool overwrite=false) |
| | Add a T entry.
|
| entry * | set (entry *entryPtr) |
| | Assign a new entry, overwriting any existing entry.
|
| entry * | set (const entry &e) |
| | Assign a new entry, overwriting any existing entry.
|
| entry * | set (const keyType &k, const dictionary &v) |
| | Assign a dictionary entry, overwriting any existing entry.
|
| entry * | set (const keyType &k, std::nullptr_t) |
| | Assign an empty primitive entry, overwriting any existing entry.
|
| entry * | set (const keyType &k, const UList< token > &tokens) |
| | Assign a primitive entry from a list of tokens, overwriting any existing entry.
|
| entry * | set (const keyType &k, List< token > &&tokens) |
| | Assign a primitive entry from a list of tokens, overwriting any existing entry.
|
| template<class T> |
| entry * | set (const keyType &k, const T &v) |
| | Assign a T entry, overwriting any existing entry.
|
| bool | remove (const word &keyword) |
| | Remove an entry specified by keyword.
|
| bool | changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false) |
| | Change the keyword for an entry,.
|
| bool | merge (const dictionary &dict) |
| | Merge entries from the given dictionary.
|
| void | clear () |
| | Clear the dictionary.
|
| void | transfer (dictionary &dict) |
| | Transfer the contents of the argument and annul the argument.
|
| void | checkITstream (const ITstream &is, const word &keyword) const |
| | Check after reading if the input token stream has unconsumed tokens remaining or if there were no tokens in the first place.
|
| bool | read (Istream &is) |
| | Read dictionary from Istream (discards the header). Reads entries until EOF or when the first token is a '{' character, it will stop reading at the matching '}' character.
|
| bool | read (Istream &is, bool keepHeader) |
| | Read dictionary from Istream (optionally keeping the header) Reads entries until EOF or when the first token is a '{' character, it will stop reading at the matching '}' character.
|
| void | writeEntry (Ostream &os) const |
| | Write sub-dictionary with its dictName as its header.
|
| void | writeEntry (const keyType &keyword, Ostream &os) const |
| | Write sub-dictionary with the keyword as its header.
|
| void | writeEntries (Ostream &os, const bool extraNewLine=false) const |
| | Write dictionary entries.
|
| void | write (Ostream &os, const bool subDict=true) const |
| | Write dictionary, normally with sub-dictionary formatting.
|
| const_searcher | csearch (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Search dictionary for given keyword.
|
| const_searcher | search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Search dictionary for given keyword.
|
| searcher | search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| | Search dictionary for given keyword.
|
| const_searcher | csearchScoped (const word &keyword, enum keyType::option matchOpt) const |
| | Search using scoping.
|
| const_searcher | searchScoped (const word &keyword, enum keyType::option matchOpt) const |
| | Search using dot or slash scoping.
|
| searcher | searchScoped (const word &keyword, enum keyType::option matchOpt) |
| | Search using dot or slash scoping.
|
| const dictionary * | cfindScopedDict (const fileName &dictPath) const |
| | Locate a sub-dictionary using slash-scoping.
|
| const dictionary * | findScopedDict (const fileName &dictPath) const |
| | Locate a sub-dictionary using slash-scoping.
|
| dictionary * | findScopedDict (const fileName &dictPath) |
| | Locate a sub-dictionary using slash-scoping.
|
| dictionary * | makeScopedDict (const fileName &dictPath) |
| | Locate existing or create sub-dictionary using slash-scoping.
|
| const_searcher | csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=keyType::REGEX) const |
| | Search dictionary for given keyword and any compatibility names.
|
| const entry * | findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt) const |
| | Find and return an entry pointer if present, or return a nullptr, using any compatibility names if needed.
|
| bool | foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=keyType::REGEX) const |
| | Search dictionary for given keyword and any compatibility names.
|
| const entry & | lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt) const |
| | Find and return an entry if present, otherwise FatalIOError, using any compatibility names if needed.
|
| ITstream & | lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return an entry data stream, using any compatibility names if needed.
|
| template<class T> |
| T | getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a T using any compatibility names if needed. FatalIOError if not found, or if there are excess tokens.
|
| template<class T> |
| T | getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find and return a T, or return the given default value using any compatibility names if needed.
|
| template<class T> |
| bool | readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, T &val, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const |
| | Find entry and assign to T val using any compatibility names if needed. FatalIOError if there are excess tokens.
|
| template<class T> |
| bool | readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, T &val, enum keyType::option matchOpt=keyType::REGEX) const |
| | Find an entry if present, and assign to T val using any compatibility names if needed. FatalIOError if it is found and there are excess tokens.
|
| void | operator= (const dictionary &rhs) |
| | Copy assignment.
|
| void | operator+= (const dictionary &rhs) |
| | Include entries from the given dictionary.
|
| void | operator|= (const dictionary &rhs) |
| | Conditionally include entries from the given dictionary.
|
| void | operator<<= (const dictionary &rhs) |
| | Unconditionally include entries from the given dictionary.
|
| bool | getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Same as get<bool>(const word&, keyType::option).
|
| label | getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Same as get<label>(const word&, keyType::option).
|
| scalar | getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Same as get<scalar>(const word&, keyType::option).
|
| string | getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Same as get<string>(const word&, keyType::option).
|
| word | getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Same as get<word>(const word&, keyType::option).
|
| fileName | getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Same as get<fileName>(const word&, keyType::option).
|
| bool | isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| | Check for existence of a sub-dictionary. Generally prefer findDict() for more flexibility.
|
| template<class T> |
| T | lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
| | Same as getOrDefault().
|
| template<class T> |
| T | lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) |
| | Same as getOrAdd().
|
| ITstream & | operator[] (const word &keyword) const |
| | Deprecated(2018-07) - use lookup() method.
|
| bool | found (const word &keyword, bool recursive, bool patternMatch=true) const |
| | Deprecated(2018-10).
|
| entry * | lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) |
| | Deprecated(2018-10).
|
| const entry * | lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const |
| | Deprecated(2018-10).
|
| const entry * | lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const |
| | Deprecated(2018-10).
|
| const dictionary * | subDictPtr (const word &keyword) const |
| | Deprecated(2018-10).
|
| dictionary * | subDictPtr (const word &keyword) |
| | Deprecated(2018-10) Find and return a sub-dictionary pointer if present.
|
| const entry & | lookupEntry (const word &keyword, bool recursive, bool patternMatch) const |
| | Deprecated(2018-10).
|
| ITstream & | lookup (const word &keyword, bool recursive, bool patternMatch=true) const |
| | Deprecated(2018-10).
|
| template<class T> |
| T | lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const |
| | Deprecated(2018-10).
|
| template<class T> |
| T | lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) |
| | Deprecated(2018-10).
|
| template<class T> |
| bool | readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const |
| | Deprecated(2018-10).
|
| template<class T> |
| T | lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const |
| | Deprecated(2018-10) find and return a T.
|
| template<class Compare> |
| Foam::wordList | sortedToc (const Compare &comp) const |
| template<class T> |
| Foam::entry * | add (const keyType &k, const T &v, bool overwrite) |
| template<class T> |
| Foam::entry * | set (const keyType &k, const T &v) |
| | ILList ()=default |
| | Default construct.
|
| | ILList (T *item) |
| | Construct and add initial item pointer.
|
| | ILList (Istream &is) |
| | Construct from Istream.
|
| | ILList (const ILList< DLListBase, T > &lst) |
| | Copy construct using the 'clone()' method for each element.
|
| | ILList (ILList< DLListBase, T > &&lst) |
| | Move construct.
|
| | ILList (const ILList< DLListBase, T > &lst, const CloneArg &cloneArg) |
| | Copy constructor with additional argument for clone 'clone()'.
|
| | ILList (Istream &is, const INew &inew) |
| | Construct from Istream using given Istream constructor class.
|
| | ~ILList () |
| | Destructor. Calls clear().
|
| void | clear () |
| | Clear the contents of the list.
|
| void | pop_front (label n=1) |
| | Remove first element(s) from the list (deletes pointers).
|
| bool | erase (T *item) |
| | Remove the specified element from the list and delete it.
|
| void | transfer (ILList< DLListBase, T > &lst) |
| | Transfer the contents of the argument into this List and annul the argument list.
|
| void | operator= (const ILList< DLListBase, T > &lst) |
| | Copy assignment using the 'clone()' method for each element.
|
| void | operator= (ILList< DLListBase, T > &&lst) |
| | Move assignment.
|
| | UILList ()=default |
| | Default construct.
|
| | UILList (T *item) |
| | Construct and add initial item pointer.
|
| | UILList (const UILList< DLListBase, T > &list) |
| | Construct as copy.
|
| T * | front () |
| | The first entry in the list.
|
| const T * | front () const |
| | The first entry in the list (const access).
|
| T * | back () |
| | The last entry in the list.
|
| const T * | back () const |
| | The last entry in the list (const access).
|
| T * | removeHead () |
| | Remove and return head.
|
| T * | remove (T *item) |
| | Remove and return element.
|
| T * | remove (iterator &iter) |
| | Remove and return item specified by iterator.
|
| void | operator= (const UILList< DLListBase, T > &lst) |
| | Copy assignment.
|
| bool | operator== (const UILList< DLListBase, T > &lst) const |
| | Equality. True both lists are element-wise equal.
|
| bool | operator!= (const UILList< DLListBase, T > &lst) const |
| | The opposite of the equality operation. Takes linear time.
|
| Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| | Write UILList with line-breaks when length exceeds shortLen.
|
| iterator | begin () |
| | Iterator to first item in list with non-const access.
|
| const_iterator | cbegin () const |
| | Iterator to first item in list with const access.
|
| reverse_iterator | rbegin () |
| | Iterator to last item in list with non-const access.
|
| const_reverse_iterator | crbegin () const |
| | Iterator to last item in list with const access.
|
| const_iterator | begin () const |
| | Iterator to first item in list with const access.
|
| const_reverse_iterator | rbegin () const |
| | Iterator to last item in list with const access.
|
| const iterator & | end () |
| | End of list for forward iterators.
|
| const const_iterator & | cend () const |
| | End of list for forward iterators.
|
| const reverse_iterator & | rend () |
| | End of list for reverse iterators.
|
| const const_reverse_iterator & | crend () const |
| | End of list for reverse iterators.
|
| const const_iterator & | end () const |
| | End of list for forward iterators.
|
| const const_reverse_iterator & | rend () const |
| | End of list for reverse iterators.
|
| T * | first () |
| | The first entry in the list.
|
| const T * | first () const |
| | The first entry in the list (const access).
|
| T * | last () |
| | The last entry in the list.
|
| const T * | last () const |
| | The last entry in the list (const access).
|
| | DLListBase ()=default |
| | Default construct.
|
| | DLListBase (const DLListBase &)=delete |
| | No copy construct.
|
| void | operator= (const DLListBase &)=delete |
| | No copy assignment.
|
| | ~DLListBase ()=default |
| | Destructor.
|
| bool | empty () const noexcept |
| | True if the list is empty.
|
| label | size () const noexcept |
| | The number of elements in list.
|
| link * | front () |
| | Return first entry.
|
| const link * | front () const |
| | Return const access to first entry.
|
| link * | back () |
| | Return last entry.
|
| const link * | back () const |
| | Return const access to last entry.
|
| void | push_front (link *item) |
| | Add at front of list.
|
| void | push_back (link *item) |
| | Add at back of list.
|
| bool | swapUp (link *item) |
| | Swap this element with the one above unless it is at the top.
|
| bool | swapDown (link *item) |
| | Swap this element with the one below unless it is at the bottom.
|
| link * | removeHead () |
| | Remove and return first entry.
|
| link * | remove (link *item) |
| | Remove and return element.
|
| link * | remove (iterator &iter) |
| | Remove and return element specified by iterator.
|
| link * | replace (link *oldLink, link *newLink) |
| | Replace oldLink with newLink and return element.
|
| link * | replace (iterator &oldIter, link *newitem) |
| | Replace oldIter with newItem and return element.
|
| void | clear () |
| | Clear the list.
|
| void | swap (DLListBase &lst) |
| | Swap the contents of the list.
|
| void | transfer (DLListBase &lst) |
| | Transfer the contents of the argument into this list and annul the argument list.
|
| iterator | begin () |
| | Iterator to first item in list with non-const access.
|
| const_iterator | cbegin () const |
| | Iterator to first item in list with const access.
|
| const_iterator | crbegin () const |
| | Iterator to last item in list with const access.
|
| const iterator & | end () |
| | End of list for iterators.
|
| const const_iterator & | cend () const |
| | End of list for iterators.
|
| const const_iterator & | crend () const |
| | End of list for reverse iterators.
|
| link * | first () |
| | Return first entry.
|
| const link * | first () const |
| | Return const access to first entry.
|
| link * | last () |
| | Return last entry.
|
| const link * | last () const |
| | Return const access to last entry.
|
| void | prepend (link *item) |
| | Add at front of list.
|
| void | append (link *item) |
| | Add at back of list.
|
| | TypeName ("transportModel") |
| | Runtime type information.
|
| | transportModel () |
| | Construct from components.
|
| virtual | ~transportModel () |
| | Destructor.
|
1.16.1 
