multiphaseSystem Class Referenceabstract

Incompressible multi-phase mixture with built in solution for the phase fractions with interface compression for interface-capturing. More...

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

Classes

class  interfacePair
 Name pair for the interface. More...
 

Public Types

typedef HashPtrTable< dragModel, interfacePair, interfacePair::symmHashdragModelTable
 
typedef HashPtrTable< volScalarField, interfacePair, interfacePair::symmHashdragCoeffFields
 
- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Public Types inherited from dictionary
typedef Searcher< true > const_searcher
 Searcher with const access. More...
 
typedef Searcher< false > searcher
 Searcher with non-const access. More...
 

Public Member Functions

 multiphaseSystem (const volVectorField &U, const surfaceScalarField &phi)
 Construct from components. More...
 
virtual ~multiphaseSystem ()=default
 Destructor. More...
 
const PtrDictionary< phaseModel > & phases () const
 Return the phases. More...
 
PtrDictionary< phaseModel > & phases ()
 Return the phases. More...
 
tmp< volScalarFieldrho () const
 Return the mixture density. More...
 
tmp< scalarFieldrho (const label patchi) const
 Return the mixture density for patch. More...
 
tmp< volScalarFieldnu () const
 Return the mixture laminar viscosity. More...
 
tmp< scalarFieldnu (const label patchi) const
 Return the laminar viscosity for patch. More...
 
tmp< volScalarFieldCvm (const phaseModel &phase) const
 Return the virtual-mass coefficient for the given phase. More...
 
tmp< volVectorFieldSvm (const phaseModel &phase) const
 Return the virtual-mass source for the given phase. More...
 
const dragModelTabledragModels () const
 Return the table of drag models. More...
 
autoPtr< dragCoeffFieldsdragCoeffs () const
 Return the drag coefficients for all of the interfaces. More...
 
tmp< volScalarFielddragCoeff (const phaseModel &phase, const dragCoeffFields &dragCoeffs) const
 Return the sum of the drag coefficients for the given phase. More...
 
tmp< surfaceScalarFieldsurfaceTension (const phaseModel &phase) const
 
tmp< volScalarFieldnearInterface () const
 Indicator of the proximity of the interface. More...
 
void solve ()
 Solve for the mixture phase-fractions. More...
 
void correct ()
 Dummy correct. More...
 
bool read ()
 Read base transportProperties dictionary. More...
 
 TypeName ("multiphaseSystem")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, multiphaseSystem, dictionary,(const fvMesh &mesh),(mesh))
 
 multiphaseSystem (const fvMesh &)
 Construct from fvMesh. More...
 
virtual ~multiphaseSystem ()=default
 Destructor. More...
 
virtual void solve ()
 Solve for the phase fractions. More...
 
const UPtrList< phaseModel > & phases () const
 Return phases. More...
 
UPtrList< phaseModel > & phases ()
 Return phases. More...
 
const phaseModelphase (const label i) const
 Constant access phase model i. More...
 
phaseModelphase (const label i)
 Access phase model i. More...
 
dimensionedScalar ddtAlphaMax () const
 Access to ddtAlphaMax. More...
 
scalar maxDiffNo () const
 Maximum diffusion number. More...
 
const compressionFluxTablelimitedPhiAlphas () const
 Access to compression fluxes for phaes. More...
 
SuSpTableSu ()
 Access Su. More...
 
SuSpTableSp ()
 Access Sp. More...
 
virtual bool read ()
 Read thermophysical properties dictionary. More...
 
 TypeName ("multiphaseSystem")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, multiphaseSystem, dictionary,(const fvMesh &mesh),(mesh))
 
 multiphaseSystem (const fvMesh &mesh)
 Construct from fvMesh. More...
 
virtual ~multiphaseSystem ()=default
 Destructor. More...
 
tmp< surfaceScalarFieldsurfaceTension (const phaseModel &phase) const
 Return the surface tension force. More...
 
tmp< volScalarFieldnearInterface () const
 Indicator of the proximity of the interface. More...
 
virtual void solve ()
 Solve for the phase fractions. More...
 
tmp< volScalarFieldsigma (const phasePairKey &key) const
 Return the surface tension coefficient for a pair. More...
 
virtual PtrList< volScalarFielddmdts () const
 Return the mass transfer rates for each phase. More...
 
- Public Member Functions inherited from IOdictionary
 IOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 
 IOdictionary (const IOobject &io, const dictionary &dict)
 
 IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)
 
 IOdictionary (const IOobject &io, Istream &is)
 Construct given an IOobject and Istream. More...
 
virtual ~IOdictionary ()=default
 Destructor. More...
 
virtual bool global () const
 Is object global. More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
- Public Member Functions inherited from baseIOdictionary
 TypeName ("dictionary")
 Declare type-name, virtual type (with debug switch) More...
 
 baseIOdictionary (const baseIOdictionary &)=default
 Copy construct. More...
 
 baseIOdictionary (baseIOdictionary &&)=default
 Move construct. More...
 
virtual ~baseIOdictionary ()=default
 Destructor. More...
 
 baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 
 baseIOdictionary (const IOobject &io, const dictionary &dict)
 
 baseIOdictionary (const IOobject &io, Istream &is)
 Construct given an IOobject and Istream (ununsed) More...
 
const wordname () const
 
virtual bool readData (Istream &)
 The readData function required by regIOobject read operation. More...
 
virtual bool writeData (Ostream &) const
 The writeData function required by regIOobject write operation. More...
 
void operator= (const baseIOdictionary &rhs)
 Copy assignment of dictionary entries (leave regIOobject untouched) More...
 
void operator= (const dictionary &rhs)
 Copy assignment of dictionary entries. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 
 regIOobject (const regIOobject &rio)
 Copy construct. More...
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 Copy construct with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry, if not already registered. More...
 
bool checkOut ()
 Remove all file watches and remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
bool store ()
 
void release (const bool unregister=false)
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
label & eventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set as up-to-date. More...
 
virtual void rename (const word &newName)
 Rename. More...
 
const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data or nullptr. More...
 
dictionarygetMetaData () noexcept
 Get or create meta-data. More...
 
void removeMetaData ()
 Remove meta-data. More...
 
virtual void updateMetaData ()
 Update internal meta-data (eg, prior to writing) More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool valid=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write using stream options. More...
 
virtual bool write (const bool valid=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &io)
 Copy assignment. More...
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
 Write using given format, version and compression. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Declare type-name, virtual type (with debug switch) More...
 
 IOobject (const IOobject &)=default
 Copy construct. More...
 
virtual ~IOobject ()=default
 Destructor. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Copy construct, resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Copy construct, resetting name. More...
 
 IOobject (const IOobject &io, readOption, writeOption)
 Copy construct, resetting io options. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
const objectRegistrydb () const noexcept
 Return the local objectRegistry. More...
 
const Timetime () const
 Return Time associated with the objectRegistry. More...
 
const wordname () const noexcept
 Return name. More...
 
const wordheaderClassName () const noexcept
 Return name of the class name read from header. More...
 
wordheaderClassName () noexcept
 Return non-constant access to the class name read from header. More...
 
const stringnote () const noexcept
 Return the optional note. More...
 
stringnote () noexcept
 Return non-constant access to the optional note. More...
 
bool registerObject () const noexcept
 Should object created with this IOobject be registered? More...
 
bool registerObject (bool on) noexcept
 Change registration preference, return previous value. More...
 
bool globalObject () const noexcept
 Is object same for all processors? More...
 
bool globalObject (bool on) noexcept
 Change global-object status, return previous value. More...
 
unsigned labelByteSize () const noexcept
 The sizeof (label) in bytes, possibly read from the header. More...
 
unsigned scalarByteSize () const noexcept
 The sizeof (scalar) in bytes, possibly read from the header. More...
 
bool isHeaderClassName (const word &clsName) const
 Test if headerClassName() equals the given class name. More...
 
template<class Type >
bool isHeaderClassName () const
 Test if headerClassName() equals Type::typeName. More...
 
readOption readOpt () const noexcept
 The read option. More...
 
readOption readOpt (readOption opt) noexcept
 Change the read option, return previous value. More...
 
writeOption writeOpt () const noexcept
 The write option. More...
 
writeOption writeOpt (writeOption opt) noexcept
 Change the write option, return previous value. More...
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const noexcept
 
fileNameinstance () noexcept
 
const fileNamelocal () const noexcept
 
fileName path () const
 The complete path. More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName objectPath () const
 The complete path + object name. More...
 
fileName objectRelPath () const
 The object path relative to the root. More...
 
fileName localFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches up if in parallel. More...
 
IOstreamOption parseHeader (const dictionary &headerDict)
 
bool readHeader (Istream &is)
 
bool readHeader (dictionary &headerDict, Istream &is)
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (uses typeFilePath to find file) and check its info. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &os) const
 Write header with current type() More...
 
bool writeHeader (Ostream &os, const word &objectType) const
 Write header with override of type. More...
 
void writeHeader (dictionary &dict, IOstreamOption streamOpt) const
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 
bool good () const noexcept
 
bool bad () const noexcept
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &io)
 
readOptionreadOpt () noexcept
 Access to the read option. More...
 
writeOptionwriteOpt () noexcept
 Access to the write option. More...
 
boolregisterObject () noexcept
 Access to the register object option. More...
 
boolglobalObject () noexcept
 Access to the global object option. More...
 
template<>
bool isHeaderClassName () const
 Specialization for void always returns true (no headerClassName check). More...
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 Default construct, a top-level empty dictionary. More...
 
 dictionary (const fileName &name)
 Construct top-level empty dictionary with given name. More...
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false)
 
 dictionary (Istream &is)
 
 dictionary (Istream &is, bool keepHeader)
 
 dictionary (const dictionary &parentDict, const dictionary &dict)
 Copy construct given the parent dictionary. More...
 
 dictionary (const dictionary &dict)
 Copy construct top-level dictionary. More...
 
 dictionary (const dictionary *dict)
 Construct top-level dictionary as copy from pointer to dictionary. More...
 
 dictionary (const dictionary &parentDict, dictionary &&dict)
 Move construct for given parent dictionary. More...
 
 dictionary (dictionary &&dict)
 Move construct top-level dictionary. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const fileNamename () const noexcept
 The dictionary name. More...
 
fileNamename () noexcept
 The dictionary name for modification (use with caution). More...
 
word dictName () const
 The local dictionary name (final part of scoped name) More...
 
fileName relativeName (const bool caseTag=false) const
 The dictionary name relative to the case. More...
 
bool isNullDict () const noexcept
 The dictionary is actually dictionary::null (root dictionary) More...
 
const dictionaryparent () const noexcept
 Return the parent dictionary. More...
 
const dictionarytopDict () const
 Return the top of the tree. More...
 
label startLineNumber () const
 Return line number of first token in dictionary. More...
 
label endLineNumber () const
 Return line number of last token in dictionary. More...
 
SHA1Digest digest () const
 Return the SHA1 digest of the dictionary contents. More...
 
tokenList tokens () const
 Return the dictionary as a list of tokens. More...
 
bool found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search for an entry (const access) with the given keyword. More...
 
entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find for an entry (non-const access) with the given keyword. More...
 
const entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find an entry (const access) with the given keyword. More...
 
const entryfindScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search for a scoped entry (const access) with the given keyword. More...
 
dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary pointer if present. More...
 
const dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary pointer if present. More...
 
const entrylookupEntry (const word &keyword, enum keyType::option matchOpt) const
 Search for an entry (const access) with the given keyword. More...
 
ITstreamlookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
bool readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T >
bool readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T , class Predicate >
bool readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T , class Predicate >
bool readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
bool isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Check if entry is found and is a sub-dictionary. More...
 
const dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary for manipulation. More...
 
dictionarysubDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary for manipulation. More...
 
dictionary subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const
 
const dictionaryoptionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary, otherwise return this dictionary. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the sorted table of contents. More...
 
template<class Compare >
wordList sortedToc (const Compare &comp) const
 Return table of contents sorted using the specified comparator. More...
 
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns. More...
 
bool substituteKeyword (const word &keyword, bool mergeEntry=false)
 Substitute the given keyword (which is prefixed by '$') More...
 
bool substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
 Substitute the given scoped keyword (which is prefixed by '$') More...
 
entryadd (entry *entryPtr, bool mergeEntry=false)
 Add a new entry. More...
 
entryadd (const entry &e, bool mergeEntry=false)
 Add an entry. More...
 
entryadd (const keyType &k, const word &v, bool overwrite=false)
 Add a word entry. More...
 
entryadd (const keyType &k, const string &v, bool overwrite=false)
 Add a string entry. More...
 
entryadd (const keyType &k, const label v, bool overwrite=false)
 Add a label entry. More...
 
entryadd (const keyType &k, const scalar v, bool overwrite=false)
 Add a scalar entry. More...
 
entryadd (const keyType &k, const dictionary &d, bool mergeEntry=false)
 Add a dictionary entry. More...
 
template<class T >
entryadd (const keyType &k, const T &v, bool overwrite=false)
 Add a T entry. More...
 
entryset (entry *entryPtr)
 Assign a new entry, overwriting any existing entry. More...
 
entryset (const entry &e)
 Assign a new entry, overwriting any existing entry. More...
 
entryset (const keyType &k, const dictionary &v)
 Assign a dictionary entry, overwriting any existing entry. More...
 
template<class T >
entryset (const keyType &k, const T &v)
 Assign a T entry, overwriting any existing entry. More...
 
bool remove (const word &keyword)
 Remove an entry specified by keyword. More...
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
 Change the keyword for an entry,. More...
 
bool merge (const dictionary &dict)
 Merge entries from the given dictionary. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (dictionary &dict)
 Transfer the contents of the argument and annul the argument. More...
 
void checkITstream (const ITstream &is, const word &keyword) const
 
bool read (Istream &is)
 Read dictionary from Istream. Discards the header. More...
 
bool read (Istream &is, bool keepHeader)
 Read dictionary from Istream, optionally keeping the header. More...
 
void writeEntry (Ostream &os) const
 Write sub-dictionary with its dictName as its header. More...
 
void writeEntry (const keyType &keyword, Ostream &os) const
 Write sub-dictionary with the keyword as its header. More...
 
void writeEntries (Ostream &os, const bool extraNewLine=false) const
 Write dictionary entries. More...
 
void write (Ostream &os, const bool subDict=true) const
 Write dictionary, normally with sub-dictionary formatting. More...
 
const_searcher csearch (const word &keyword, enum keyType::option=keyType::REGEX) const
 Search dictionary for given keyword. More...
 
const_searcher search (const word &keyword, enum keyType::option=keyType::REGEX) const
 Search dictionary for given keyword. More...
 
searcher search (const word &keyword, enum keyType::option=keyType::REGEX)
 Search dictionary for given keyword. More...
 
const_searcher csearchScoped (const word &keyword, enum keyType::option) const
 Search using scoping. More...
 
const_searcher searchScoped (const word &keyword, enum keyType::option) const
 Search using dot or slash scoping. More...
 
searcher searchScoped (const word &keyword, enum keyType::option)
 Search using dot or slash scoping. More...
 
const dictionarycfindScopedDict (const fileName &dictPath) const
 Locate a sub-dictionary using slash-scoping. More...
 
const dictionaryfindScopedDict (const fileName &dictPath) const
 Locate a sub-dictionary using slash-scoping. More...
 
dictionaryfindScopedDict (const fileName &dictPath)
 Locate a sub-dictionary using slash-scoping. More...
 
dictionarymakeScopedDict (const fileName &dictPath)
 Locate existing or create sub-dictionary using slash-scoping. More...
 
const_searcher csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 Search dictionary for given keyword and any compatibility names. More...
 
bool foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 Search dictionary for given keyword and any compatibility names. More...
 
const entryfindCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const
 
const entrylookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const
 
ITstreamlookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
template<class T >
T getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
template<class T >
T getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const
 
template<class T >
bool readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const
 
template<class T >
bool readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const
 
void operator= (const dictionary &rhs)
 Copy assignment. More...
 
void operator+= (const dictionary &rhs)
 Include entries from the given dictionary. More...
 
void operator|= (const dictionary &rhs)
 Conditionally include entries from the given dictionary. More...
 
void operator<<= (const dictionary &rhs)
 Unconditionally include entries from the given dictionary. More...
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
T lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
ITstreamoperator[] (const word &keyword) const
 Deprecated(2018-07) find and return an entry data stream. More...
 
bool found (const word &keyword, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
 Deprecated(2018-10) More...
 
const entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 Deprecated(2018-10) More...
 
const entrylookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 Deprecated(2018-10) More...
 
const dictionarysubDictPtr (const word &keyword) const
 Deprecated(2018-10) More...
 
dictionarysubDictPtr (const word &keyword)
 
const entrylookupEntry (const word &keyword, bool recursive, bool patternMatch) const
 Deprecated(2018-10) More...
 
ITstreamlookup (const word &keyword, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
 Deprecated(2018-10) More...
 
template<class T >
bool readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
template<class T >
T lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
 Deprecated(2018-10) find and return a T. More...
 
bool getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< bool >(const word&, keyType::option) More...
 
label getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< label >(const word&, keyType::option) More...
 
scalar getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< scalar >(const word&, keyType::option) More...
 
string getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< string >(const word&, keyType::option) More...
 
word getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< word >(const word&, keyType::option) More...
 
fileName getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< fileName >(const word&, keyType::option) More...
 
template<class Compare >
Foam::wordList sortedToc (const Compare &comp) const
 
template<class T >
Foam::entryadd (const keyType &k, const T &v, bool overwrite)
 
template<class T >
Foam::entryset (const keyType &k, const T &v)
 
- Public Member Functions inherited from ILList< LListBase, T >
 ILList ()=default
 Default construct. More...
 
 ILList (T *item)
 Construct and insert the initial T item pointer. More...
 
 ILList (Istream &is)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &lst)
 Copy construct using the 'clone()' method for each element. More...
 
 ILList (ILList< LListBase, T > &&lst)
 Move construct. More...
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone 'clone()'. More...
 
template<class INew >
 ILList (Istream &is, const INew &inew)
 Construct from Istream using given Istream constructor class. More...
 
 ~ILList ()
 Destructor. More...
 
bool eraseHead ()
 Remove the head element specified from the list and delete it. More...
 
bool erase (T *item)
 Remove the specified element from the list and delete it. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (ILList< LListBase, T > &lst)
 
void operator= (const ILList< LListBase, T > &lst)
 Copy assignment using the 'clone()' method for each element. More...
 
void operator= (ILList< LListBase, T > &&lst)
 Move assignment. More...
 
- Public Member Functions inherited from transportModel
 TypeName ("transportModel")
 Runtime type information. More...
 
 transportModel ()
 Construct from components. More...
 
virtual ~transportModel ()
 Destructor. More...
 

Static Public Member Functions

static autoPtr< multiphaseSystemNew (const fvMesh &mesh)
 
static autoPtr< multiphaseSystemNew (const fvMesh &mesh)
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 Status of output file banner. More...
 
static bool bannerEnabled (bool on) noexcept
 Enable/disable an output file banner. More...
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class StringType >
static word groupName (StringType base, const word &group)
 Create dot-delimited name.group string. More...
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
static word scopedName (const std::string &scope, const word &name)
 Create scope:name or scope_name string. More...
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name. More...
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from dictionary
static int reportOptional () noexcept
 Return the state of reporting optional (default) entries. More...
 
static int reportOptional (const int level) noexcept
 Change the state of reporting optional (default) entries. More...
 
static autoPtr< dictionaryNew (Istream &is)
 Construct top-level dictionary on freestore from Istream. More...
 

Protected Types

typedef HashTable< volScalarField::InternalSuSpTable
 
typedef HashTable< scalar, phasePairKey, phasePairKey::hashscalarTable
 
typedef HashTable< surfaceScalarFieldcompressionFluxTable
 

Protected Member Functions

void calculateSuSp ()
 Calculate Sp and Su. More...
 
void solveAlphas ()
 Solve alphas. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 Set the object state to bad. More...
 

Protected Attributes

UPtrList< phaseModelphases_
 Unallocated phase list. More...
 
scalarTable cAlphas_
 Table for compression factors between phases. More...
 
dimensionedScalar ddtAlphaMax_
 Maximum volumen rate change. More...
 
compressionFluxTable limitedPhiAlphas_
 Compression fluxed for phases. More...
 
SuSpTable Su_
 Su phase source terms. More...
 
SuSpTable Sp_
 Sp phase source terms. More...
 

Static Protected Attributes

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

Additional Inherited Members

- Public Attributes inherited from dictionary
friend const_searcher
 Declare friendship with the searcher classes. More...
 
friend searcher
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 Names for the fileCheckTypes. More...
 
static char scopeSeparator
 Character for scoping object names (':' or '_') More...
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
static float fileModificationSkew
 Time skew (seconds) for file modification checks. More...
 
static int maxFileModificationPolls
 Max number of times to poll for file modification changes. More...
 
- Static Public Attributes inherited from dictionary
static int writeOptionalEntries
 Report optional keywords and values if not present in dictionary. More...
 
static const dictionary null
 An empty dictionary, which is also the parent for all dictionaries. More...
 
static refPtr< OSstreamreportingOutput
 Output location when reporting default values. More...
 
- Static Protected Member Functions inherited from IOobject
static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 

Detailed Description

Incompressible multi-phase mixture with built in solution for the phase fractions with interface compression for interface-capturing.

Class which solves the volume fraction equations for two phases.

Class which solves the volume fraction equations for multiple phases.

Derived from transportModel so that it can be unused in conjunction with the incompressible turbulence models.

Surface tension and contact-angle is handled for the interface between each phase-pair.

Source files

Source files

Source files

Definition at line 65 of file multiphaseSystem.H.

Member Typedef Documentation

◆ dragModelTable

◆ dragCoeffFields

◆ SuSpTable

Definition at line 58 of file multiphaseSystem.H.

◆ scalarTable

Definition at line 61 of file multiphaseSystem.H.

◆ compressionFluxTable

Definition at line 63 of file multiphaseSystem.H.

Constructor & Destructor Documentation

◆ multiphaseSystem() [1/3]

multiphaseSystem ( const volVectorField U,
const surfaceScalarField phi 
)

Construct from components.

Definition at line 361 of file multiphaseSystem.C.

References Foam::endl(), forAllConstIters(), Foam::glTF::key(), phaseModel::name(), dragModel::New(), phase1, phase2, autoPtr< T >::ptr(), and WarningInFunction.

Here is the call graph for this function:

◆ ~multiphaseSystem() [1/3]

virtual ~multiphaseSystem ( )
virtualdefault

Destructor.

◆ multiphaseSystem() [2/3]

multiphaseSystem ( const fvMesh mesh)

Construct from fvMesh.

Definition at line 59 of file multiphaseSystem.C.

References Foam::dimless, Foam::dimTime, forAllConstIters(), forAllIters, mesh, phaseModel::name(), phasei, and Foam::Zero.

Here is the call graph for this function:

◆ ~multiphaseSystem() [2/3]

virtual ~multiphaseSystem ( )
virtualdefault

Destructor.

◆ multiphaseSystem() [3/3]

multiphaseSystem ( const fvMesh mesh)
explicit

Construct from fvMesh.

◆ ~multiphaseSystem() [3/3]

virtual ~multiphaseSystem ( )
virtualdefault

Destructor.

Member Function Documentation

◆ phases() [1/4]

const Foam::UPtrList< Foam::phaseModel > & phases ( ) const
inline

Return the phases.

Definition at line 215 of file multiphaseSystem.H.

◆ phases() [2/4]

Foam::UPtrList< Foam::phaseModel > & phases ( )
inline

Return the phases.

Definition at line 221 of file multiphaseSystem.H.

◆ rho() [1/2]

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

Return the mixture density.

Definition at line 452 of file multiphaseSystem.C.

References rho, and trho.

◆ rho() [2/2]

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

Return the mixture density for patch.

Definition at line 469 of file multiphaseSystem.C.

References rho, and trho.

◆ nu() [1/2]

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

Return the mixture laminar viscosity.

Implements transportModel.

Definition at line 485 of file multiphaseSystem.C.

References Foam::constant::physicoChemical::mu, tmp< T >::ref(), and rho.

Here is the call graph for this function:

◆ nu() [2/2]

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

Return the laminar viscosity for patch.

Implements transportModel.

Definition at line 502 of file multiphaseSystem.C.

References Foam::constant::physicoChemical::mu, tmp< T >::ref(), and rho.

Here is the call graph for this function:

◆ Cvm()

Foam::tmp< Foam::volScalarField > Cvm ( const phaseModel phase) const

Return the virtual-mass coefficient for the given phase.

Definition at line 523 of file multiphaseSystem.C.

References Foam::dimDensity, phase2, tmp< T >::ref(), phase::rho(), phaseModel::rho(), and Foam::Zero.

Here is the call graph for this function:

◆ Svm()

Foam::tmp< Foam::volVectorField > Svm ( const phaseModel phase) const

Return the virtual-mass source for the given phase.

Definition at line 571 of file multiphaseSystem.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), phaseModel::DDtU(), forAll, phase2, tmp< T >::ref(), GeometricField< Type, PatchField, GeoMesh >::ref(), phase::rho(), phaseModel::rho(), and Foam::Zero.

Here is the call graph for this function:

◆ dragModels()

const dragModelTable& dragModels ( ) const
inline

Return the table of drag models.

Definition at line 245 of file multiphaseSystem.H.

◆ dragCoeffs()

Return the drag coefficients for all of the interfaces.

Definition at line 642 of file multiphaseSystem.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), forAll, forAllConstIters(), dragModel::K(), Foam::mag(), Foam::max(), dragModel::phase1(), dragModel::phase2(), phaseModel::phi(), dragModel::residualPhaseFraction(), dragModel::residualSlip(), autoPtr< T >::set(), and phaseModel::U().

Here is the call graph for this function:

◆ dragCoeff()

Foam::tmp< Foam::volScalarField > dragCoeff ( const phaseModel phase,
const dragCoeffFields dragCoeffs 
) const

Return the sum of the drag coefficients for the given phase.

Definition at line 694 of file multiphaseSystem.C.

References dragCoeffs(), and tmp< T >::good().

Here is the call graph for this function:

◆ surfaceTension() [1/2]

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

Definition at line 743 of file multiphaseSystem.C.

References Foam::fvc::interpolate(), phase1, phase2, tmp< T >::ref(), sigma(), and Foam::fvc::snGrad().

Here is the call graph for this function:

◆ nearInterface() [1/2]

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 794 of file multiphaseSystem.C.

References Foam::dimless, Foam::max(), Foam::pos0(), and tmp< T >::ref().

Here is the call graph for this function:

◆ solve() [1/3]

void solve ( )

Solve for the mixture phase-fractions.

Definition at line 821 of file multiphaseSystem.C.

References Foam::constant::atomic::alpha, alphaControls, phase::correct(), TimeState::deltaT(), stdFoam::end(), dictionary::get(), nAlphaSubCycles(), dimensioned< Type >::name(), phasei, runTime, objectRegistry::time(), TimeState::timeIndex(), and Time::timeName().

Here is the call graph for this function:

◆ correct()

void correct ( )
inlinevirtual

Dummy correct.

Implements transportModel.

Definition at line 270 of file multiphaseSystem.H.

◆ read() [1/2]

bool read ( )
virtual

Read base transportProperties dictionary.

Implements transportModel.

Definition at line 916 of file multiphaseSystem.C.

References dict, phasei, phase::read(), and regIOobject::read().

Here is the call graph for this function:

◆ calculateSuSp()

void calculateSuSp ( )
protected

Calculate Sp and Su.

Definition at line 122 of file multiphaseSystem.C.

References multiphaseSystem::Sp_, and multiphaseSystem::Su_.

◆ solveAlphas()

void solveAlphas ( )
protected

Solve alphas.

◆ TypeName() [1/2]

TypeName ( "multiphaseSystem"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

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

◆ New() [1/2]

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

Definition at line 33 of file multiphaseSystemNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and mesh.

Here is the call graph for this function:

◆ solve() [2/3]

virtual void solve ( )
virtual

Solve for the phase fractions.

◆ phases() [3/4]

const UPtrList<phaseModel>& phases ( ) const

Return phases.

◆ phases() [4/4]

UPtrList<phaseModel>& phases ( )

Return phases.

◆ phase() [1/2]

const Foam::phaseModel & phase ( const label  i) const

Constant access phase model i.

Definition at line 446 of file multiphaseSystem.C.

◆ phase() [2/2]

Foam::phaseModel & phase ( const label  i)

Access phase model i.

Definition at line 452 of file multiphaseSystem.C.

◆ ddtAlphaMax()

Foam::dimensionedScalar ddtAlphaMax ( ) const

Access to ddtAlphaMax.

Definition at line 458 of file multiphaseSystem.C.

◆ maxDiffNo()

Foam::scalar maxDiffNo ( ) const

Maximum diffusion number.

Definition at line 464 of file multiphaseSystem.C.

References Foam::max().

Here is the call graph for this function:

◆ limitedPhiAlphas()

const Foam::multiphaseSystem::compressionFluxTable & limitedPhiAlphas ( ) const

Access to compression fluxes for phaes.

Definition at line 480 of file multiphaseSystem.C.

◆ Su()

Access Su.

Definition at line 486 of file multiphaseSystem.C.

◆ Sp()

Access Sp.

Definition at line 492 of file multiphaseSystem.C.

◆ read() [2/2]

virtual bool read ( )
virtual

Read thermophysical properties dictionary.

Implements transportModel.

◆ TypeName() [2/2]

TypeName ( "multiphaseSystem"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [2/2]

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

◆ New() [2/2]

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

◆ surfaceTension() [2/2]

tmp<surfaceScalarField> surfaceTension ( const phaseModel phase) const

Return the surface tension force.

◆ nearInterface() [2/2]

tmp<volScalarField> nearInterface ( ) const

Indicator of the proximity of the interface.

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

◆ solve() [3/3]

virtual void solve ( )
virtual

Solve for the phase fractions.

◆ sigma()

Return the surface tension coefficient for a pair.

Definition at line 319 of file phaseSystem.C.

◆ dmdts()

Return the mass transfer rates for each phase.

Definition at line 351 of file phaseSystem.C.

Member Data Documentation

◆ phases_

UPtrList<phaseModel> phases_
protected

Unallocated phase list.

Definition at line 69 of file multiphaseSystem.H.

◆ cAlphas_

scalarTable cAlphas_
protected

Table for compression factors between phases.

Definition at line 72 of file multiphaseSystem.H.

◆ ddtAlphaMax_

dimensionedScalar ddtAlphaMax_
protected

Maximum volumen rate change.

Definition at line 75 of file multiphaseSystem.H.

◆ limitedPhiAlphas_

compressionFluxTable limitedPhiAlphas_
protected

Compression fluxed for phases.

Definition at line 78 of file multiphaseSystem.H.

◆ Su_

SuSpTable Su_
protected

Su phase source terms.

Definition at line 81 of file multiphaseSystem.H.

Referenced by multiphaseSystem::calculateSuSp().

◆ Sp_

SuSpTable Sp_
protected

Sp phase source terms.

Definition at line 84 of file multiphaseSystem.H.

Referenced by multiphaseSystem::calculateSuSp().

◆ 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 122 of file multiphaseSystem.H.


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