phaseSystem Class Referenceabstract

Class to represent a system of phases and model interfacial transfers between them. More...

Inheritance diagram for phaseSystem:
Collaboration diagram for phaseSystem:

Public Types

typedef HashPtrTable< fvVectorMatrixmomentumTransferTable
 
typedef HashPtrTable< fvScalarMatrixheatTransferTable
 
typedef HashPtrTable< fvScalarMatrixspecieTransferTable
 
typedef PtrListDictionary< phaseModelphaseModelList
 
typedef UPtrList< phaseModelphaseModelPartialList
 
typedef HashPtrTable< volScalarField, phaseInterfaceKey, phaseInterfaceKey::hashdmdtfTable
 
typedef HashPtrTable< HashPtrTable< volScalarField >, phaseInterfaceKey, phaseInterfaceKey::hashdmidtfTable
 
- Public Types inherited from IOobject
enum  objectState { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Public Types inherited from UILList< LListBase, T >
typedef T value_type
 Type of values the DLList contains. More...
 
typedef Treference
 Type that can be used for storing into DLList::value_type. More...
 
typedef const Tconst_reference
 Type that can be used for storing into constant. More...
 
typedef label size_type
 The type that can represent the size of a DLList. More...
 
typedef LListBase::iterator LListBase_iterator
 
typedef LListBase::const_iterator LListBase_const_iterator
 

Public Member Functions

 TypeName ("phaseSystem")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, phaseSystem, dictionary,(const fvMesh &mesh),(mesh))
 
 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 phaseModelotherPhase (const phaseModel &phase) const
 Return the phase not given as an argument in a two-phase system. 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...
 
Foam::fvModelsfvModels (fvMesh &mesh)
 Access the fvModels. More...
 
const Foam::fvModelsfvModels () const
 Access the fvModels. More...
 
Foam::fvConstraintsfvConstraints (fvMesh &mesh)
 Access the fvConstraints. More...
 
const Foam::fvConstraintsfvConstraints () const
 Access the fvConstraints. More...
 
template<class ModelType >
word modelName () const
 Return the model name. This is the same as the model's typename. More...
 
template<class ModelType , class ... InterfaceTypes>
void generateInterfacialModels (const dictionary &dict, const phaseInterface &interface, PtrList< phaseInterface > &interfaces, PtrList< ModelType > &models) const
 Generate interfacial-model lists. More...
 
template<class ModelType >
void generateInterfacialModels (const dictionary &dict, HashTable< autoPtr< ModelType >, phaseInterfaceKey, phaseInterfaceKey::hash > &models) const
 Generate interfacial-model tables. More...
 
template<class ModelType >
void generateInterfacialModels (HashTable< autoPtr< ModelType >, phaseInterfaceKey, phaseInterfaceKey::hash > &models) const
 Generate interfacial-model tables. More...
 
template<class ValueType >
void generateInterfacialValues (const dictionary &dict, HashTable< ValueType, phaseInterfaceKey, phaseInterfaceKey::hash > &values) const
 Generate interfacial-model tables. More...
 
template<class ValueType >
void generateInterfacialValues (const word &valueName, HashTable< ValueType, phaseInterfaceKey, phaseInterfaceKey::hash > &values) const
 Generate interfacial-model tables. More...
 
template<class ModelType >
bool foundInterfacialModel (const phaseInterface &interface) const
 Check availability of a sub model for a given interface. More...
 
template<class ModelType >
const ModelType & lookupInterfacialModel (const phaseInterface &interface) const
 Return a sub model for an interface. 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< volScalarFieldsigma (const phaseInterfaceKey &key) const
 Return the surface tension coefficient for an interface. More...
 
tmp< scalarFieldsigma (const phaseInterfaceKey &key, const label patchi) const
 Return the surface tension coefficient for an interface on a. More...
 
tmp< volScalarFieldnearInterface () const
 Indicator of the proximity of the interface. More...
 
const dimensionedScalardeltaN () const
 Stabilisation for normalisation of the interface normal. More...
 
virtual tmp< volScalarFielddmdtf (const phaseInterfaceKey &key) const
 Return the mass transfer rate for an interface. More...
 
virtual PtrList< volScalarFielddmdts () const
 Return the mass transfer rates for each phase. More...
 
virtual PtrList< volScalarFieldd2mdtdps () const
 Return the mass transfer pressure implicit coefficients. More...
 
bool incompressible () const
 Return incompressibility. 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 bool implicitPhasePressure (const phaseModel &phase) const
 Returns true if the phase pressure is treated implicitly. More...
 
virtual bool implicitPhasePressure () const
 Returns true if the phase pressure is treated implicitly. More...
 
virtual PtrList< surfaceScalarFieldDByAfs (const PtrList< volScalarField > &rAUs, const PtrList< surfaceScalarField > &rAUfs) const =0
 Return the phase diffusivity. More...
 
virtual void partialElimination (const PtrList< volScalarField > &rAUs, const PtrList< volVectorField > &KdUByAs, const PtrList< surfaceScalarField > &alphafs, const PtrList< surfaceScalarField > &phiKdPhis)=0
 Solve the drag system for the new velocities and fluxes. More...
 
virtual void partialEliminationf (const PtrList< surfaceScalarField > &rAUfs, const PtrList< surfaceScalarField > &alphafs, const PtrList< surfaceScalarField > &phiKdPhifs)=0
 Solve the drag system for the new fluxes. More...
 
void setMixturePhi (const PtrList< surfaceScalarField > &alphafs, const surfaceScalarField &phim)
 Re-normalise the flux of the phases. 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 autoPtr< heatTransferTableheatTransfer () const =0
 Return the heat transfer matrices. More...
 
virtual autoPtr< specieTransferTablespecieTransfer () const =0
 Return the specie transfer matrices. More...
 
tmp< surfaceScalarFieldsurfaceTension (const phaseModel &phase) const
 Return the surface tension force. More...
 
virtual void solve (const PtrList< volScalarField > &rAUs, const PtrList< surfaceScalarField > &rAUfs)
 Solve for the phase fractions. More...
 
virtual void correct ()
 Correct the fluid properties other than those listed below. More...
 
virtual void correctContinuityError ()
 Correct the continuity errors. More...
 
virtual void correctKinematics ()
 Correct the kinematics. More...
 
virtual void correctThermo ()
 Correct the thermodynamics. More...
 
virtual void correctReactions ()
 Correct the reactions. More...
 
virtual void correctSpecies ()
 Correct the species mass fractions. More...
 
virtual void correctTurbulence ()
 Correct the turbulence. More...
 
virtual void correctEnergyTransport ()
 Correct the energy transport e.g. alphat. More...
 
virtual void meshUpdate ()
 Update the fluid properties for mesh changes. More...
 
void correctBoundaryFlux ()
 Correct fixed-flux BCs to be consistent with the velocity BCs. More...
 
void correctPhi (const volScalarField &p_rgh, const tmp< volScalarField > &divU, const pressureReference &pressureReference, nonOrthogonalSolutionControl &pimple)
 
virtual bool read ()
 Read base phaseProperties dictionary. More...
 
- Public Member Functions inherited from IOdictionary
 TypeName ("dictionary")
 
 IOdictionary (const IOobject &)
 Construct given an IOobject. More...
 
 IOdictionary (const IOobject &, const dictionary &)
 Construct given an IOobject and dictionary. More...
 
 IOdictionary (const IOobject &, Istream &)
 Construct given an IOobject and Istream. More...
 
 IOdictionary (const IOdictionary &)
 Copy constructor. More...
 
 IOdictionary (IOdictionary &&)
 Move constructor. More...
 
virtual ~IOdictionary ()
 Destructor. More...
 
virtual bool global () const
 Return true as object is global, i.e. same for all processors. More...
 
virtual bool readData (Istream &)
 ReadData function required for regIOobject read operation. More...
 
virtual bool writeData (Ostream &) const
 WriteData function required for regIOobject write operation. More...
 
void operator= (const IOdictionary &)
 Assignment of dictionary entries only. More...
 
void operator= (IOdictionary &&)
 Move assignment of dictionary entries only. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Copy constructor. More...
 
 regIOobject (const regIOobject &&)
 Move constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
virtual bool globalFile () const
 Return true if object is global, i.e. same for all processors. More...
 
const fileNamecaseName () const
 
fileName path () const
 Return complete path. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const
 Is this object registered with the registry? More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 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 up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool read=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
boolregisterObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
word modelName (const char *name) const
 Return the name of the object within this model. More...
 
const fileNamerootPath () const
 
const fileNamecaseName (const bool global) const
 
fileNameinstance () const
 Return the instance directory, constant, system, <time> etc. More...
 
void updateInstance () const
 If the instance is a time directory update to the current time. More...
 
const fileNamelocal () const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName relativePath () const
 Return the path relative to the case directory. More...
 
fileName relativeObjectPath () const
 Return complete relativePath + object name. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read header of local object without type-checking. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
template<class Name >
Foam::word modelName (Name name, const word &model)
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 Construct top-level dictionary null. More...
 
 dictionary (const fileName &name)
 Construct top-level empty dictionary with given name. More...
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &)
 Construct given the entry name, parent dictionary and Istream,. More...
 
 dictionary (Istream &, const bool keepHeader=false)
 Construct top-level dictionary from Istream,. More...
 
 dictionary (const dictionary &parentDict, const dictionary &)
 Construct as copy given the parent dictionary. More...
 
 dictionary (const dictionary &)
 Construct top-level dictionary as copy. More...
 
 dictionary (const dictionary *)
 Construct top-level dictionary as copy from pointer to dictionary. More...
 
 dictionary (const dictionary &parentDict, dictionary &&)
 Move constructor transferring parameter contents. More...
 
 dictionary (dictionary &&)
 Move constructor. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const dictionaryparent () const
 Return the parent dictionary. More...
 
bool isNull () const
 Return whether this dictionary is null. More...
 
const dictionarytopDict () const
 Return the top of the tree. More...
 
word topDictKeyword () const
 Return the scoped keyword with which this dictionary can be. 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 &, bool recursive=false, bool patternMatch=true) const
 Search dictionary for given keyword. More...
 
const entrylookupEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
entrylookupEntryPtr (const word &, bool recursive, bool patternMatch)
 Find and return an entry data stream pointer for manipulation. More...
 
const entrylookupEntryPtrBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present, trying a list. More...
 
const entrylookupEntry (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present otherwise error. More...
 
const entrylookupEntryBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present, trying a list. More...
 
ITstreamlookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return an entry data stream. More...
 
ITstreamlookupBackwardsCompatible (const wordList &, bool recursive=false, bool patternMatch=true) const
 Find and return an entry data stream, trying a list of keywords. More...
 
template<class T >
T lookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. More...
 
template<class T >
T lookupBackwardsCompatible (const wordList &, bool recursive=false, bool patternMatch=true) const
 Find and return a T, trying a list of keywords in sequence. More...
 
template<class T >
T lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. More...
 
template<class T >
T lookupOrDefaultBackwardsCompatible (const wordList &, const T &, bool recursive=false, bool patternMatch=true) const
 Find and return a T, trying a list of keywords in sequence. More...
 
template<class T >
T lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true)
 Find and return a T, if not found return the given. More...
 
template<class T >
bool readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const
 Find an entry if present, and assign to T. More...
 
const entrylookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
bool isDict (const word &) const
 Check if entry is a sub-dictionary. More...
 
const dictionarysubDictPtr (const word &) const
 Find and return a sub-dictionary pointer if present. More...
 
dictionarysubDictPtr (const word &)
 Find and return a sub-dictionary pointer if present. More...
 
const dictionarysubDict (const word &) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &)
 Find and return a sub-dictionary for manipulation. More...
 
dictionary subOrEmptyDict (const word &, const bool mustRead=false) const
 Find and return a sub-dictionary as a copy, or. More...
 
const dictionaryoptionalSubDict (const word &) const
 Find and return a sub-dictionary if found. More...
 
const dictionaryscopedDict (const word &) const
 Find and return a sub-dictionary by scoped lookup. More...
 
dictionaryscopedDict (const word &)
 Find and return a sub-dictionary by scoped lookup. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the sorted table of contents. More...
 
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns. More...
 
bool substituteKeyword (const word &keyword)
 Substitute the given keyword prepended by '$' with the. More...
 
bool substituteScopedKeyword (const word &keyword)
 Substitute the given scoped keyword prepended by '$' with the. More...
 
bool add (entry *, bool mergeEntry=false)
 Add a new entry. More...
 
void add (const entry &, bool mergeEntry=false)
 Add an entry. More...
 
void add (const keyType &, const word &, bool overwrite=false)
 Add a word entry. More...
 
void add (const keyType &, const string &, bool overwrite=false)
 Add a string entry. More...
 
void add (const keyType &, const label, bool overwrite=false)
 Add a label entry. More...
 
void add (const keyType &, const scalar, bool overwrite=false)
 Add a scalar entry. More...
 
void add (const keyType &, const dictionary &, bool mergeEntry=false)
 Add a dictionary entry. More...
 
template<class T >
void add (const keyType &, const T &, bool overwrite=false)
 Add a T entry. More...
 
void set (entry *)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const entry &)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const keyType &, const dictionary &)
 Assign a dictionary entry, overwrite any existing entry. More...
 
template<class T >
void set (const keyType &, const T &)
 Assign a T entry, overwrite any existing entry. More...
 
bool remove (const word &)
 Remove an entry specified by keyword. More...
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false)
 Change the keyword for an entry,. More...
 
bool merge (const dictionary &)
 Merge entries from the given dictionary. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (dictionary &)
 Transfer the contents of the argument and annul the argument. More...
 
bool read (Istream &, const bool keepHeader=false)
 Read dictionary from Istream, optionally keeping the header. More...
 
void write (Ostream &, const bool subDict=true) const
 Write dictionary, normally with sub-dictionary formatting. More...
 
ITstreamoperator[] (const word &) const
 Find and return entry. More...
 
void operator= (const dictionary &)
 
void operator= (dictionary &&)
 
void operator+= (const dictionary &)
 Include entries from the given dictionary. More...
 
void operator|= (const dictionary &)
 Conditionally include entries from the given dictionary. More...
 
void operator<<= (const dictionary &)
 Unconditionally include entries from the given dictionary. More...
 
- Public Member Functions inherited from dictionaryName
 dictionaryName ()
 Construct dictionaryName null. More...
 
 dictionaryName (const fileName &name)
 Construct dictionaryName as copy of the given fileName. More...
 
 dictionaryName (dictionaryName &&name)
 Move constructor. More...
 
const fileNamename () const
 Return the dictionary name. More...
 
fileNamename ()
 Return the dictionary name. More...
 
const word dictName () const
 Return the local dictionary name (final part of scoped name) More...
 
void operator= (const dictionaryName &name)
 
void operator= (dictionaryName &&name)
 
- Public Member Functions inherited from ILList< LListBase, T >
 ILList ()
 Null construct. More...
 
 ILList (T *a)
 Construct given initial T. More...
 
 ILList (Istream &)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &)
 Copy constructor. More...
 
 ILList (ILList< LListBase, T > &&)
 Move constructor. More...
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
template<class INew >
 ILList (Istream &, const 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 *p)
 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 > &)
 Transfer the contents of the argument into this List. More...
 
void operator= (const ILList< LListBase, T > &)
 Assignment operator. More...
 
void operator= (ILList< LListBase, T > &&)
 Move assignment operator. More...
 
- Public Member Functions inherited from UILList< LListBase, T >
 UILList ()
 Null construct. More...
 
 UILList (T *a)
 Construct given initial T. More...
 
 UILList (const UILList< LListBase, T > &)
 Copy constructor. More...
 
 UILList (UILList< LListBase, T > &&)
 Move constructor. More...
 
Tfirst ()
 Return the first entry. More...
 
const Tfirst () const
 Return the first entry. More...
 
Tlast ()
 Return the last entry. More...
 
const Tlast () const
 Return the last entry. More...
 
TremoveHead ()
 Remove and return head. More...
 
Tremove (T *p)
 Remove and return element. More...
 
Tremove (iterator &it)
 Remove and return specified by iterator. More...
 
void operator= (const UILList< LListBase, T > &)
 Assignment operator. More...
 
void operator= (UILList< LListBase, T > &&)
 Move assignment operator. More...
 
iterator begin ()
 
const iteratorend ()
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 
const_iterator begin () const
 
const const_iteratorend () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iteratorcrend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iteratorrend () const
 
bool operator== (const UILList< LListBase, T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UILList< LListBase, T > &) const
 The opposite of the equality operation. Takes linear time. More...
 

Static Public Member Functions

static autoPtr< phaseSystemNew (const fvMesh &mesh)
 
template<class ModelType >
static const dictionarymodelSubDict (const dictionary &dict)
 Return the dictionary from which to construct a low-level. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
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...
 
template<class Name >
static word modelName (Name name, const word &model)
 Return the name of the object within the given model. More...
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from dictionary
static autoPtr< dictionaryNew (Istream &)
 Construct top-level dictionary on freestore from Istream. More...
 

Static Public Attributes

static const word propertiesName
 Default name of the phase properties dictionary. More...
 
- Static Public Attributes inherited from IOdictionary
static bool writeDictionaries
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static constexpr const char * foamFile = "FoamFile"
 Keyword for the FoamFile header sub-dictionary. More...
 
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
- Static Public Attributes inherited from dictionary
static const dictionary null
 Null dictionary. More...
 
static bool writeOptionalEntries
 If true write optional keywords and values. More...
 

Protected Types

typedef HashTable< autoPtr< surfaceTensionModel >, phaseInterfaceKey, phaseInterfaceKey::hashsurfaceTensionModelTable
 
typedef HashTable< scalar, phaseInterfaceKey, phaseInterfaceKey::hashcAlphaTable
 

Protected Member Functions

tmp< surfaceScalarFieldcalcPhi (const phaseModelList &phaseModels) const
 Calculate and return the mixture flux. More...
 
template<class ModelType >
void validateMassTransfer (const phaseInterface &interface) const
 Check that mass transfer is supported across the given interface. More...
 
tmp< volScalarFieldsumAlphaMoving () const
 Return the sum of the phase fractions of the moving phases. More...
 
void setMixtureU (const volVectorField &Um)
 Re-normalise the velocity of the phases. More...
 
tmp< surfaceVectorFieldnHatfv (const volScalarField &alpha1, const volScalarField &alpha2) const
 Normal to interface between two phases. More...
 
tmp< surfaceScalarFieldnHatf (const volScalarField &alpha1, const volScalarField &alpha2) const
 Normal to interface between two phases dotted with face areas. More...
 
tmp< volScalarFieldK (const phaseModel &alpha1, const phaseModel &alpha2) const
 Curvature of interface between two phases. More...
 
template<class Type >
dictionary interfacialDict (const word &name) const
 Return the dictionary containing interfacial model or value. More...
 
- Protected Member Functions inherited from IOdictionary
 IOdictionary (const IOobject &io, const word &wantedType)
 Construct given an IOobject, supply wanted typeName. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
 Read header, check readOpt flags and read data if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType)
 Read header using typeGlobalFile to find file. More...
 

Protected Attributes

const fvMeshmesh_
 Reference to the mesh. More...
 
word referencePhaseName_
 Name of optional reference phase which is not solved for. 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...
 
surfaceScalarField phi_
 Total volumetric flux. More...
 
volScalarField dpdt_
 Rate of change of pressure. More...
 
IOMRFZoneList MRF_
 Optional MRF zones. More...
 
cAlphaTable cAlphas_
 Interface compression coefficients. More...
 
const dimensionedScalar deltaN_
 Stabilisation for normalisation of the interface normal. More...
 
surfaceTensionModelTable surfaceTensionModels_
 Surface tension models. More...
 

Static Protected Attributes

static const bool fillFields_ = false
 Flag to indicate that returned lists of fields are "complete"; i.e.,. More...
 

Detailed Description

Class to represent a system of phases and model interfacial transfers between them.

Source files

Definition at line 68 of file phaseSystem.H.

Member Typedef Documentation

◆ momentumTransferTable

Definition at line 76 of file phaseSystem.H.

◆ heatTransferTable

Definition at line 78 of file phaseSystem.H.

◆ specieTransferTable

Definition at line 80 of file phaseSystem.H.

◆ phaseModelList

Definition at line 82 of file phaseSystem.H.

◆ phaseModelPartialList

Definition at line 84 of file phaseSystem.H.

◆ dmdtfTable

◆ dmidtfTable

◆ surfaceTensionModelTable

◆ cAlphaTable

Definition at line 120 of file phaseSystem.H.

Constructor & Destructor Documentation

◆ phaseSystem()

phaseSystem ( const fvMesh mesh)

Construct from fvMesh.

◆ ~phaseSystem()

virtual ~phaseSystem ( )
virtual

Destructor.

Member Function Documentation

◆ calcPhi()

tmp<surfaceScalarField> calcPhi ( const phaseModelList phaseModels) const
protected

Calculate and return the mixture flux.

◆ validateMassTransfer()

void validateMassTransfer ( const phaseInterface interface) const
protected

Check that mass transfer is supported across the given interface.

◆ sumAlphaMoving()

tmp<volScalarField> sumAlphaMoving ( ) const
protected

Return the sum of the phase fractions of the moving phases.

◆ setMixtureU()

void setMixtureU ( const volVectorField Um)
protected

Re-normalise the velocity of the phases.

around the specified mixture mean

◆ nHatfv()

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

Normal to interface between two phases.

Used for interface compression

◆ nHatf()

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

Normal to interface between two phases dotted with face areas.

Used for interface compression

◆ K()

tmp<volScalarField> K ( const phaseModel alpha1,
const phaseModel alpha2 
) const
protected

Curvature of interface between two phases.

Used for interface compression

◆ interfacialDict()

dictionary interfacialDict ( const word name) const
protected

Return the dictionary containing interfacial model or value.

settings for the given name. Performs backwards compatibility conversions.

◆ TypeName()

TypeName ( "phaseSystem"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

static autoPtr<phaseSystem> New ( const fvMesh mesh)
static

◆ mesh()

const Foam::fvMesh & mesh ( ) const
inline

Return the mesh.

Definition at line 28 of file phaseSystemI.H.

References phaseSystem::mesh_.

◆ phases() [1/2]

const Foam::phaseSystem::phaseModelList & phases ( ) const
inline

Return the phase models.

Definition at line 35 of file phaseSystemI.H.

References phaseSystem::phaseModels_.

Referenced by kOmegaSSTSato< BasicMomentumTransportModel >::read().

Here is the caller graph for this function:

◆ phases() [2/2]

Foam::phaseSystem::phaseModelList & phases ( )
inline

Access the phase models.

Definition at line 42 of file phaseSystemI.H.

References phaseSystem::phaseModels_.

◆ movingPhases() [1/2]

const Foam::phaseSystem::phaseModelPartialList & movingPhases ( ) const
inline

Return the models for phases that are moving.

Definition at line 49 of file phaseSystemI.H.

References phaseSystem::movingPhaseModels_.

Referenced by kOmegaSSTSato< BasicMomentumTransportModel >::read().

Here is the caller graph for this function:

◆ movingPhases() [2/2]

Foam::phaseSystem::phaseModelPartialList & movingPhases ( )
inline

Access the models for phases that are moving.

Definition at line 56 of file phaseSystemI.H.

References phaseSystem::movingPhaseModels_.

◆ stationaryPhases() [1/2]

const Foam::phaseSystem::phaseModelPartialList & stationaryPhases ( ) const
inline

Return the models for phases that are stationary.

Definition at line 63 of file phaseSystemI.H.

References phaseSystem::stationaryPhaseModels_.

◆ stationaryPhases() [2/2]

Foam::phaseSystem::phaseModelPartialList & stationaryPhases ( )
inline

Access the models for phases that are stationary.

Definition at line 70 of file phaseSystemI.H.

References phaseSystem::stationaryPhaseModels_.

◆ anisothermalPhases() [1/2]

const Foam::phaseSystem::phaseModelPartialList & anisothermalPhases ( ) const
inline

Return the models for phases that have variable temperature.

Definition at line 77 of file phaseSystemI.H.

References phaseSystem::anisothermalPhaseModels_.

◆ anisothermalPhases() [2/2]

Foam::phaseSystem::phaseModelPartialList & anisothermalPhases ( )
inline

Access the models for phases that have variable temperature.

Definition at line 84 of file phaseSystemI.H.

References phaseSystem::anisothermalPhaseModels_.

◆ multiComponentPhases() [1/2]

const Foam::phaseSystem::phaseModelPartialList & multiComponentPhases ( ) const
inline

Return the models for phases that have multiple species.

Definition at line 91 of file phaseSystemI.H.

References phaseSystem::multiComponentPhaseModels_.

◆ multiComponentPhases() [2/2]

Foam::phaseSystem::phaseModelPartialList & multiComponentPhases ( )
inline

Access the models for phases that have multiple species.

Definition at line 98 of file phaseSystemI.H.

References phaseSystem::multiComponentPhaseModels_, and phaseSystem::otherPhase().

Here is the call graph for this function:

◆ otherPhase()

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

Return the phase not given as an argument in a two-phase system.

An error is generated if the system is not two-phase

Definition at line 105 of file phaseSystemI.H.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, phaseSystem::phaseModels_, and UPtrList< T >::size().

Referenced by phaseSystem::multiComponentPhases(), and IATEsource::otherPhase().

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

◆ phi() [1/2]

const Foam::surfaceScalarField & phi ( ) const
inline

Return the mixture flux.

Definition at line 127 of file phaseSystemI.H.

References phaseSystem::phi_.

◆ phi() [2/2]

Foam::surfaceScalarField & phi ( )
inline

Access the mixture flux.

Definition at line 133 of file phaseSystemI.H.

References phaseSystem::phi_.

◆ dpdt() [1/2]

const Foam::volScalarField & dpdt ( ) const
inline

Return the rate of change of the pressure.

Definition at line 139 of file phaseSystemI.H.

References phaseSystem::dpdt_.

◆ dpdt() [2/2]

Foam::volScalarField & dpdt ( )
inline

Access the rate of change of the pressure.

Definition at line 145 of file phaseSystemI.H.

References phaseSystem::dpdt_.

◆ MRF()

const Foam::IOMRFZoneList & MRF ( ) const
inline

Return MRF zones.

Definition at line 151 of file phaseSystemI.H.

References phaseSystem::MRF_.

◆ fvModels() [1/2]

Foam::fvModels & fvModels ( fvMesh mesh)
inline

Access the fvModels.

Definition at line 157 of file phaseSystemI.H.

References dictionary::New().

Here is the call graph for this function:

◆ fvModels() [2/2]

const Foam::fvModels & fvModels ( ) const
inline

Access the fvModels.

Definition at line 163 of file phaseSystemI.H.

References phaseSystem::mesh_, and dictionary::New().

Here is the call graph for this function:

◆ fvConstraints() [1/2]

Access the fvConstraints.

Definition at line 169 of file phaseSystemI.H.

References dictionary::New().

Here is the call graph for this function:

◆ fvConstraints() [2/2]

const Foam::fvConstraints & fvConstraints ( ) const
inline

Access the fvConstraints.

Definition at line 175 of file phaseSystemI.H.

References phaseSystem::mesh_, and dictionary::New().

Here is the call graph for this function:

◆ modelName()

word modelName ( ) const

Return the model name. This is the same as the model's typename.

but without "Model" on the end.

◆ generateInterfacialModels() [1/3]

void generateInterfacialModels ( const dictionary dict,
const phaseInterface interface,
PtrList< phaseInterface > &  interfaces,
PtrList< ModelType > &  models 
) const

Generate interfacial-model lists.

◆ generateInterfacialModels() [2/3]

void generateInterfacialModels ( const dictionary dict,
HashTable< autoPtr< ModelType >, phaseInterfaceKey, phaseInterfaceKey::hash > &  models 
) const

Generate interfacial-model tables.

◆ generateInterfacialModels() [3/3]

void generateInterfacialModels ( HashTable< autoPtr< ModelType >, phaseInterfaceKey, phaseInterfaceKey::hash > &  models) const

Generate interfacial-model tables.

◆ generateInterfacialValues() [1/2]

void generateInterfacialValues ( const dictionary dict,
HashTable< ValueType, phaseInterfaceKey, phaseInterfaceKey::hash > &  values 
) const

Generate interfacial-model tables.

◆ generateInterfacialValues() [2/2]

void generateInterfacialValues ( const word valueName,
HashTable< ValueType, phaseInterfaceKey, phaseInterfaceKey::hash > &  values 
) const

Generate interfacial-model tables.

◆ modelSubDict()

static const dictionary& modelSubDict ( const dictionary dict)
static

Return the dictionary from which to construct a low-level.

sub-model. Checks that there is just one sub-dictionary then returns it.

◆ foundInterfacialModel()

bool foundInterfacialModel ( const phaseInterface interface) const

Check availability of a sub model for a given interface.

◆ lookupInterfacialModel()

const ModelType& lookupInterfacialModel ( const phaseInterface interface) const

Return a sub model for an interface.

◆ fillFields() [1/2]

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.

◆ fillFields() [2/2]

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.

◆ rho()

tmp<volScalarField> rho ( ) const

Return the mixture density.

◆ U()

tmp<volVectorField> U ( ) const

Return the mixture velocity.

◆ sigma() [1/2]

tmp<volScalarField> sigma ( const phaseInterfaceKey key) const

Return the surface tension coefficient for an interface.

Referenced by IATEsource::sigma().

Here is the caller graph for this function:

◆ sigma() [2/2]

tmp<scalarField> sigma ( const phaseInterfaceKey key,
const label  patchi 
) const

Return the surface tension coefficient for an interface on a.

patch

◆ nearInterface()

tmp<volScalarField> nearInterface ( ) const

Indicator of the proximity of the interface.

Field values are 1 near and 0 away for the interface.

◆ deltaN()

const Foam::dimensionedScalar & deltaN ( ) const
inline

Stabilisation for normalisation of the interface normal.

Definition at line 181 of file phaseSystemI.H.

References phaseSystem::deltaN_.

◆ dmdtf()

virtual tmp<volScalarField> dmdtf ( const phaseInterfaceKey key) const
virtual

Return the mass transfer rate for an interface.

◆ dmdts()

virtual PtrList<volScalarField> dmdts ( ) const
virtual

Return the mass transfer rates for each phase.

◆ d2mdtdps()

virtual PtrList<volScalarField> d2mdtdps ( ) const
virtual

Return the mass transfer pressure implicit coefficients.

for each phase

◆ incompressible()

bool incompressible ( ) const

Return incompressibility.

◆ momentumTransfer()

virtual autoPtr<momentumTransferTable> momentumTransfer ( )
pure virtual

Return the momentum transfer matrices for the cell-based.

algorithm

◆ momentumTransferf()

virtual autoPtr<momentumTransferTable> momentumTransferf ( )
pure virtual

Return the momentum transfer matrices for the face-based.

algorithm

◆ AFfs()

virtual PtrList<surfaceScalarField> AFfs ( ) const
pure virtual

Return the implicit force coefficients for the face-based.

algorithm

◆ phiFs()

virtual PtrList<surfaceScalarField> phiFs ( const PtrList< volScalarField > &  rAUs)
pure virtual

Return the force fluxes for the cell-based algorithm.

◆ phiFfs()

virtual PtrList<surfaceScalarField> phiFfs ( const PtrList< surfaceScalarField > &  rAUfs)
pure virtual

Return the force fluxes for the face-based algorithm.

◆ phiKdPhis()

virtual PtrList<surfaceScalarField> phiKdPhis ( const PtrList< volScalarField > &  rAUs) const
pure virtual

Return the force fluxes for the cell-based algorithm.

◆ phiKdPhifs()

virtual PtrList<surfaceScalarField> phiKdPhifs ( const PtrList< surfaceScalarField > &  rAUfs) const
pure virtual

Return the force fluxes for the face-based algorithm.

◆ KdUByAs()

virtual PtrList<volVectorField> KdUByAs ( const PtrList< volScalarField > &  rAUs) const
pure virtual

Return the explicit part of the drag force.

◆ implicitPhasePressure() [1/2]

virtual bool implicitPhasePressure ( const phaseModel phase) const
virtual

Returns true if the phase pressure is treated implicitly.

in the phase fraction equation

◆ implicitPhasePressure() [2/2]

virtual bool implicitPhasePressure ( ) const
virtual

Returns true if the phase pressure is treated implicitly.

in the phase fraction equation for any phase

◆ DByAfs()

virtual PtrList<surfaceScalarField> DByAfs ( const PtrList< volScalarField > &  rAUs,
const PtrList< surfaceScalarField > &  rAUfs 
) const
pure virtual

Return the phase diffusivity.

divided by the momentum central coefficient

◆ partialElimination()

virtual void partialElimination ( const PtrList< volScalarField > &  rAUs,
const PtrList< volVectorField > &  KdUByAs,
const PtrList< surfaceScalarField > &  alphafs,
const PtrList< surfaceScalarField > &  phiKdPhis 
)
pure virtual

Solve the drag system for the new velocities and fluxes.

◆ partialEliminationf()

virtual void partialEliminationf ( const PtrList< surfaceScalarField > &  rAUfs,
const PtrList< surfaceScalarField > &  alphafs,
const PtrList< surfaceScalarField > &  phiKdPhifs 
)
pure virtual

Solve the drag system for the new fluxes.

◆ setMixturePhi()

void setMixturePhi ( const PtrList< surfaceScalarField > &  alphafs,
const surfaceScalarField phim 
)

Re-normalise the flux of the phases.

around the specified mixture mean

◆ ddtCorrByAs()

virtual PtrList<surfaceScalarField> ddtCorrByAs ( const PtrList< volScalarField > &  rAUs,
const bool  includeVirtualMass = false 
) const
pure virtual

Return the flux corrections for the cell-based algorithm.

◆ heatTransfer()

virtual autoPtr<heatTransferTable> heatTransfer ( ) const
pure virtual

Return the heat transfer matrices.

◆ specieTransfer()

virtual autoPtr<specieTransferTable> specieTransfer ( ) const
pure virtual

Return the specie transfer matrices.

◆ surfaceTension()

tmp<surfaceScalarField> surfaceTension ( const phaseModel phase) const

Return the surface tension force.

◆ solve()

virtual void solve ( const PtrList< volScalarField > &  rAUs,
const PtrList< surfaceScalarField > &  rAUfs 
)
virtual

Solve for the phase fractions.

◆ correct()

virtual void correct ( )
virtual

Correct the fluid properties other than those listed below.

◆ correctContinuityError()

virtual void correctContinuityError ( )
virtual

Correct the continuity errors.

◆ correctKinematics()

virtual void correctKinematics ( )
virtual

Correct the kinematics.

◆ correctThermo()

virtual void correctThermo ( )
virtual

Correct the thermodynamics.

◆ correctReactions()

virtual void correctReactions ( )
virtual

Correct the reactions.

◆ correctSpecies()

virtual void correctSpecies ( )
virtual

Correct the species mass fractions.

◆ correctTurbulence()

virtual void correctTurbulence ( )
virtual

Correct the turbulence.

◆ correctEnergyTransport()

virtual void correctEnergyTransport ( )
virtual

Correct the energy transport e.g. alphat.

◆ meshUpdate()

virtual void meshUpdate ( )
virtual

Update the fluid properties for mesh changes.

◆ correctBoundaryFlux()

void correctBoundaryFlux ( )

Correct fixed-flux BCs to be consistent with the velocity BCs.

◆ correctPhi()

void correctPhi ( const volScalarField p_rgh,
const tmp< volScalarField > &  divU,
const pressureReference pressureReference,
nonOrthogonalSolutionControl pimple 
)

◆ read()

virtual bool read ( )
virtual

Read base phaseProperties dictionary.

Reimplemented from regIOobject.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_
protected

Reference to the mesh.

Definition at line 126 of file phaseSystem.H.

Referenced by phaseSystem::fvConstraints(), phaseSystem::fvModels(), and phaseSystem::mesh().

◆ referencePhaseName_

word referencePhaseName_
protected

Name of optional reference phase which is not solved for.

but obtained from the sum of the other phases

Definition at line 130 of file phaseSystem.H.

◆ phaseModels_

phaseModelList phaseModels_
protected

Phase models.

Definition at line 133 of file phaseSystem.H.

Referenced by phaseSystem::otherPhase(), and phaseSystem::phases().

◆ movingPhaseModels_

phaseModelPartialList movingPhaseModels_
protected

Moving phase models.

Definition at line 136 of file phaseSystem.H.

Referenced by phaseSystem::movingPhases().

◆ stationaryPhaseModels_

phaseModelPartialList stationaryPhaseModels_
protected

Stationary phase models.

Definition at line 139 of file phaseSystem.H.

Referenced by phaseSystem::stationaryPhases().

◆ anisothermalPhaseModels_

phaseModelPartialList anisothermalPhaseModels_
protected

Anisothermal phase models.

Definition at line 142 of file phaseSystem.H.

Referenced by phaseSystem::anisothermalPhases().

◆ multiComponentPhaseModels_

phaseModelPartialList multiComponentPhaseModels_
protected

Multi-component phase models.

Definition at line 145 of file phaseSystem.H.

Referenced by phaseSystem::multiComponentPhases().

◆ phi_

surfaceScalarField phi_
protected

Total volumetric flux.

Definition at line 148 of file phaseSystem.H.

Referenced by phaseSystem::phi().

◆ dpdt_

volScalarField dpdt_
protected

Rate of change of pressure.

Definition at line 151 of file phaseSystem.H.

Referenced by phaseSystem::dpdt().

◆ MRF_

IOMRFZoneList MRF_
protected

Optional MRF zones.

Definition at line 154 of file phaseSystem.H.

Referenced by phaseSystem::MRF().

◆ cAlphas_

cAlphaTable cAlphas_
protected

Interface compression coefficients.

Definition at line 157 of file phaseSystem.H.

◆ deltaN_

const dimensionedScalar deltaN_
protected

Stabilisation for normalisation of the interface normal.

Definition at line 160 of file phaseSystem.H.

Referenced by phaseSystem::deltaN().

◆ surfaceTensionModels_

surfaceTensionModelTable surfaceTensionModels_
protected

Surface tension models.

Definition at line 166 of file phaseSystem.H.

◆ fillFields_

const bool fillFields_ = false
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 172 of file phaseSystem.H.

◆ propertiesName

const word propertiesName
static

Default name of the phase properties dictionary.

Definition at line 237 of file phaseSystem.H.


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