Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for multiphaseSystem:
Collaboration graph
[legend]

Classes

class  interfacePair
 

Public Types

typedef HashPtrTable< dragModel, interfacePair, interfacePair::symmHashdragModelTable
 
typedef HashPtrTable< volScalarField, interfacePair, interfacePair::symmHashdragCoeffFields
 
- Public Types inherited from phaseSystem
typedef HashPtrTable< volScalarField, phasePairKey, phasePairKey::hashKdTable
 
typedef HashPtrTable< volScalarField, phasePairKey, phasePairKey::hashVmTable
 
typedef HashPtrTable< fvVectorMatrix, word, string::hashmomentumTransferTable
 
typedef HashPtrTable< fvScalarMatrix, word, string::hashheatTransferTable
 
typedef HashPtrTable< fvScalarMatrix, word, string::hashmassTransferTable
 
typedef PtrListDictionary< phaseModelphaseModelList
 
- Public Types inherited from regIOobject
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Types of communications. 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...
 
- Public Types inherited from UILList< DLListBase, entry >
typedef entry value_type
 Type of values the DLList contains. More...
 
typedef entryreference
 Type that can be used for storing into DLList::value_type. More...
 
typedef const entryconst_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 DLListBase::iterator LListBase_iterator
 
typedef DLListBase::const_iterator LListBase_const_iterator
 

Public Member Functions

 multiphaseSystem (const volVectorField &U, const surfaceScalarField &phi)
 Construct from components. More...
 
virtual ~multiphaseSystem ()
 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 ()
 Destructor. More...
 
virtual const phaseSystem::KdTableKds () const =0
 Return the drag coefficient for all phase-pairs. More...
 
virtual tmp< volScalarFieldKd (const phaseModel &phase) const =0
 Return the drag coefficient for phase. More...
 
virtual autoPtr< PtrList< Foam::volVectorField > > Fs () const =0
 Return the combined force (lift + wall-lubrication) for phase pair. More...
 
virtual autoPtr< PtrList< Foam::surfaceScalarField > > phiDs (const PtrList< volScalarField > &rAUs) const =0
 Return the turbulent dispersion force on faces for phase pair. More...
 
virtual bool transfersMass (const phaseModel &phase) const =0
 Return true if there is mass transfer for phase. More...
 
virtual tmp< volScalarFielddmdt (const phaseModel &phase) const =0
 Return the total interfacial mass transfer rate for phase. More...
 
virtual autoPtr< momentumTransferTablemomentumTransfer () const =0
 Return the momentum transfer matrices. More...
 
virtual autoPtr< heatTransferTableheatTransfer () const =0
 Return the heat transfer matrices. More...
 
virtual autoPtr< massTransferTablemassTransfer () const =0
 Return the mass transfer matrices. More...
 
tmp< surfaceScalarFieldsurfaceTension (const phaseModel &phase) const
 
tmp< volScalarFieldnearInterface () const
 Indicator of the proximity of the interface. More...
 
virtual void solve ()
 Solve for the phase fractions. More...
 
- Public Member Functions inherited from phaseSystem
 TypeName ("phaseSystem")
 Runtime type information. More...
 
 phaseSystem (const fvMesh &mesh)
 Construct from fvMesh. More...
 
virtual ~phaseSystem ()
 Destructor. More...
 
const fvMeshmesh () const
 Constant access the mesh. More...
 
const phaseModelListphases () const
 Constant access the phase models. More...
 
phaseModelListphases ()
 Access the phase models. More...
 
const phasePairTablephasePairs () const
 Constant access the phase pairs. More...
 
tmp< volScalarFieldrho () const
 Return the mixture density. More...
 
tmp< volVectorFieldU () const
 Return the mixture velocity. More...
 
const surfaceScalarFieldphi () const
 Constant access the mixture flux. More...
 
surfaceScalarFieldphi ()
 Access the mixture flux. More...
 
const volScalarFielddpdt () const
 Constant access the rate of change of the pressure. More...
 
volScalarFielddpdt ()
 Access the rate of change of the pressure. More...
 
tmp< volScalarFieldsigma (const phasePairKey &key) const
 Return the surface tension coefficient. More...
 
const IOMRFZoneListMRF () const
 Return MRF zones. More...
 
fv::IOoptionListfvOptions () const
 Optional FV-options. More...
 
template<class modelType >
const modelType & lookupSubModel (const phasePair &key) const
 Access a sub model between a phase pair. More...
 
template<class modelType >
const modelType & lookupSubModel (const phaseModel &dispersed, const phaseModel &continuous) const
 Access a sub model between two phases. More...
 
virtual void correctKinematics ()
 Correct the kinematics. More...
 
virtual void correctThermo ()
 Correct the thermodynamics. More...
 
virtual void correctTurbulence ()
 Correct the turbulence. More...
 
virtual void correctEnergyTransport ()
 Correct the energy transport e.g. alphat. More...
 
- 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...
 
virtual ~IOdictionary ()
 Destructor. More...
 
const wordname () const
 Name function is needed to disambiguate those inherited. More...
 
bool readData (Istream &)
 ReadData function required for regIOobject read operation. More...
 
bool writeData (Ostream &) const
 WriteData function required for regIOobject write operation. More...
 
void operator= (const IOdictionary &)
 Assignment of other IOdictionary's entries to this IOdictionary. 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 &)
 Construct as copy. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Construct as copy with new name, transfering registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Construct as copy with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from 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...
 
IstreamreadStream (const word &)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
label watchIndex () const
 Return file-monitoring handle. More...
 
labelwatchIndex ()
 Return file-monitoring handle. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
 Write using given format, version and compression. More...
 
virtual bool write () const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
Foam::autoPtr< IOobjectclone () const
 Clone. 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...
 
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
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 Return complete path. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read and check header info. 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, Istream &)
 Construct given the entry name, parent dictionary and Istream,. More...
 
 dictionary (Istream &)
 Construct top-level dictionary from Istream,. More...
 
 dictionary (Istream &, const bool keepHeader)
 Construct top-level dictionary from Istream,. More...
 
 dictionary (const dictionary &parentDict, const dictionary &)
 Construct as copy given the parent dictionary. More...
 
 dictionary (const dictionary &)
 Construct top-level dictionary as copy. More...
 
 dictionary (const dictionary *)
 Construct top-level dictionary as copy from pointer to dictionary. More...
 
 dictionary (const dictionary &parentDict, const Xfer< dictionary > &)
 Construct by transferring parameter contents given parent dictionary. More...
 
 dictionary (const Xfer< dictionary > &)
 Construct top-level dictionary by transferring parameter contents. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const dictionaryparent () const
 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 &, 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 entrylookupEntry (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present otherwise error. More...
 
ITstreamlookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return an entry data stream. More...
 
template<class T >
T lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. More...
 
template<class T >
T lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true)
 Find and return a T, if not found return the given. More...
 
template<class T >
bool readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const
 Find an entry if present, and assign to T. More...
 
const entrylookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
bool isDict (const word &) const
 Check if entry is a sub-dictionary. More...
 
const dictionarysubDictPtr (const word &) const
 Find and return a sub-dictionary pointer if present. More...
 
const dictionarysubDict (const word &) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &)
 Find and return a sub-dictionary for manipulation. More...
 
dictionary subOrEmptyDict (const word &, const bool mustRead=false) const
 Find and return a sub-dictionary as a copy, or. More...
 
wordList toc () const
 Return the table of contents. More...
 
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns. More...
 
bool substituteKeyword (const word &keyword)
 Substitute the given keyword prepended by '$' with the. More...
 
bool substituteScopedKeyword (const word &keyword)
 Substitute the given scoped keyword prepended by '$' with the. More...
 
bool add (entry *, bool mergeEntry=false)
 Add a new entry. More...
 
void add (const entry &, bool mergeEntry=false)
 Add an entry. More...
 
void add (const keyType &, const word &, bool overwrite=false)
 Add a word entry. More...
 
void add (const keyType &, const string &, bool overwrite=false)
 Add a string entry. More...
 
void add (const keyType &, const label, bool overwrite=false)
 Add a label entry. More...
 
void add (const keyType &, const scalar, bool overwrite=false)
 Add a scalar entry. More...
 
void add (const keyType &, const dictionary &, bool mergeEntry=false)
 Add a dictionary entry. More...
 
template<class T >
void add (const keyType &, const T &, bool overwrite=false)
 Add a T entry. More...
 
void set (entry *)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const entry &)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const keyType &, const dictionary &)
 Assign a dictionary entry, overwrite any existing entry. More...
 
template<class T >
void set (const keyType &, const T &)
 Assign a T entry, overwrite any existing entry. More...
 
bool remove (const word &)
 Remove an entry specified by keyword. More...
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false)
 Change the keyword for an entry,. More...
 
bool merge (const dictionary &)
 Merge entries from the given dictionary. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (dictionary &)
 Transfer the contents of the argument and annul the argument. More...
 
Xfer< dictionaryxfer ()
 Transfer contents to the Xfer container. More...
 
bool read (Istream &)
 Read dictionary from Istream. More...
 
bool read (Istream &, const bool keepHeader)
 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...
 
- Public Member Functions inherited from dictionaryName
 dictionaryName ()
 Construct dictionaryName null. More...
 
 dictionaryName (const fileName &name)
 Construct dictionaryName as copy of the given fileName. 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...
 
- Public Member Functions inherited from IDLList< entry >
 IDLList ()
 Null construct. More...
 
 IDLList (const entry &a)
 Construct given initial T. More...
 
 IDLList (Istream &is, const INew &inewt)
 Construct from Istream using given Istream constructor class. More...
 
 IDLList (Istream &is)
 Construct from Istream. More...
 
 IDLList (const IDLList< entry > &idll, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
- Public Member Functions inherited from ILList< DLListBase, entry >
 ILList ()
 Null construct. More...
 
 ILList (entry *a)
 Construct given initial T. More...
 
 ILList (Istream &)
 Construct from Istream. More...
 
 ILList (const ILList< DLListBase, entry > &)
 Construct as copy. More...
 
 ILList (const ILList< DLListBase, entry > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
 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 (entry *p)
 Remove the specified element from the list and delete it. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (ILList< DLListBase, entry > &)
 Transfer the contents of the argument into this List. More...
 
void operator= (const ILList< DLListBase, entry > &)
 
- Public Member Functions inherited from UILList< DLListBase, entry >
 UILList ()
 Null construct. More...
 
 UILList (entry *a)
 Construct given initial T. More...
 
 UILList (const UILList< DLListBase, entry > &)
 Construct as copy. More...
 
entryfirst ()
 Return the first entry. More...
 
const entryfirst () const
 Return the first entry. More...
 
entrylast ()
 Return the last entry. More...
 
const entrylast () const
 Return the last entry. More...
 
entryremoveHead ()
 Remove and return head. More...
 
entryremove (entry *p)
 Remove and return element. More...
 
entryremove (iterator &it)
 Remove and return specified by iterator. More...
 
void operator= (const UILList< DLListBase, entry > &)
 
iterator begin ()
 
const_iterator begin () const
 
const iteratorend ()
 
const const_iteratorend () const
 
const_iterator cbegin () const
 
const const_iteratorcend () 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< DLListBase, entry > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UILList< DLListBase, entry > &) const
 The opposite of the equality operation. Takes linear time. More...
 
- Public Member Functions inherited from DLListBase
 DLListBase ()
 Null construct. More...
 
 DLListBase (link *)
 Construct given initial entry. More...
 
 ~DLListBase ()
 Destructor. More...
 
label size () const
 Return number of elements in list. More...
 
bool empty () const
 Return true if the list is empty. More...
 
linkfirst ()
 Return first entry. More...
 
const linkfirst () const
 Return const access to first entry. More...
 
linklast ()
 Return last entry. More...
 
const linklast () const
 Return const access to last entry. More...
 
void insert (link *)
 Add at head of list. More...
 
void append (link *)
 Add at tail of list. More...
 
bool swapUp (link *)
 Swap this element with the one above unless it is at the top. More...
 
bool swapDown (link *)
 Swap this element with the one below unless it is at the bottom. More...
 
linkremoveHead ()
 Remove and return head. More...
 
linkremove (link *)
 Remove and return element. More...
 
linkremove (iterator &)
 
linkreplace (link *oldLink, link *newLink)
 Replace oldLink with newLink and return element. More...
 
linkreplace (iterator &oldIter, link *newLink)
 Replace oldIter with newLink and return element. More...
 
void clear ()
 Clear the list. More...
 
void transfer (DLListBase &)
 Transfer the contents of the argument into this List. 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
 
- 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 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)
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from dictionary
static autoPtr< dictionaryNew (Istream &)
 Construct top-level dictionary on freestore from Istream. More...
 

Additional Inherited Members

- Static Public Attributes inherited from phaseSystem
static const word propertiesName
 Default name of the phase properties dictionary. More...
 
- Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- Static Public Attributes inherited from dictionary
static const dictionary null
 Null dictionary. More...
 
- Protected Types inherited from phaseSystem
typedef HashTable< dictionary, phasePairKey, phasePairKey::hashdictTable
 
typedef HashTable< autoPtr< phasePair >, phasePairKey, phasePairKey::hashphasePairTable
 
typedef HashTable< autoPtr< blendingMethod >, word, word::hashblendingMethodTable
 
typedef HashTable< autoPtr< surfaceTensionModel >, phasePairKey, phasePairKey::hashsurfaceTensionModelTable
 
typedef HashTable< autoPtr< aspectRatioModel >, phasePairKey, phasePairKey::hashaspectRatioModelTable
 
- Protected Member Functions inherited from phaseSystem
tmp< surfaceScalarFieldcalcPhi (const phaseModelList &phaseModels) const
 Calculate and return the mixture flux. More...
 
void generatePairs (const dictTable &modelDicts)
 Generate pairs. More...
 
template<class modelType >
void createSubModels (const dictTable &modelDicts, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models)
 Generate pairs and sub-model tables. More...
 
template<class modelType >
void generatePairsAndSubModels (const word &modelName, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models)
 Generate pairs and sub-model tables. More...
 
template<class modelType >
void generatePairsAndSubModels (const word &modelName, HashTable< autoPtr< BlendedInterfacialModel< modelType > >, phasePairKey, phasePairKey::hash > &models)
 Generate pairs and blended sub-model tables. More...
 
template<class modelType >
void generatePairsAndSubModels (const word &modelName, HashTable< HashTable< autoPtr< modelType > >, phasePairKey, phasePairKey::hash > &models)
 Generate pairs and per-phase sub-model tables. More...
 
- Protected Member Functions inherited from IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (const fileName &)
 Construct and return an IFstream for the object given the. More...
 
void setBad (const string &)
 Set the object state to bad. More...
 
- Protected Attributes inherited from phaseSystem
const fvMeshmesh_
 Reference to the mesh. More...
 
phaseModelList phaseModels_
 Phase models. More...
 
phasePairTable phasePairs_
 Phase pairs. More...
 
surfaceScalarField phi_
 Total volumetric flux. More...
 
volScalarField dpdt_
 Rate of change of pressure. More...
 
IOMRFZoneList MRF_
 Optional MRF zones. More...
 
fv::IOoptionList fvOptions_
 Optional FV-options. More...
 
blendingMethodTable blendingMethods_
 Blending methods. More...
 
surfaceTensionModelTable surfaceTensionModels_
 Surface tension models. More...
 
aspectRatioModelTable aspectRatioModels_
 Aspect ratio models. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

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.

Derived from transportModel so that it can be unsed 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

Definition at line 62 of file multiphaseSystem.H.

Member Typedef Documentation

Definition at line 150 of file multiphaseSystem.H.

Definition at line 153 of file multiphaseSystem.H.

Constructor & Destructor Documentation

multiphaseSystem ( const volVectorField U,
const surfaceScalarField phi 
)

Construct from components.

virtual ~multiphaseSystem ( )
inlinevirtual

Destructor.

Definition at line 238 of file multiphaseSystem.H.

multiphaseSystem ( const fvMesh )

Construct from fvMesh.

virtual ~multiphaseSystem ( )
virtual

Destructor.

Member Function Documentation

const PtrDictionary<phaseModel>& phases ( ) const
inline

Return the phases.

Definition at line 245 of file multiphaseSystem.H.

PtrDictionary<phaseModel>& phases ( )
inline

Return the phases.

Definition at line 251 of file multiphaseSystem.H.

References multiphaseSystem::Cvm(), multiphaseSystem::nu(), patchi, multiphaseSystem::rho(), and multiphaseSystem::Svm().

Here is the call graph for this function:

tmp<volScalarField> rho ( ) const

Return the mixture density.

Referenced by multiphaseSystem::phases().

Here is the caller graph for this function:

tmp<scalarField> rho ( const label  patchi) const

Return the mixture density for patch.

tmp<volScalarField> nu ( ) const
virtual

Return the mixture laminar viscosity.

Implements transportModel.

Referenced by multiphaseSystem::phases().

Here is the caller graph for this function:

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

Return the laminar viscosity for patch.

Implements transportModel.

tmp<volScalarField> Cvm ( const phaseModel phase) const

Return the virtual-mass coefficient for the given phase.

Referenced by multiphaseSystem::phases().

Here is the caller graph for this function:

tmp<volVectorField> Svm ( const phaseModel phase) const

Return the virtual-mass source for the given phase.

Referenced by multiphaseSystem::phases().

Here is the caller graph for this function:

const dragModelTable& dragModels ( ) const
inline

Return the table of drag models.

Definition at line 275 of file multiphaseSystem.H.

References multiphaseSystem::dragCoeff(), multiphaseSystem::dragCoeffs(), multiphaseSystem::nearInterface(), multiphaseSystem::solve(), and multiphaseSystem::surfaceTension().

Here is the call graph for this function:

autoPtr<dragCoeffFields> dragCoeffs ( ) const

Return the drag coefficients for all of the interfaces.

Referenced by multiphaseSystem::dragModels().

Here is the caller graph for this function:

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

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

Referenced by multiphaseSystem::dragModels().

Here is the caller graph for this function:

tmp<surfaceScalarField> surfaceTension ( const phaseModel phase) const

Referenced by multiphaseSystem::dragModels().

Here is the caller graph for this function:

tmp<volScalarField> nearInterface ( ) const

Indicator of the proximity of the interface.

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

Referenced by multiphaseSystem::dragModels().

Here is the caller graph for this function:

void solve ( )
virtual

Solve for the mixture phase-fractions.

Reimplemented from phaseSystem.

Referenced by multiphaseSystem::dragModels().

Here is the caller graph for this function:

void correct ( )
inlinevirtual

Dummy correct.

Implements transportModel.

Definition at line 300 of file multiphaseSystem.H.

References multiphaseSystem::read().

Here is the call graph for this function:

bool read ( )
virtual

Read base transportProperties dictionary.

Implements transportModel.

Referenced by multiphaseSystem::correct().

Here is the caller graph for this function:

TypeName ( "multiphaseSystem"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
multiphaseSystem  ,
dictionary  ,
( const fvMesh &mesh ,
(mesh  
)
static autoPtr<multiphaseSystem> New ( const fvMesh mesh)
static
virtual const phaseSystem::KdTable& Kds ( ) const
pure virtual

Return the drag coefficient for all phase-pairs.

virtual tmp<volScalarField> Kd ( const phaseModel phase) const
pure virtual

Return the drag coefficient for phase.

virtual autoPtr<PtrList<Foam::volVectorField> > Fs ( ) const
pure virtual

Return the combined force (lift + wall-lubrication) for phase pair.

virtual autoPtr<PtrList<Foam::surfaceScalarField> > phiDs ( const PtrList< volScalarField > &  rAUs) const
pure virtual

Return the turbulent dispersion force on faces for phase pair.

virtual bool transfersMass ( const phaseModel phase) const
pure virtual

Return true if there is mass transfer for phase.

virtual tmp<volScalarField> dmdt ( const phaseModel phase) const
pure virtual

Return the total interfacial mass transfer rate for phase.

virtual autoPtr<momentumTransferTable> momentumTransfer ( ) const
pure virtual

Return the momentum transfer matrices.

virtual autoPtr<heatTransferTable> heatTransfer ( ) const
pure virtual

Return the heat transfer matrices.

virtual autoPtr<massTransferTable> massTransfer ( ) const
pure virtual

Return the mass transfer matrices.

tmp<surfaceScalarField> surfaceTension ( const phaseModel phase) const
tmp<volScalarField> nearInterface ( ) const

Indicator of the proximity of the interface.

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

virtual void solve ( )
virtual

Solve for the phase fractions.

Reimplemented from phaseSystem.


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