multiphaseInterSystem Class Referenceabstract
Inheritance diagram for multiphaseInterSystem:
[legend]
Collaboration diagram for multiphaseInterSystem:
[legend]

Public Types

typedef HashTable< autoPtr< phasePair >, phasePairKey, phasePairKey::hashphasePairTable
 
typedef HashTable< autoPtr< multiphaseInter::phaseModel > > phaseModelTable
 
typedef HashTable< volScalarField::InternalSuSpTable
 
- Public Types inherited from IOobject
enum  readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 }
 Enumeration defining the read options. More...
 
enum  writeOption : char { NO_WRITE = 0 , AUTO_WRITE = 0x10 }
 Enumeration defining the write options. More...
 
enum  objectState : char { GOOD , BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  fileCheckTypes : char { timeStamp , timeStampMaster , inotify , inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Public Types inherited from dictionary
typedef Searcher< true > const_searcher
 Searcher with const access. More...
 
typedef Searcher< false > searcher
 Searcher with non-const access. More...
 
- Public Types inherited from UILList< LListBase, T >
typedef T value_type
 Type of values stored. More...
 
typedef Tpointer
 Pointer for value_type. More...
 
typedef const Tconst_pointer
 Const pointer for value_type. More...
 
typedef Treference
 Reference for value_type. More...
 
typedef const Tconst_reference
 Const reference for value_type. More...
 
typedef label size_type
 The type that can represent the container size. More...
 
typedef label difference_type
 The difference between iterator objects. More...
 
using base_iterator = typename LListBase::iterator
 
using const_base_iterator = typename LListBase::const_iterator
 

Public Member Functions

 TypeName ("multiphaseInterSystem")
 Runtime type information. More...
 
 multiphaseInterSystem (const fvMesh &mesh)
 Construct from fvMesh. More...
 
virtual ~multiphaseInterSystem ()
 Destructor. More...
 
virtual volScalarFieldhe ()
 Return access to the internal energy field [J/Kg]. More...
 
virtual const volScalarFieldhe () const
 Return access to the internal energy field [J/Kg]. More...
 
virtual tmp< volScalarFieldhe (const volScalarField &p, const volScalarField &T) const
 Enthalpy/Internal energy. More...
 
virtual tmp< scalarFieldhe (const scalarField &p, const scalarField &T, const labelList &cells) const
 Enthalpy/Internal energy for cell-set [J/kg]. More...
 
virtual tmp< scalarFieldhe (const scalarField &p, const scalarField &T, const label patchi) const
 Enthalpy/Internal energy for patch [J/kg]. More...
 
virtual tmp< volScalarFieldhc () const
 Chemical enthalpy of the mixture [J/kg]. More...
 
virtual tmp< scalarFieldTHE (const scalarField &h, const scalarField &p, const scalarField &T0, const labelList &cells) const
 Temperature from enthalpy/internal energy for cell-set. More...
 
virtual tmp< scalarFieldTHE (const scalarField &h, const scalarField &p, const scalarField &T0, const label patchi) const
 Temperature from enthalpy/internal energy for patch. More...
 
virtual tmp< volScalarFieldrho () const
 Return the mixture density. More...
 
virtual tmp< scalarFieldrho (const label patchi) const
 Return the mixture density on a patch. More...
 
virtual tmp< volScalarFieldCp () const
 Return Cp of the mixture. More...
 
virtual tmp< scalarFieldCp (const scalarField &p, const scalarField &T, const label patchi) const
 Heat capacity at constant pressure for patch [J/kg/K]. More...
 
virtual tmp< scalarFieldCp (const scalarField &p, const scalarField &T, const labelList &cells) const
 Heat capacity using pressure and temperature. More...
 
virtual tmp< volScalarFieldCv () const
 Return Cv of the mixture. More...
 
virtual tmp< scalarFieldCv (const scalarField &p, const scalarField &T, const label patchI) const
 Heat capacity at constant volume for patch [J/kg/K]. More...
 
virtual tmp< scalarFieldrhoEoS (const scalarField &p, const scalarField &T, const labelList &cells) const
 Density from pressure and temperature. More...
 
virtual tmp< volScalarFieldgamma () const
 Gamma = Cp/Cv []. More...
 
virtual tmp< scalarFieldgamma (const scalarField &p, const scalarField &T, const label patchi) const
 Gamma = Cp/Cv for patch []. More...
 
virtual tmp< volScalarFieldCpv () const
 Heat capacity at constant pressure/volume [J/kg/K]. More...
 
virtual tmp< scalarFieldCpv (const scalarField &p, const scalarField &T, const label patchi) const
 Heat capacity at constant pressure/volume for patch [J/kg/K]. More...
 
virtual tmp< volScalarFieldCpByCpv () const
 Heat capacity ratio []. More...
 
virtual tmp< scalarFieldCpByCpv (const scalarField &p, const scalarField &T, const label patchi) const
 Heat capacity ratio for patch []. More...
 
virtual tmp< volScalarFieldW () const
 Molecular weight [kg/kmol] of the mixture. More...
 
virtual tmp< volScalarFieldkappa () const
 Thermal diffusivity for temperature of mixture [J/m/s/K]. More...
 
virtual tmp< scalarFieldkappa (const label patchi) const
 Thermal diffusivity for temperature. More...
 
virtual tmp< volScalarFieldalphahe () const
 Thermal diffusivity for energy of mixture [kg/m/s]. More...
 
virtual tmp< scalarFieldalphahe (const label patchi) const
 Thermal diffusivity for energy of mixture for patch [kg/m/s]. More...
 
virtual tmp< volScalarFieldkappaEff (const volScalarField &kappat) const
 Effective thermal diffusivity for temperature. More...
 
virtual tmp< scalarFieldkappaEff (const scalarField &alphat, const label patchi) const
 Effective thermal diffusivity for temperature. More...
 
virtual tmp< volScalarFieldalphaEff (const volScalarField &alphat) const
 Effective thermal diffusivity of mixture [kg/m/s]. More...
 
virtual tmp< scalarFieldalphaEff (const scalarField &alphat, const label patchi) const
 Effective thermal diffusivity of mixture for patch [kg/m/s]. More...
 
const dimensionedScalarPrt () const
 Return Prandt number. More...
 
virtual tmp< volScalarFieldmu () const
 Dynamic viscosity of mixture [kg/m/s]. More...
 
virtual tmp< scalarFieldmu (const label patchi) const
 Dynamic viscosity of mixture for patch [kg/m/s]. More...
 
virtual tmp< volScalarFieldnu () const
 Kinematic viscosity of mixture [m^2/s]. More...
 
virtual tmp< scalarFieldnu (const label patchi) const
 Kinematic viscosity of mixture for patch [m^2/s]. More...
 
void setTurbulence (compressibleTurbulenceModel &turb)
 Set turbulence model. More...
 
compressibleTurbulenceModelturbulence () const
 Return pointer to turbulence model. More...
 
tmp< volScalarFieldmut () const
 Return the turbulent dynamic viscosity. More...
 
tmp< volScalarFieldmuEff () const
 Return the effective dynamic viscosity. More...
 
tmp< volScalarFieldnut () const
 Return the turbulent kinematic viscosity. More...
 
tmp< volScalarFieldnuEff () const
 Return the effective kinematic viscosity. More...
 
tmp< volScalarFieldkappaEff () const
 Effective thermal turbulent diffusivity for temperature. More...
 
tmp< scalarFieldkappaEff (const label patchi) const
 Effective thermal turbulent diffusivity for temperature. More...
 
tmp< volScalarFieldalphaEff () const
 Effective thermal turbulent diffusivity of mixture [kg/m/s]. More...
 
tmp< scalarFieldalphaEff (const label patchi) const
 Effective thermal turbulent diffusivity of mixture [kg/m/s]. More...
 
const surfaceScalarFieldphi () const
 Constant access to the total flux. More...
 
surfaceScalarFieldphi ()
 Access to the total mixture flux. More...
 
const surfaceScalarFieldrhoPhi () const
 Constant access to the mixture mass flux. More...
 
surfaceScalarFieldrhoPhi ()
 Access to the total mixture mass flux. More...
 
tmp< volVectorFieldU () const
 Mixture U. More...
 
tmp< surfaceScalarFieldsurfaceTensionForce () const
 Calculate surface tension of the mixture. More...
 
virtual tmp< volScalarFieldsurfaceTensionCoeff (const phasePairKey &key) const
 Return the surface tension coefficient. More...
 
virtual tmp< volScalarFieldcoeffs (const word &key) const
 Return coefficients (1/rho) More...
 
void addInterfacePorosity (fvVectorMatrix &UEqn)
 Add interface porosity on phasePair. More...
 
virtual tmp< volScalarFielddmdt (const phasePairKey &key) const =0
 Return interfacial source mass rate per phase pair. More...
 
virtual tmp< fvScalarMatrixheatTransfer (const volScalarField &T)=0
 Return the heat transfer matrices. More...
 
virtual tmp< fvScalarMatrixvolTransfer (const volScalarField &p)=0
 Return the volumetric rate transfer matrix. More...
 
virtual void alphaTransfer (SuSpTable &Su, SuSpTable &Sp)=0
 Calculate mass transfer for alpha's. More...
 
virtual void massSpeciesTransfer (const multiphaseInter::phaseModel &phase, volScalarField::Internal &Su, volScalarField::Internal &Sp, const word speciesName)=0
 Calculate mass transfer for species. More...
 
virtual bool includeVolChange ()=0
 Add volume change in pEq. More...
 
virtual void solve ()=0
 Solve for the phase transport equations. More...
 
virtual void correct ()
 Correct the mixture thermos. More...
 
virtual void correctMassSources (const volScalarField &T)=0
 Correct mass sources. More...
 
virtual word thermoName () const
 Return the name of the thermo physics. More...
 
virtual void correctTurbulence ()
 Correct the turbulence. More...
 
virtual bool read ()
 Read base phaseProperties dictionary. More...
 
const phasePairTabletotalPhasePairs () const
 Constant access the total phase pairs. More...
 
phasePairTabletotalPhasePairs ()
 Non-constant access the total phase pairs. More...
 
const phaseModelTablephases () const
 Constant access the phases. More...
 
phaseModelTablephases ()
 Access the phases. More...
 
template<class modelType >
const modelType & lookupSubModel (const phasePair &key) const
 Access a sub model between a phase pair. More...
 
template<class modelType >
const modelType & lookupSubModel (const multiphaseInter::phaseModel &from, const multiphaseInter::phaseModel &to) const
 Access a sub model between two phases. More...
 
virtual bool incompressible () const
 Return true if the equation of state is incompressible for all. More...
 
virtual bool incompressible (const word) const
 Return true if a phase is incompressible. More...
 
virtual bool isochoric () const
 Return true if the equation of state is isochoric for all phasses. More...
 
const fvMeshmesh () const
 Return mesh. More...
 
tmp< surfaceVectorFieldnHatfv (const volScalarField &alpha1, const volScalarField &alpha2) const
 Interface normal surface vector. More...
 
tmp< volVectorFieldnVolHatfv (const volScalarField &alpha1, const volScalarField &alpha2) const
 Interface normal volField vector. More...
 
tmp< surfaceScalarFieldnHatf (const volScalarField &alpha1, const volScalarField &alpha2) const
 Interface normal surface vector. More...
 
tmp< volScalarFieldK (const volScalarField &alpha1, const volScalarField &alpha2) const
 Interface curvature. More...
 
tmp< volScalarFieldnearInterface (const volScalarField &alpha1, const volScalarField &alpha2) const
 Near Interface of alpha1 and alpha2. More...
 
tmp< volScalarFieldnearInterface () const
 Near Interface of alpha'n. More...
 
- Public Member Functions inherited from basicThermo
 TypeName ("basicThermo")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, basicThermo, fvMesh,(const fvMesh &mesh, const word &phaseName),(mesh, phaseName))
 Declare run-time constructor selection table. More...
 
 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. More...
 
 basicThermo (const fvMesh &, const word &phaseName)
 Construct from mesh and phase name. More...
 
 basicThermo (const fvMesh &, const dictionary &, const word &phaseName)
 Construct from mesh, dictionary and phase name. More...
 
 basicThermo (const fvMesh &, const word &phaseName, const word &dictionaryName)
 
virtual ~basicThermo ()
 Destructor. More...
 
word phasePropertyName (const word &name) const
 
void validate (const string &app, const word &) const
 Check that the thermodynamics package is consistent. More...
 
void validate (const string &app, const word &, const word &) const
 Check that the thermodynamics package is consistent. More...
 
void validate (const string &app, const word &, const word &, const word &) const
 Check that the thermodynamics package is consistent. More...
 
void validate (const string &app, const word &, const word &, const word &, const word &) const
 Check that the thermodynamics package is consistent. More...
 
virtual void correct ()=0
 Update properties. More...
 
virtual word thermoName () const =0
 Return the name of the thermo physics. More...
 
virtual bool incompressible () const =0
 Return true if the equation of state is incompressible. More...
 
virtual bool isochoric () const =0
 Return true if the equation of state is isochoric. More...
 
bool dpdt () const noexcept
 True if dpdt term should be included in enthalpy equation. More...
 
bool updateT () const noexcept
 True if T should be updated. More...
 
virtual volScalarFieldp ()
 Pressure [Pa]. More...
 
virtual const volScalarFieldp () const
 Pressure [Pa]. More...
 
virtual tmp< volScalarFieldrho () const =0
 Density [kg/m^3]. More...
 
virtual tmp< scalarFieldrho (const label patchi) const =0
 Density for patch [kg/m^3]. More...
 
virtual volScalarFieldhe ()=0
 Enthalpy/Internal energy [J/kg]. More...
 
virtual const volScalarFieldhe () const =0
 Enthalpy/Internal energy [J/kg]. More...
 
virtual tmp< volScalarFieldhe (const volScalarField &p, const volScalarField &T) const =0
 Enthalpy/Internal energy. More...
 
virtual tmp< scalarFieldhe (const scalarField &p, const scalarField &T, const labelList &cells) const =0
 Enthalpy/Internal energy for cell-set [J/kg]. More...
 
virtual tmp< scalarFieldhe (const scalarField &p, const scalarField &T, const label patchi) const =0
 Enthalpy/Internal energy for patch [J/kg]. More...
 
virtual tmp< volScalarFieldhc () const =0
 Chemical enthalpy [J/kg]. More...
 
virtual tmp< scalarFieldTHE (const scalarField &h, const scalarField &p, const scalarField &T0, const labelList &cells) const =0
 Temperature from enthalpy/internal energy for cell-set. More...
 
virtual tmp< scalarFieldTHE (const scalarField &h, const scalarField &p, const scalarField &T0, const label patchi) const =0
 Temperature from enthalpy/internal energy for patch. More...
 
virtual const volScalarFieldT () const
 Temperature [K]. More...
 
virtual volScalarFieldT ()
 Temperature [K]. More...
 
virtual tmp< volScalarFieldCp () const =0
 Heat capacity at constant pressure [J/kg/K]. More...
 
virtual tmp< scalarFieldCp (const scalarField &p, const scalarField &T, const label patchi) const =0
 Heat capacity at constant pressure for patch [J/kg/K]. More...
 
virtual tmp< scalarFieldCp (const scalarField &p, const scalarField &T, const labelList &cells) const =0
 Heat capacity using pressure and temperature [J/kg/K]. More...
 
virtual tmp< volScalarFieldCv () const =0
 Heat capacity at constant volume [J/kg/K]. More...
 
virtual tmp< scalarFieldCv (const scalarField &p, const scalarField &T, const label patchi) const =0
 Heat capacity at constant volume for patch [J/kg/K]. More...
 
virtual tmp< scalarFieldrhoEoS (const scalarField &p, const scalarField &T, const labelList &cells) const =0
 Density from pressure and temperature from EoS. More...
 
virtual tmp< volScalarFieldgamma () const =0
 Gamma = Cp/Cv []. More...
 
virtual tmp< scalarFieldgamma (const scalarField &p, const scalarField &T, const label patchi) const =0
 Gamma = Cp/Cv for patch []. More...
 
virtual tmp< volScalarFieldCpv () const =0
 Heat capacity at constant pressure/volume [J/kg/K]. More...
 
virtual tmp< scalarFieldCpv (const scalarField &p, const scalarField &T, const label patchi) const =0
 Heat capacity at constant pressure/volume for patch [J/kg/K]. More...
 
virtual tmp< volScalarFieldCpByCpv () const =0
 Heat capacity ratio []. More...
 
virtual tmp< scalarFieldCpByCpv (const scalarField &p, const scalarField &T, const label patchi) const =0
 Heat capacity ratio for patch []. More...
 
virtual tmp< volScalarFieldW () const =0
 Molecular weight [kg/kmol]. More...
 
virtual const volScalarFieldalpha () const
 Thermal diffusivity for enthalpy of mixture [kg/m/s]. More...
 
virtual const scalarFieldalpha (const label patchi) const
 Thermal diffusivity for enthalpy of mixture for patch [kg/m/s]. More...
 
virtual tmp< volScalarFieldkappa () const =0
 Thermal diffusivity for temperature of mixture [J/m/s/K]. More...
 
virtual tmp< scalarFieldkappa (const label patchi) const =0
 Thermal diffusivity for temperature. More...
 
virtual tmp< volScalarFieldalphahe () const =0
 Thermal diffusivity for energy of mixture [kg/m/s]. More...
 
virtual tmp< scalarFieldalphahe (const label patchi) const =0
 Thermal diffusivity for energy of mixture for patch [kg/m/s]. More...
 
virtual tmp< volScalarFieldkappaEff (const volScalarField &) const =0
 Effective thermal diffusivity for temperature. More...
 
virtual tmp< scalarFieldkappaEff (const scalarField &alphat, const label patchi) const =0
 Effective thermal diffusivity for temperature. More...
 
virtual tmp< volScalarFieldalphaEff (const volScalarField &alphat) const =0
 Effective thermal diffusivity of mixture [kg/m/s]. More...
 
virtual tmp< scalarFieldalphaEff (const scalarField &alphat, const label patchi) const =0
 Effective thermal diffusivity of mixture for patch [kg/m/s]. More...
 
virtual bool read ()
 Read thermophysical properties dictionary. More...
 
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)
 
 IOdictionary (const IOobject &io, const dictionary &dict)
 
 IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)
 
 IOdictionary (const IOobject &io, Istream &is)
 Construct given an IOobject and Istream. More...
 
virtual ~IOdictionary ()=default
 Destructor. More...
 
virtual bool global () const
 Is object global. More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
- Public Member Functions inherited from baseIOdictionary
 TypeName ("dictionary")
 Declare type-name, virtual type (with debug switch) More...
 
 baseIOdictionary (const baseIOdictionary &)=default
 Copy construct. More...
 
 baseIOdictionary (baseIOdictionary &&)=default
 Move construct. More...
 
virtual ~baseIOdictionary ()=default
 Destructor. More...
 
 baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 
 baseIOdictionary (const IOobject &io, const dictionary &dict)
 
 baseIOdictionary (const IOobject &io, Istream &is)
 Construct given an IOobject and Istream (ununsed) More...
 
virtual fileName filePath () const =0
 
const wordname () const
 
virtual bool readData (Istream &)
 The readData function required by regIOobject read operation. More...
 
virtual bool writeData (Ostream &) const
 The writeData function required by regIOobject write operation. More...
 
virtual bool global () const =0
 Is object global. More...
 
void operator= (const baseIOdictionary &rhs)
 Copy assignment of dictionary entries (leave regIOobject untouched) More...
 
void operator= (const dictionary &rhs)
 Copy assignment of dictionary entries. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 
 regIOobject (const regIOobject &rio)
 Copy construct. More...
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 Copy construct with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry, if not already registered. More...
 
bool checkOut ()
 Remove all file watches and remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const noexcept
 
bool ownedByRegistry () const noexcept
 Is this object owned by the registry? More...
 
bool store ()
 
void release (const bool unregister=false) noexcept
 Set object as not ownedByRegistry. More...
 
label eventNo () const noexcept
 Event number at last update. More...
 
label & eventNo () noexcept
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set as up-to-date. More...
 
virtual void rename (const word &newName)
 Rename. More...
 
const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data or nullptr. More...
 
dictionarygetMetaData () noexcept
 Get or create meta-data. More...
 
void removeMetaData ()
 Remove meta-data. More...
 
virtual void updateMetaData ()
 Update internal meta-data (eg, prior to writing) More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool headerOk ()
 Read and check header info. Does not check the headerClassName. More...
 
IstreamreadStream (const word &, const bool valid=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
virtual bool read ()
 Read object. More...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. More...
 
const labelListwatchIndices () const noexcept
 Read access to file-monitoring handles. More...
 
labelListwatchIndices () noexcept
 Write access to file-monitoring handles. More...
 
virtual bool modified () const
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeData (Ostream &) const =0
 Pure virtual writeData function. More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write using stream options. More...
 
virtual bool write (const bool valid=true) const
 Write using setting from DB. More...
 
virtual bool global () const
 Is object global. More...
 
void operator= (const IOobject &io)
 Copy assignment. More...
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
 Write using given format, version and compression. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Declare type-name, virtual type (with debug switch) More...
 
 IOobject (const IOobject &)=default
 Copy construct. More...
 
virtual ~IOobject ()=default
 Destructor. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Copy construct, resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Copy construct, resetting name. More...
 
 IOobject (const IOobject &io, const word &name, const fileName &local)
 Copy construct, resetting name and local component. More...
 
 IOobject (const IOobject &io, readOption rOpt, writeOption wOpt)
 Copy construct, resetting read/write options. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
const objectRegistrydb () const noexcept
 Return the local objectRegistry. More...
 
const Timetime () const
 Return Time associated with the objectRegistry. More...
 
const wordname () const noexcept
 Return the object name. More...
 
const wordheaderClassName () const noexcept
 Return name of the class name read from header. More...
 
wordheaderClassName () noexcept
 Return non-constant access to the class name read from header. More...
 
const stringnote () const noexcept
 Return the optional note. More...
 
stringnote () noexcept
 Modifiable access to the optional note. More...
 
virtual void rename (const word &newName)
 Rename the object. More...
 
bool registerObject () const noexcept
 Should object created with this IOobject be registered? More...
 
bool registerObject (bool on) noexcept
 Change registration preference, return previous value. More...
 
bool globalObject () const noexcept
 Is object same for all processors? More...
 
bool globalObject (bool on) noexcept
 Change global-object status, return previous value. More...
 
unsigned labelByteSize () const noexcept
 The sizeof (label) in bytes, possibly read from the header. More...
 
unsigned scalarByteSize () const noexcept
 The sizeof (scalar) in bytes, possibly read from the header. More...
 
bool hasHeaderClass () const noexcept
 True if headerClassName() is non-empty (after reading) More...
 
template<class Type >
bool isHeaderClass () const
 Check if headerClassName() equals Type::typeName. More...
 
template<class Type >
bool isHeaderClassName () const
 Same as isHeaderClass() More...
 
virtual const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data (if any) or nullptr. More...
 
readOption readOpt () const noexcept
 The read option. More...
 
readOption readOpt (readOption opt) noexcept
 Change the read option, return previous value. More...
 
writeOption writeOpt () const noexcept
 The write option. More...
 
writeOption writeOpt (writeOption opt) noexcept
 Change the write option, return previous value. More...
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 Return the Time::rootPath() More...
 
const fileNamecaseName () const
 Return the Time::caseName() More...
 
const fileNameinstance () const noexcept
 Read access to instance path component. More...
 
fileNameinstance () noexcept
 Write access to instance path component. More...
 
const fileNamelocal () const noexcept
 Read access to local path component. More...
 
fileName path () const
 The complete path. More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName objectPath () const
 The complete path + object name. More...
 
fileName objectRelPath () const
 The object path relative to the root. More...
 
fileName localFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches up if in parallel. More...
 
IOstreamOption parseHeader (const dictionary &headerDict)
 
bool readHeader (Istream &is)
 
bool readHeader (dictionary &headerDict, Istream &is)
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (uses typeFilePath to find file) and check its info. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &os) const
 Write header with current type() More...
 
bool writeHeader (Ostream &os, const word &objectType) const
 Write header with override of type. More...
 
void writeHeader (dictionary &dict, IOstreamOption streamOpt) const
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 
bool good () const noexcept
 Did last readHeader() succeed? More...
 
bool bad () const noexcept
 Did last readHeader() fail? More...
 
InfoProxy< IOobjectinfo () const
 Return info proxy, for printing information to a stream. More...
 
void operator= (const IOobject &io)
 Copy assignment, copies all values (except the registry) More...
 
readOptionreadOpt () noexcept
 Access to the read option. More...
 
writeOptionwriteOpt () noexcept
 Access to the write option. More...
 
boolregisterObject () noexcept
 Access to the register object option. More...
 
boolglobalObject () noexcept
 Access to the global object option. More...
 
template<>
bool isHeaderClass () const
 Specialization for void always returns true (no headerClassName check). More...
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 Default construct, a top-level empty dictionary. More...
 
 dictionary (const fileName &name)
 Construct top-level empty dictionary with given name. More...
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false)
 
 dictionary (Istream &is)
 
 dictionary (Istream &is, bool keepHeader)
 
 dictionary (const dictionary &parentDict, const dictionary &dict)
 Copy construct given the parent dictionary. More...
 
 dictionary (const dictionary &dict)
 Copy construct top-level dictionary. More...
 
 dictionary (const dictionary *dict)
 Construct top-level dictionary as copy from pointer to dictionary. More...
 
 dictionary (const dictionary &parentDict, dictionary &&dict)
 Move construct for given parent dictionary. More...
 
 dictionary (dictionary &&dict)
 Move construct top-level dictionary. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const fileNamename () const noexcept
 The dictionary name. More...
 
fileNamename () noexcept
 The dictionary name for modification (use with caution). More...
 
word dictName () const
 The local dictionary name (final part of scoped name) More...
 
fileName relativeName (const bool caseTag=false) const
 The dictionary name relative to the case. More...
 
bool isNullDict () const noexcept
 The dictionary is actually dictionary::null (root dictionary) More...
 
const dictionaryparent () const noexcept
 Return the parent dictionary. More...
 
const dictionarytopDict () const
 Return the top of the tree. More...
 
label startLineNumber () const
 Return line number of first token in dictionary. More...
 
label endLineNumber () const
 Return line number of last token in dictionary. More...
 
SHA1Digest digest () const
 Return the SHA1 digest of the dictionary contents. More...
 
tokenList tokens () const
 Return the dictionary as a list of tokens. More...
 
bool found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search for an entry (const access) with the given keyword. More...
 
entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find for an entry (non-const access) with the given keyword. More...
 
const entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find an entry (const access) with the given keyword. More...
 
const entryfindScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search for a scoped entry (const access) with the given keyword. More...
 
dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary pointer if present. More...
 
const dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary pointer if present. More...
 
const entrylookupEntry (const word &keyword, enum keyType::option matchOpt) const
 Search for an entry (const access) with the given keyword. More...
 
ITstreamlookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
bool readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T >
bool readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T , class Predicate >
bool readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T , class Predicate >
bool readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
bool isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Check if entry is found and is a sub-dictionary. More...
 
const dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary for manipulation. More...
 
dictionarysubDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary for manipulation. More...
 
dictionary subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const
 
const dictionaryoptionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary, otherwise return this dictionary. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the sorted table of contents. More...
 
template<class Compare >
wordList sortedToc (const Compare &comp) const
 Return table of contents sorted using the specified comparator. More...
 
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns. More...
 
bool substituteKeyword (const word &keyword, bool mergeEntry=false)
 Substitute the given keyword (which is prefixed by '$') More...
 
bool substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
 Substitute the given scoped keyword (which is prefixed by '$') More...
 
entryadd (entry *entryPtr, bool mergeEntry=false)
 Add a new entry. More...
 
entryadd (const entry &e, bool mergeEntry=false)
 Add an entry. More...
 
entryadd (const keyType &k, const word &v, bool overwrite=false)
 Add a word entry. More...
 
entryadd (const keyType &k, const string &v, bool overwrite=false)
 Add a string entry. More...
 
entryadd (const keyType &k, const label v, bool overwrite=false)
 Add a label entry. More...
 
entryadd (const keyType &k, const scalar v, bool overwrite=false)
 Add a scalar entry. More...
 
entryadd (const keyType &k, const dictionary &d, bool mergeEntry=false)
 Add a dictionary entry. More...
 
template<class T >
entryadd (const keyType &k, const T &v, bool overwrite=false)
 Add a T entry. More...
 
entryset (entry *entryPtr)
 Assign a new entry, overwriting any existing entry. More...
 
entryset (const entry &e)
 Assign a new entry, overwriting any existing entry. More...
 
entryset (const keyType &k, const dictionary &v)
 Assign a dictionary entry, overwriting any existing entry. More...
 
template<class T >
entryset (const keyType &k, const T &v)
 Assign a T entry, overwriting any existing entry. More...
 
bool remove (const word &keyword)
 Remove an entry specified by keyword. More...
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
 Change the keyword for an entry,. More...
 
bool merge (const dictionary &dict)
 Merge entries from the given dictionary. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (dictionary &dict)
 Transfer the contents of the argument and annul the argument. More...
 
void checkITstream (const ITstream &is, const word &keyword) const
 
bool read (Istream &is)
 Read dictionary from Istream. Discards the header. More...
 
bool read (Istream &is, bool keepHeader)
 Read dictionary from Istream, optionally keeping the header. More...
 
void writeEntry (Ostream &os) const
 Write sub-dictionary with its dictName as its header. More...
 
void writeEntry (const keyType &keyword, Ostream &os) const
 Write sub-dictionary with the keyword as its header. More...
 
void writeEntries (Ostream &os, const bool extraNewLine=false) const
 Write dictionary entries. More...
 
void write (Ostream &os, const bool subDict=true) const
 Write dictionary, normally with sub-dictionary formatting. More...
 
const_searcher csearch (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search dictionary for given keyword. More...
 
const_searcher search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search dictionary for given keyword. More...
 
searcher search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Search dictionary for given keyword. More...
 
const_searcher csearchScoped (const word &keyword, enum keyType::option matchOpt) const
 Search using scoping. More...
 
const_searcher searchScoped (const word &keyword, enum keyType::option matchOpt) const
 Search using dot or slash scoping. More...
 
searcher searchScoped (const word &keyword, enum keyType::option matchOpt)
 Search using dot or slash scoping. More...
 
const dictionarycfindScopedDict (const fileName &dictPath) const
 Locate a sub-dictionary using slash-scoping. More...
 
const dictionaryfindScopedDict (const fileName &dictPath) const
 Locate a sub-dictionary using slash-scoping. More...
 
dictionaryfindScopedDict (const fileName &dictPath)
 Locate a sub-dictionary using slash-scoping. More...
 
dictionarymakeScopedDict (const fileName &dictPath)
 Locate existing or create sub-dictionary using slash-scoping. More...
 
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. More...
 
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. More...
 
const entryfindCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt) const
 
const entrylookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt) const
 
ITstreamlookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=keyType::REGEX) const
 
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
 
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, bool mandatory=true) const
 
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
 
void operator= (const dictionary &rhs)
 Copy assignment. More...
 
void operator+= (const dictionary &rhs)
 Include entries from the given dictionary. More...
 
void operator|= (const dictionary &rhs)
 Conditionally include entries from the given dictionary. More...
 
void operator<<= (const dictionary &rhs)
 Unconditionally include entries from the given dictionary. More...
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
T lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
ITstreamoperator[] (const word &keyword) const
 Deprecated(2018-07) find and return an entry data stream. More...
 
bool found (const word &keyword, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
 Deprecated(2018-10) More...
 
const entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 Deprecated(2018-10) More...
 
const entrylookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 Deprecated(2018-10) More...
 
const dictionarysubDictPtr (const word &keyword) const
 Deprecated(2018-10) More...
 
dictionarysubDictPtr (const word &keyword)
 
const entrylookupEntry (const word &keyword, bool recursive, bool patternMatch) const
 Deprecated(2018-10) More...
 
ITstreamlookup (const word &keyword, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
 Deprecated(2018-10) More...
 
template<class T >
bool readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
template<class T >
T lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
 Deprecated(2018-10) find and return a T. More...
 
bool getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< bool >(const word&, keyType::option) More...
 
label getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< label >(const word&, keyType::option) More...
 
scalar getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< scalar >(const word&, keyType::option) More...
 
string getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< string >(const word&, keyType::option) More...
 
word getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< word >(const word&, keyType::option) More...
 
fileName getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< fileName >(const word&, keyType::option) More...
 
template<class Compare >
Foam::wordList sortedToc (const Compare &comp) const
 
template<class T >
Foam::entryadd (const keyType &k, const T &v, bool overwrite)
 
template<class T >
Foam::entryset (const keyType &k, const T &v)
 
- Public Member Functions inherited from ILList< LListBase, T >
 ILList ()=default
 Default construct. More...
 
 ILList (T *item)
 Construct and add initial item pointer. More...
 
 ILList (Istream &is)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &lst)
 Copy construct using the 'clone()' method for each element. More...
 
 ILList (ILList< LListBase, T > &&lst)
 Move construct. More...
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone 'clone()'. More...
 
template<class INew >
 ILList (Istream &is, const INew &inew)
 Construct from Istream using given Istream constructor class. More...
 
 ~ILList ()
 Destructor. More...
 
bool eraseHead ()
 Remove the head element specified from the list and delete it. More...
 
bool erase (T *item)
 Remove the specified element from the list and delete it. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (ILList< LListBase, T > &lst)
 
void operator= (const ILList< LListBase, T > &lst)
 Copy assignment using the 'clone()' method for each element. More...
 
void operator= (ILList< LListBase, T > &&lst)
 Move assignment. More...
 
- Public Member Functions inherited from UILList< LListBase, T >
 UILList ()=default
 Default construct. More...
 
 UILList (T *item)
 Construct and add initial item pointer. More...
 
 UILList (const UILList< LListBase, T > &lst)
 Construct as copy. More...
 
Tfirst ()
 The first entry in the list. More...
 
const Tfirst () const
 The first entry in the list (const access) More...
 
Tlast ()
 The last entry in the list. More...
 
const Tlast () const
 The last entry in the list (const access) More...
 
TremoveHead ()
 Remove and return head. More...
 
Tremove (T *item)
 Remove and return element. More...
 
Tremove (iterator &iter)
 Remove and return item specified by iterator. More...
 
void operator= (const UILList< LListBase, T > &lst)
 Copy assignment. More...
 
bool operator== (const UILList< LListBase, T > &lst) const
 Equality. True both lists are element-wise equal. More...
 
bool operator!= (const UILList< LListBase, T > &lst) const
 The opposite of the equality operation. Takes linear time. More...
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write UILList with line-breaks when length exceeds shortLen. More...
 
iterator begin ()
 Iterator to first item in list with non-const access. More...
 
const_iterator cbegin () const
 Iterator to first item in list with const access. More...
 
reverse_iterator rbegin ()
 Iterator to last item in list with non-const access. More...
 
const_reverse_iterator crbegin () const
 Iterator to last item in list with const access. More...
 
const_iterator begin () const
 Iterator to first item in list with const access. More...
 
const_reverse_iterator rbegin () const
 Iterator to last item in list with const access. More...
 
const iteratorend ()
 End of list for forward iterators. More...
 
const const_iteratorcend () const
 End of list for forward iterators. More...
 
const reverse_iteratorrend ()
 End of list for reverse iterators. More...
 
const const_reverse_iteratorcrend () const
 End of list for reverse iterators. More...
 
const const_iteratorend () const
 End of list for forward iterators. More...
 
const const_reverse_iteratorrend () const
 End of list for reverse iterators. More...
 
- Public Member Functions inherited from compressibleTransportModel
 TypeName ("compressibleTransportModel")
 Runtime type information. More...
 
 compressibleTransportModel ()
 Construct from components. More...
 
virtual ~compressibleTransportModel ()
 Destructor. More...
 
virtual tmp< volScalarFieldmu () const =0
 Return the dynamic laminar viscosity. More...
 
virtual tmp< scalarFieldmu (const label patchi) const =0
 Return the dynamic laminar viscosity for patch. More...
 
virtual tmp< volScalarFieldnu () const =0
 Return the laminar viscosity. More...
 
virtual tmp< scalarFieldnu (const label patchi) const =0
 Return the laminar viscosity for patch. More...
 

Static Public Attributes

static const word phasePropertiesName
 Default name of the phase properties dictionary. More...
 
- Static Public Attributes inherited from basicThermo
static const word dictName
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 Names for the fileCheckTypes. More...
 
static char scopeSeparator
 Character for scoping object names (':' or '_') More...
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
static float fileModificationSkew
 Time skew (seconds) for file modification checks. More...
 
static int maxFileModificationPolls
 Max number of times to poll for file modification changes. More...
 
- Static Public Attributes inherited from dictionary
static int writeOptionalEntries
 Report optional keywords and values if not present in dictionary. More...
 
static const dictionary null
 An empty dictionary, which is also the parent for all dictionaries. More...
 
static refPtr< OSstreamreportingOutput
 Output location when reporting default values. More...
 

Protected Types

typedef HashTable< dictionary, phasePairKey, phasePairKey::hashdictTable
 
typedef HashTable< autoPtr< multiphaseInter::surfaceTensionModel >, phasePairKey, phasePairKey::hashsurfaceTensionModelTable
 
typedef HashTable< autoPtr< porousModel >, phasePairKey, phasePairKey::hashinterfacePorousModelTable
 

Protected Member Functions

void calcMu ()
 Calculate and return the laminar viscosity. More...
 
HashTable< autoPtr< multiphaseInter::phaseModel > > generatePhaseModels (const wordList &names) const
 Generate the phases. More...
 
tmp< surfaceScalarFieldgeneratePhi (const HashTable< autoPtr< multiphaseInter::phaseModel > > &phaseModels) const
 Generate the mixture flux. More...
 
void generatePairs (const dictTable &modelDicts)
 Generate pairs. More...
 
void generatePairsTable ()
 Generate pair table. More...
 
template<class modelType >
void createSubModels (const dictTable &modelDicts, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models)
 Generate pairs and sub-model tables using pair keys. More...
 
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. More...
 
template<class modelType >
void generatePairsAndSubModels (const word &modelName, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models)
 Generate pairs and sub-model tables. More...
 
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. More...
 
template<class modelType >
void generatePairsAndSubModels (const word &modelName, HashTable< HashTable< autoPtr< modelType > >, phasePairKey, phasePairKey::hash > &models)
 Generate pairs and per-phase sub-model tables. More...
 
- Protected Member Functions inherited from basicThermo
wordList heBoundaryTypes ()
 
wordList heBoundaryBaseTypes ()
 
 basicThermo (const basicThermo &)=delete
 No copy construct. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 Set the object state to bad. More...
 

Protected Attributes

const fvMeshmesh_
 Reference to the mesh. More...
 
volScalarField mu_
 Dynamic viscocity. More...
 
wordList phaseNames_
 Phase names. More...
 
surfaceScalarField phi_
 Mixture total volumetric flux. More...
 
surfaceScalarField rhoPhi_
 Mixture total mass flux. More...
 
phaseModelTable phaseModels_
 Phase models. More...
 
phasePairTable phasePairs_
 Phase pairs. More...
 
phasePairTable totalPhasePairs_
 Total ordered phase pairs in the system. More...
 
dimensionedScalar Prt_
 Turbulent Prandt number. More...
 
compressibleTurbulenceModelturb_
 Turbulence model. More...
 
surfaceTensionModelTable surfaceTensionModels_
 Surface tension models. More...
 
interfacePorousModelTable interfacePorousModelTable_
 Interface porous models. More...
 
- Protected Attributes inherited from basicThermo
const wordphaseName_
 Phase-name. More...
 
bool pOwner_
 Pressure created and stored by this instance. More...
 
bool TOwner_
 Temperature created and stored by this instance. More...
 
bool dpdt_
 Include dpdt term in the enthalpy equation? More...
 
volScalarFieldp_
 Pressure [Pa]. More...
 
volScalarFieldT_
 Temperature [K]. More...
 
volScalarField alpha_
 Laminar thermal diffusivity [kg/m/s]. More...
 

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. More...
 
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. More...
 
template<class Thermo >
static autoPtr< Thermo > New (const fvMesh &, const word &phaseName, const word &dictName)
 Generic New for each of the related thermodynamics packages. More...
 
static autoPtr< basicThermoNew (const fvMesh &, const word &phaseName=word::null)
 Specialisation of the Generic New for basicThermo. More...
 
static word phasePropertyName (const word &name, const word &phaseName)
 
static const basicThermolookupThermo (const fvPatchScalarField &pf)
 
static OstreamprintThermoNames (Ostream &os, const wordList &cmptNames, const wordList &thermoNames)
 Print (filtered) table of thermo names, splits on " ,<>". More...
 
static wordList splitThermoName (const std::string &thermoName, const int nExpectedCmpts)
 Split thermo package name into a list of components names. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 Status of output file banner. More...
 
static bool bannerEnabled (bool on) noexcept
 Enable/disable output file banner. More...
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class StringType >
static word groupName (StringType base, const word &group)
 Create dot-delimited name.group string. More...
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
static word scopedName (const std::string &scope, const word &name)
 Create scope:name or scope_name string. More...
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name. More...
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from dictionary
static int reportOptional () noexcept
 Return the state of reporting optional (default) entries. More...
 
static int reportOptional (const int level) noexcept
 Change the state of reporting optional (default) entries. More...
 
static autoPtr< dictionaryNew (Istream &is)
 Construct top-level dictionary on freestore from Istream. More...
 
- Public Attributes inherited from dictionary
friend const_searcher
 Declare friendship with the searcher classes. More...
 
friend searcher
 
- Static Protected Member Functions inherited from IOobject
static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Member Typedef Documentation

◆ phasePairTable

◆ phaseModelTable

◆ SuSpTable

◆ dictTable

Definition at line 96 of file multiphaseInterSystem.H.

◆ surfaceTensionModelTable

◆ interfacePorousModelTable

Constructor & Destructor Documentation

◆ multiphaseInterSystem()

◆ ~multiphaseInterSystem()

~multiphaseInterSystem ( )
virtual

Destructor.

Definition at line 295 of file multiphaseInterSystem.C.

Member Function Documentation

◆ calcMu()

void calcMu ( )
protected

Calculate and return the laminar viscosity.

Definition at line 59 of file multiphaseInterSystem.C.

References multiphaseInterSystem::mu(), and multiphaseInterSystem::mu_.

Referenced by multiphaseInterSystem::multiphaseInterSystem().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ generatePhaseModels()

Foam::multiphaseInterSystem::phaseModelTable generatePhaseModels ( const wordList names) const
protected

Generate the phases.

Definition at line 66 of file multiphaseInterSystem.C.

References HashTable< T, Key, Hash >::insert(), and Time::New().

Here is the call graph for this function:

◆ generatePhi()

Foam::tmp< Foam::surfaceScalarField > generatePhi ( const HashTable< autoPtr< multiphaseInter::phaseModel > > &  phaseModels) const
protected

Generate the mixture flux.

Definition at line 90 of file multiphaseInterSystem.C.

References HashTable< T, Key, Hash >::cbegin(), HashTable< T, Key, Hash >::cend(), Foam::fvc::interpolate(), Time::New(), and phi.

Here is the call graph for this function:

◆ generatePairs()

void generatePairs ( const dictTable modelDicts)
protected

Generate pairs.

Definition at line 112 of file multiphaseInterSystem.C.

References forAllConstIters.

◆ generatePairsTable()

void generatePairsTable ( )
protected

Generate pair table.

Definition at line 159 of file multiphaseInterSystem.C.

References forAllConstIters, and Foam::name().

Referenced by multiphaseInterSystem::multiphaseInterSystem().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ createSubModels() [1/2]

void createSubModels ( const dictTable modelDicts,
HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &  models 
)
protected

Generate pairs and sub-model tables using pair keys.

Definition at line 31 of file multiphaseInterSystemTemplates.H.

References forAllConstIters, and multiphaseInterSystem::phasePairs_.

◆ createSubModels() [2/2]

void createSubModels ( const dictTable modelDicts,
const fvMesh mesh,
HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &  models 
)
protected

Generate pairs and sub-model tables using mesh.

Definition at line 60 of file multiphaseInterSystemTemplates.H.

References forAllConstIters, and mesh.

◆ generatePairsAndSubModels() [1/3]

void generatePairsAndSubModels ( const word modelName,
HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &  models 
)
protected

Generate pairs and sub-model tables.

Definition at line 90 of file multiphaseInterSystemTemplates.H.

Referenced by multiphaseInterSystem::multiphaseInterSystem().

Here is the caller graph for this function:

◆ generatePairsAndSubModels() [2/3]

void generatePairsAndSubModels ( const word modelName,
const fvMesh mesh,
HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &  models 
)
protected

Generate pairs and per-phase sub-model tables with mesh ref.

Definition at line 110 of file multiphaseInterSystemTemplates.H.

References mesh.

◆ generatePairsAndSubModels() [3/3]

void generatePairsAndSubModels ( const word modelName,
HashTable< HashTable< autoPtr< modelType > >, phasePairKey, phasePairKey::hash > &  models 
)
protected

Generate pairs and per-phase sub-model tables.

Definition at line 131 of file multiphaseInterSystemTemplates.H.

References forAllConstIters, and IOobject::groupName().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "multiphaseInterSystem"  )

Runtime type information.

◆ he() [1/5]

virtual volScalarField & he ( )
inlinevirtual

Return access to the internal energy field [J/Kg].

Note
this mixture thermo is prepared to work with T

Implements basicThermo.

Definition at line 281 of file multiphaseInterSystem.H.

◆ he() [2/5]

virtual const volScalarField & he ( ) const
inlinevirtual

Return access to the internal energy field [J/Kg].

Note
this mixture thermo is prepared to work with T

Implements basicThermo.

Definition at line 289 of file multiphaseInterSystem.H.

◆ he() [3/5]

Foam::tmp< Foam::volScalarField > he ( const volScalarField p,
const volScalarField T 
) const
virtual

Enthalpy/Internal energy.

for given pressure and temperature [J/kg]

Implements basicThermo.

Definition at line 301 of file multiphaseInterSystem.C.

References NotImplemented.

◆ he() [4/5]

Foam::tmp< Foam::scalarField > he ( const scalarField p,
const scalarField T,
const labelList cells 
) const
virtual

Enthalpy/Internal energy for cell-set [J/kg].

Implements basicThermo.

Definition at line 312 of file multiphaseInterSystem.C.

References NotImplemented.

◆ he() [5/5]

Foam::tmp< Foam::scalarField > he ( const scalarField p,
const scalarField T,
const label  patchi 
) const
virtual

Enthalpy/Internal energy for patch [J/kg].

Implements basicThermo.

Definition at line 324 of file multiphaseInterSystem.C.

References NotImplemented.

◆ hc()

Foam::tmp< Foam::volScalarField > hc ( ) const
virtual

Chemical enthalpy of the mixture [J/kg].

Implements basicThermo.

Definition at line 336 of file multiphaseInterSystem.C.

References tmp< T >::ref().

Here is the call graph for this function:

◆ THE() [1/2]

Foam::tmp< Foam::scalarField > THE ( const scalarField h,
const scalarField p,
const scalarField T0,
const labelList cells 
) const
virtual

Temperature from enthalpy/internal energy for cell-set.

Implements basicThermo.

Definition at line 354 of file multiphaseInterSystem.C.

References NotImplemented.

◆ THE() [2/2]

Foam::tmp< Foam::scalarField > THE ( const scalarField h,
const scalarField p,
const scalarField T0,
const label  patchi 
) const
virtual

Temperature from enthalpy/internal energy for patch.

Implements basicThermo.

Definition at line 367 of file multiphaseInterSystem.C.

References NotImplemented.

◆ rho() [1/2]

Foam::tmp< Foam::volScalarField > rho ( ) const
virtual

Return the mixture density.

Implements basicThermo.

Definition at line 380 of file multiphaseInterSystem.C.

References tmp< T >::ref(), and rho.

Here is the call graph for this function:

◆ rho() [2/2]

Foam::tmp< Foam::scalarField > rho ( const label  patchi) const
virtual

Return the mixture density on a patch.

Implements basicThermo.

Definition at line 398 of file multiphaseInterSystem.C.

References tmp< T >::ref(), and rho.

Here is the call graph for this function:

◆ Cp() [1/3]

Foam::tmp< Foam::volScalarField > Cp ( ) const
virtual

Return Cp of the mixture.

Implements basicThermo.

Definition at line 424 of file multiphaseInterSystem.C.

References Cp, and tmp< T >::ref().

Here is the call graph for this function:

◆ Cp() [2/3]

Foam::tmp< Foam::scalarField > Cp ( const scalarField p,
const scalarField T,
const label  patchi 
) const
virtual

Heat capacity at constant pressure for patch [J/kg/K].

Implements basicThermo.

Definition at line 442 of file multiphaseInterSystem.C.

References Cp, p, tmp< T >::ref(), and T.

Here is the call graph for this function:

◆ Cp() [3/3]

virtual tmp< scalarField > Cp ( const scalarField p,
const scalarField T,
const labelList cells 
) const
inlinevirtual

Heat capacity using pressure and temperature.

Implements basicThermo.

Definition at line 361 of file multiphaseInterSystem.H.

References Time::New(), NotImplemented, and basicThermo::p().

Here is the call graph for this function:

◆ Cv() [1/2]

Foam::tmp< Foam::volScalarField > Cv ( ) const
virtual

Return Cv of the mixture.

Implements basicThermo.

Definition at line 465 of file multiphaseInterSystem.C.

References Cv, and tmp< T >::ref().

Here is the call graph for this function:

◆ Cv() [2/2]

Foam::tmp< Foam::scalarField > Cv ( const scalarField p,
const scalarField T,
const label  patchI 
) const
virtual

Heat capacity at constant volume for patch [J/kg/K].

Implements basicThermo.

Definition at line 483 of file multiphaseInterSystem.C.

References Cv, p, tmp< T >::ref(), and T.

Here is the call graph for this function:

◆ rhoEoS()

Foam::tmp< Foam::scalarField > rhoEoS ( const scalarField p,
const scalarField T,
const labelList cells 
) const
virtual

Density from pressure and temperature.

Implements basicThermo.

Definition at line 506 of file multiphaseInterSystem.C.

References NotImplemented.

◆ gamma() [1/2]

Foam::tmp< Foam::volScalarField > gamma ( ) const
virtual

Gamma = Cp/Cv [].

Implements basicThermo.

Definition at line 518 of file multiphaseInterSystem.C.

References Cp, Cv, and tmp< T >::ref().

Here is the call graph for this function:

◆ gamma() [2/2]

Foam::tmp< Foam::scalarField > gamma ( const scalarField p,
const scalarField T,
const label  patchi 
) const
virtual

Gamma = Cp/Cv for patch [].

Implements basicThermo.

Definition at line 542 of file multiphaseInterSystem.C.

References gamma.

◆ Cpv() [1/2]

Foam::tmp< Foam::volScalarField > Cpv ( ) const
virtual

Heat capacity at constant pressure/volume [J/kg/K].

Implements basicThermo.

Definition at line 556 of file multiphaseInterSystem.C.

References tmp< T >::ref().

Here is the call graph for this function:

◆ Cpv() [2/2]

Foam::tmp< Foam::scalarField > Cpv ( const scalarField p,
const scalarField T,
const label  patchi 
) const
virtual

Heat capacity at constant pressure/volume for patch [J/kg/K].

Implements basicThermo.

Definition at line 574 of file multiphaseInterSystem.C.

References p, tmp< T >::ref(), and T.

Here is the call graph for this function:

◆ CpByCpv() [1/2]

Foam::tmp< Foam::volScalarField > CpByCpv ( ) const
virtual

Heat capacity ratio [].

Implements basicThermo.

Definition at line 597 of file multiphaseInterSystem.C.

References tmp< T >::ref().

Here is the call graph for this function:

◆ CpByCpv() [2/2]

Foam::tmp< Foam::scalarField > CpByCpv ( const scalarField p,
const scalarField T,
const label  patchi 
) const
virtual

Heat capacity ratio for patch [].

Implements basicThermo.

Definition at line 615 of file multiphaseInterSystem.C.

References p, tmp< T >::ref(), and T.

Here is the call graph for this function:

◆ W()

Foam::tmp< Foam::volScalarField > W ( ) const
virtual

Molecular weight [kg/kmol] of the mixture.

Implements basicThermo.

Definition at line 643 of file multiphaseInterSystem.C.

References NotImplemented.

◆ kappa() [1/2]

Foam::tmp< Foam::volScalarField > kappa ( ) const
virtual

Thermal diffusivity for temperature of mixture [J/m/s/K].

Implements basicThermo.

Definition at line 650 of file multiphaseInterSystem.C.

References tmp< T >::ref().

Here is the call graph for this function:

◆ kappa() [2/2]

Foam::tmp< Foam::scalarField > kappa ( const label  patchi) const
virtual

Thermal diffusivity for temperature.

of mixture for patch [J/m/s/K]

Implements basicThermo.

Definition at line 668 of file multiphaseInterSystem.C.

References tmp< T >::ref().

Here is the call graph for this function:

◆ alphahe() [1/2]

Foam::tmp< Foam::volScalarField > alphahe ( ) const
virtual

Thermal diffusivity for energy of mixture [kg/m/s].

Implements basicThermo.

Definition at line 694 of file multiphaseInterSystem.C.

References tmp< T >::ref().

Here is the call graph for this function:

◆ alphahe() [2/2]

Foam::tmp< Foam::scalarField > alphahe ( const label  patchi) const
virtual

Thermal diffusivity for energy of mixture for patch [kg/m/s].

Implements basicThermo.

Definition at line 712 of file multiphaseInterSystem.C.

References tmp< T >::ref().

Here is the call graph for this function:

◆ kappaEff() [1/4]

Foam::tmp< Foam::volScalarField > kappaEff ( const volScalarField kappat) const
virtual

Effective thermal diffusivity for temperature.

of mixture [J/m/s/K]

Implements basicThermo.

Definition at line 736 of file multiphaseInterSystem.C.

References kappaEff.

Referenced by temperatureCoupledBase::kappa().

Here is the caller graph for this function:

◆ kappaEff() [2/4]

Foam::tmp< Foam::scalarField > kappaEff ( const scalarField alphat,
const label  patchi 
) const
virtual

Effective thermal diffusivity for temperature.

of mixture for patch [J/m/s/K]

Implements basicThermo.

Definition at line 747 of file multiphaseInterSystem.C.

◆ alphaEff() [1/4]

Foam::tmp< Foam::volScalarField > alphaEff ( const volScalarField alphat) const
virtual

Effective thermal diffusivity of mixture [kg/m/s].

Implements basicThermo.

Definition at line 757 of file multiphaseInterSystem.C.

References alpha, and tmp< T >::ref().

Here is the call graph for this function:

◆ alphaEff() [2/4]

Foam::tmp< Foam::scalarField > alphaEff ( const scalarField alphat,
const label  patchi 
) const
virtual

Effective thermal diffusivity of mixture for patch [kg/m/s].

Implements basicThermo.

Definition at line 780 of file multiphaseInterSystem.C.

References alpha, and tmp< T >::ref().

Here is the call graph for this function:

◆ Prt()

const Foam::dimensionedScalar & Prt ( ) const

Return Prandt number.

Definition at line 809 of file multiphaseInterSystem.C.

◆ mu() [1/2]

Foam::tmp< Foam::volScalarField > mu ( ) const
virtual

Dynamic viscosity of mixture [kg/m/s].

Implements compressibleTransportModel.

Definition at line 815 of file multiphaseInterSystem.C.

References mu, and tmp< T >::ref().

Referenced by multiphaseInterSystem::calcMu().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ mu() [2/2]

Foam::tmp< Foam::scalarField > mu ( const label  patchi) const
virtual

Dynamic viscosity of mixture for patch [kg/m/s].

Implements compressibleTransportModel.

Definition at line 833 of file multiphaseInterSystem.C.

References mu, and tmp< T >::ref().

Here is the call graph for this function:

◆ nu() [1/2]

Foam::tmp< Foam::volScalarField > nu ( ) const
virtual

Kinematic viscosity of mixture [m^2/s].

Implements compressibleTransportModel.

Definition at line 859 of file multiphaseInterSystem.C.

References nu, and tmp< T >::ref().

Here is the call graph for this function:

◆ nu() [2/2]

Foam::tmp< Foam::scalarField > nu ( const label  patchi) const
virtual

Kinematic viscosity of mixture for patch [m^2/s].

Implements compressibleTransportModel.

Definition at line 877 of file multiphaseInterSystem.C.

References nu, and tmp< T >::ref().

Here is the call graph for this function:

◆ setTurbulence()

void setTurbulence ( compressibleTurbulenceModel turb)
inline

Set turbulence model.

Definition at line 496 of file multiphaseInterSystem.H.

References turb, and multiphaseInterSystem::turb_.

◆ turbulence()

compressibleTurbulenceModel * turbulence ( ) const
inline

Return pointer to turbulence model.

Definition at line 502 of file multiphaseInterSystem.H.

References multiphaseInterSystem::turb_.

◆ mut()

Foam::tmp< Foam::volScalarField > mut ( ) const

Return the turbulent dynamic viscosity.

Definition at line 903 of file multiphaseInterSystem.C.

◆ muEff()

Foam::tmp< Foam::volScalarField > muEff ( ) const

Return the effective dynamic viscosity.

Definition at line 909 of file multiphaseInterSystem.C.

◆ nut()

Foam::tmp< Foam::volScalarField > nut ( ) const

Return the turbulent kinematic viscosity.

Definition at line 915 of file multiphaseInterSystem.C.

◆ nuEff()

Foam::tmp< Foam::volScalarField > nuEff ( ) const

Return the effective kinematic viscosity.

Definition at line 921 of file multiphaseInterSystem.C.

◆ kappaEff() [3/4]

Foam::tmp< Foam::volScalarField > kappaEff ( ) const

Effective thermal turbulent diffusivity for temperature.

of mixture [J/m/s/K]

Definition at line 927 of file multiphaseInterSystem.C.

References Cp, kappaEff, and Time::New().

Here is the call graph for this function:

◆ kappaEff() [4/4]

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 939 of file multiphaseInterSystem.C.

References Cp, and Time::New().

Here is the call graph for this function:

◆ alphaEff() [3/4]

Foam::tmp< Foam::volScalarField > alphaEff ( ) const

Effective thermal turbulent diffusivity of mixture [kg/m/s].

Definition at line 951 of file multiphaseInterSystem.C.

References alpha.

◆ alphaEff() [4/4]

Foam::tmp< Foam::scalarField > alphaEff ( const label  patchi) const

Effective thermal turbulent diffusivity of mixture [kg/m/s].

Definition at line 958 of file multiphaseInterSystem.C.

References alpha.

◆ phi() [1/2]

const Foam::surfaceScalarField & phi ( ) const

Constant access to the total flux.

Definition at line 964 of file multiphaseInterSystem.C.

◆ phi() [2/2]

Access to the total mixture flux.

Definition at line 970 of file multiphaseInterSystem.C.

◆ rhoPhi() [1/2]

const Foam::surfaceScalarField & rhoPhi ( ) const

Constant access to the mixture mass flux.

Definition at line 976 of file multiphaseInterSystem.C.

◆ rhoPhi() [2/2]

Access to the total mixture mass flux.

Definition at line 982 of file multiphaseInterSystem.C.

◆ U()

Mixture U.

Definition at line 1127 of file multiphaseInterSystem.C.

References Foam::dimVelocity, forAllConstIters, Time::New(), and Foam::Zero.

Here is the call graph for this function:

◆ surfaceTensionForce()

Foam::tmp< Foam::surfaceScalarField > surfaceTensionForce ( ) const

Calculate surface tension of the mixture.

Definition at line 1077 of file multiphaseInterSystem.C.

References alpha1, alpha2, forAllConstIters, Foam::fvc::interpolate(), Foam::name(), Time::New(), Foam::fvc::snGrad(), and Foam::Zero.

Here is the call graph for this function:

◆ surfaceTensionCoeff()

Foam::tmp< Foam::volScalarField > surfaceTensionCoeff ( const phasePairKey key) const
virtual

Return the surface tension coefficient.

Definition at line 1153 of file multiphaseInterSystem.C.

◆ coeffs()

Foam::tmp< Foam::volScalarField > coeffs ( const word key) const
virtual

Return coefficients (1/rho)

Definition at line 1159 of file multiphaseInterSystem.C.

◆ addInterfacePorosity()

void addInterfacePorosity ( fvVectorMatrix UEqn)

Add interface porosity on phasePair.

Definition at line 1168 of file multiphaseInterSystem.C.

References lduMatrix::diag(), forAllConstIters, phaseModel::name(), Foam::name(), phasei, and UEqn.

Here is the call graph for this function:

◆ dmdt()

virtual tmp< volScalarField > dmdt ( const phasePairKey key) const
pure virtual

Return interfacial source mass rate per phase pair.

◆ heatTransfer()

virtual tmp< fvScalarMatrix > heatTransfer ( const volScalarField T)
pure virtual

Return the heat transfer matrices.

◆ volTransfer()

virtual tmp< fvScalarMatrix > volTransfer ( const volScalarField p)
pure virtual

Return the volumetric rate transfer matrix.

◆ alphaTransfer()

virtual void alphaTransfer ( SuSpTable Su,
SuSpTable Sp 
)
pure virtual

Calculate mass transfer for alpha's.

◆ massSpeciesTransfer()

virtual void massSpeciesTransfer ( const multiphaseInter::phaseModel phase,
volScalarField::Internal Su,
volScalarField::Internal Sp,
const word  speciesName 
)
pure virtual

Calculate mass transfer for species.

◆ includeVolChange()

virtual bool includeVolChange ( )
pure virtual

Add volume change in pEq.

◆ solve()

virtual void solve ( )
pure virtual

Solve for the phase transport equations.

Implemented in multiphaseSystem.

◆ correct()

void correct ( )
virtual

Correct the mixture thermos.

Implements basicThermo.

Definition at line 988 of file multiphaseInterSystem.C.

References forAllIters.

◆ correctMassSources()

virtual void correctMassSources ( const volScalarField T)
pure virtual

Correct mass sources.

◆ thermoName()

virtual word thermoName ( ) const
inlinevirtual

Return the name of the thermo physics.

Implements basicThermo.

Definition at line 619 of file multiphaseInterSystem.H.

References NotImplemented.

◆ correctTurbulence()

void correctTurbulence ( )
virtual

Correct the turbulence.

Note
Each phase could have its own turbulence

Definition at line 999 of file multiphaseInterSystem.C.

References forAllIters.

◆ read()

bool read ( )
virtual

Read base phaseProperties dictionary.

Reimplemented from basicThermo.

Reimplemented in multiphaseSystem.

Definition at line 1350 of file multiphaseInterSystem.C.

References regIOobject::read().

Here is the call graph for this function:

◆ totalPhasePairs() [1/2]

const Foam::multiphaseInterSystem::phasePairTable & totalPhasePairs ( ) const

Constant access the total phase pairs.

Definition at line 1023 of file multiphaseInterSystem.C.

◆ totalPhasePairs() [2/2]

Non-constant access the total phase pairs.

Definition at line 1030 of file multiphaseInterSystem.C.

◆ phases() [1/2]

Constant access the phases.

Definition at line 1009 of file multiphaseInterSystem.C.

◆ phases() [2/2]

Access the phases.

Definition at line 1016 of file multiphaseInterSystem.C.

◆ lookupSubModel() [1/2]

const modelType & lookupSubModel ( const phasePair key) const

Access a sub model between a phase pair.

Definition at line 179 of file multiphaseInterSystemTemplates.H.

References IOobject::groupName(), objectRegistry::lookupObject(), and mesh.

Here is the call graph for this function:

◆ lookupSubModel() [2/2]

const modelType & lookupSubModel ( const multiphaseInter::phaseModel from,
const multiphaseInter::phaseModel to 
) const

Access a sub model between two phases.

Definition at line 193 of file multiphaseInterSystemTemplates.H.

◆ incompressible() [1/2]

bool incompressible ( ) const
virtual

Return true if the equation of state is incompressible for all.

phases

Implements basicThermo.

Definition at line 1036 of file multiphaseInterSystem.C.

References forAllConstIters.

◆ incompressible() [2/2]

bool incompressible ( const word  phaseName) const
virtual

Return true if a phase is incompressible.

Definition at line 1050 of file multiphaseInterSystem.C.

◆ isochoric()

bool isochoric ( ) const
virtual

Return true if the equation of state is isochoric for all phasses.

i.e. rho = const

Implements basicThermo.

Definition at line 1056 of file multiphaseInterSystem.C.

References forAllConstIters.

◆ mesh()

const Foam::fvMesh & mesh ( ) const

Return mesh.

Definition at line 1070 of file multiphaseInterSystem.C.

Referenced by multiphaseSystem::multiphaseSystem(), and multiphaseSystem::New().

Here is the caller graph for this function:

◆ nHatfv()

Foam::tmp< Foam::surfaceVectorField > nHatfv ( const volScalarField alpha1,
const volScalarField alpha2 
) const

Interface normal surface vector.

Definition at line 1305 of file multiphaseInterSystem.C.

References alpha1, alpha2, Foam::average(), Foam::cbrt(), e, Foam::fvc::grad(), Foam::fvc::interpolate(), Foam::mag(), Foam::max(), and Foam::min().

Here is the call graph for this function:

◆ nVolHatfv()

Foam::tmp< Foam::volVectorField > nVolHatfv ( const volScalarField alpha1,
const volScalarField alpha2 
) const

Interface normal volField vector.

Definition at line 1272 of file multiphaseInterSystem.C.

References alpha1, alpha2, Foam::average(), Foam::cbrt(), e, Foam::fvc::grad(), Foam::mag(), Foam::max(), and Foam::min().

Here is the call graph for this function:

◆ nHatf()

Foam::tmp< Foam::surfaceScalarField > nHatf ( const volScalarField alpha1,
const volScalarField alpha2 
) const

Interface normal surface vector.

Definition at line 1339 of file multiphaseInterSystem.C.

References alpha1, and alpha2.

◆ K()

Foam::tmp< Foam::volScalarField > K ( const volScalarField alpha1,
const volScalarField alpha2 
) const

Interface curvature.

Definition at line 1206 of file multiphaseInterSystem.C.

References alpha1, alpha2, Foam::fvc::div(), and tmp< T >::ref().

Here is the call graph for this function:

◆ nearInterface() [1/2]

Foam::tmp< Foam::volScalarField > nearInterface ( const volScalarField alpha1,
const volScalarField alpha2 
) const

Near Interface of alpha1 and alpha2.

Definition at line 1219 of file multiphaseInterSystem.C.

References alpha1, alpha2, and Foam::pos().

Here is the call graph for this function:

◆ nearInterface() [2/2]

Foam::tmp< Foam::volScalarField > nearInterface ( ) const

Near Interface of alpha'n.

Definition at line 1234 of file multiphaseInterSystem.C.

References alpha1, alpha2, Foam::dimless, forAllConstIters, Time::New(), Foam::pos(), and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

◆ mesh_

const fvMesh& mesh_
protected

Reference to the mesh.

Definition at line 123 of file multiphaseInterSystem.H.

Referenced by multiphaseInterSystem::multiphaseInterSystem(), and multiphaseSystem::multiphaseSystem().

◆ mu_

volScalarField mu_
protected

Dynamic viscocity.

Definition at line 126 of file multiphaseInterSystem.H.

Referenced by multiphaseInterSystem::calcMu().

◆ phaseNames_

wordList phaseNames_
protected

Phase names.

Definition at line 129 of file multiphaseInterSystem.H.

◆ phi_

surfaceScalarField phi_
protected

Mixture total volumetric flux.

Definition at line 132 of file multiphaseInterSystem.H.

Referenced by multiphaseInterSystem::multiphaseInterSystem().

◆ rhoPhi_

surfaceScalarField rhoPhi_
protected

Mixture total mass flux.

Definition at line 135 of file multiphaseInterSystem.H.

Referenced by multiphaseInterSystem::multiphaseInterSystem().

◆ phaseModels_

phaseModelTable phaseModels_
protected

Phase models.

Definition at line 138 of file multiphaseInterSystem.H.

Referenced by multiphaseSystem::multiphaseSystem().

◆ phasePairs_

phasePairTable phasePairs_
protected

Phase pairs.

Definition at line 141 of file multiphaseInterSystem.H.

Referenced by multiphaseInterSystem::createSubModels().

◆ totalPhasePairs_

phasePairTable totalPhasePairs_
protected

Total ordered phase pairs in the system.

Definition at line 144 of file multiphaseInterSystem.H.

◆ Prt_

dimensionedScalar Prt_
protected

Turbulent Prandt number.

Definition at line 147 of file multiphaseInterSystem.H.

◆ turb_

compressibleTurbulenceModel* turb_
protected

Turbulence model.

Definition at line 150 of file multiphaseInterSystem.H.

Referenced by multiphaseInterSystem::setTurbulence(), and multiphaseInterSystem::turbulence().

◆ surfaceTensionModels_

surfaceTensionModelTable surfaceTensionModels_
protected

Surface tension models.

Definition at line 156 of file multiphaseInterSystem.H.

Referenced by multiphaseInterSystem::multiphaseInterSystem().

◆ interfacePorousModelTable_

interfacePorousModelTable interfacePorousModelTable_
protected

Interface porous models.

Definition at line 159 of file multiphaseInterSystem.H.

Referenced by multiphaseInterSystem::multiphaseInterSystem().

◆ phasePropertiesName

const Foam::word phasePropertiesName
static

Default name of the phase properties dictionary.

Definition at line 262 of file multiphaseInterSystem.H.

Referenced by wallHeatFlux::execute(), temperatureCoupledBase::kappa(), and multiphaseSystem::New().


The documentation for this class was generated from the following files: