#include <multiphaseInterSystem.H>


Public Types | |
| typedef HashTable< autoPtr< phasePair >, phasePairKey, phasePairKey::hash > | phasePairTable |
| typedef HashTable< autoPtr< multiphaseInter::phaseModel > > | phaseModelTable |
| typedef HashTable< volScalarField::Internal > | SuSpTable |
| 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 ("multiphaseInterSystem") | |
| Runtime type information. | |
| multiphaseInterSystem (const fvMesh &mesh) | |
| Construct from fvMesh. | |
| virtual | ~multiphaseInterSystem () |
| Destructor. | |
| virtual volScalarField & | he () |
| Return access to the internal energy field [J/Kg]. | |
| virtual const volScalarField & | he () const |
| Return access to the internal energy field [J/Kg]. | |
| virtual tmp< volScalarField > | he (const volScalarField &p, const volScalarField &T) const |
| Enthalpy/Internal energy. | |
| virtual tmp< scalarField > | he (const scalarField &p, const scalarField &T, const labelList &cells) const |
| Enthalpy/Internal energy for cell-set [J/kg]. | |
| virtual tmp< scalarField > | he (const scalarField &p, const scalarField &T, const label patchi) const |
| Enthalpy/Internal energy for patch [J/kg]. | |
| virtual tmp< volScalarField > | hc () const |
| Chemical enthalpy of the mixture [J/kg]. | |
| virtual tmp< scalarField > | THE (const scalarField &h, const scalarField &p, const scalarField &T0, const labelList &cells) const |
| Temperature from enthalpy/internal energy for cell-set. | |
| virtual tmp< scalarField > | THE (const scalarField &h, const scalarField &p, const scalarField &T0, const label patchi) const |
| Temperature from enthalpy/internal energy for patch. | |
| virtual tmp< volScalarField > | rho () const |
| Return the mixture density. | |
| virtual tmp< scalarField > | rho (const label patchi) const |
| Return the mixture density on a patch. | |
| virtual tmp< volScalarField > | Cp () const |
| Return Cp of the mixture. | |
| virtual tmp< scalarField > | Cp (const scalarField &p, const scalarField &T, const label patchi) const |
| Heat capacity at constant pressure for patch [J/kg/K]. | |
| virtual tmp< scalarField > | Cp (const scalarField &p, const scalarField &T, const labelList &cells) const |
| Heat capacity using pressure and temperature. | |
| virtual tmp< volScalarField > | Cv () const |
| Return Cv of the mixture. | |
| virtual tmp< scalarField > | Cv (const scalarField &p, const scalarField &T, const label patchI) const |
| Heat capacity at constant volume for patch [J/kg/K]. | |
| virtual tmp< scalarField > | rhoEoS (const scalarField &p, const scalarField &T, const labelList &cells) const |
| Density from pressure and temperature. | |
| virtual tmp< volScalarField > | gamma () const |
| Gamma = Cp/Cv []. | |
| virtual tmp< scalarField > | gamma (const scalarField &p, const scalarField &T, const label patchi) const |
| Gamma = Cp/Cv for patch []. | |
| virtual tmp< volScalarField > | Cpv () const |
| Heat capacity at constant pressure/volume [J/kg/K]. | |
| virtual tmp< scalarField > | Cpv (const scalarField &p, const scalarField &T, const label patchi) const |
| Heat capacity at constant pressure/volume for patch [J/kg/K]. | |
| virtual tmp< volScalarField > | CpByCpv () const |
| Heat capacity ratio []. | |
| virtual tmp< scalarField > | CpByCpv (const scalarField &p, const scalarField &T, const label patchi) const |
| Heat capacity ratio for patch []. | |
| virtual tmp< volScalarField > | W () const |
| Molecular weight [kg/kmol] of the mixture. | |
| virtual tmp< volScalarField > | kappa () const |
| Thermal diffusivity for temperature of mixture [J/m/s/K]. | |
| virtual tmp< scalarField > | kappa (const label patchi) const |
| Thermal diffusivity for temperature. | |
| virtual tmp< volScalarField > | alphahe () const |
| Thermal diffusivity for energy of mixture [kg/m/s]. | |
| virtual tmp< scalarField > | alphahe (const label patchi) const |
| Thermal diffusivity for energy of mixture for patch [kg/m/s]. | |
| virtual tmp< volScalarField > | kappaEff (const volScalarField &kappat) const |
| Effective thermal diffusivity for temperature. | |
| virtual tmp< scalarField > | kappaEff (const scalarField &alphat, const label patchi) const |
| Effective thermal diffusivity for temperature. | |
| virtual tmp< volScalarField > | alphaEff (const volScalarField &alphat) const |
| Effective thermal diffusivity of mixture [kg/m/s]. | |
| virtual tmp< scalarField > | alphaEff (const scalarField &alphat, const label patchi) const |
| Effective thermal diffusivity of mixture for patch [kg/m/s]. | |
| const dimensionedScalar & | Prt () const |
| Return Prandt number. | |
| virtual tmp< volScalarField > | mu () const |
| Dynamic viscosity of mixture [kg/m/s]. | |
| virtual tmp< scalarField > | mu (const label patchi) const |
| Dynamic viscosity of mixture for patch [kg/m/s]. | |
| virtual tmp< volScalarField > | nu () const |
| Kinematic viscosity of mixture [m^2/s]. | |
| virtual tmp< scalarField > | nu (const label patchi) const |
| Kinematic viscosity of mixture for patch [m^2/s]. | |
| void | setTurbulence (compressibleTurbulenceModel &turb) |
| Set turbulence model. | |
| compressibleTurbulenceModel * | turbulence () const |
| Return pointer to turbulence model. | |
| tmp< volScalarField > | mut () const |
| Return the turbulent dynamic viscosity. | |
| tmp< volScalarField > | muEff () const |
| Return the effective dynamic viscosity. | |
| tmp< volScalarField > | nut () const |
| Return the turbulent kinematic viscosity. | |
| tmp< volScalarField > | nuEff () const |
| Return the effective kinematic viscosity. | |
| tmp< volScalarField > | kappaEff () const |
| Effective thermal turbulent diffusivity for temperature. | |
| tmp< scalarField > | kappaEff (const label patchi) const |
| Effective thermal turbulent diffusivity for temperature. | |
| tmp< volScalarField > | alphaEff () const |
| Effective thermal turbulent diffusivity of mixture [kg/m/s]. | |
| tmp< scalarField > | alphaEff (const label patchi) const |
| Effective thermal turbulent diffusivity of mixture [kg/m/s]. | |
| const surfaceScalarField & | phi () const |
| Constant access to the total flux. | |
| surfaceScalarField & | phi () |
| Access to the total mixture flux. | |
| const surfaceScalarField & | rhoPhi () const |
| Constant access to the mixture mass flux. | |
| surfaceScalarField & | rhoPhi () |
| Access to the total mixture mass flux. | |
| tmp< volVectorField > | U () const |
| Mixture U. | |
| tmp< surfaceScalarField > | surfaceTensionForce () const |
| Calculate surface tension of the mixture. | |
| virtual tmp< volScalarField > | surfaceTensionCoeff (const phasePairKey &key) const |
| Return the surface tension coefficient. | |
| virtual tmp< volScalarField > | coeffs (const word &key) const |
| Return coefficients (1/rho). | |
| void | addInterfacePorosity (fvVectorMatrix &UEqn) |
| Add interface porosity on phasePair. | |
| virtual tmp< volScalarField > | dmdt (const phasePairKey &key) const =0 |
| Return interfacial source mass rate per phase pair. | |
| virtual tmp< fvScalarMatrix > | heatTransfer (const volScalarField &T)=0 |
| Return the heat transfer matrices. | |
| virtual tmp< fvScalarMatrix > | volTransfer (const volScalarField &p)=0 |
| Return the volumetric rate transfer matrix. | |
| virtual void | alphaTransfer (SuSpTable &Su, SuSpTable &Sp)=0 |
| Calculate mass transfer for alpha's. | |
| virtual void | massSpeciesTransfer (const multiphaseInter::phaseModel &phase, volScalarField::Internal &Su, volScalarField::Internal &Sp, const word speciesName)=0 |
| Calculate mass transfer for species. | |
| virtual bool | includeVolChange ()=0 |
| Add volume change in pEq. | |
| virtual void | solve ()=0 |
| Solve for the phase transport equations. | |
| virtual void | correct () |
| Correct the mixture thermos. | |
| virtual void | correctMassSources (const volScalarField &T)=0 |
| Correct mass sources. | |
| virtual word | thermoName () const |
| Return the name of the thermo physics. | |
| virtual void | correctTurbulence () |
| Correct the turbulence. | |
| virtual bool | read () |
| Read base phaseProperties dictionary. | |
| const phasePairTable & | totalPhasePairs () const |
| Constant access the total phase pairs. | |
| phasePairTable & | totalPhasePairs () |
| Non-constant access the total phase pairs. | |
| const phaseModelTable & | phases () const |
| Constant access the phases. | |
| phaseModelTable & | phases () |
| Access the phases. | |
| template<class modelType> | |
| const modelType & | lookupSubModel (const phasePair &key) const |
| Access a sub model between a phase pair. | |
| template<class modelType> | |
| const modelType & | lookupSubModel (const multiphaseInter::phaseModel &from, const multiphaseInter::phaseModel &to) const |
| Access a sub model between two phases. | |
| virtual bool | incompressible () const |
| Return true if the equation of state is incompressible for all. | |
| virtual bool | incompressible (const word) const |
| Return true if a phase is incompressible. | |
| virtual bool | isochoric () const |
| Return true if the equation of state is isochoric for all phasses. | |
| const fvMesh & | mesh () const |
| Return mesh. | |
| tmp< surfaceVectorField > | nHatfv (const volScalarField &alpha1, const volScalarField &alpha2) const |
| Interface normal surface vector. | |
| tmp< volVectorField > | nVolHatfv (const volScalarField &alpha1, const volScalarField &alpha2) const |
| Interface normal volField vector. | |
| tmp< surfaceScalarField > | nHatf (const volScalarField &alpha1, const volScalarField &alpha2) const |
| Interface normal surface vector. | |
| tmp< volScalarField > | K (const volScalarField &alpha1, const volScalarField &alpha2) const |
| Interface curvature. | |
| tmp< volScalarField > | nearInterface (const volScalarField &alpha1, const volScalarField &alpha2) const |
| Near Interface of alpha1 and alpha2. | |
| tmp< volScalarField > | nearInterface () const |
| Near Interface of alpha'n. | |
| Public Member Functions inherited from basicThermo | |
| TypeName ("basicThermo") | |
| Runtime type information. | |
| declareRunTimeSelectionTable (autoPtr, basicThermo, fvMesh,(const fvMesh &mesh, const word &phaseName),(mesh, phaseName)) | |
| Declare run-time constructor selection table. | |
| declareRunTimeSelectionTable (autoPtr, basicThermo, fvMeshDictPhase,(const fvMesh &mesh, const word &phaseName, const word &dictName),(mesh, phaseName, dictName)) | |
| Declare run-time constructor selection table for dictionary based. | |
| basicThermo (const fvMesh &, const word &phaseName) | |
| Construct from mesh and phase name. | |
| basicThermo (const fvMesh &, const dictionary &, const word &phaseName) | |
| Construct from mesh, dictionary and phase name. | |
| basicThermo (const fvMesh &, const word &phaseName, const word &dictionaryName) | |
| Construct from mesh, phase name and explicit naming of the dictionary (so it can be shared amongst phases). | |
| virtual | ~basicThermo () |
| Destructor. | |
| word | phasePropertyName (const word &name) const |
| The phase property name as property.phase (using phaseName_). | |
| word | phaseScopedName (const std::string &scope, const word &name) const |
| The phase property name scoped as scope:property.phase. | |
| void | validate (const string &app, const word &) const |
| Check that the thermodynamics package is consistent. | |
| void | validate (const string &app, const word &, const word &) const |
| Check that the thermodynamics package is consistent. | |
| void | validate (const string &app, const word &, const word &, const word &) const |
| Check that the thermodynamics package is consistent. | |
| void | validate (const string &app, const word &, const word &, const word &, const word &) const |
| Check that the thermodynamics package is consistent. | |
| bool | dpdt () const noexcept |
| True if dpdt term should be included in enthalpy equation. | |
| bool | updateT () const noexcept |
| True if T should be updated. | |
| virtual volScalarField & | p () |
| Pressure [Pa]. | |
| virtual const volScalarField & | p () const |
| Pressure [Pa]. | |
| virtual const volScalarField & | T () const |
| Temperature [K]. | |
| virtual volScalarField & | T () |
| Temperature [K]. | |
| virtual const volScalarField & | alpha () const |
| Thermal diffusivity for enthalpy of mixture [kg/m/s]. | |
| virtual const scalarField & | alpha (const label patchi) const |
| Thermal diffusivity for enthalpy of mixture for patch [kg/m/s]. | |
| template<class Thermo> | |
| Foam::autoPtr< Thermo > | New (const fvMesh &mesh, const word &phaseName) |
| template<class Thermo> | |
| Foam::autoPtr< Thermo > | New (const fvMesh &mesh, const dictionary &dict, const word &phaseName) |
| template<class Thermo> | |
| Foam::autoPtr< Thermo > | New (const fvMesh &mesh, const word &phaseName, const word &dictName) |
| 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. | |
| Public Member Functions inherited from compressibleTransportModel | |
| TypeName ("compressibleTransportModel") | |
| Runtime type information. | |
| compressibleTransportModel () | |
| Construct from components. | |
| virtual | ~compressibleTransportModel () |
| Destructor. | |
Static Public Attributes | |
| static const word | phasePropertiesName |
| Default name of the phase properties dictionary. | |
| Static Public Attributes inherited from basicThermo | |
| static const word | dictName |
| The dictionary name ("thermophysicalProperties"). | |
| 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< multiphaseInter::surfaceTensionModel >, phasePairKey, phasePairKey::hash > | surfaceTensionModelTable |
| typedef HashTable< autoPtr< porousModel >, phasePairKey, phasePairKey::hash > | interfacePorousModelTable |
Protected Member Functions | |
| void | calcMu () |
| Calculate and return the laminar viscosity. | |
| HashTable< autoPtr< multiphaseInter::phaseModel > > | generatePhaseModels (const wordList &names) const |
| Generate the phases. | |
| tmp< surfaceScalarField > | generatePhi (const HashTable< autoPtr< multiphaseInter::phaseModel > > &phaseModels) const |
| Generate the mixture flux. | |
| void | generatePairs (const dictTable &modelDicts) |
| Generate pairs. | |
| void | generatePairsTable () |
| Generate pair table. | |
| template<class modelType> | |
| void | createSubModels (const dictTable &modelDicts, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models) |
| Generate pairs and sub-model tables using pair keys. | |
| template<class modelType> | |
| void | createSubModels (const dictTable &modelDicts, const fvMesh &mesh, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models) |
| Generate pairs and sub-model tables using mesh. | |
| 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, const fvMesh &mesh, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models) |
| Generate pairs and per-phase sub-model tables with mesh ref. | |
| template<class modelType> | |
| void | generatePairsAndSubModels (const word &modelName, HashTable< HashTable< autoPtr< modelType > >, phasePairKey, phasePairKey::hash > &models) |
| Generate pairs and per-phase sub-model tables. | |
| Protected Member Functions inherited from basicThermo | |
| wordList | heBoundaryTypes () |
| Return the enthalpy/internal energy field boundary types by interrogating the temperature field boundary types. | |
| wordList | heBoundaryBaseTypes () |
| Return the enthalpy/internal energy field boundary base types by interrogating the temperature field boundary types. | |
| basicThermo (const basicThermo &)=delete | |
| No copy construct. | |
| 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. | |
| volScalarField | mu_ |
| Dynamic viscocity. | |
| wordList | phaseNames_ |
| Phase names. | |
| surfaceScalarField | phi_ |
| Mixture total volumetric flux. | |
| surfaceScalarField | rhoPhi_ |
| Mixture total mass flux. | |
| phaseModelTable | phaseModels_ |
| Phase models. | |
| phasePairTable | phasePairs_ |
| Phase pairs. | |
| phasePairTable | totalPhasePairs_ |
| Total ordered phase pairs in the system. | |
| dimensionedScalar | Prt_ |
| Turbulent Prandt number. | |
| compressibleTurbulenceModel * | turb_ |
| Turbulence model. | |
| surfaceTensionModelTable | surfaceTensionModels_ |
| Surface tension models. | |
| interfacePorousModelTable | interfacePorousModelTable_ |
| Interface porous models. | |
| Protected Attributes inherited from basicThermo | |
| const word & | phaseName_ |
| Phase-name. | |
| bool | pOwner_ |
| Pressure created and stored by this instance. | |
| bool | TOwner_ |
| Temperature created and stored by this instance. | |
| bool | dpdt_ |
| Include dpdt term in the enthalpy equation? | |
| volScalarField & | p_ |
| Pressure [Pa]. | |
| volScalarField & | T_ |
| Temperature [K]. | |
| volScalarField | alpha_ |
| Laminar thermal diffusivity [kg/m/s]. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from basicThermo | |
| template<class Thermo> | |
| static autoPtr< Thermo > | New (const fvMesh &, const word &phaseName=word::null) |
| Generic New for each of the related thermodynamics packages. | |
| template<class Thermo> | |
| static autoPtr< Thermo > | New (const fvMesh &, const dictionary &, const word &phaseName=word::null) |
| Generic New for each of the related thermodynamics packages. | |
| template<class Thermo> | |
| static autoPtr< Thermo > | New (const fvMesh &, const word &phaseName, const word &dictName) |
| Generic New for each of the related thermodynamics packages. | |
| static autoPtr< basicThermo > | New (const fvMesh &, const word &phaseName=word::null) |
| Specialisation of the Generic New for basicThermo. | |
| static word | phasePropertyName (const word &name, const word &phaseName) |
| The phase property name as property.phase. | |
| static const basicThermo & | lookupThermo (const fvPatchScalarField &pf) |
| static Ostream & | printThermoNames (Ostream &os, const wordList &cmptNames, const wordList &thermoNames) |
Print (filtered) table of thermo names, splits on " ,<>". | |
| static wordList | splitThermoName (const std::string &thermoName, const int nExpectedCmpts) |
| Split thermo package name into a list of components names. | |
| 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. | |
Definition at line 64 of file multiphaseInterSystem.H.
| typedef HashTable< autoPtr<phasePair>, phasePairKey, phasePairKey::hash > phasePairTable |
Definition at line 78 of file multiphaseInterSystem.H.
Definition at line 81 of file multiphaseInterSystem.H.
| typedef HashTable<volScalarField::Internal> SuSpTable |
Definition at line 84 of file multiphaseInterSystem.H.
|
protected |
Definition at line 92 of file multiphaseInterSystem.H.
|
protected |
Definition at line 102 of file multiphaseInterSystem.H.
|
protected |
Definition at line 112 of file multiphaseInterSystem.H.
| multiphaseInterSystem | ( | const fvMesh & | mesh | ) |
Construct from fvMesh.
Definition at line 202 of file multiphaseInterSystem.C.
References IOobjectOption::AUTO_WRITE, basicThermo::basicThermo(), calcMu(), Foam::dimDensity, Foam::dimMass, Foam::dimTime, Foam::dimViscosity, Foam::dimVolume, found, generatePairsAndSubModels(), generatePairsTable(), generatePhaseModels(), dictionary::get(), interfacePorousModelTable_, mesh(), mesh_, mu_, dictionary::null, phaseModels_, phaseNames_, phasePairs_, phasePropertiesName, phi_, Prt_, IOobjectOption::READ_IF_PRESENT, rhoPhi_, surfaceTensionModels_, IOobject::time(), timeName, totalPhasePairs_, and Foam::Zero.
Referenced by multiphaseSystem::multiphaseSystem().


|
virtual |
Destructor.
Definition at line 288 of file multiphaseInterSystem.C.
|
protected |
Calculate and return the laminar viscosity.
Definition at line 52 of file multiphaseInterSystem.C.
Referenced by correct(), and multiphaseInterSystem().


|
protected |
Generate the phases.
Definition at line 59 of file multiphaseInterSystem.C.
References HashTable< T, Key, Hash >::insert(), and phaseModel::New().
Referenced by multiphaseInterSystem().


|
protected |
Generate the mixture flux.
Definition at line 83 of file multiphaseInterSystem.C.
References HashTable< T, Key, Hash >::cbegin(), HashTable< T, Key, Hash >::cend(), Foam::fvc::interpolate(), GeometricField< scalar, fvsPatchField, surfaceMesh >::New(), IOobjectOption::NO_REGISTER, and phi.

|
protected |
Generate pairs.
Definition at line 106 of file multiphaseInterSystem.C.
References forAllConstIters, phaseModels_, and phasePairs_.
Referenced by generatePairsAndSubModels(), and generatePairsAndSubModels().

|
protected |
Generate pair table.
Definition at line 153 of file multiphaseInterSystem.C.
References forAllConstIters, name, phaseModels_, and totalPhasePairs_.
Referenced by multiphaseInterSystem().

|
protected |
Generate pairs and sub-model tables using pair keys.
Definition at line 24 of file multiphaseInterSystemTemplates.H.
References forAllConstIters, and phasePairs_.
Referenced by generatePairsAndSubModels(), and generatePairsAndSubModels().

|
protected |
Generate pairs and sub-model tables using mesh.
Definition at line 53 of file multiphaseInterSystemTemplates.H.
References forAllConstIters, and mesh().

|
protected |
Generate pairs and sub-model tables.
Definition at line 83 of file multiphaseInterSystemTemplates.H.
References createSubModels(), and generatePairs().
Referenced by generatePairsAndSubModels(), and multiphaseInterSystem().


|
protected |
Generate pairs and per-phase sub-model tables with mesh ref.
Definition at line 103 of file multiphaseInterSystemTemplates.H.
References createSubModels(), generatePairs(), and mesh().

|
protected |
Generate pairs and per-phase sub-model tables.
Definition at line 124 of file multiphaseInterSystemTemplates.H.
References forAllConstIters, generatePairsAndSubModels(), IOobject::groupName(), and phaseNames_.

| TypeName | ( | "multiphaseInterSystem" | ) |
Runtime type information.
|
inlinevirtual |
Return access to the internal energy field [J/Kg].
Implements basicThermo.
Definition at line 332 of file multiphaseInterSystem.H.
References GeometricField< Type, PatchField, GeoMesh >::constCast(), NotImplemented, and GeometricField< scalar, fvPatchField, volMesh >::null().

|
inlinevirtual |
Return access to the internal energy field [J/Kg].
Implements basicThermo.
Definition at line 343 of file multiphaseInterSystem.H.
References NotImplemented, and GeometricField< scalar, fvPatchField, volMesh >::null().

|
virtual |
Enthalpy/Internal energy.
for given pressure and temperature [J/kg]
Implements basicThermo.
Definition at line 294 of file multiphaseInterSystem.C.
References NotImplemented, basicThermo::p(), and basicThermo::T().

|
virtual |
Enthalpy/Internal energy for cell-set [J/kg].
Implements basicThermo.
Definition at line 305 of file multiphaseInterSystem.C.
References cells, NotImplemented, basicThermo::p(), and basicThermo::T().

|
virtual |
Enthalpy/Internal energy for patch [J/kg].
Implements basicThermo.
Definition at line 317 of file multiphaseInterSystem.C.
References NotImplemented, basicThermo::p(), and basicThermo::T().

|
virtual |
Chemical enthalpy of the mixture [J/kg].
Implements basicThermo.
Definition at line 329 of file multiphaseInterSystem.C.
References hc(), phaseModels_, and tmp< T >::ref().
Referenced by hc().


|
virtual |
Temperature from enthalpy/internal energy for cell-set.
Implements basicThermo.
Definition at line 347 of file multiphaseInterSystem.C.
References cells, e, NotImplemented, basicThermo::p(), and T0.

|
virtual |
Temperature from enthalpy/internal energy for patch.
Implements basicThermo.
Definition at line 360 of file multiphaseInterSystem.C.
References e, NotImplemented, basicThermo::p(), and T0.

|
virtual |
Return the mixture density.
Implements basicThermo.
Definition at line 373 of file multiphaseInterSystem.C.
References phaseModels_, tmp< T >::ref(), and rho.

|
virtual |
Return the mixture density on a patch.
Implements basicThermo.
Definition at line 391 of file multiphaseInterSystem.C.
References phaseModels_, tmp< T >::ref(), and rho.

|
virtual |
Return Cp of the mixture.
Implements basicThermo.
Definition at line 417 of file multiphaseInterSystem.C.
References Cp(), phaseModels_, and tmp< T >::ref().
Referenced by Cp(), and kappaEff().


|
virtual |
Heat capacity at constant pressure for patch [J/kg/K].
Implements basicThermo.
Definition at line 435 of file multiphaseInterSystem.C.
References Cp, basicThermo::p(), phaseModels_, tmp< T >::ref(), and basicThermo::T().

|
inlinevirtual |
Heat capacity using pressure and temperature.
Implements basicThermo.
Definition at line 438 of file multiphaseInterSystem.H.
References cells, NotImplemented, basicThermo::p(), and basicThermo::T().

|
virtual |
Return Cv of the mixture.
Implements basicThermo.
Definition at line 458 of file multiphaseInterSystem.C.
References Cv, phaseModels_, and tmp< T >::ref().

|
virtual |
Heat capacity at constant volume for patch [J/kg/K].
Implements basicThermo.
Definition at line 476 of file multiphaseInterSystem.C.
References Cv, basicThermo::p(), phaseModels_, tmp< T >::ref(), and basicThermo::T().

|
virtual |
Density from pressure and temperature.
Implements basicThermo.
Definition at line 499 of file multiphaseInterSystem.C.
References cells, NotImplemented, basicThermo::p(), and basicThermo::T().

|
virtual |
Gamma = Cp/Cv [].
Implements basicThermo.
Definition at line 511 of file multiphaseInterSystem.C.
References Cp, Cv, phaseModels_, and tmp< T >::ref().

|
virtual |
Gamma = Cp/Cv for patch [].
Implements basicThermo.
Definition at line 535 of file multiphaseInterSystem.C.
References gamma, basicThermo::p(), and basicThermo::T().

|
virtual |
Heat capacity at constant pressure/volume [J/kg/K].
Implements basicThermo.
Definition at line 549 of file multiphaseInterSystem.C.
References Cpv(), phaseModels_, and tmp< T >::ref().
Referenced by Cpv(), and Cpv().


|
virtual |
Heat capacity at constant pressure/volume for patch [J/kg/K].
Implements basicThermo.
Definition at line 567 of file multiphaseInterSystem.C.
References Cpv(), basicThermo::p(), phaseModels_, tmp< T >::ref(), and basicThermo::T().

|
virtual |
Heat capacity ratio [].
Implements basicThermo.
Definition at line 590 of file multiphaseInterSystem.C.
References CpByCpv(), phaseModels_, and tmp< T >::ref().
Referenced by CpByCpv(), and CpByCpv().


|
virtual |
Heat capacity ratio for patch [].
Implements basicThermo.
Definition at line 608 of file multiphaseInterSystem.C.
References CpByCpv(), basicThermo::p(), phaseModels_, tmp< T >::ref(), and basicThermo::T().

|
virtual |
Molecular weight [kg/kmol] of the mixture.
Implements basicThermo.
Definition at line 636 of file multiphaseInterSystem.C.
References NotImplemented.
|
virtual |
Thermal diffusivity for temperature of mixture [J/m/s/K].
Implements basicThermo.
Definition at line 643 of file multiphaseInterSystem.C.
References kappa(), phaseModels_, and tmp< T >::ref().
Referenced by kappa(), kappa(), kappaEff(), kappaEff(), kappaEff(), and kappaEff().


|
virtual |
Thermal diffusivity for temperature.
of mixture for patch [J/m/s/K]
Implements basicThermo.
Definition at line 661 of file multiphaseInterSystem.C.
References kappa(), phaseModels_, and tmp< T >::ref().

|
virtual |
Thermal diffusivity for energy of mixture [kg/m/s].
Implements basicThermo.
Definition at line 687 of file multiphaseInterSystem.C.
References alphahe(), phaseModels_, and tmp< T >::ref().
Referenced by alphahe(), and alphahe().


|
virtual |
Thermal diffusivity for energy of mixture for patch [kg/m/s].
Implements basicThermo.
Definition at line 705 of file multiphaseInterSystem.C.
References alphahe(), phaseModels_, and tmp< T >::ref().

|
virtual |
Effective thermal diffusivity for temperature.
of mixture [J/m/s/K]
Implements basicThermo.
Definition at line 729 of file multiphaseInterSystem.C.
References kappa(), kappaEff(), and kappaEff.
Referenced by kappaEff().


|
virtual |
Effective thermal diffusivity for temperature.
of mixture for patch [J/m/s/K]
Implements basicThermo.
Definition at line 740 of file multiphaseInterSystem.C.
References kappa().

|
virtual |
Effective thermal diffusivity of mixture [kg/m/s].
Implements basicThermo.
Definition at line 750 of file multiphaseInterSystem.C.
References alpha, phaseModels_, and tmp< T >::ref().

|
virtual |
Effective thermal diffusivity of mixture for patch [kg/m/s].
Implements basicThermo.
Definition at line 773 of file multiphaseInterSystem.C.
References alpha, phaseModels_, and tmp< T >::ref().

| const Foam::dimensionedScalar & Prt | ( | ) | const |
|
virtual |
Dynamic viscosity of mixture [kg/m/s].
Implements compressibleTransportModel.
Definition at line 808 of file multiphaseInterSystem.C.
References mu, phaseModels_, and tmp< T >::ref().
Referenced by calcMu().


|
virtual |
Dynamic viscosity of mixture for patch [kg/m/s].
Implements compressibleTransportModel.
Definition at line 826 of file multiphaseInterSystem.C.
References mu, phaseModels_, and tmp< T >::ref().

|
virtual |
Kinematic viscosity of mixture [m^2/s].
Implements compressibleTransportModel.
Definition at line 852 of file multiphaseInterSystem.C.
References nu, phaseModels_, and tmp< T >::ref().

|
virtual |
Kinematic viscosity of mixture for patch [m^2/s].
Implements compressibleTransportModel.
Definition at line 870 of file multiphaseInterSystem.C.
References nu, phaseModels_, and tmp< T >::ref().

|
inline |
Set turbulence model.
Definition at line 624 of file multiphaseInterSystem.H.
|
inline |
Return pointer to turbulence model.
Definition at line 632 of file multiphaseInterSystem.H.
References turb_.
| Foam::tmp< Foam::volScalarField > mut | ( | ) | const |
Return the turbulent dynamic viscosity.
Definition at line 896 of file multiphaseInterSystem.C.
References turb_.
| Foam::tmp< Foam::volScalarField > muEff | ( | ) | const |
Return the effective dynamic viscosity.
Definition at line 902 of file multiphaseInterSystem.C.
References turb_.
| Foam::tmp< Foam::volScalarField > nut | ( | ) | const |
Return the turbulent kinematic viscosity.
Definition at line 908 of file multiphaseInterSystem.C.
References turb_.
| Foam::tmp< Foam::volScalarField > nuEff | ( | ) | const |
Return the effective kinematic viscosity.
Definition at line 914 of file multiphaseInterSystem.C.
References turb_.
| Foam::tmp< Foam::volScalarField > kappaEff | ( | ) | const |
| Foam::tmp< Foam::scalarField > kappaEff | ( | const label | patchi | ) | const |
Effective thermal turbulent diffusivity for temperature.
of mixture for patch [J/m/s/K]
Definition at line 930 of file multiphaseInterSystem.C.
References Cp, Cp(), kappa(), tmp< T >::New(), Prt_, and turb_.

| Foam::tmp< Foam::volScalarField > alphaEff | ( | ) | const |
Effective thermal turbulent diffusivity of mixture [kg/m/s].
Definition at line 942 of file multiphaseInterSystem.C.
| Foam::tmp< Foam::scalarField > alphaEff | ( | const label | patchi | ) | const |
Effective thermal turbulent diffusivity of mixture [kg/m/s].
Definition at line 949 of file multiphaseInterSystem.C.
| const Foam::surfaceScalarField & phi | ( | ) | const |
Constant access to the total flux.
Definition at line 955 of file multiphaseInterSystem.C.
References phi_.
Referenced by multiphaseSystem::solveAlphas().

| Foam::surfaceScalarField & phi | ( | ) |
Access to the total mixture flux.
Definition at line 961 of file multiphaseInterSystem.C.
References phi_.
| const Foam::surfaceScalarField & rhoPhi | ( | ) | const |
Constant access to the mixture mass flux.
Definition at line 967 of file multiphaseInterSystem.C.
References rhoPhi_.
| Foam::surfaceScalarField & rhoPhi | ( | ) |
Access to the total mixture mass flux.
Definition at line 973 of file multiphaseInterSystem.C.
References rhoPhi_.
| Foam::tmp< Foam::volVectorField > U | ( | ) | const |
Mixture U.
Definition at line 1114 of file multiphaseInterSystem.C.
References Foam::dimVelocity, forAllConstIters, mesh_, GeometricField< vector, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, phaseModels_, and Foam::Zero.

| Foam::tmp< Foam::surfaceScalarField > surfaceTensionForce | ( | ) | const |
Calculate surface tension of the mixture.
Definition at line 1068 of file multiphaseInterSystem.C.
References alpha1, alpha2, forAllConstIters, Foam::fvc::interpolate(), mesh_, name, GeometricField< scalar, fvsPatchField, surfaceMesh >::New(), IOobjectOption::NO_REGISTER, phaseModels_, tmp< T >::ref(), Foam::fvc::snGrad(), surfaceTensionCoeff(), surfaceTensionModels_, and Foam::Zero.

|
virtual |
Return the surface tension coefficient.
Definition at line 1136 of file multiphaseInterSystem.C.
References surfaceTensionModels_.
Referenced by surfaceTensionForce().

|
virtual |
Return coefficients (1/rho).
Definition at line 1142 of file multiphaseInterSystem.C.
References phaseModels_, and rho.
| void addInterfacePorosity | ( | fvVectorMatrix & | UEqn | ) |
Add interface porosity on phasePair.
Definition at line 1151 of file multiphaseInterSystem.C.
References forAllConstIters, interfacePorousModelTable_, mesh_, phaseModel::name(), name, phasei, phaseModels_, and UEqn.

|
pure virtual |
Return interfacial source mass rate per phase pair.
Implemented in MassTransferPhaseSystem< multiphaseInter::multiphaseSystem >.
|
pure virtual |
Return the heat transfer matrices.
Implemented in MassTransferPhaseSystem< multiphaseInter::multiphaseSystem >.
References basicThermo::T().

|
pure virtual |
Return the volumetric rate transfer matrix.
Implemented in MassTransferPhaseSystem< multiphaseInter::multiphaseSystem >.
References basicThermo::p().

Calculate mass transfer for alpha's.
Implemented in MassTransferPhaseSystem< multiphaseInter::multiphaseSystem >.
References Foam::Sp(), and Foam::Su().
Referenced by multiphaseSystem::calculateSuSp().


|
pure virtual |
Calculate mass transfer for species.
References Foam::Sp(), and Foam::Su().

|
pure virtual |
Add volume change in pEq.
Implemented in MassTransferPhaseSystem< multiphaseInter::multiphaseSystem >.
|
pure virtual |
Solve for the phase transport equations.
Implemented in multiphaseSystem.
|
virtual |
Correct the mixture thermos.
Implements basicThermo.
Definition at line 979 of file multiphaseInterSystem.C.
References calcMu(), forAllIters, and phaseModels_.
Referenced by phaseModel::correct().


|
pure virtual |
Correct mass sources.
Implemented in MassTransferPhaseSystem< multiphaseInter::multiphaseSystem >.
References basicThermo::T().

|
inlinevirtual |
Return the name of the thermo physics.
Implements basicThermo.
Definition at line 805 of file multiphaseInterSystem.H.
References NotImplemented.
|
virtual |
Correct the turbulence.
Definition at line 990 of file multiphaseInterSystem.C.
References forAllIters, and phaseModels_.
|
virtual |
Read base phaseProperties dictionary.
Reimplemented from basicThermo.
Reimplemented in multiphaseSystem.
Definition at line 1329 of file multiphaseInterSystem.C.
References regIOobject::read().

| const Foam::multiphaseInterSystem::phasePairTable & totalPhasePairs | ( | ) | const |
Constant access the total phase pairs.
Definition at line 1014 of file multiphaseInterSystem.C.
References totalPhasePairs_.
| Foam::multiphaseInterSystem::phasePairTable & totalPhasePairs | ( | ) |
Non-constant access the total phase pairs.
Definition at line 1021 of file multiphaseInterSystem.C.
References totalPhasePairs_.
| const Foam::multiphaseInterSystem::phaseModelTable & phases | ( | ) | const |
Constant access the phases.
Definition at line 1000 of file multiphaseInterSystem.C.
References phaseModels_.
| Foam::multiphaseInterSystem::phaseModelTable & phases | ( | ) |
Access the phases.
Definition at line 1007 of file multiphaseInterSystem.C.
References phaseModels_.
| const modelType & lookupSubModel | ( | const phasePair & | key | ) | const |
Access a sub model between a phase pair.
Definition at line 172 of file multiphaseInterSystemTemplates.H.
References IOobject::groupName(), objectRegistry::lookupObject(), and mesh.
Referenced by lookupSubModel().


| const modelType & lookupSubModel | ( | const multiphaseInter::phaseModel & | from, |
| const multiphaseInter::phaseModel & | to ) const |
Access a sub model between two phases.
Definition at line 186 of file multiphaseInterSystemTemplates.H.
References lookupSubModel().

|
virtual |
Return true if the equation of state is incompressible for all.
phases
Implements basicThermo.
Definition at line 1027 of file multiphaseInterSystem.C.
References forAllConstIters, incompressible(), phaseModels_, and thermo.
Referenced by incompressible().


|
virtual |
Return true if a phase is incompressible.
Definition at line 1041 of file multiphaseInterSystem.C.
References phaseModels_.
|
virtual |
Return true if the equation of state is isochoric for all phasses.
i.e. rho = const
Implements basicThermo.
Definition at line 1047 of file multiphaseInterSystem.C.
References forAllConstIters, isochoric(), phaseModels_, and thermo.
Referenced by isochoric().


| const Foam::fvMesh & mesh | ( | ) | const |
Return mesh.
Definition at line 1061 of file multiphaseInterSystem.C.
References mesh_.
Referenced by createSubModels(), multiphaseSystem::declareRunTimeSelectionTable(), generatePairsAndSubModels(), multiphaseInterSystem(), multiphaseSystem::multiphaseSystem(), multiphaseSystem::New(), and multiphaseSystem::~multiphaseSystem().

| Foam::tmp< Foam::surfaceVectorField > nHatfv | ( | const volScalarField & | alpha1, |
| const volScalarField & | alpha2 ) const |
Interface normal surface vector.
Definition at line 1284 of file multiphaseInterSystem.C.
References alpha1, alpha2, Foam::average(), Foam::cbrt(), Foam::clamp(), e, Foam::fvc::grad(), Foam::fvc::interpolate(), Foam::mag(), and mesh_.
Referenced by K(), and nHatf().


| Foam::tmp< Foam::volVectorField > nVolHatfv | ( | const volScalarField & | alpha1, |
| const volScalarField & | alpha2 ) const |
Interface normal volField vector.
Definition at line 1251 of file multiphaseInterSystem.C.
References alpha1, alpha2, Foam::average(), Foam::cbrt(), Foam::clamp(), e, Foam::fvc::grad(), Foam::mag(), and mesh_.

| Foam::tmp< Foam::surfaceScalarField > nHatf | ( | const volScalarField & | alpha1, |
| const volScalarField & | alpha2 ) const |
Interface normal surface vector.
Definition at line 1318 of file multiphaseInterSystem.C.
References alpha1, alpha2, mesh_, and nHatfv().
Referenced by multiphaseSystem::solveAlphas().


| Foam::tmp< Foam::volScalarField > K | ( | const volScalarField & | alpha1, |
| const volScalarField & | alpha2 ) const |
Interface curvature.
Definition at line 1189 of file multiphaseInterSystem.C.
References alpha1, alpha2, Foam::fvc::div(), mesh_, nHatfv(), and tmp< T >::ref().

| Foam::tmp< Foam::volScalarField > nearInterface | ( | const volScalarField & | alpha1, |
| const volScalarField & | alpha2 ) const |
Near Interface of alpha1 and alpha2.
Definition at line 1202 of file multiphaseInterSystem.C.
References alpha1, alpha2, and Foam::pos().

| Foam::tmp< Foam::volScalarField > nearInterface | ( | ) | const |
Near Interface of alpha'n.
Definition at line 1217 of file multiphaseInterSystem.C.
References alpha1, alpha2, Foam::dimless, forAllConstIters, mesh_, GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, phaseModels_, Foam::pos(), and Foam::Zero.

|
protected |
Reference to the mesh.
Definition at line 121 of file multiphaseInterSystem.H.
Referenced by addInterfacePorosity(), K(), multiphaseSystem::maxDiffNo(), mesh(), multiphaseInterSystem(), multiphaseSystem::multiphaseSystem(), nearInterface(), nHatf(), nHatfv(), nVolHatfv(), multiphaseSystem::solve(), multiphaseSystem::solveAlphas(), surfaceTensionForce(), and U().
|
protected |
Dynamic viscocity.
Definition at line 126 of file multiphaseInterSystem.H.
Referenced by calcMu(), and multiphaseInterSystem().
|
protected |
Phase names.
Definition at line 131 of file multiphaseInterSystem.H.
Referenced by generatePairsAndSubModels(), and multiphaseInterSystem().
|
protected |
Mixture total volumetric flux.
Definition at line 136 of file multiphaseInterSystem.H.
Referenced by multiphaseInterSystem(), phi(), and phi().
|
protected |
Mixture total mass flux.
Definition at line 141 of file multiphaseInterSystem.H.
Referenced by multiphaseInterSystem(), rhoPhi(), rhoPhi(), multiphaseSystem::solve(), and multiphaseSystem::solveAlphas().
|
protected |
Phase models.
Definition at line 146 of file multiphaseInterSystem.H.
Referenced by addInterfacePorosity(), alphaEff(), alphaEff(), alphahe(), alphahe(), coeffs(), correct(), correctTurbulence(), Cp(), Cp(), CpByCpv(), CpByCpv(), Cpv(), Cpv(), Cv(), Cv(), gamma(), generatePairs(), generatePairsTable(), hc(), incompressible(), incompressible(), isochoric(), kappa(), kappa(), multiphaseSystem::maxDiffNo(), mu(), mu(), multiphaseInterSystem(), multiphaseSystem::multiphaseSystem(), nearInterface(), nu(), nu(), phases(), phases(), rho(), rho(), surfaceTensionForce(), and U().
|
protected |
Phase pairs.
Definition at line 151 of file multiphaseInterSystem.H.
Referenced by createSubModels(), generatePairs(), and multiphaseInterSystem().
|
protected |
Total ordered phase pairs in the system.
Definition at line 156 of file multiphaseInterSystem.H.
Referenced by generatePairsTable(), multiphaseInterSystem(), totalPhasePairs(), and totalPhasePairs().
|
protected |
Turbulent Prandt number.
Definition at line 161 of file multiphaseInterSystem.H.
Referenced by alphaEff(), alphaEff(), kappaEff(), kappaEff(), multiphaseInterSystem(), and Prt().
|
protected |
Turbulence model.
Definition at line 166 of file multiphaseInterSystem.H.
Referenced by alphaEff(), alphaEff(), kappaEff(), kappaEff(), muEff(), mut(), nuEff(), nut(), setTurbulence(), and turbulence().
|
protected |
Surface tension models.
Definition at line 174 of file multiphaseInterSystem.H.
Referenced by multiphaseInterSystem(), surfaceTensionCoeff(), and surfaceTensionForce().
|
protected |
Interface porous models.
Definition at line 179 of file multiphaseInterSystem.H.
Referenced by addInterfacePorosity(), and multiphaseInterSystem().
|
static |
Default name of the phase properties dictionary.
Definition at line 306 of file multiphaseInterSystem.H.
Referenced by temperatureCoupledBase::kappa(), multiphaseInterSystem(), and multiphaseSystem::New().