phaseSystem Class Reference

Class to represent a system of phases. More...

Inheritance diagram for phaseSystem:
Collaboration diagram for phaseSystem:

Classes

struct  alphaControl
 alpha solution control structure More...
 

Public Types

typedef PtrListDictionary< phaseModelphaseModelList
 List of phase models. More...
 
typedef UPtrList< phaseModelphaseModelPartialList
 Partial list of phase models. More...
 
- 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...
 
 phaseSystem (const fvMesh &mesh)
 Construct from fvMesh. More...
 
virtual ~phaseSystem ()
 Destructor. More...
 
const fvMeshmesh () const
 Return the mesh. More...
 
const pimpleNoLoopControlpimple () const
 Return pimpleNoLoopControl. 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 phaseModelPartialListthermalPhases () const
 Return the models for phases that have variable temperature. More...
 
phaseModelPartialListthermalPhases ()
 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 >
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...
 
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...
 
tmp< surfaceScalarFieldsurfaceTension (const phaseModel &) const
 Return the surface tension force. More...
 
bool incompressible () const
 Return incompressibility. More...
 
bool implicitPhasePressure () const
 Returns true if the phase pressure is treated implicitly. More...
 
void solve (const alphaControl &alphaControls, const PtrList< volScalarField > &rAs, const momentumTransferSystem &mts)
 Solve for the phase fractions. More...
 
void correct ()
 Correct the fluid properties other than those listed below. More...
 
void correctContinuityError (const PtrList< volScalarField::Internal > &dmdts)
 Correct the continuity errors. More...
 
void correctKinematics ()
 Correct the kinematics. More...
 
void correctThermo ()
 Correct the thermodynamics. More...
 
void correctReactions ()
 Correct the reactions. More...
 
void correctSpecies ()
 Correct the species mass fractions. More...
 
void predictMomentumTransport ()
 Predict the momentumTransport. More...
 
void predictThermophysicalTransport ()
 Predict the energy transport e.g. alphat. More...
 
void correctMomentumTransport ()
 Correct the momentumTransport. More...
 
void correctThermophysicalTransport ()
 Correct the energy transport e.g. alphat. More...
 
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 autoPtr< volScalarField > &divU, const pressureReference &pressureReference, nonOrthogonalSolutionControl &pimple)
 ... More...
 
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 (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 dependenciesModified () const
 Return true if the object's dependencies have been modified. 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 &)=delete
 Assign to IOobject. More...
 
void operator= (const regIOobject &)=delete
 Disallow default assignment. More...
 
const fileNamecaseName (const bool global) 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 filePath (const bool global) const
 Return complete path + object name if the file exists. More...
 
- 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...
 
bool & registerObject ()
 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...
 
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...
 
void updateTimeInstance () const
 Update instance 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 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)
 
- 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)
 Construct an empty sub-dictionary with given name and parent. More...
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &)
 Construct given the 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...
 
template<class ... Entries>
 dictionary (const std::tuple< const Entries &... > &)
 Construct top-level dictionary with given entries. More...
 
template<class ... Entries>
 dictionary (const fileName &name, const std::tuple< const Entries &... > &)
 Construct top-level dictionary with given name and entries. More...
 
template<class ... Entries>
 dictionary (const fileName &name, const dictionary &parentDict, const std::tuple< const Entries &... > &)
 Construct dictionary with given name, parent and entries. More...
 
template<class ... Entries>
 dictionary (const dictionary &dict, const std::tuple< const Entries &... > &)
 Construct dictionary as copy and add a list of entries. 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...
 
virtual label startLineNumber () const
 Return line number of first token in dictionary. More...
 
virtual 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, if not found throw a fatal error. More...
 
template<class T >
T lookup (const word &, const unitConversion &, bool recursive=false, bool patternMatch=true) const
 Find and return a T, with dimension checking and unit. 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 lookupBackwardsCompatible (const wordList &, const unitConversion &, bool recursive=false, bool patternMatch=true) const
 Find and return a T, with dimension checking and unit. More...
 
template<class T >
T lookupOrDefault (const word &, const T &, const bool writeDefault=writeOptionalEntries > 0) const
 Find and return a T, if not found return the given default. More...
 
template<class T >
T lookupOrDefault (const word &, const unitConversion &, const T &, const bool writeDefault=writeOptionalEntries > 0) const
 Find and return a T with dimension checking and unit. More...
 
template<class T >
T lookupOrDefaultBackwardsCompatible (const wordList &, const T &) const
 Find and return a T, trying a list of keywords in sequence,. More...
 
template<class T >
T lookupOrDefaultBackwardsCompatible (const wordList &, const unitConversion &, const T &) const
 Find and return a T, with dimension checking and unit. More...
 
template<class T >
T lookupOrAddDefault (const word &, const T &)
 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...
 
template<class T >
bool readIfPresent (const word &, const unitConversion &, T &, bool recursive=false, bool patternMatch=true) const
 Find an entry if present, and assign to T, with dimension. More...
 
const entrylookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present,. More...
 
template<class T >
T lookupScoped (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. More...
 
template<class T >
const TlookupCompoundScoped (const word &keyword, bool recursive, bool patternMatch) const
 Find return the reference to the compound T,. 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...
 
const dictionarysubDictBackwardsCompatible (const wordList &) const
 Find and return a sub-dictionary, trying a list of keywords in. More...
 
const dictionarysubOrEmptyDict (const word &, const bool mustRead=false) const
 Find and return a sub-dictionary. 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 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...
 
template<class ... Entries>
void set (const entry &e, const Entries &...)
 Assign multiple entries, overwriting any existing entries. More...
 
template<class T , class ... Entries>
void set (const keyType &, const T &, const Entries &...)
 Assign multiple T entries, overwriting any existing entries. More...
 
bool remove (const word &)
 Remove an entry specified by keyword. More...
 
void remove (const wordList &)
 Remove entries specified by keywords. 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+= (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...
 
template<class ... Entries>
std::tuple< const Entries &... > entries (const Entries &... entries)
 
template<class T >
T lookupOrDefault (const word &keyword, const T &defaultValue, const bool writeDefault) const
 
template<class T >
T lookupOrDefault (const word &keyword, const unitConversion &defaultUnits, const T &defaultValue, const bool writeDefault) const
 
template<class ... Entries>
void set (const entry &e, const Entries &... entries)
 
template<class T , class ... Entries>
void set (const keyType &k, const T &t, const Entries &... entries)
 
- 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 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 int writeOptionalEntries
 If true write optional keywords and values. More...
 

Protected Types

typedef HashTable< scalar, phaseInterfaceKey, phaseInterfaceKey::hashcAlphaTable
 Table of interface compression coefficients. More...
 
typedef HashPtrTable< surfaceTensionCoefficientModel, phaseInterfaceKey, phaseInterfaceKey::hashsurfaceTensionCoefficientModelTable
 Table of surface tension models. More...
 

Protected Member Functions

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...
 
void setMixturePhi (const PtrList< surfaceScalarField > &alphafs, const surfaceScalarField &phim)
 Re-normalise the flux 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...
 
- 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
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...
 
const pimpleNoLoopControlpimple_
 Reference to pimpleNoLoopControl. More...
 
IOMRFZoneList MRF_
 Optional MRF zones. 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 thermalPhaseModels_
 Thermal phase models. More...
 
phaseModelPartialList multicomponentPhaseModels_
 Multi-component phase models. More...
 
surfaceScalarField phi_
 Total volumetric flux. More...
 
volScalarField dpdt_
 Rate of change of pressure. More...
 
const cAlphaTable cAlphas_
 Interface compression coefficients. More...
 
const dimensionedScalar deltaN_
 Stabilisation for normalisation of the interface normal. More...
 
const surfaceTensionCoefficientModelTable surfaceTensionCoefficientModels_
 Surface tension models. More...
 

Additional Inherited Members

- 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 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
template<class ... Entries>
static std::tuple< const Entries &... > entries (const Entries &...)
 Construct an entries tuple from which to make a dictionary. More...
 
static autoPtr< dictionaryNew (Istream &)
 Construct top-level dictionary on freestore from Istream. More...
 

Detailed Description

Class to represent a system of phases.

Source files

Definition at line 71 of file phaseSystem.H.

Member Typedef Documentation

◆ phaseModelList

List of phase models.

Definition at line 122 of file phaseSystem.H.

◆ phaseModelPartialList

Partial list of phase models.

Definition at line 125 of file phaseSystem.H.

◆ cAlphaTable

Table of interface compression coefficients.

Definition at line 140 of file phaseSystem.H.

◆ surfaceTensionCoefficientModelTable

Table of surface tension models.

Definition at line 150 of file phaseSystem.H.

Constructor & Destructor Documentation

◆ phaseSystem()

◆ ~phaseSystem()

~phaseSystem ( )
virtual

Destructor.

Definition at line 409 of file phaseSystem.C.

Member Function Documentation

◆ sumAlphaMoving()

Foam::tmp< Foam::volScalarField > sumAlphaMoving ( ) const
protected

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

Definition at line 57 of file phaseSystem.C.

References phaseSystem::movingPhaseModels_, GeometricField< Type, GeoMesh, PrimitiveField >::New(), and UPtrList< T >::size().

Here is the call graph for this function:

◆ setMixtureU()

void setMixtureU ( const volVectorField Um)
protected

Re-normalise the velocity of the phases.

around the specified mixture mean

Definition at line 83 of file phaseSystem.C.

References forAll.

◆ setMixturePhi()

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

Re-normalise the flux of the phases.

around the specified mixture mean

Definition at line 103 of file phaseSystem.C.

References forAll.

◆ nHatfv()

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

Normal to interface between two phases.

Used for interface compression

Definition at line 127 of file phaseSystem.C.

References Foam::fvc::grad(), Foam::fvc::interpolate(), and Foam::mag().

Here is the call graph for this function:

◆ nHatf()

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

Normal to interface between two phases dotted with face areas.

Used for interface compression

Definition at line 153 of file phaseSystem.C.

◆ K()

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

Curvature of interface between two phases.

Used for interface compression

Definition at line 164 of file phaseSystem.C.

References Foam::correctContactAngle(), Foam::fvc::div(), tmp< T >::ref(), and phaseModel::U().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "phaseSystem"  )

Runtime type information.

◆ mesh()

◆ pimple()

const Foam::pimpleNoLoopControl & pimple ( ) const
inline

Return pimpleNoLoopControl.

Definition at line 97 of file phaseSystemI.H.

Referenced by velocityGroup::correct().

Here is the caller graph for this function:

◆ phases() [1/2]

◆ phases() [2/2]

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

Access the phase models.

Definition at line 111 of file phaseSystemI.H.

◆ movingPhases() [1/2]

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

Return the models for phases that are moving.

Definition at line 118 of file phaseSystemI.H.

◆ movingPhases() [2/2]

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

Access the models for phases that are moving.

Definition at line 125 of file phaseSystemI.H.

◆ stationaryPhases() [1/2]

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

Return the models for phases that are stationary.

Definition at line 132 of file phaseSystemI.H.

◆ stationaryPhases() [2/2]

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

Access the models for phases that are stationary.

Definition at line 139 of file phaseSystemI.H.

◆ thermalPhases() [1/2]

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

Return the models for phases that have variable temperature.

Definition at line 146 of file phaseSystemI.H.

Referenced by heatTransferSystem::heatTransferSystem().

Here is the caller graph for this function:

◆ thermalPhases() [2/2]

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

Access the models for phases that have variable temperature.

Definition at line 153 of file phaseSystemI.H.

◆ multicomponentPhases() [1/2]

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

Return the models for phases that have multiple species.

Definition at line 160 of file phaseSystemI.H.

◆ multicomponentPhases() [2/2]

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

Access the models for phases that have multiple species.

Definition at line 167 of file phaseSystemI.H.

◆ otherPhase()

◆ phi() [1/2]

const Foam::surfaceScalarField & phi ( ) const
inline

Return the mixture flux.

Definition at line 196 of file phaseSystemI.H.

◆ phi() [2/2]

Foam::surfaceScalarField & phi ( )
inline

Access the mixture flux.

Definition at line 202 of file phaseSystemI.H.

◆ dpdt() [1/2]

const Foam::volScalarField & dpdt ( ) const
inline

Return the rate of change of the pressure.

Definition at line 208 of file phaseSystemI.H.

◆ dpdt() [2/2]

Foam::volScalarField & dpdt ( )
inline

Access the rate of change of the pressure.

Definition at line 214 of file phaseSystemI.H.

◆ MRF()

const Foam::IOMRFZoneList & MRF ( ) const
inline

Return MRF zones.

Definition at line 220 of file phaseSystemI.H.

◆ fvModels() [1/2]

Foam::fvModels & fvModels ( fvMesh mesh)
inline

Access the fvModels.

Definition at line 226 of file phaseSystemI.H.

References mesh, and dictionary::New().

Referenced by fractal::correct().

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

◆ fvModels() [2/2]

const Foam::fvModels & fvModels ( ) const
inline

Access the fvModels.

Definition at line 232 of file phaseSystemI.H.

References dictionary::New().

Here is the call graph for this function:

◆ fvConstraints() [1/2]

Access the fvConstraints.

Definition at line 238 of file phaseSystemI.H.

References mesh, and dictionary::New().

Referenced by fractal::correct().

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

◆ fvConstraints() [2/2]

const Foam::fvConstraints & fvConstraints ( ) const
inline

Access the fvConstraints.

Definition at line 244 of file phaseSystemI.H.

References dictionary::New().

Here is the call graph for this function:

◆ foundInterfacialModel()

bool foundInterfacialModel ( const phaseInterface interface) const

Check availability of a sub model for a given interface.

Definition at line 31 of file phaseSystemTemplates.C.

References objectRegistry::foundObject(), IOobject::groupName(), phaseSystem::mesh(), and phaseInterface::name().

Referenced by kineticTheoryModel::correct(), and phaseForces::phaseForces().

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

◆ lookupInterfacialModel()

◆ rho()

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

Return the mixture density.

Definition at line 452 of file phaseSystem.C.

References rho.

◆ U()

Return the mixture velocity.

Definition at line 479 of file phaseSystem.C.

References U.

◆ sigma() [1/2]

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

Return the surface tension coefficient for an interface.

Definition at line 507 of file phaseSystem.C.

References surfaceTensionCoefficientModel::dimSigma, and GeometricField< Type, GeoMesh, PrimitiveField >::New().

Referenced by IATEsource::sigma().

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

◆ sigma() [2/2]

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

Return the surface tension coefficient for an interface on a.

patch

Definition at line 526 of file phaseSystem.C.

References patchi.

◆ nearInterface()

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

Indicator of the proximity of the interface.

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

Definition at line 543 of file phaseSystem.C.

References Foam::dimless, forAll, Foam::max(), GeometricField< Type, GeoMesh, PrimitiveField >::New(), Foam::pos0(), and tmp< T >::ref().

Here is the call graph for this function:

◆ deltaN()

const Foam::dimensionedScalar & deltaN ( ) const
inline

Stabilisation for normalisation of the interface normal.

Definition at line 250 of file phaseSystemI.H.

◆ surfaceTension()

Foam::tmp< Foam::surfaceScalarField > surfaceTension ( const phaseModel phase1) const

Return the surface tension force.

Definition at line 568 of file phaseSystem.C.

References forAll, Foam::fvc::interpolate(), K, GeometricField< Type, GeoMesh, PrimitiveField >::New(), tmp< T >::ref(), Foam::constant::physicoChemical::sigma, and Foam::fvc::snGrad().

Here is the call graph for this function:

◆ incompressible()

bool incompressible ( ) const

Return incompressibility.

Definition at line 607 of file phaseSystem.C.

References forAll.

◆ implicitPhasePressure()

bool implicitPhasePressure ( ) const

Returns true if the phase pressure is treated implicitly.

in the phase fraction equations

Definition at line 48 of file phaseSystemSolve.C.

References forAll, phaseSystem::mesh(), IOobject::name(), and phaseSystem::phases().

Here is the call graph for this function:

◆ solve()

void solve ( const alphaControl alphaControls,
const PtrList< volScalarField > &  rAs,
const momentumTransferSystem mts 
)

Solve for the phase fractions.

Definition at line 68 of file phaseSystemSolve.C.

References Foam::fvc::absolute(), alpha(), momentumTransferSystem::alphaDByAf(), phaseModel::alphaMax(), phaseModel::alphaPhi(), phaseModel::alphaPhiRef(), phaseModel::alphaRhoPhiRef(), GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), phaseSystem::alphaControl::clip, Foam::MULES::correct(), phaseModel::correctInflowOutflow(), fvsPatchField< Type >::coupled(), Foam::fvc::ddt(), Foam::fvm::ddt(), Foam::dimless, Foam::dimTime, Foam::fvc::div(), phaseModel::divU(), localEulerDdt::enabled(), Foam::endl(), Foam::MULES::explicitSolve(), control::extremaCoeff, fvMatrix< Type >::flux(), limitedSurfaceInterpolationScheme< Type >::flux(), Foam::fvc::flux(), forAll, control::globalBounds, IOobject::groupName(), Foam::identityMap(), phaseModel::index(), Foam::Info, surfaceInterpolationScheme< Type >::interpolate(), Foam::fvc::interpolate(), Foam::fvm::laplacian(), Foam::MULES::limit(), Foam::MULES::limitCorr(), Foam::MULES::limitSum(), Foam::MULES::limitSumCorr(), localEulerDdt::localRSubDeltaT(), Foam::mag(), Foam::max(), GeometricField< Type, GeoMesh, PrimitiveField >::maxMin(), Foam::min(), phaseSystem::alphaControl::MULES, phaseSystem::alphaControl::MULESCorr, phaseSystem::alphaControl::MULESCorrRelax, phaseSystem::alphaControl::nAlphaCorr, phaseSystem::alphaControl::nAlphaSubCycles, phaseModel::name(), IOobject::name(), DimensionedField< Type, GeoMesh, PrimitiveField >::New(), word::null, patchi, phaseModel::phi(), GeometricField< Type, GeoMesh, PrimitiveField >::primitiveField(), phaseModel::rho(), PtrList< T >::set(), UPtrList< T >::set(), List< T >::setSize(), UPtrList< T >::setSize(), UPtrList< T >::size(), Foam::fvc::snGrad(), fvMatrix< Type >::solve(), Foam::fvc::Sp(), Foam::fvm::Sp(), phaseModel::stationary(), Foam::fvc::Su(), phaseModel::U(), GeometricField< Type, GeoMesh, PrimitiveField >::v(), Foam::blendedInterfacialModel::valid(), phaseSystem::alphaControl::vDotResidualAlpha, and DimensionedField< Type, GeoMesh, PrimitiveField >::weightedAverage().

Here is the call graph for this function:

◆ correct()

void correct ( )

Correct the fluid properties other than those listed below.

Definition at line 621 of file phaseSystem.C.

References forAll.

◆ correctContinuityError()

◆ correctKinematics()

void correctKinematics ( )

Correct the kinematics.

Definition at line 666 of file phaseSystem.C.

References Foam::fvc::ddt(), forAll, p, and thermo.

Referenced by phaseSystem::phaseSystem(), and multiphaseEuler::pressureCorrector().

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

◆ correctThermo()

void correctThermo ( )

Correct the thermodynamics.

Definition at line 684 of file phaseSystem.C.

References forAll.

◆ correctReactions()

void correctReactions ( )

Correct the reactions.

Definition at line 693 of file phaseSystem.C.

References forAll.

◆ correctSpecies()

void correctSpecies ( )

Correct the species mass fractions.

Definition at line 702 of file phaseSystem.C.

References forAll.

◆ predictMomentumTransport()

void predictMomentumTransport ( )

Predict the momentumTransport.

Definition at line 711 of file phaseSystem.C.

References forAll.

◆ predictThermophysicalTransport()

void predictThermophysicalTransport ( )

Predict the energy transport e.g. alphat.

Definition at line 720 of file phaseSystem.C.

References forAll.

◆ correctMomentumTransport()

void correctMomentumTransport ( )

Correct the momentumTransport.

Definition at line 729 of file phaseSystem.C.

References forAll.

◆ correctThermophysicalTransport()

void correctThermophysicalTransport ( )

Correct the energy transport e.g. alphat.

Definition at line 738 of file phaseSystem.C.

References forAll.

◆ meshUpdate()

void meshUpdate ( )

Update the fluid properties for mesh changes.

Definition at line 747 of file phaseSystem.C.

◆ correctBoundaryFlux()

void correctBoundaryFlux ( )

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

Definition at line 761 of file phaseSystem.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryFieldRef(), forAll, patchi, phaseModel::phiRef(), and phaseModel::U().

Here is the call graph for this function:

◆ correctPhi()

◆ read()

bool read ( )
virtual

Read base phaseProperties dictionary.

Reimplemented from regIOobject.

Definition at line 905 of file phaseSystem.C.

References forAll, and regIOobject::read().

Here is the call graph for this function:

Member Data Documentation

◆ mesh_

const fvMesh& mesh_
protected

Reference to the mesh.

Definition at line 156 of file phaseSystem.H.

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

◆ pimple_

const pimpleNoLoopControl& pimple_
protected

Reference to pimpleNoLoopControl.

Definition at line 159 of file phaseSystem.H.

◆ MRF_

IOMRFZoneList MRF_
protected

Optional MRF zones.

Definition at line 162 of file phaseSystem.H.

◆ 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 166 of file phaseSystem.H.

Referenced by phaseSystem::phaseSystem().

◆ phaseModels_

phaseModelList phaseModels_
protected

Phase models.

Definition at line 169 of file phaseSystem.H.

Referenced by phaseSystem::phaseSystem().

◆ movingPhaseModels_

phaseModelPartialList movingPhaseModels_
protected

Moving phase models.

Definition at line 172 of file phaseSystem.H.

Referenced by phaseSystem::phaseSystem(), and phaseSystem::sumAlphaMoving().

◆ stationaryPhaseModels_

phaseModelPartialList stationaryPhaseModels_
protected

Stationary phase models.

Definition at line 175 of file phaseSystem.H.

Referenced by phaseSystem::phaseSystem().

◆ thermalPhaseModels_

phaseModelPartialList thermalPhaseModels_
protected

Thermal phase models.

Definition at line 178 of file phaseSystem.H.

Referenced by phaseSystem::phaseSystem().

◆ multicomponentPhaseModels_

phaseModelPartialList multicomponentPhaseModels_
protected

Multi-component phase models.

Definition at line 181 of file phaseSystem.H.

Referenced by phaseSystem::phaseSystem().

◆ phi_

surfaceScalarField phi_
protected

Total volumetric flux.

Definition at line 184 of file phaseSystem.H.

Referenced by phaseSystem::phaseSystem().

◆ dpdt_

volScalarField dpdt_
protected

Rate of change of pressure.

Definition at line 187 of file phaseSystem.H.

◆ cAlphas_

const cAlphaTable cAlphas_
protected

Interface compression coefficients.

Definition at line 190 of file phaseSystem.H.

◆ deltaN_

const dimensionedScalar deltaN_
protected

Stabilisation for normalisation of the interface normal.

Definition at line 193 of file phaseSystem.H.

◆ surfaceTensionCoefficientModels_

const surfaceTensionCoefficientModelTable surfaceTensionCoefficientModels_
protected

Surface tension models.

Definition at line 197 of file phaseSystem.H.

◆ propertiesName


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