twoPhaseSystem Class Referenceabstract

Class which solves the volume fraction equations for two phases. More...

Inheritance diagram for twoPhaseSystem:
[legend]
Collaboration diagram for twoPhaseSystem:
[legend]

Public Member Functions

 TypeName ("twoPhaseSystem")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, twoPhaseSystem, dictionary,(const fvMesh &mesh),(mesh))
 
 twoPhaseSystem (const fvMesh &)
 Construct from fvMesh. More...
 
virtual ~twoPhaseSystem ()
 Destructor. More...
 
const phaseModelphase1 () const
 Return phase model 1. More...
 
phaseModelphase1 ()
 Access phase model 1. More...
 
const phaseModelphase2 () const
 Return phase model 2. More...
 
phaseModelphase2 ()
 Access phase model 2. More...
 
const phaseModelotherPhase (const phaseModel &phase) const
 Return the phase not given as an argument. More...
 
tmp< volScalarFieldsigma () const
 Return the surface tension coefficient. More...
 
tmp< volScalarFieldKd () const
 Return the drag coefficient. More...
 
tmp< surfaceScalarFieldKdf () const
 Return the face drag coefficient. More...
 
tmp< volScalarFieldVm () const
 Return the virtual mass coefficient. More...
 
virtual void solve ()
 Solve for the phase fractions. More...
 
 twoPhaseSystem (const fvMesh &, const dimensionedVector &g)
 Construct from fvMesh. More...
 
virtual ~twoPhaseSystem ()
 Destructor. More...
 
tmp< volScalarFieldrho () const
 Return the mixture density. More...
 
tmp< volVectorFieldU () const
 Return the mixture velocity. More...
 
tmp< volScalarFieldKd () const
 Return the drag coefficient. More...
 
tmp< surfaceScalarFieldKdf () const
 Return the face drag coefficient. More...
 
tmp< volScalarFieldVm () const
 Return the virtual mass coefficient. More...
 
tmp< surfaceScalarFieldVmf () const
 Return the face virtual mass coefficient. More...
 
tmp< volScalarFieldKh () const
 Return the heat transfer coefficient. More...
 
tmp< volVectorFieldF () const
 Return the combined force (lift + wall-lubrication) More...
 
tmp< surfaceScalarFieldFf () const
 Return the combined face-force (lift + wall-lubrication) More...
 
tmp< volScalarFieldD () const
 Return the turbulent diffusivity. More...
 
void solve ()
 Solve for the two-phase-fractions. More...
 
void correct ()
 Correct two-phase properties other than turbulence. More...
 
void correctTurbulence ()
 Correct two-phase turbulence. More...
 
bool read ()
 Read base phaseProperties dictionary. 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 phaseModel &dispersed, const phaseModel &continuous) const
 Access a sub model between two phases. More...
 
const dimensionedScalarsigma () const
 Return the surface tension coefficient. More...
 
const fvMeshmesh () const
 Return the mesh. More...
 
const phaseModelphase1 () const
 Return phase model 1. More...
 
phaseModelphase1 ()
 Return non-const access to phase model 1. More...
 
const phaseModelphase2 () const
 Return phase model 2. More...
 
phaseModelphase2 ()
 Return non-const access to phase model 2. More...
 
const phaseModelotherPhase (const phaseModel &phase) const
 Return the phase not given as an argument. More...
 
const surfaceScalarFieldphi () const
 Return the mixture flux. More...
 
surfaceScalarFieldphi ()
 Return non-const access to the mixture flux. More...
 
const volScalarFielddgdt () const
 Return the dilatation term. More...
 
volScalarFielddgdt ()
 Return non-const access to the dilatation parameter. More...
 
tmp< surfaceScalarField > & pPrimeByA ()
 Return non-const access to the dispersion diffusivity. More...
 
template<>
const dragModellookupSubModel (const phaseModel &dispersed, const phaseModel &continuous) const
 
template<>
const virtualMassModellookupSubModel (const phaseModel &dispersed, const phaseModel &continuous) const
 
tmp< volScalarFieldsigma (const phasePairKey &key) const
 Return the surface tension coefficient for a pair. More...
 
virtual PtrList< volScalarFielddmdts () const
 Return the mass transfer rates for each phase. More...
 
- Public Member Functions inherited from phaseSystem
 TypeName ("phaseSystem")
 Runtime type information. More...
 
 phaseSystem (const fvMesh &mesh)
 Construct from fvMesh. More...
 
virtual ~phaseSystem ()
 Destructor. More...
 
const fvMeshmesh () const
 Return the mesh. More...
 
const phaseModelListphases () const
 Return the phase models. More...
 
phaseModelListphases ()
 Access the phase models. More...
 
const phaseModelPartialListmovingPhases () const
 Return the models for phases that are moving. More...
 
phaseModelPartialListmovingPhases ()
 Access the models for phases that are moving. More...
 
const phaseModelPartialListstationaryPhases () const
 Return the models for phases that are stationary. More...
 
phaseModelPartialListstationaryPhases ()
 Access the models for phases that are stationary. More...
 
const phaseModelPartialListanisothermalPhases () const
 Return the models for phases that have variable temperature. More...
 
phaseModelPartialListanisothermalPhases ()
 Access the models for phases that have variable temperature. More...
 
const phaseModelPartialListmultiComponentPhases () const
 Return the models for phases that have multiple species. More...
 
phaseModelPartialListmultiComponentPhases ()
 Access the models for phases that have multiple species. More...
 
const phasePairTablephasePairs () const
 Return the phase pairs. More...
 
const surfaceScalarFieldphi () const
 Return the mixture flux. More...
 
surfaceScalarFieldphi ()
 Access the mixture flux. More...
 
const volScalarFielddpdt () const
 Return the rate of change of the pressure. More...
 
volScalarFielddpdt ()
 Access the rate of change of the pressure. More...
 
const IOMRFZoneListMRF () const
 Return MRF zones. More...
 
fv::optionsfvOptions () const
 Access the fvOptions. More...
 
template<class modelType >
bool foundSubModel (const phasePair &key) const
 Check availability of a sub model for a given phase pair. More...
 
template<class modelType >
const modelType & lookupSubModel (const phasePair &key) const
 Return a sub model between a phase pair. More...
 
template<class modelType >
bool foundSubModel (const phaseModel &dispersed, const phaseModel &continuous) const
 Check availability of a sub model between two phases. More...
 
template<class modelType >
const modelType & lookupSubModel (const phaseModel &dispersed, const phaseModel &continuous) const
 Return a sub model between two phases. More...
 
template<class modelType >
bool foundBlendedSubModel (const phasePair &key) const
 Check availability of a blended sub model for a given phase pair. More...
 
template<class modelType >
const BlendedInterfacialModel< modelType > & lookupBlendedSubModel (const phasePair &key) const
 Return a blended sub model between a phase pair. More...
 
template<class Type , template< class > class PatchField, class GeoMesh >
void fillFields (const word &name, const dimensionSet &dims, PtrList< GeometricField< Type, PatchField, GeoMesh > > &fieldList) const
 Fill up gaps in a phase-indexed list of fields with zeros. More...
 
template<class Type , template< class > class PatchField, class GeoMesh >
void fillFields (const word &name, const dimensionSet &dims, HashPtrTable< GeometricField< Type, PatchField, GeoMesh > > &fieldTable) const
 Fill up gaps in a phase-indexed table of fields with zeros. More...
 
tmp< volScalarFieldrho () const
 Return the mixture density. More...
 
tmp< volVectorFieldU () const
 Return the mixture velocity. More...
 
tmp< volScalarFieldE (const phasePairKey &key) const
 Return the aspect-ratio for a pair. More...
 
tmp< volScalarFieldsigma (const phasePairKey &key) const
 Return the surface tension coefficient for a pair. More...
 
virtual tmp< volScalarFielddmdt (const phasePairKey &key) const
 Return the mass transfer rate for a pair. More...
 
virtual PtrList< volScalarFielddmdts () const
 Return the mass transfer rates for each phase. More...
 
virtual autoPtr< momentumTransferTablemomentumTransfer ()=0
 Return the momentum transfer matrices for the cell-based. More...
 
virtual autoPtr< momentumTransferTablemomentumTransferf ()=0
 Return the momentum transfer matrices for the face-based. More...
 
virtual PtrList< surfaceScalarFieldAFfs () const =0
 Return the implicit force coefficients for the face-based. More...
 
virtual PtrList< surfaceScalarFieldphiFs (const PtrList< volScalarField > &rAUs)=0
 Return the force fluxes for the cell-based algorithm. More...
 
virtual PtrList< surfaceScalarFieldphiFfs (const PtrList< surfaceScalarField > &rAUfs)=0
 Return the force fluxes for the face-based algorithm. More...
 
virtual PtrList< surfaceScalarFieldphiKdPhis (const PtrList< volScalarField > &rAUs) const =0
 Return the force fluxes for the cell-based algorithm. More...
 
virtual PtrList< surfaceScalarFieldphiKdPhifs (const PtrList< surfaceScalarField > &rAUfs) const =0
 Return the force fluxes for the face-based algorithm. More...
 
virtual PtrList< volVectorFieldKdUByAs (const PtrList< volScalarField > &rAUs) const =0
 Return the explicit part of the drag force. More...
 
virtual void partialElimination (const PtrList< volScalarField > &rAUs)=0
 Solve the drag system for the new velocities and fluxes. More...
 
virtual void partialEliminationf (const PtrList< surfaceScalarField > &rAUfs)=0
 Solve the drag system for the new fluxes. More...
 
virtual PtrList< surfaceScalarFieldddtCorrByAs (const PtrList< volScalarField > &rAUs, const bool includeVirtualMass=false) const =0
 Return the flux corrections for the cell-based algorithm. More...
 
virtual const HashPtrTable< surfaceScalarField > & DByAfs () const =0
 Return the phase diffusivities divided by the momentum. More...
 
virtual autoPtr< heatTransferTableheatTransfer () const =0
 Return the heat transfer matrices. More...
 
virtual autoPtr< massTransferTablemassTransfer () const =0
 Return the mass transfer matrices. More...
 
virtual void solve ()
 Solve for the phase fractions. More...
 
virtual void correct ()
 Correct the fluid properties other than those listed below. More...
 
virtual void correctKinematics ()
 Correct the kinematics. More...
 
virtual void correctThermo ()
 Correct the thermodynamics. More...
 
virtual void correctTurbulence ()
 Correct the turbulence. More...
 
virtual void correctEnergyTransport ()
 Correct the energy transport e.g. alphat. More...
 
virtual bool read ()
 Read base phaseProperties dictionary. More...
 
template<class modelType >
const Foam::BlendedInterfacialModel< modelType > & lookupBlendedSubModel (const phasePair &key) const
 
- Public Member Functions inherited from IOdictionary
 IOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 
 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...
 

Static Public Member Functions

static autoPtr< twoPhaseSystemNew (const fvMesh &mesh)
 
- 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...
 

Protected Attributes

phaseModelphase1_
 Phase model 1. More...
 
phaseModelphase2_
 Phase model 2. More...
 
- Protected Attributes inherited from phaseSystem
const fvMeshmesh_
 Reference to the mesh. More...
 
phaseModelList phaseModels_
 Phase models. More...
 
phaseModelPartialList movingPhaseModels_
 Moving phase models. More...
 
phaseModelPartialList stationaryPhaseModels_
 Stationary phase models. More...
 
phaseModelPartialList anisothermalPhaseModels_
 Anisothermal phase models. More...
 
phaseModelPartialList multiComponentPhaseModels_
 Multi-component phase models. More...
 
phasePairTable phasePairs_
 Phase pairs. More...
 
surfaceScalarField phi_
 Total volumetric flux. More...
 
volScalarField dpdt_
 Rate of change of pressure. More...
 
IOMRFZoneList MRF_
 Optional MRF zones. More...
 
blendingMethodTable blendingMethods_
 Blending methods. More...
 
surfaceTensionModelTable surfaceTensionModels_
 Surface tension models. More...
 
aspectRatioModelTable aspectRatioModels_
 Aspect ratio models. More...
 

Static Protected Attributes

static const bool fillFields_ = true
 Flag to indicate that returned lists of fields are "complete"; i.e.,. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Additional Inherited Members

- Public Types inherited from phaseSystem
typedef HashPtrTable< fvVectorMatrixmomentumTransferTable
 
typedef HashPtrTable< fvScalarMatrixheatTransferTable
 
typedef HashPtrTable< fvScalarMatrixmassTransferTable
 
typedef PtrListDictionary< phaseModelphaseModelList
 
typedef UPtrList< phaseModelphaseModelPartialList
 
typedef HashTable< autoPtr< phasePair >, phasePairKey, phasePairKey::hashphasePairTable
 
- 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 Attributes inherited from dictionary
friend const_searcher
 Declare friendship with the searcher classes. More...
 
friend searcher
 
- Static Public Attributes inherited from phaseSystem
static const word propertiesName
 Default name of the phase properties dictionary. More...
 
- 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 inherited from phaseSystem
typedef HashTable< dictionary, phasePairKey, phasePairKey::hashdictTable
 
typedef HashTable< autoPtr< blendingMethod > > blendingMethodTable
 
typedef HashTable< autoPtr< reactingMultiphaseEuler::surfaceTensionModel >, phasePairKey, phasePairKey::hashsurfaceTensionModelTable
 
typedef HashTable< autoPtr< aspectRatioModel >, phasePairKey, phasePairKey::hashaspectRatioModelTable
 
- Protected Member Functions inherited from phaseSystem
tmp< surfaceScalarFieldcalcPhi (const phaseModelList &phaseModels) const
 Calculate and return the mixture flux. More...
 
void generatePairs (const dictTable &modelDicts)
 Generate pairs. More...
 
template<class modelType >
void createSubModels (const dictTable &modelDicts, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models)
 Generate pairs and sub-model tables. 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, HashTable< autoPtr< BlendedInterfacialModel< modelType > >, phasePairKey, phasePairKey::hash > &models, const bool correctFixedFluxBCs=true)
 Generate pairs and blended sub-model tables. More...
 
template<class modelType >
void generatePairsAndSubModels (const word &modelName, HashTable< Pair< autoPtr< modelType > >, phasePairKey, phasePairKey::hash > &models, const bool correctFixedFluxBCs=true)
 Generate pairs and two-sided sub-model tables. More...
 
template<class GeoField >
void addField (const phaseModel &phase, const word &fieldName, tmp< GeoField > field, PtrList< GeoField > &fieldList) const
 Add the field to a phase-indexed list, with the given name,. More...
 
template<class GeoField >
void addField (const phaseModel &phase, const word &fieldName, const GeoField &field, PtrList< GeoField > &fieldList) const
 Add the field to a phase-indexed list, with the given name,. More...
 
template<class GeoField >
void addField (const phaseModel &phase, const word &fieldName, tmp< GeoField > field, HashPtrTable< GeoField > &fieldTable) const
 Add the field to a phase-indexed table, with the given name,. More...
 
template<class GeoField >
void addField (const phaseModel &phase, const word &fieldName, const GeoField &field, HashPtrTable< GeoField > &fieldTable) const
 Add the field to a phase-indexed table, with the given name,. 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...
 
- 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)
 

Detailed Description

Class which solves the volume fraction equations for two phases.

Source files

Source files

Definition at line 53 of file twoPhaseSystem.H.

Constructor & Destructor Documentation

◆ twoPhaseSystem() [1/2]

twoPhaseSystem ( const fvMesh mesh)

Construct from fvMesh.

Definition at line 58 of file twoPhaseSystem.C.

References alpha1, twoPhaseSystem::mesh(), IOobject::name(), twoPhaseSystem::phase1_, twoPhaseSystem::phase2_, and schemesLookup::setFluxRequired().

Here is the call graph for this function:

◆ ~twoPhaseSystem() [1/2]

~twoPhaseSystem ( )
virtual

Destructor.

Definition at line 76 of file twoPhaseSystem.C.

◆ twoPhaseSystem() [2/2]

twoPhaseSystem ( const fvMesh mesh,
const dimensionedVector g 
)

Construct from fvMesh.

Definition at line 55 of file twoPhaseSystem.C.

References dict, dictionary::dictName(), Foam::dimless, Foam::dimTime, forAllConstIter, HashTable< T, Key, Hash >::found(), g, HashTable< T, Key, Hash >::insert(), Time::New(), twoPhaseSystem::phase1_, twoPhaseSystem::phase2_, and dictionary::subDict().

Here is the call graph for this function:

◆ ~twoPhaseSystem() [2/2]

virtual ~twoPhaseSystem ( )
virtual

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "twoPhaseSystem"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
twoPhaseSystem  ,
dictionary  ,
(const fvMesh &mesh ,
(mesh  
)

◆ New()

Foam::autoPtr< Foam::twoPhaseSystem > New ( const fvMesh mesh)
static

Definition at line 34 of file twoPhaseSystemNew.C.

References TimePaths::constant(), dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), Foam::Info, twoPhaseSystem::mesh(), IOobject::MUST_READ_IF_MODIFIED, IOobject::NO_WRITE, phaseSystem::propertiesName, and fvMesh::time().

Here is the call graph for this function:

◆ phase1() [1/4]

const Foam::phaseModel & phase1 ( ) const
inline

Return phase model 1.

Definition at line 30 of file twoPhaseSystemI.H.

References twoPhaseSystem::phase1_.

Referenced by JohnsonJacksonParticleSlipFvPatchVectorField::updateCoeffs(), and JohnsonJacksonParticleThetaFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ phase1() [2/4]

Foam::phaseModel & phase1 ( )
inline

Access phase model 1.

Definition at line 36 of file twoPhaseSystemI.H.

◆ phase2() [1/4]

const Foam::phaseModel & phase2 ( ) const
inline

Return phase model 2.

Definition at line 42 of file twoPhaseSystemI.H.

Referenced by JohnsonJacksonParticleSlipFvPatchVectorField::updateCoeffs(), and JohnsonJacksonParticleThetaFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ phase2() [2/4]

Foam::phaseModel & phase2 ( )
inline

Access phase model 2.

Definition at line 48 of file twoPhaseSystemI.H.

◆ otherPhase() [1/2]

const Foam::phaseModel & otherPhase ( const phaseModel phase) const
inline

Return the phase not given as an argument.

Definition at line 54 of file twoPhaseSystemI.H.

Referenced by IATEsource::otherPhase().

Here is the caller graph for this function:

◆ sigma() [1/3]

const Foam::dimensionedScalar & sigma ( ) const

Return the surface tension coefficient.

Definition at line 83 of file twoPhaseSystem.C.

References Foam::name(), phase1, and phase2.

Here is the call graph for this function:

◆ Kd() [1/2]

Return the drag coefficient.

Definition at line 93 of file twoPhaseSystem.C.

References Kd(), Foam::name(), phase1, and phase2.

Here is the call graph for this function:

◆ Kdf() [1/2]

Return the face drag coefficient.

Definition at line 103 of file twoPhaseSystem.C.

References Kdf(), Foam::name(), phase1, and phase2.

Here is the call graph for this function:

◆ Vm() [1/2]

Return the virtual mass coefficient.

Definition at line 113 of file twoPhaseSystem.C.

References Foam::name(), phase1, and phase2.

Here is the call graph for this function:

◆ solve() [1/2]

◆ rho()

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

Return the mixture density.

Definition at line 284 of file twoPhaseSystem.C.

◆ U()

Return the mixture velocity.

Definition at line 290 of file twoPhaseSystem.C.

◆ Kd() [2/2]

tmp< volScalarField > Kd ( ) const

Return the drag coefficient.

◆ Kdf() [2/2]

tmp< surfaceScalarField > Kdf ( ) const

Return the face drag coefficient.

◆ Vm() [2/2]

tmp< volScalarField > Vm ( ) const

Return the virtual mass coefficient.

◆ Vmf()

Return the face virtual mass coefficient.

Definition at line 322 of file twoPhaseSystem.C.

◆ Kh()

Return the heat transfer coefficient.

Definition at line 328 of file twoPhaseSystem.C.

◆ F()

Return the combined force (lift + wall-lubrication)

Definition at line 334 of file twoPhaseSystem.C.

◆ Ff()

Return the combined face-force (lift + wall-lubrication)

Definition at line 340 of file twoPhaseSystem.C.

◆ D()

Return the turbulent diffusivity.

Multiplies the phase-fraction gradient

Definition at line 346 of file twoPhaseSystem.C.

◆ solve() [2/2]

void solve ( )
virtual

Solve for the two-phase-fractions.

Reimplemented from phaseSystem.

◆ correct()

void correct ( )
virtual

Correct two-phase properties other than turbulence.

Reimplemented from phaseSystem.

Definition at line 541 of file twoPhaseSystem.C.

◆ correctTurbulence()

void correctTurbulence ( )
virtual

Correct two-phase turbulence.

Reimplemented from phaseSystem.

Definition at line 548 of file twoPhaseSystem.C.

◆ read()

bool read ( )
virtual

Read base phaseProperties dictionary.

Reimplemented from phaseSystem.

Definition at line 555 of file twoPhaseSystem.C.

References regIOobject::read().

Here is the call graph for this function:

◆ lookupSubModel() [1/4]

const modelType & lookupSubModel ( const phasePair key) const

Access a sub model between a phase pair.

Definition at line 40 of file twoPhaseSystemTemplates.C.

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

Here is the call graph for this function:

◆ lookupSubModel() [2/4]

const modelType & lookupSubModel ( const phaseModel dispersed,
const phaseModel continuous 
) const

Access a sub model between two phases.

◆ sigma() [2/3]

const dimensionedScalar & sigma ( ) const

Return the surface tension coefficient.

◆ mesh()

const Foam::fvMesh & mesh ( ) const
inline

Return the mesh.

Definition at line 30 of file twoPhaseSystemI.H.

Referenced by twoPhaseSystem::lookupSubModel(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::MultiComponentPhaseModel(), twoPhaseSystem::New(), PurePhaseModel< BasePhaseModel, phaseThermo >::PurePhaseModel(), and twoPhaseSystem::twoPhaseSystem().

Here is the caller graph for this function:

◆ phase1() [3/4]

const phaseModel & phase1 ( ) const
inline

Return phase model 1.

◆ phase1() [4/4]

phaseModel & phase1 ( )
inline

Return non-const access to phase model 1.

◆ phase2() [3/4]

const phaseModel & phase2 ( ) const
inline

Return phase model 2.

◆ phase2() [4/4]

phaseModel & phase2 ( )
inline

Return non-const access to phase model 2.

◆ otherPhase() [2/2]

const phaseModel & otherPhase ( const phaseModel phase) const
inline

Return the phase not given as an argument.

◆ phi() [1/2]

const Foam::surfaceScalarField & phi ( ) const
inline

Return the mixture flux.

Definition at line 76 of file twoPhaseSystemI.H.

Referenced by MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi().

Here is the caller graph for this function:

◆ phi() [2/2]

Foam::surfaceScalarField & phi ( )
inline

Return non-const access to the mixture flux.

Definition at line 82 of file twoPhaseSystemI.H.

◆ dgdt() [1/2]

const Foam::volScalarField & dgdt ( ) const
inline

Return the dilatation term.

Definition at line 88 of file twoPhaseSystemI.H.

◆ dgdt() [2/2]

Foam::volScalarField & dgdt ( )
inline

Return non-const access to the dilatation parameter.

Definition at line 94 of file twoPhaseSystemI.H.

◆ pPrimeByA()

Foam::tmp< Foam::surfaceScalarField > & pPrimeByA ( )
inline

Return non-const access to the dispersion diffusivity.

Definition at line 100 of file twoPhaseSystemI.H.

◆ lookupSubModel() [3/4]

const dragModel & lookupSubModel ( const phaseModel dispersed,
const phaseModel continuous 
) const
inline

Definition at line 54 of file twoPhaseSystemTemplates.C.

◆ lookupSubModel() [4/4]

const virtualMassModel & lookupSubModel ( const phaseModel dispersed,
const phaseModel continuous 
) const
inline

Definition at line 65 of file twoPhaseSystemTemplates.C.

◆ sigma() [3/3]

Foam::tmp< Foam::volScalarField > sigma ( const phasePairKey key) const

Return the surface tension coefficient for a pair.

Definition at line 442 of file phaseSystem.C.

◆ dmdts()

Foam::PtrList< Foam::volScalarField > dmdts ( ) const
virtual

Return the mass transfer rates for each phase.

Reimplemented from phaseSystem.

Definition at line 448 of file phaseSystem.C.

Member Data Documentation

◆ fillFields_

const bool fillFields_ = true
staticprotected

Flag to indicate that returned lists of fields are "complete"; i.e.,.

that an absence of force is returned as a constructed list of zeros, rather than a null pointer

Definition at line 78 of file twoPhaseSystem.H.

◆ phase1_

phaseModel& phase1_
protected

Phase model 1.

Definition at line 81 of file twoPhaseSystem.H.

Referenced by twoPhaseSystem::phase1(), and twoPhaseSystem::twoPhaseSystem().

◆ phase2_

phaseModel& phase2_
protected

Phase model 2.

Definition at line 84 of file twoPhaseSystem.H.

Referenced by twoPhaseSystem::twoPhaseSystem().


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