Public Member Functions | |
TypeName ("multiphaseSystem") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, multiphaseSystem, dictionary,(const fvMesh &mesh),(mesh)) | |
multiphaseSystem (const fvMesh &) | |
Construct from fvMesh. More... | |
virtual | ~multiphaseSystem ()=default |
Destructor. More... | |
virtual void | solve () |
Solve for the phase fractions. More... | |
const UPtrList< phaseModel > & | phases () const |
Return phases. More... | |
UPtrList< phaseModel > & | phases () |
Return phases. More... | |
const phaseModel & | phase (const label i) const |
Constant access phase model i. More... | |
phaseModel & | phase (const label i) |
Access phase model i. More... | |
dimensionedScalar | ddtAlphaMax () const |
Access to ddtAlphaMax. More... | |
scalar | maxDiffNo () const |
Maximum diffusion number. More... | |
const compressionFluxTable & | limitedPhiAlphas () const |
Access to compression fluxes for phaes. More... | |
SuSpTable & | Su () |
Access Su. More... | |
SuSpTable & | Sp () |
Access Sp. More... | |
virtual bool | read () |
Read thermophysical properties dictionary. More... | |
Public Member Functions inherited from multiphaseInterSystem | |
TypeName ("multiphaseInterSystem") | |
Runtime type information. More... | |
multiphaseInterSystem (const fvMesh &mesh) | |
Construct from fvMesh. More... | |
virtual | ~multiphaseInterSystem () |
Destructor. More... | |
virtual volScalarField & | he () |
Return access to the internal energy field [J/Kg]. More... | |
virtual const volScalarField & | he () const |
Return access to the internal energy field [J/Kg]. More... | |
virtual tmp< volScalarField > | he (const volScalarField &p, const volScalarField &T) const |
Enthalpy/Internal energy. More... | |
virtual tmp< scalarField > | he (const scalarField &p, const scalarField &T, const labelList &cells) const |
Enthalpy/Internal energy for cell-set [J/kg]. More... | |
virtual tmp< scalarField > | he (const scalarField &p, const scalarField &T, const label patchi) const |
Enthalpy/Internal energy for patch [J/kg]. More... | |
virtual tmp< volScalarField > | hc () const |
Chemical enthalpy of the mixture [J/kg]. More... | |
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. More... | |
virtual tmp< scalarField > | THE (const scalarField &h, const scalarField &p, const scalarField &T0, const label patchi) const |
Temperature from enthalpy/internal energy for patch. More... | |
virtual tmp< volScalarField > | rho () const |
Return the mixture density. More... | |
virtual tmp< scalarField > | rho (const label patchi) const |
Return the mixture density on a patch. More... | |
virtual tmp< volScalarField > | Cp () const |
Return Cp of the mixture. More... | |
virtual tmp< scalarField > | Cp (const scalarField &p, const scalarField &T, const label patchi) const |
Heat capacity at constant pressure for patch [J/kg/K]. More... | |
virtual tmp< scalarField > | Cp (const scalarField &p, const scalarField &T, const labelList &cells) const |
Heat capacity using pressure and temperature. More... | |
virtual tmp< volScalarField > | Cv () const |
Return Cv of the mixture. More... | |
virtual tmp< scalarField > | Cv (const scalarField &p, const scalarField &T, const label patchI) const |
Heat capacity at constant volume for patch [J/kg/K]. More... | |
virtual tmp< scalarField > | rhoEoS (const scalarField &p, const scalarField &T, const labelList &cells) const |
Density from pressure and temperature. More... | |
virtual tmp< volScalarField > | gamma () const |
Gamma = Cp/Cv []. More... | |
virtual tmp< scalarField > | gamma (const scalarField &p, const scalarField &T, const label patchi) const |
Gamma = Cp/Cv for patch []. More... | |
virtual tmp< volScalarField > | Cpv () const |
Heat capacity at constant pressure/volume [J/kg/K]. More... | |
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]. More... | |
virtual tmp< volScalarField > | CpByCpv () const |
Heat capacity ratio []. More... | |
virtual tmp< scalarField > | CpByCpv (const scalarField &p, const scalarField &T, const label patchi) const |
Heat capacity ratio for patch []. More... | |
virtual tmp< volScalarField > | W () const |
Molecular weight [kg/kmol] of the mixture. More... | |
virtual tmp< volScalarField > | kappa () const |
Thermal diffusivity for temperature of mixture [J/m/s/K]. More... | |
virtual tmp< scalarField > | kappa (const label patchi) const |
Thermal diffusivity for temperature. More... | |
virtual tmp< volScalarField > | alphahe () const |
Thermal diffusivity for energy of mixture [kg/m/s]. More... | |
virtual tmp< scalarField > | alphahe (const label patchi) const |
Thermal diffusivity for energy of mixture for patch [kg/m/s]. More... | |
virtual tmp< volScalarField > | kappaEff (const volScalarField &kappat) const |
Effective thermal diffusivity for temperature. More... | |
virtual tmp< scalarField > | kappaEff (const scalarField &alphat, const label patchi) const |
Effective thermal diffusivity for temperature. More... | |
virtual tmp< volScalarField > | alphaEff (const volScalarField &alphat) const |
Effective thermal diffusivity of mixture [kg/m/s]. More... | |
virtual tmp< scalarField > | alphaEff (const scalarField &alphat, const label patchi) const |
Effective thermal diffusivity of mixture for patch [kg/m/s]. More... | |
const dimensionedScalar & | Prt () const |
Return Prandt number. More... | |
virtual tmp< volScalarField > | mu () const |
Dynamic viscosity of mixture [kg/m/s]. More... | |
virtual tmp< scalarField > | mu (const label patchi) const |
Dynamic viscosity of mixture for patch [kg/m/s]. More... | |
virtual tmp< volScalarField > | nu () const |
Kinematic viscosity of mixture [m^2/s]. More... | |
virtual tmp< scalarField > | nu (const label patchi) const |
Kinematic viscosity of mixture for patch [m^2/s]. More... | |
void | setTurbulence (compressibleTurbulenceModel &turb) |
Set turbulence model. More... | |
compressibleTurbulenceModel * | turbulence () const |
Return pointer to turbulence model. More... | |
tmp< volScalarField > | mut () const |
Return the turbulent dynamic viscosity. More... | |
tmp< volScalarField > | muEff () const |
Return the effective dynamic viscosity. More... | |
tmp< volScalarField > | nut () const |
Return the turbulent kinematic viscosity. More... | |
tmp< volScalarField > | nuEff () const |
Return the effective kinematic viscosity. More... | |
tmp< volScalarField > | kappaEff () const |
Effective thermal turbulent diffusivity for temperature. More... | |
tmp< scalarField > | kappaEff (const label patchi) const |
Effective thermal turbulent diffusivity for temperature. More... | |
tmp< volScalarField > | alphaEff () const |
Effective thermal turbulent diffusivity of mixture [kg/m/s]. More... | |
tmp< scalarField > | alphaEff (const label patchi) const |
Effective thermal turbulent diffusivity of mixture [kg/m/s]. More... | |
const surfaceScalarField & | phi () const |
Constant access to the total flux. More... | |
surfaceScalarField & | phi () |
Access to the total mixture flux. More... | |
const surfaceScalarField & | rhoPhi () const |
Constant access to the mixture mass flux. More... | |
surfaceScalarField & | rhoPhi () |
Access to the total mixture mass flux. More... | |
tmp< volVectorField > | U () const |
Mixture U. More... | |
tmp< surfaceScalarField > | surfaceTensionForce () const |
Calculate surface tension of the mixture. More... | |
virtual tmp< volScalarField > | surfaceTensionCoeff (const phasePairKey &key) const |
Return the surface tension coefficient. More... | |
virtual tmp< volScalarField > | coeffs (const word &key) const |
Return coefficients (1/rho) More... | |
void | addInterfacePorosity (fvVectorMatrix &UEqn) |
Add interface porosity on phasePair. More... | |
virtual tmp< volScalarField > | dmdt (const phasePairKey &key) const =0 |
Return interfacial source mass rate per phase pair. More... | |
virtual tmp< fvScalarMatrix > | heatTransfer (const volScalarField &T)=0 |
Return the heat transfer matrices. More... | |
virtual tmp< fvScalarMatrix > | volTransfer (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 phasePairTable & | totalPhasePairs () const |
Constant access the total phase pairs. More... | |
phasePairTable & | totalPhasePairs () |
Non-constant access the total phase pairs. More... | |
const phaseModelTable & | phases () const |
Constant access the phases. More... | |
phaseModelTable & | phases () |
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 fvMesh & | mesh () const |
Return mesh. More... | |
tmp< surfaceVectorField > | nHatfv (const volScalarField &alpha1, const volScalarField &alpha2) const |
Interface normal surface vector. More... | |
tmp< volVectorField > | nVolHatfv (const volScalarField &alpha1, const volScalarField &alpha2) const |
Interface normal volField vector. More... | |
tmp< surfaceScalarField > | nHatf (const volScalarField &alpha1, const volScalarField &alpha2) const |
Interface normal surface vector. More... | |
tmp< volScalarField > | K (const volScalarField &alpha1, const volScalarField &alpha2) const |
Interface curvature. More... | |
tmp< volScalarField > | nearInterface (const volScalarField &alpha1, const volScalarField &alpha2) const |
Near Interface of alpha1 and alpha2. More... | |
tmp< volScalarField > | nearInterface () 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 volScalarField & | p () |
Pressure [Pa]. More... | |
virtual const volScalarField & | p () const |
Pressure [Pa]. More... | |
virtual tmp< volScalarField > | rho () const =0 |
Density [kg/m^3]. More... | |
virtual tmp< scalarField > | rho (const label patchi) const =0 |
Density for patch [kg/m^3]. More... | |
virtual volScalarField & | he ()=0 |
Enthalpy/Internal energy [J/kg]. More... | |
virtual const volScalarField & | he () const =0 |
Enthalpy/Internal energy [J/kg]. More... | |
virtual tmp< volScalarField > | he (const volScalarField &p, const volScalarField &T) const =0 |
Enthalpy/Internal energy. More... | |
virtual tmp< scalarField > | he (const scalarField &p, const scalarField &T, const labelList &cells) const =0 |
Enthalpy/Internal energy for cell-set [J/kg]. More... | |
virtual tmp< scalarField > | he (const scalarField &p, const scalarField &T, const label patchi) const =0 |
Enthalpy/Internal energy for patch [J/kg]. More... | |
virtual tmp< volScalarField > | hc () const =0 |
Chemical enthalpy [J/kg]. More... | |
virtual tmp< scalarField > | THE (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< scalarField > | THE (const scalarField &h, const scalarField &p, const scalarField &T0, const label patchi) const =0 |
Temperature from enthalpy/internal energy for patch. More... | |
virtual const volScalarField & | T () const |
Temperature [K]. More... | |
virtual volScalarField & | T () |
Temperature [K]. More... | |
virtual tmp< volScalarField > | Cp () const =0 |
Heat capacity at constant pressure [J/kg/K]. More... | |
virtual tmp< scalarField > | Cp (const scalarField &p, const scalarField &T, const label patchi) const =0 |
Heat capacity at constant pressure for patch [J/kg/K]. More... | |
virtual tmp< scalarField > | Cp (const scalarField &p, const scalarField &T, const labelList &cells) const =0 |
Heat capacity using pressure and temperature [J/kg/K]. More... | |
virtual tmp< volScalarField > | Cv () const =0 |
Heat capacity at constant volume [J/kg/K]. More... | |
virtual tmp< scalarField > | Cv (const scalarField &p, const scalarField &T, const label patchi) const =0 |
Heat capacity at constant volume for patch [J/kg/K]. More... | |
virtual tmp< scalarField > | rhoEoS (const scalarField &p, const scalarField &T, const labelList &cells) const =0 |
Density from pressure and temperature from EoS. More... | |
virtual tmp< volScalarField > | gamma () const =0 |
Gamma = Cp/Cv []. More... | |
virtual tmp< scalarField > | gamma (const scalarField &p, const scalarField &T, const label patchi) const =0 |
Gamma = Cp/Cv for patch []. More... | |
virtual tmp< volScalarField > | Cpv () const =0 |
Heat capacity at constant pressure/volume [J/kg/K]. More... | |
virtual tmp< scalarField > | Cpv (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< volScalarField > | CpByCpv () const =0 |
Heat capacity ratio []. More... | |
virtual tmp< scalarField > | CpByCpv (const scalarField &p, const scalarField &T, const label patchi) const =0 |
Heat capacity ratio for patch []. More... | |
virtual tmp< volScalarField > | W () const =0 |
Molecular weight [kg/kmol]. More... | |
virtual const volScalarField & | alpha () const |
Thermal diffusivity for enthalpy of mixture [kg/m/s]. More... | |
virtual const scalarField & | alpha (const label patchi) const |
Thermal diffusivity for enthalpy of mixture for patch [kg/m/s]. More... | |
virtual tmp< volScalarField > | kappa () const =0 |
Thermal diffusivity for temperature of mixture [J/m/s/K]. More... | |
virtual tmp< scalarField > | kappa (const label patchi) const =0 |
Thermal diffusivity for temperature. More... | |
virtual tmp< volScalarField > | alphahe () const =0 |
Thermal diffusivity for energy of mixture [kg/m/s]. More... | |
virtual tmp< scalarField > | alphahe (const label patchi) const =0 |
Thermal diffusivity for energy of mixture for patch [kg/m/s]. More... | |
virtual tmp< volScalarField > | kappaEff (const volScalarField &) const =0 |
Effective thermal diffusivity for temperature. More... | |
virtual tmp< scalarField > | kappaEff (const scalarField &alphat, const label patchi) const =0 |
Effective thermal diffusivity for temperature. More... | |
virtual tmp< volScalarField > | alphaEff (const volScalarField &alphat) const =0 |
Effective thermal diffusivity of mixture [kg/m/s]. More... | |
virtual tmp< scalarField > | alphaEff (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 word & | name () 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 dictionary * | findMetaData () const noexcept |
Return pointer to meta-data or nullptr. More... | |
dictionary & | getMetaData () 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... | |
Istream & | readStream (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 labelList & | watchIndices () const noexcept |
Read access to file-monitoring handles. More... | |
labelList & | watchIndices () 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 ®istry, 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 ®istry, 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 ®istry, 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 ®istry) | |
Copy construct, resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Copy construct, resetting name. More... | |
IOobject (const IOobject &io, const word &name, const fileName &local) | |
Copy construct, resetting name and local component. More... | |
IOobject (const IOobject &io, readOption rOpt, writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
const objectRegistry & | db () const noexcept |
Return the local objectRegistry. More... | |
const Time & | time () const |
Return Time associated with the objectRegistry. More... | |
const word & | name () const noexcept |
Return the object name. More... | |
const word & | headerClassName () const noexcept |
Return name of the class name read from header. More... | |
word & | headerClassName () noexcept |
Return non-constant access to the class name read from header. More... | |
const string & | note () const noexcept |
Return the optional note. More... | |
string & | note () noexcept |
Modifiable access to the optional note. More... | |
virtual void | rename (const word &newName) |
Rename the object. More... | |
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 dictionary * | findMetaData () 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 fileName & | rootPath () const |
Return the Time::rootPath() More... | |
const fileName & | caseName () const |
Return the Time::caseName() More... | |
const fileName & | instance () const noexcept |
Read access to instance path component. More... | |
fileName & | instance () noexcept |
Write access to instance path component. More... | |
const fileName & | local () const noexcept |
Read access to local path component. More... | |
fileName | path () const |
The complete path. 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< IOobject > | info () 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... | |
readOption & | readOpt () noexcept |
Access to the read option. More... | |
writeOption & | writeOpt () noexcept |
Access to the write option. More... | |
bool & | registerObject () noexcept |
Access to the register object option. More... | |
bool & | globalObject () noexcept |
Access to the global object option. More... | |
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< dictionary > | clone () const |
Construct and return clone. More... | |
virtual | ~dictionary () |
Destructor. More... | |
const fileName & | name () const noexcept |
The dictionary name. More... | |
fileName & | name () 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 dictionary & | parent () const noexcept |
Return the parent dictionary. More... | |
const dictionary & | topDict () 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... | |
entry * | findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
Find for an entry (non-const access) with the given keyword. More... | |
const entry * | findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Find an entry (const access) with the given keyword. More... | |
const entry * | findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Search for a scoped entry (const access) with the given keyword. More... | |
dictionary * | findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
Find and return a sub-dictionary pointer if present. More... | |
const dictionary * | findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Find and return a sub-dictionary pointer if present. More... | |
const entry & | lookupEntry (const word &keyword, enum keyType::option matchOpt) const |
Search for an entry (const access) with the given keyword. More... | |
ITstream & | lookup (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 dictionary & | subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Find and return a sub-dictionary. More... | |
dictionary & | subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
Find and return a sub-dictionary for manipulation. More... | |
dictionary & | subDictOrAdd (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 dictionary & | optionalSubDict (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< keyType > | keys (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... | |
entry * | add (entry *entryPtr, bool mergeEntry=false) |
Add a new entry. More... | |
entry * | add (const entry &e, bool mergeEntry=false) |
Add an entry. More... | |
entry * | add (const keyType &k, const word &v, bool overwrite=false) |
Add a word entry. More... | |
entry * | add (const keyType &k, const string &v, bool overwrite=false) |
Add a string entry. More... | |
entry * | add (const keyType &k, const label v, bool overwrite=false) |
Add a label entry. More... | |
entry * | add (const keyType &k, const scalar v, bool overwrite=false) |
Add a scalar entry. More... | |
entry * | add (const keyType &k, const dictionary &d, bool mergeEntry=false) |
Add a dictionary entry. More... | |
template<class T > | |
entry * | add (const keyType &k, const T &v, bool overwrite=false) |
Add a T entry. More... | |
entry * | set (entry *entryPtr) |
Assign a new entry, overwriting any existing entry. More... | |
entry * | set (const entry &e) |
Assign a new entry, overwriting any existing entry. More... | |
entry * | set (const keyType &k, const dictionary &v) |
Assign a dictionary entry, overwriting any existing entry. More... | |
template<class T > | |
entry * | set (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 dictionary * | cfindScopedDict (const fileName &dictPath) const |
Locate a sub-dictionary using slash-scoping. More... | |
const dictionary * | findScopedDict (const fileName &dictPath) const |
Locate a sub-dictionary using slash-scoping. More... | |
dictionary * | findScopedDict (const fileName &dictPath) |
Locate a sub-dictionary using slash-scoping. More... | |
dictionary * | makeScopedDict (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 entry * | findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt) const |
const entry & | lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt) const |
ITstream & | lookupCompat (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 |
ITstream & | operator[] (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... | |
entry * | lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) |
Deprecated(2018-10) More... | |
const entry * | lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const |
Deprecated(2018-10) More... | |
const entry * | lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const |
Deprecated(2018-10) More... | |
const dictionary * | subDictPtr (const word &keyword) const |
Deprecated(2018-10) More... | |
dictionary * | subDictPtr (const word &keyword) |
const entry & | lookupEntry (const word &keyword, bool recursive, bool patternMatch) const |
Deprecated(2018-10) More... | |
ITstream & | lookup (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::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< 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... | |
T * | first () |
The first entry in the list. More... | |
const T * | first () const |
The first entry in the list (const access) More... | |
T * | last () |
The last entry in the list. More... | |
const T * | last () const |
The last entry in the list (const access) More... | |
T * | removeHead () |
Remove and return head. More... | |
T * | remove (T *item) |
Remove and return element. More... | |
T * | remove (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... | |
Ostream & | writeList (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 iterator & | end () |
End of list for forward iterators. More... | |
const const_iterator & | cend () const |
End of list for forward iterators. More... | |
const reverse_iterator & | rend () |
End of list for reverse iterators. More... | |
const const_reverse_iterator & | crend () const |
End of list for reverse iterators. More... | |
const const_iterator & | end () const |
End of list for forward iterators. More... | |
const const_reverse_iterator & | rend () 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< volScalarField > | mu () const =0 |
Return the dynamic laminar viscosity. More... | |
virtual tmp< scalarField > | mu (const label patchi) const =0 |
Return the dynamic laminar viscosity for patch. More... | |
virtual tmp< volScalarField > | nu () const =0 |
Return the laminar viscosity. More... | |
virtual tmp< scalarField > | nu (const label patchi) const =0 |
Return the laminar viscosity for patch. More... | |
Static Public Member Functions | |
static autoPtr< multiphaseSystem > | New (const fvMesh &mesh) |
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< basicThermo > | New (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 basicThermo & | lookupThermo (const fvPatchScalarField &pf) |
static Ostream & | printThermoNames (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 Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
static Ostream & | writeDivider (Ostream &os) |
Write the standard file section divider. More... | |
static Ostream & | writeEndDivider (Ostream &os) |
Write the standard end file divider. More... | |
Static Public Member Functions inherited from 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< dictionary > | New (Istream &is) |
Construct top-level dictionary on freestore from Istream. More... | |
Protected Types | |
typedef HashTable< volScalarField::Internal > | SuSpTable |
typedef HashTable< scalar, phasePairKey, phasePairKey::hash > | scalarTable |
typedef HashTable< surfaceScalarField > | compressionFluxTable |
Protected Types inherited from multiphaseInterSystem | |
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 | calculateSuSp () |
Calculate Sp and Su. More... | |
void | solveAlphas () |
Solve alphas. More... | |
Protected Member Functions inherited from multiphaseInterSystem | |
void | calcMu () |
Calculate and return the laminar viscosity. More... | |
HashTable< autoPtr< multiphaseInter::phaseModel > > | generatePhaseModels (const wordList &names) const |
Generate the phases. More... | |
tmp< surfaceScalarField > | generatePhi (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 | |
UPtrList< phaseModel > | phases_ |
Unallocated phase list. More... | |
scalarTable | cAlphas_ |
Table for compression factors between phases. More... | |
dimensionedScalar | ddtAlphaMax_ |
Maximum volumen rate change. More... | |
compressionFluxTable | limitedPhiAlphas_ |
Compression fluxed for phases. More... | |
SuSpTable | Su_ |
Su phase source terms. More... | |
SuSpTable | Sp_ |
Sp phase source terms. More... | |
Protected Attributes inherited from multiphaseInterSystem | |
const fvMesh & | mesh_ |
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... | |
compressibleTurbulenceModel * | turb_ |
Turbulence model. More... | |
surfaceTensionModelTable | surfaceTensionModels_ |
Surface tension models. More... | |
interfacePorousModelTable | interfacePorousModelTable_ |
Interface porous models. More... | |
Protected Attributes inherited from basicThermo | |
const word & | phaseName_ |
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... | |
volScalarField & | p_ |
Pressure [Pa]. More... | |
volScalarField & | T_ |
Temperature [K]. More... | |
volScalarField | alpha_ |
Laminar thermal diffusivity [kg/m/s]. More... | |
Additional Inherited Members | |
Public Types inherited from multiphaseInterSystem | |
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 | 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 T * | pointer |
Pointer for value_type. More... | |
typedef const T * | const_pointer |
Const pointer for value_type. More... | |
typedef T & | reference |
Reference for value_type. More... | |
typedef const T & | const_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 Attributes inherited from dictionary | |
friend | const_searcher |
Declare friendship with the searcher classes. More... | |
friend | searcher |
Static Public Attributes inherited from multiphaseInterSystem | |
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< fileCheckTypes > | fileCheckTypesNames |
Names for the fileCheckTypes. More... | |
static char | scopeSeparator |
Character for scoping object names (':' or '_') More... | |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
static float | fileModificationSkew |
Time skew (seconds) for file modification checks. More... | |
static int | maxFileModificationPolls |
Max number of times to poll for file modification changes. More... | |
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< OSstream > | reportingOutput |
Output location when reporting default values. More... | |
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... | |
Definition at line 53 of file multiphaseSystem.H.
|
protected |
Definition at line 59 of file multiphaseSystem.H.
|
protected |
Definition at line 62 of file multiphaseSystem.H.
|
protected |
Definition at line 64 of file multiphaseSystem.H.
multiphaseSystem | ( | const fvMesh & | mesh | ) |
Construct from fvMesh.
Definition at line 60 of file multiphaseSystem.C.
References multiphaseSystem::cAlphas_, Foam::dimless, Foam::dimTime, forAllConstIters, forAllIters, HashTable< T, Key, Hash >::insert(), multiphaseInterSystem::mesh(), multiphaseInterSystem::mesh_, phaseModel::name(), phasei, multiphaseInterSystem::phaseModels_, multiphaseSystem::phases_, dictionary::readEntry(), UPtrList< T >::set(), UPtrList< T >::setSize(), HashTable< T, Key, Hash >::size(), solution::solverDict(), multiphaseSystem::Sp_, multiphaseSystem::Su_, fvMesh::time(), Time::timeName(), and Foam::Zero.
|
virtualdefault |
Destructor.
|
protected |
Calculate Sp and Su.
Definition at line 124 of file multiphaseSystem.C.
|
protected |
Solve alphas.
Definition at line 172 of file multiphaseSystem.C.
References alpha, alpha1, alpha2, alphaControls, GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), fvMatrix< Type >::boundaryManipulate(), fvsPatchField< Type >::coupled(), Foam::dimless, Foam::dimMass, Foam::dimTime, Foam::endl(), Foam::exit(), Foam::MULES::explicitSolve(), Foam::FatalError, FatalErrorInFunction, fvMatrix< Type >::flux(), Foam::fvc::flux(), forAll, Foam::Info, Foam::fvc::interpolate(), Foam::MULES::limit(), Foam::MULES::limitSum(), Foam::mag(), Foam::max(), Foam::min(), nAlphaCorr(), phase::name(), phaseModel::name(), phase1, phase2, phasei, phi, phic(), phicBf, phir(), phase::rho(), PtrList< T >::set(), fvMatrix< Type >::solve(), Sp, Foam::fvm::Sp(), Su, DimensionedField< Type, GeoMesh >::weightedAverage(), and Foam::Zero.
TypeName | ( | "multiphaseSystem" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
multiphaseSystem | , | ||
dictionary | , | ||
(const fvMesh &mesh) | , | ||
(mesh) | |||
) |
|
static |
Definition at line 33 of file multiphaseSystemNew.C.
References TimePaths::constant(), dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), Foam::Info, multiphaseInterSystem::mesh(), IOobject::MUST_READ_IF_MODIFIED, IOobject::NO_WRITE, multiphaseInterSystem::phasePropertiesName, and fvMesh::time().
|
virtual |
Solve for the phase fractions.
Implements multiphaseInterSystem.
Definition at line 130 of file multiphaseSystem.C.
References alpha, alphaControls, nAlphaSubCycles(), and Foam::Zero.
const Foam::UPtrList< Foam::multiphaseInter::phaseModel > & phases | ( | ) | const |
Return phases.
Definition at line 437 of file multiphaseSystem.C.
Foam::UPtrList< Foam::multiphaseInter::phaseModel > & phases | ( | ) |
Return phases.
Definition at line 444 of file multiphaseSystem.C.
const Foam::multiphaseInter::phaseModel & phase | ( | const label | i | ) | const |
Constant access phase model i.
Definition at line 451 of file multiphaseSystem.C.
Foam::multiphaseInter::phaseModel & phase | ( | const label | i | ) |
Access phase model i.
Definition at line 458 of file multiphaseSystem.C.
Foam::dimensionedScalar ddtAlphaMax | ( | ) | const |
Access to ddtAlphaMax.
Definition at line 465 of file multiphaseSystem.C.
Foam::scalar maxDiffNo | ( | ) | const |
Maximum diffusion number.
Definition at line 472 of file multiphaseSystem.C.
References Foam::max().
const Foam::multiphaseInter::multiphaseSystem::compressionFluxTable & limitedPhiAlphas | ( | ) | const |
Access to compression fluxes for phaes.
Definition at line 488 of file multiphaseSystem.C.
Access Su.
Definition at line 495 of file multiphaseSystem.C.
Access Sp.
Definition at line 502 of file multiphaseSystem.C.
|
virtual |
Read thermophysical properties dictionary.
Reimplemented from multiphaseInterSystem.
Definition at line 508 of file multiphaseSystem.C.
|
protected |
Unallocated phase list.
Definition at line 70 of file multiphaseSystem.H.
Referenced by multiphaseSystem::multiphaseSystem().
|
protected |
Table for compression factors between phases.
Definition at line 73 of file multiphaseSystem.H.
Referenced by multiphaseSystem::multiphaseSystem().
|
protected |
Maximum volumen rate change.
Definition at line 76 of file multiphaseSystem.H.
|
protected |
Compression fluxed for phases.
Definition at line 79 of file multiphaseSystem.H.
|
protected |
Su phase source terms.
Definition at line 82 of file multiphaseSystem.H.
Referenced by multiphaseSystem::multiphaseSystem().
|
protected |
Sp phase source terms.
Definition at line 85 of file multiphaseSystem.H.
Referenced by multiphaseSystem::multiphaseSystem().