Class to represent a system of phases and model interfacial transfers between them. More...
#include <phaseSystem.H>
Public Types | |
| typedef HashPtrTable< fvVectorMatrix > | momentumTransferTable |
| typedef HashPtrTable< fvScalarMatrix > | heatTransferTable |
| typedef HashPtrTable< fvScalarMatrix > | massTransferTable |
| typedef PtrListDictionary< phaseModel > | phaseModelList |
| typedef UPtrList< phaseModel > | phaseModelPartialList |
| typedef HashTable< autoPtr< phasePair >, phasePairKey, phasePairKey::hash > | phasePairTable |
| Public Types inherited from IOobject | |
| enum | objectState : char { GOOD , BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | fileCheckTypes : char { timeStamp = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 } |
| Enumeration defining the file checking options (time-stamp | inotify) | (all | masterOnly). 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... | |
| enum class | Layout : unsigned char { regular , global } |
| The layout of the case structure. More... | |
| Public Types inherited from dictionary | |
| typedef Searcher< true > | const_searcher |
| Searcher with const access. | |
| typedef Searcher< false > | searcher |
| Searcher with non-const access. | |
| Public Types inherited from UILList< DLListBase, T > | |
| typedef T | value_type |
| Type of values stored. | |
| typedef T * | pointer |
| Pointer for value_type. | |
| typedef const T * | const_pointer |
| Const pointer for value_type. | |
| typedef T & | reference |
| Reference for value_type. | |
| typedef const T & | const_reference |
| Const reference for value_type. | |
| typedef label | size_type |
| The type that can represent the container size. | |
| typedef label | difference_type |
| The difference between iterator objects. | |
| using | base_iterator |
| using | const_base_iterator |
Public Member Functions | |
| TypeName ("phaseSystem") | |
| Runtime type information. | |
| phaseSystem (const fvMesh &mesh) | |
| Construct from fvMesh. | |
| virtual | ~phaseSystem () |
| Destructor. | |
| const fvMesh & | mesh () const |
| Return the mesh. | |
| const phaseModelList & | phases () const |
| Return the phase models. | |
| phaseModelList & | phases () |
| Access the phase models. | |
| const phaseModelPartialList & | movingPhases () const |
| Return the models for phases that are moving. | |
| phaseModelPartialList & | movingPhases () |
| Access the models for phases that are moving. | |
| const phaseModelPartialList & | stationaryPhases () const |
| Return the models for phases that are stationary. | |
| phaseModelPartialList & | stationaryPhases () |
| Access the models for phases that are stationary. | |
| const phaseModelPartialList & | anisothermalPhases () const |
| Return the models for phases that have variable temperature. | |
| phaseModelPartialList & | anisothermalPhases () |
| Access the models for phases that have variable temperature. | |
| const phaseModelPartialList & | multiComponentPhases () const |
| Return the models for phases that have multiple species. | |
| phaseModelPartialList & | multiComponentPhases () |
| Access the models for phases that have multiple species. | |
| const phasePairTable & | phasePairs () const |
| Return the phase pairs. | |
| const surfaceScalarField & | phi () const |
| Return the mixture flux. | |
| surfaceScalarField & | phi () |
| Access the mixture flux. | |
| const volScalarField & | dpdt () const |
| Return the rate of change of the pressure. | |
| volScalarField & | dpdt () |
| Access the rate of change of the pressure. | |
| const IOMRFZoneList & | MRF () const |
| Return MRF zones. | |
| fv::options & | fvOptions () const |
| Access the fvOptions. | |
| template<class modelType> | |
| bool | foundSubModel (const phasePair &key) const |
| Check availability of a sub model for a given phase pair. | |
| template<class modelType> | |
| const modelType & | lookupSubModel (const phasePair &key) const |
| Return a sub model between a phase pair. | |
| template<class modelType> | |
| bool | foundSubModel (const phaseModel &dispersed, const phaseModel &continuous) const |
| Check availability of a sub model between two phases. | |
| template<class modelType> | |
| const modelType & | lookupSubModel (const phaseModel &dispersed, const phaseModel &continuous) const |
| Return a sub model between two phases. | |
| template<class modelType> | |
| bool | foundBlendedSubModel (const phasePair &key) const |
| Check availability of a blended sub model for a given phase pair. | |
| template<class modelType> | |
| const BlendedInterfacialModel< modelType > & | lookupBlendedSubModel (const phasePair &key) const |
| Return a blended sub model between a phase pair. | |
| template<class Type, template< class > class PatchField, class GeoMesh> | |
| void | fillFields (const word &name, const dimensionSet &dims, PtrList< GeometricField< Type, PatchField, GeoMesh > > &fieldList) const |
| Fill up gaps in a phase-indexed list of fields with zeros. | |
| template<class Type, template< class > class PatchField, class GeoMesh> | |
| void | fillFields (const word &name, const dimensionSet &dims, HashPtrTable< GeometricField< Type, PatchField, GeoMesh > > &fieldTable) const |
| Fill up gaps in a phase-indexed table of fields with zeros. | |
| tmp< volScalarField > | rho () const |
| Return the mixture density. | |
| tmp< volVectorField > | U () const |
| Return the mixture velocity. | |
| tmp< volScalarField > | E (const phasePairKey &key) const |
| Return the aspect-ratio for a pair. | |
| tmp< volScalarField > | sigma (const phasePairKey &key) const |
| Return the surface tension coefficient for a pair. | |
| virtual tmp< volScalarField > | dmdt (const phasePairKey &key) const |
| Return the mass transfer rate for a pair. | |
| virtual PtrList< volScalarField > | dmdts () const |
| Return the mass transfer rates for each phase. | |
| virtual autoPtr< momentumTransferTable > | momentumTransfer ()=0 |
| Return the momentum transfer matrices for the cell-based. | |
| virtual autoPtr< momentumTransferTable > | momentumTransferf ()=0 |
| Return the momentum transfer matrices for the face-based. | |
| virtual PtrList< surfaceScalarField > | AFfs () const =0 |
| Return the implicit force coefficients for the face-based. | |
| virtual PtrList< surfaceScalarField > | phiFs (const PtrList< volScalarField > &rAUs)=0 |
| Return the force fluxes for the cell-based algorithm. | |
| virtual PtrList< surfaceScalarField > | phiFfs (const PtrList< surfaceScalarField > &rAUfs)=0 |
| Return the force fluxes for the face-based algorithm. | |
| virtual PtrList< surfaceScalarField > | phiKdPhis (const PtrList< volScalarField > &rAUs) const =0 |
| Return the force fluxes for the cell-based algorithm. | |
| virtual PtrList< surfaceScalarField > | phiKdPhifs (const PtrList< surfaceScalarField > &rAUfs) const =0 |
| Return the force fluxes for the face-based algorithm. | |
| virtual PtrList< volVectorField > | KdUByAs (const PtrList< volScalarField > &rAUs) const =0 |
| Return the explicit part of the drag force. | |
| virtual void | partialElimination (const PtrList< volScalarField > &rAUs)=0 |
| Solve the drag system for the new velocities and fluxes. | |
| virtual void | partialEliminationf (const PtrList< surfaceScalarField > &rAUfs)=0 |
| Solve the drag system for the new fluxes. | |
| virtual PtrList< surfaceScalarField > | ddtCorrByAs (const PtrList< volScalarField > &rAUs, const bool includeVirtualMass=false) const =0 |
| Return the flux corrections for the cell-based algorithm. | |
| virtual const HashPtrTable< surfaceScalarField > & | DByAfs () const =0 |
| Return the phase diffusivities divided by the momentum. | |
| virtual autoPtr< heatTransferTable > | heatTransfer () const =0 |
| Return the heat transfer matrices. | |
| virtual autoPtr< massTransferTable > | massTransfer () const =0 |
| Return the mass transfer matrices. | |
| virtual void | solve () |
| Solve for the phase fractions. | |
| virtual void | correct () |
| Correct the fluid properties other than those listed below. | |
| virtual void | correctKinematics () |
| Correct the kinematics. | |
| virtual void | correctThermo () |
| Correct the thermodynamics. | |
| virtual void | correctTurbulence () |
| Correct the turbulence. | |
| virtual void | correctEnergyTransport () |
| Correct the energy transport e.g. alphat. | |
| virtual bool | read () |
| Read base phaseProperties dictionary. | |
| template<class modelType> | |
| const Foam::BlendedInterfacialModel< modelType > & | lookupBlendedSubModel (const phasePair &key) const |
| Public Member Functions inherited from IOdictionary | |
| 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. | |
| Public Member Functions inherited from baseIOdictionary | |
| 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. | |
| Public Member Functions inherited from regIOobject | |
| 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. | |
| Public Member Functions inherited from IOobject | |
| 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 |
| 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. | |
| 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. | |
| Public Member Functions inherited from dictionary | |
| 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) |
| Public Member Functions inherited from ILList< DLListBase, T > | |
| 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. | |
| Public Member Functions inherited from UILList< DLListBase, T > | |
| 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). | |
| Public Member Functions inherited from DLListBase | |
| 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. | |
Static Public Attributes | |
| static const word | propertiesName |
| Default name of the phase properties dictionary. | |
| Static Public Attributes inherited from IOobject | |
| static const Enum< fileCheckTypes > | fileCheckTypesNames |
| Names for the fileCheckTypes. | |
| static char | scopeSeparator |
| Character for scoping object names (':' or '_'). | |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. | |
| static float | fileModificationSkew |
| Time skew (seconds) for file modification checks. | |
| static int | maxFileModificationPolls |
| Max number of times to poll for file modification changes. | |
| Static Public Attributes inherited from dictionary | |
| static int | writeOptionalEntries |
| Report optional keywords and values if not present in dictionary. | |
| static const dictionary | null |
| An empty dictionary, which is also the parent for all dictionaries. | |
| static refPtr< OSstream > | reportingOutput |
| Output location when reporting default values. | |
Protected Types | |
| typedef HashTable< dictionary, phasePairKey, phasePairKey::hash > | dictTable |
| typedef HashTable< autoPtr< blendingMethod > > | blendingMethodTable |
| typedef HashTable< autoPtr< reactingMultiphaseEuler::surfaceTensionModel >, phasePairKey, phasePairKey::hash > | surfaceTensionModelTable |
| typedef HashTable< autoPtr< aspectRatioModel >, phasePairKey, phasePairKey::hash > | aspectRatioModelTable |
Protected Member Functions | |
| tmp< surfaceScalarField > | calcPhi (const phaseModelList &phaseModels) const |
| Calculate and return the mixture flux. | |
| void | generatePairs (const dictTable &modelDicts) |
| Generate pairs. | |
| template<class modelType> | |
| void | createSubModels (const dictTable &modelDicts, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models) |
| Generate pairs and sub-model tables. | |
| template<class modelType> | |
| void | generatePairsAndSubModels (const word &modelName, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models) |
| Generate pairs and sub-model tables. | |
| template<class modelType> | |
| void | generatePairsAndSubModels (const word &modelName, HashTable< autoPtr< BlendedInterfacialModel< modelType > >, phasePairKey, phasePairKey::hash > &models, const bool correctFixedFluxBCs=true) |
| Generate pairs and blended sub-model tables. | |
| template<class modelType> | |
| void | generatePairsAndSubModels (const word &modelName, HashTable< Pair< autoPtr< modelType > >, phasePairKey, phasePairKey::hash > &models, const bool correctFixedFluxBCs=true) |
| Generate pairs and two-sided sub-model tables. | |
| template<class GeoField> | |
| void | addField (const phaseModel &phase, const word &fieldName, tmp< GeoField > field, PtrList< GeoField > &fieldList) const |
| Add the field to a phase-indexed list, with the given name,. | |
| template<class GeoField> | |
| void | addField (const phaseModel &phase, const word &fieldName, const GeoField &field, PtrList< GeoField > &fieldList) const |
| Add the field to a phase-indexed list, with the given name,. | |
| template<class GeoField> | |
| void | addField (const phaseModel &phase, const word &fieldName, tmp< GeoField > field, HashPtrTable< GeoField > &fieldTable) const |
| Add the field to a phase-indexed table, with the given name,. | |
| template<class GeoField> | |
| void | addField (const phaseModel &phase, const word &fieldName, const GeoField &field, HashPtrTable< GeoField > &fieldTable) const |
| Add the field to a phase-indexed table, with the given name,. | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
| Helper: check readOpt flags and read if necessary. | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &s) |
| Set the object state to bad. | |
| Protected Member Functions inherited from DLListBase | |
| template<class IteratorType> | |
| IteratorType | iterator_first () const |
| Return iterator to first item or end-iterator if list is empty. | |
| template<class IteratorType> | |
| IteratorType | iterator_last () const |
| Return iterator to last item or end-iterator if list is empty. | |
Protected Attributes | |
| const fvMesh & | mesh_ |
| Reference to the mesh. | |
| phaseModelList | phaseModels_ |
| Phase models. | |
| phaseModelPartialList | movingPhaseModels_ |
| Moving phase models. | |
| phaseModelPartialList | stationaryPhaseModels_ |
| Stationary phase models. | |
| phaseModelPartialList | anisothermalPhaseModels_ |
| Anisothermal phase models. | |
| phaseModelPartialList | multiComponentPhaseModels_ |
| Multi-component phase models. | |
| phasePairTable | phasePairs_ |
| Phase pairs. | |
| surfaceScalarField | phi_ |
| Total volumetric flux. | |
| volScalarField | dpdt_ |
| Rate of change of pressure. | |
| IOMRFZoneList | MRF_ |
| Optional MRF zones. | |
| blendingMethodTable | blendingMethods_ |
| Blending methods. | |
| surfaceTensionModelTable | surfaceTensionModels_ |
| Surface tension models. | |
| aspectRatioModelTable | aspectRatioModels_ |
| Aspect ratio models. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from IOdictionary | |
| static dictionary | readContents (const IOobject &io) |
| Read and return contents, testing for "dictionary" type. The IOobject will not be registered. | |
| static dictionary | readContents (const IOobject &io, const word &wantedType) |
| Read and return contents, testing for expected type. The IOobject will not be registered. | |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type> | |
| static Type & | store (Type *p) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (std::unique_ptr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (autoPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (autoPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (refPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (refPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (tmp< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (tmp< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| Static Public Member Functions inherited from IOobject | |
| static bool | bannerEnabled () noexcept |
| Status of output file banner. | |
| static bool | bannerEnabled (bool on) noexcept |
| Enable/disable output file banner. | |
| static bool | fileModificationChecking_masterOnly () noexcept |
| Test fileModificationChecking for master-only. | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. | |
| template<class StringType> | |
| static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. | |
| static word | group (const word &name) |
| Return group (extension part of name). | |
| static word | member (const word &name) |
| Return member (name without the extension). | |
| static word | scopedName (const std::string &scope, const word &name) |
| Create scope:name or scope_name string. | |
| static word | scopedName (const std::string &scope, const word &name1, const word &name2) |
| Create scope:name1:name2 or scope_name1_name2 string. | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. | |
| static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
| Write the standard OpenFOAM file/dictionary banner. | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. | |
| Static Public Member Functions inherited from IOobjectOption | |
| static bool | isAnyRead (readOption opt) noexcept |
| True if any reading may be required (ie, != NO_READ). | |
| static bool | isReadRequired (readOption opt) noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. | |
| static bool | isReadOptional (readOption opt) noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. | |
| static readOption | lazierRead (readOption opt) noexcept |
| Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. | |
| Static Public Member Functions inherited from dictionary | |
| static int | reportOptional () noexcept |
| Return the state of reporting optional (default) entries. | |
| static int | reportOptional (const int level) noexcept |
| Change the state of reporting optional (default) entries. | |
| static autoPtr< dictionary > | New (Istream &is) |
| Construct top-level dictionary on freestore from Istream. | |
| Public Attributes inherited from dictionary | |
| friend | const_searcher |
| Declare friendship with the searcher classes. | |
| friend | searcher |
| 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. | |
| 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. | |
| Static Protected Member Functions inherited from DLListBase | |
| template<class IteratorType> | |
| static const IteratorType & | iterator_end () |
| Factory method to return an iterator end. | |
| template<class IteratorType> | |
| static const IteratorType & | iterator_rend () |
| Factory method to return an iterator reverse end. | |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. | |
Class to represent a system of phases and model interfacial transfers between them.
Definition at line 69 of file phaseSystem.H.
Definition at line 77 of file phaseSystem.H.
| typedef HashPtrTable<fvScalarMatrix> heatTransferTable |
Definition at line 79 of file phaseSystem.H.
| typedef HashPtrTable<fvScalarMatrix> massTransferTable |
Definition at line 81 of file phaseSystem.H.
| typedef PtrListDictionary<phaseModel> phaseModelList |
Definition at line 83 of file phaseSystem.H.
| typedef UPtrList<phaseModel> phaseModelPartialList |
Definition at line 85 of file phaseSystem.H.
Definition at line 89 of file phaseSystem.H.
|
protected |
Definition at line 98 of file phaseSystem.H.
|
protected |
Definition at line 101 of file phaseSystem.H.
|
protected |
Definition at line 110 of file phaseSystem.H.
|
protected |
Definition at line 119 of file phaseSystem.H.
| phaseSystem | ( | const fvMesh & | mesh | ) |
Construct from fvMesh.
Definition at line 118 of file phaseSystem.C.
References anisothermalPhaseModels_, aspectRatioModels_, IOobjectOption::AUTO_WRITE, blendingMethods_, calcPhi(), correctKinematics(), dict, Foam::dimPressure, Foam::dimTime, dpdt_, forAll, forAllConstIter, generatePairsAndSubModels(), IOdictionary::IOdictionary(), mesh(), mesh_, movingPhaseModels_, MRF_, multiComponentPhaseModels_, blendingMethod::New(), IOobjectOption::NO_WRITE, phasei, phaseModels_, phi_, IOobjectOption::READ_MODIFIED, IOobjectOption::REGISTER, stationaryPhaseModels_, dictionary::subDict(), surfaceTensionModels_, IOobject::time(), timeName, and Foam::Zero.
Referenced by multiphaseSystem::multiphaseSystem(), and twoPhaseSystem::twoPhaseSystem().
|
virtual |
Destructor.
Definition at line 228 of file phaseSystem.C.
|
protected |
Calculate and return the mixture flux.
Definition at line 44 of file phaseSystem.C.
References Foam::fvc::interpolate(), GeometricField< scalar, fvsPatchField, surfaceMesh >::New(), IOobjectOption::NO_REGISTER, phasei, and phi().
Referenced by phaseSystem().
|
protected |
Generate pairs.
Definition at line 66 of file phaseSystem.C.
References forAllConstIters, phaseModels_, and phasePairs_.
Referenced by generatePairsAndSubModels().
|
protected |
Generate pairs and sub-model tables.
Definition at line 26 of file phaseSystemTemplates.C.
References forAllConstIter, and phasePairs_.
Referenced by generatePairsAndSubModels().
|
protected |
Generate pairs and sub-model tables.
Definition at line 55 of file phaseSystemTemplates.C.
References createSubModels(), and generatePairs().
Referenced by generatePairsAndSubModels(), generatePairsAndSubModels(), and phaseSystem().
|
protected |
Generate pairs and blended sub-model tables.
Definition at line 75 of file phaseSystemTemplates.C.
References blendingMethods_, forAllConstIter, generatePairsAndSubModels(), IOobject::member(), phaseModels_, and phasePairs_.
|
protected |
Generate pairs and two-sided sub-model tables.
Definition at line 156 of file phaseSystemTemplates.C.
References phasePair::contains(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, forAllIter, generatePairsAndSubModels(), IOobject::groupName(), phasePair::index(), phase::name(), phasei, phaseModels_, and phasePairs_.
|
protected |
Add the field to a phase-indexed list, with the given name,.
constructing if necessary
Definition at line 215 of file phaseSystemTemplates.C.
References field(), IOobject::groupName(), phase::name(), and PtrList< T >::set().
Referenced by addField(), and addField().
|
protected |
Add the field to a phase-indexed list, with the given name,.
constructing if necessary
Definition at line 243 of file phaseSystemTemplates.C.
References addField(), and field().
|
protected |
Add the field to a phase-indexed table, with the given name,.
constructing if necessary
Definition at line 256 of file phaseSystemTemplates.C.
References field(), HashTable< T, Key, Hash >::found(), IOobject::groupName(), phase::name(), and HashPtrTable< T, Key, Hash >::set().
|
protected |
Add the field to a phase-indexed table, with the given name,.
constructing if necessary
Definition at line 284 of file phaseSystemTemplates.C.
References addField(), and field().
| TypeName | ( | "phaseSystem" | ) |
Runtime type information.
|
inline |
Return the mesh.
Definition at line 23 of file phaseSystemI.H.
References mesh_.
Referenced by multiphaseSystem::declareRunTimeSelectionTable(), foundBlendedSubModel(), lookupSubModel(), multiphaseSystem::multiphaseSystem(), multiphaseSystem::multiphaseSystem(), multiphaseSystem::New(), phaseSystem(), and multiphaseSystem::~multiphaseSystem().
|
inline |
Return the phase models.
Definition at line 30 of file phaseSystemI.H.
References phaseModels_.
Referenced by deposition::dmdt().
|
inline |
|
inline |
Return the models for phases that are moving.
Definition at line 44 of file phaseSystemI.H.
References movingPhaseModels_.
|
inline |
Access the models for phases that are moving.
Definition at line 51 of file phaseSystemI.H.
References movingPhaseModels_.
|
inline |
Return the models for phases that are stationary.
Definition at line 58 of file phaseSystemI.H.
References stationaryPhaseModels_.
|
inline |
Access the models for phases that are stationary.
Definition at line 65 of file phaseSystemI.H.
References stationaryPhaseModels_.
|
inline |
Return the models for phases that have variable temperature.
Definition at line 72 of file phaseSystemI.H.
References anisothermalPhaseModels_.
|
inline |
Access the models for phases that have variable temperature.
Definition at line 79 of file phaseSystemI.H.
References anisothermalPhaseModels_.
|
inline |
Return the models for phases that have multiple species.
Definition at line 86 of file phaseSystemI.H.
References multiComponentPhaseModels_.
|
inline |
Access the models for phases that have multiple species.
Definition at line 93 of file phaseSystemI.H.
References multiComponentPhaseModels_.
|
inline |
|
inline |
Return the mixture flux.
Definition at line 106 of file phaseSystemI.H.
References phi_.
Referenced by calcPhi(), and multiphaseSystem::multiphaseSystem().
|
inline |
|
inline |
Return the rate of change of the pressure.
Definition at line 118 of file phaseSystemI.H.
References dpdt_.
|
inline |
Access the rate of change of the pressure.
Definition at line 124 of file phaseSystemI.H.
References dpdt_.
|
inline |
|
inline |
Access the fvOptions.
Definition at line 136 of file phaseSystemI.H.
References mesh_, and options::New().
| bool foundSubModel | ( | const phasePair & | key | ) | const |
Check availability of a sub model for a given phase pair.
Definition at line 371 of file phaseSystemTemplates.C.
References IOobject::groupName(), mesh, baseIOdictionary::name(), and name.
Referenced by foundSubModel().
| const modelType & lookupSubModel | ( | const phasePair & | key | ) | const |
Return a sub model between a phase pair.
Definition at line 409 of file phaseSystemTemplates.C.
References IOobject::groupName(), objectRegistry::lookupObject(), mesh(), mesh, baseIOdictionary::name(), and name.
Referenced by lookupSubModel().
| bool foundSubModel | ( | const phaseModel & | dispersed, |
| const phaseModel & | continuous ) const |
Check availability of a sub model between two phases.
Definition at line 429 of file phaseSystemTemplates.C.
References foundSubModel().
| const modelType & lookupSubModel | ( | const phaseModel & | dispersed, |
| const phaseModel & | continuous ) const |
Return a sub model between two phases.
Definition at line 440 of file phaseSystemTemplates.C.
References lookupSubModel().
| bool foundBlendedSubModel | ( | const phasePair & | key | ) | const |
Check availability of a blended sub model for a given phase pair.
Definition at line 451 of file phaseSystemTemplates.C.
References IOobject::groupName(), mesh(), and mesh.
| const BlendedInterfacialModel< modelType > & lookupBlendedSubModel | ( | const phasePair & | key | ) | const |
Return a blended sub model between a phase pair.
References baseIOdictionary::name().
| void fillFields | ( | const word & | name, |
| const dimensionSet & | dims, | ||
| PtrList< GeometricField< Type, PatchField, GeoMesh > > & | fieldList ) const |
Fill up gaps in a phase-indexed list of fields with zeros.
Definition at line 299 of file phaseSystemTemplates.C.
References forAll, IOobject::groupName(), baseIOdictionary::name(), phase::name(), phasei, phaseModels_, and Foam::Zero.
| void fillFields | ( | const word & | name, |
| const dimensionSet & | dims, | ||
| HashPtrTable< GeometricField< Type, PatchField, GeoMesh > > & | fieldTable ) const |
Fill up gaps in a phase-indexed table of fields with zeros.
Definition at line 335 of file phaseSystemTemplates.C.
References forAll, IOobject::groupName(), baseIOdictionary::name(), phase::name(), phasei, phaseModels_, and Foam::Zero.
| Foam::tmp< Foam::volScalarField > rho | ( | ) | const |
Return the mixture density.
Definition at line 234 of file phaseSystem.C.
References alpha, movingPhaseModels_, phasei, rho, stationaryPhaseModels_, and trho.
| Foam::tmp< Foam::volVectorField > U | ( | ) | const |
Return the mixture velocity.
Definition at line 262 of file phaseSystem.C.
References alpha, movingPhaseModels_, phasei, tmp< T >::ref(), stationaryPhaseModels_, and U.
Referenced by multiphaseSystem::multiphaseSystem().
| Foam::tmp< Foam::volScalarField > E | ( | const phasePairKey & | key | ) | const |
Return the aspect-ratio for a pair.
Definition at line 292 of file phaseSystem.C.
References aspectRatioModels_, Foam::dimless, mesh_, GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, and IOobject::scopedName().
Referenced by orderedPhasePair::E().
| Foam::tmp< Foam::volScalarField > sigma | ( | const phasePairKey & | key | ) | const |
Return the surface tension coefficient for a pair.
Definition at line 310 of file phaseSystem.C.
References surfaceTensionModel::dimSigma, mesh_, GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, IOobject::scopedName(), surfaceTensionModels_, and Foam::Zero.
Referenced by twoPhaseSystem::declareRunTimeSelectionTable(), phasePair::sigma(), and multiphaseSystem::~multiphaseSystem().
|
virtual |
Return the mass transfer rate for a pair.
Definition at line 334 of file phaseSystem.C.
References Foam::dimDensity, Foam::dimTime, IOobject::groupName(), mesh_, name, GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, phasePairs_, and Foam::Zero.
Referenced by InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::iDmdt(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::iDmdt(), PopulationBalancePhaseSystem< BasePhaseSystem >::pDmdt(), PhaseTransferPhaseSystem< BasePhaseSystem >::PhaseTransferPhaseSystem(), PhaseTransferPhaseSystem< BasePhaseSystem >::rDmdt(), and ThermalPhaseChangePhaseSystem< BasePhaseSystem >::wDmdt().
|
virtual |
Return the mass transfer rates for each phase.
Reimplemented in multiphaseSystem, and twoPhaseSystem.
Definition at line 349 of file phaseSystem.C.
References dmdts(), and phaseModels_.
Referenced by twoPhaseSystem::declareRunTimeSelectionTable(), dmdts(), and multiphaseSystem::~multiphaseSystem().
|
pure virtual |
Return the momentum transfer matrices for the cell-based.
algorithm
|
pure virtual |
Return the momentum transfer matrices for the face-based.
algorithm
|
pure virtual |
Return the implicit force coefficients for the face-based.
algorithm
|
pure virtual |
Return the force fluxes for the cell-based algorithm.
References rAUs.
|
pure virtual |
Return the force fluxes for the face-based algorithm.
References rAUfs.
|
pure virtual |
Return the force fluxes for the cell-based algorithm.
References rAUs.
|
pure virtual |
Return the force fluxes for the face-based algorithm.
References rAUfs.
|
pure virtual |
Return the explicit part of the drag force.
References rAUs.
|
pure virtual |
Solve the drag system for the new velocities and fluxes.
References rAUs.
|
pure virtual |
Solve the drag system for the new fluxes.
References rAUfs.
|
pure virtual |
Return the flux corrections for the cell-based algorithm.
References rAUs.
|
pure virtual |
Return the phase diffusivities divided by the momentum.
coefficients
Referenced by twoPhaseSystem::solve().
|
pure virtual |
Return the heat transfer matrices.
|
pure virtual |
Return the mass transfer matrices.
|
virtual |
Solve for the phase fractions.
Reimplemented in multiphaseSystem, multiphaseSystem, twoPhaseSystem, and twoPhaseSystem.
Definition at line 357 of file phaseSystem.C.
|
virtual |
Correct the fluid properties other than those listed below.
Reimplemented in multiphaseSystem, and twoPhaseSystem.
Definition at line 361 of file phaseSystem.C.
References phase::correct(), and phaseModels_.
|
virtual |
Correct the kinematics.
Definition at line 370 of file phaseSystem.C.
References Foam::fvc::ddt(), dpdt_, and phaseModels_.
Referenced by phaseSystem().
|
virtual |
|
virtual |
Correct the turbulence.
Reimplemented in twoPhaseSystem.
Definition at line 398 of file phaseSystem.C.
References phaseModels_.
|
virtual |
Correct the energy transport e.g. alphat.
Definition at line 407 of file phaseSystem.C.
References phaseModels_.
|
virtual |
Read base phaseProperties dictionary.
Reimplemented from regIOobject.
Reimplemented in multiphaseSystem, and twoPhaseSystem.
Definition at line 416 of file phaseSystem.C.
References phaseModels_, phase::read(), and regIOobject::read().
| const Foam::BlendedInterfacialModel< modelType > & lookupBlendedSubModel | ( | const phasePair & | key | ) | const |
Definition at line 484 of file phaseSystemTemplates.C.
References IOobject::groupName(), objectRegistry::lookupObject(), mesh, baseIOdictionary::name(), and name.
|
protected |
Reference to the mesh.
Definition at line 127 of file phaseSystem.H.
Referenced by dmdt(), E(), fvOptions(), mesh(), phaseSystem(), and sigma().
|
protected |
Phase models.
Definition at line 132 of file phaseSystem.H.
Referenced by correct(), correctEnergyTransport(), correctKinematics(), correctThermo(), correctTurbulence(), dmdts(), fillFields(), fillFields(), generatePairs(), generatePairsAndSubModels(), generatePairsAndSubModels(), phases(), phases(), phaseSystem(), read(), and twoPhaseSystem::twoPhaseSystem().
|
protected |
Moving phase models.
Definition at line 137 of file phaseSystem.H.
Referenced by movingPhases(), movingPhases(), phaseSystem(), rho(), and U().
|
protected |
Stationary phase models.
Definition at line 142 of file phaseSystem.H.
Referenced by phaseSystem(), rho(), stationaryPhases(), stationaryPhases(), and U().
|
protected |
Anisothermal phase models.
Definition at line 147 of file phaseSystem.H.
Referenced by anisothermalPhases(), anisothermalPhases(), and phaseSystem().
|
protected |
Multi-component phase models.
Definition at line 152 of file phaseSystem.H.
Referenced by multiComponentPhases(), multiComponentPhases(), and phaseSystem().
|
protected |
Phase pairs.
Definition at line 157 of file phaseSystem.H.
Referenced by createSubModels(), dmdt(), generatePairs(), generatePairsAndSubModels(), generatePairsAndSubModels(), and phasePairs().
|
protected |
Total volumetric flux.
Definition at line 162 of file phaseSystem.H.
Referenced by phaseSystem(), phi(), and phi().
|
protected |
Rate of change of pressure.
Definition at line 167 of file phaseSystem.H.
Referenced by correctKinematics(), dpdt(), dpdt(), and phaseSystem().
|
protected |
Optional MRF zones.
Definition at line 172 of file phaseSystem.H.
Referenced by MRF(), and phaseSystem().
|
protected |
Blending methods.
Definition at line 177 of file phaseSystem.H.
Referenced by generatePairsAndSubModels(), and phaseSystem().
|
protected |
Surface tension models.
Definition at line 185 of file phaseSystem.H.
Referenced by phaseSystem(), and sigma().
|
protected |
Aspect ratio models.
Definition at line 190 of file phaseSystem.H.
Referenced by E(), and phaseSystem().
|
static |
Default name of the phase properties dictionary.
Definition at line 340 of file phaseSystem.H.
Referenced by multiphaseSystem::New(), and twoPhaseSystem::New().
1.16.1 