Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
twoPhaseSystem Class Referenceabstract

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

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

Public Member Functions

 TypeName ("twoPhaseSystem")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, twoPhaseSystem, dictionary,(const fvMesh &mesh),(mesh))
 
 twoPhaseSystem (const fvMesh &)
 Construct from fvMesh. More...
 
virtual ~twoPhaseSystem ()
 Destructor. More...
 
const phaseModelphase1 () const
 Constant access phase model 1. More...
 
phaseModelphase1 ()
 Access phase model 1. More...
 
const phaseModelphase2 () const
 Constant access phase model 2. More...
 
phaseModelphase2 ()
 Access phase model 2. More...
 
const phaseModelotherPhase (const phaseModel &phase) const
 Constant access the phase not given as an argument. 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< volScalarFieldsigma () const
 Return the surface tension coefficient. More...
 
const dragModeldrag (const phaseModel &phase) const
 Return the drag model for the given phase. More...
 
tmp< volScalarFieldKd () const
 Return the drag coefficient. More...
 
tmp< surfaceScalarFieldKdf () const
 Return the face drag coefficient. More...
 
const virtualMassModelvirtualMass (const phaseModel &phase) const
 Return the virtual mass model for the given phase. More...
 
tmp< volScalarFieldVm () const
 Return the virtual mass coefficient. More...
 
tmp< surfaceScalarFieldVmf () const
 Return the face virtual mass coefficient. More...
 
tmp< volVectorFieldF () const
 Return the combined force (lift + wall-lubrication) More...
 
tmp< surfaceScalarFieldFf () const
 Return the combined face-force (lift + wall-lubrication) More...
 
tmp< volScalarFieldD () const
 Return the turbulent diffusivity. More...
 
bool transfersMass () const
 Return true if there is mass transfer. More...
 
tmp< volScalarFielddmdt () const
 Return the interfacial mass flow rate. More...
 
virtual void solve ()
 Solve for the phase fractions. More...
 
 twoPhaseSystem (const fvMesh &, const dimensionedVector &g)
 Construct from fvMesh. More...
 
virtual ~twoPhaseSystem ()
 Destructor. More...
 
tmp< volScalarFieldrho () const
 Return the mixture density. More...
 
tmp< volVectorFieldU () const
 Return the mixture velocity. More...
 
tmp< volScalarFieldKd () const
 Return the drag coefficient. More...
 
tmp< surfaceScalarFieldKdf () const
 Return the face drag coefficient. More...
 
tmp< volScalarFieldVm () const
 Return the virtual mass coefficient. More...
 
tmp< surfaceScalarFieldVmf () const
 Return the face virtual mass coefficient. More...
 
tmp< volScalarFieldKh () const
 Return the heat transfer coefficient. More...
 
tmp< volVectorFieldF () const
 Return the combined force (lift + wall-lubrication) More...
 
tmp< surfaceScalarFieldFf () const
 Return the combined face-force (lift + wall-lubrication) More...
 
tmp< volScalarFieldD () const
 Return the turbulent diffusivity. More...
 
void solve ()
 Solve for the two-phase-fractions. More...
 
void correct ()
 Correct two-phase properties other than turbulence. More...
 
void correctTurbulence ()
 Correct two-phase turbulence. More...
 
bool read ()
 Read base phaseProperties dictionary. More...
 
const dragModeldrag (const phaseModel &phase) const
 Return the drag model for the given phase. More...
 
const virtualMassModelvirtualMass (const phaseModel &phase) const
 Return the virtual mass model for the given phase. More...
 
const dimensionedScalarsigma () const
 Return the surface tension coefficient. More...
 
const fvMeshmesh () const
 Return the mesh. More...
 
const phaseModelphase1 () const
 Return phase model 1. More...
 
phaseModelphase1 ()
 Return non-const access to phase model 1. More...
 
const phaseModelphase2 () const
 Return phase model 2. More...
 
phaseModelphase2 ()
 Return non-const access to phase model 2. More...
 
const phaseModelotherPhase (const phaseModel &phase) const
 Return the phase not given as an argument. More...
 
const surfaceScalarFieldphi () const
 Return the mixture flux. More...
 
surfaceScalarFieldphi ()
 Return non-const access to the the mixture flux. More...
 
const volScalarFielddgdt () const
 Return the dilatation term. More...
 
volScalarFielddgdt ()
 Return non-const access to the dilatation parameter. More...
 
tmp< surfaceScalarField > & pPrimeByA ()
 Return non-const access to the dispersion diffusivity. More...
 
- Public Member Functions inherited from IOdictionary
 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...
 
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")
 
 baseIOdictionary (const IOobject &)
 Construct given an IOobject. More...
 
 baseIOdictionary (const IOobject &, const dictionary &)
 Construct given an IOobject and dictionary. More...
 
 baseIOdictionary (const IOobject &, Istream &)
 Construct given an IOobject and Istream. More...
 
virtual ~baseIOdictionary ()
 Destructor. More...
 
const wordname () const
 Name function is needed to disambiguate those inherited. 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 baseIOdictionary &)
 Assignment of other baseIOdictionary's entries to this. 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...
 
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...
 
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 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. Return. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool valid) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool valid=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, 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)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. 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...
 
bool & globalObject ()
 Is object same for all processors. More...
 
bool globalObject () const
 Is object same for all processors. 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 localFilePath (const word &typeName) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName) const
 Helper for filePath that searches up if in parallel. More...
 
bool readHeader (Istream &)
 Read header. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType=true)
 Read header (uses typeFilePath to find file) and check header. 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, 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 lookupType (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. 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...
 
dictionarysubDictPtr (const word &)
 Find and return a sub-dictionary pointer if present. More...
 
const dictionarysubDict (const word &) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &)
 Find and return a sub-dictionary for manipulation. More...
 
dictionary subOrEmptyDict (const word &, const bool mustRead=false) const
 Find and return a sub-dictionary as a copy, or. More...
 
const dictionaryoptionalSubDict (const word &) const
 Find and return a sub-dictionary if found. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the sorted table of contents. More...
 
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns. More...
 
bool substituteKeyword (const word &keyword)
 Substitute the given keyword prepended by '$' with the. More...
 
bool substituteScopedKeyword (const word &keyword)
 Substitute the given scoped keyword prepended by '$' with the. More...
 
bool add (entry *, bool mergeEntry=false)
 Add a new entry. More...
 
void add (const entry &, bool mergeEntry=false)
 Add an entry. More...
 
void add (const keyType &, const word &, bool overwrite=false)
 Add a word entry. More...
 
void add (const keyType &, const string &, bool overwrite=false)
 Add a string entry. More...
 
void add (const keyType &, const label, bool overwrite=false)
 Add a label entry. More...
 
void add (const keyType &, const scalar, bool overwrite=false)
 Add a scalar entry. More...
 
void add (const keyType &, const dictionary &, bool mergeEntry=false)
 Add a dictionary entry. More...
 
template<class T >
void add (const keyType &, const T &, bool overwrite=false)
 Add a T entry. More...
 
void set (entry *)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const entry &)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const keyType &, const dictionary &)
 Assign a dictionary entry, overwrite any existing entry. More...
 
template<class T >
void set (const keyType &, const T &)
 Assign a T entry, overwrite any existing entry. More...
 
bool remove (const word &)
 Remove an entry specified by keyword. More...
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false)
 Change the keyword for an entry,. More...
 
bool merge (const dictionary &)
 Merge entries from the given dictionary. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (dictionary &)
 Transfer the contents of the argument and annul the argument. More...
 
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 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 > &)
 Construct as copy. 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...
 
- 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 > &)
 Construct as copy. 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 > &)
 
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...
 
- 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< volScalarFieldE (const phasePairKey &key) const
 Return the aspect-ratio. More...
 
tmp< volScalarFieldsigma (const phasePairKey &key) const
 Return the surface tension coefficient. More...
 
const IOMRFZoneListMRF () const
 Return MRF zones. More...
 
fv::optionsfvOptions () 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 correctEnergyTransport ()
 Correct the energy transport e.g. alphat. More...
 

Static Public Member Functions

static autoPtr< twoPhaseSystemNew (const fvMesh &mesh)
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 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...
 

Protected Attributes

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

Additional Inherited Members

- 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 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
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
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 Public Attributes inherited from phaseSystem
static const word propertiesName
 Default name of the phase properties 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 regIOobject
bool readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 
- 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...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Class which solves the volume fraction equations for two phases.

Source files

Source files

Definition at line 51 of file twoPhaseSystem.H.

Constructor & Destructor Documentation

◆ twoPhaseSystem() [1/2]

twoPhaseSystem ( const fvMesh )

Construct from fvMesh.

◆ ~twoPhaseSystem() [1/2]

virtual ~twoPhaseSystem ( )
virtual

Destructor.

◆ twoPhaseSystem() [2/2]

twoPhaseSystem ( const fvMesh ,
const dimensionedVector g 
)

Construct from fvMesh.

◆ ~twoPhaseSystem() [2/2]

virtual ~twoPhaseSystem ( )
virtual

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "twoPhaseSystem"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

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

◆ phase1() [1/4]

const Foam::phaseModel & phase1 ( ) const
inline

Constant access phase model 1.

Definition at line 28 of file twoPhaseSystemI.H.

References twoPhaseSystem::phase1_.

Referenced by mixtureKEpsilon< BasicTurbulenceModel >::correct(), and twoPhaseSystem::mesh().

Here is the caller graph for this function:

◆ phase1() [2/4]

Foam::phaseModel & phase1 ( )
inline

Access phase model 1.

Definition at line 34 of file twoPhaseSystemI.H.

References twoPhaseSystem::phase1_.

◆ phase2() [1/4]

const Foam::phaseModel & phase2 ( ) const
inline

Constant access phase model 2.

Definition at line 40 of file twoPhaseSystemI.H.

References twoPhaseSystem::phase2_.

Referenced by twoPhaseSystem::mesh().

Here is the caller graph for this function:

◆ phase2() [2/4]

Foam::phaseModel & phase2 ( )
inline

Access phase model 2.

Definition at line 46 of file twoPhaseSystemI.H.

References twoPhaseSystem::otherPhase(), and twoPhaseSystem::phase2_.

Here is the call graph for this function:

◆ otherPhase() [1/2]

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

◆ momentumTransfer()

virtual autoPtr<momentumTransferTable> momentumTransfer ( ) const
pure virtual

Return the momentum transfer matrices.

◆ heatTransfer()

virtual autoPtr<heatTransferTable> heatTransfer ( ) const
pure virtual

Return the heat transfer matrices.

◆ massTransfer()

virtual autoPtr<massTransferTable> massTransfer ( ) const
pure virtual

Return the mass transfer matrices.

◆ sigma() [1/2]

tmp<volScalarField> sigma ( ) const

Return the surface tension coefficient.

◆ drag() [1/2]

const dragModel& drag ( const phaseModel phase) const

◆ Kd() [1/2]

tmp<volScalarField> Kd ( ) const

Return the drag coefficient.

◆ Kdf() [1/2]

tmp<surfaceScalarField> Kdf ( ) const

Return the face drag coefficient.

◆ virtualMass() [1/2]

const virtualMassModel& virtualMass ( const phaseModel phase) const

Return the virtual mass model for the given phase.

Referenced by continuousGasKEpsilon< BasicTurbulenceModel >::correctNut(), continuousGasKEpsilon< BasicTurbulenceModel >::rhoEff(), and mixtureKEpsilon< BasicTurbulenceModel >::rhogEff().

Here is the caller graph for this function:

◆ Vm() [1/2]

tmp<volScalarField> Vm ( ) const

Return the virtual mass coefficient.

◆ Vmf() [1/2]

tmp<surfaceScalarField> Vmf ( ) const

Return the face virtual mass coefficient.

◆ F() [1/2]

tmp<volVectorField> F ( ) const

Return the combined force (lift + wall-lubrication)

◆ Ff() [1/2]

tmp<surfaceScalarField> Ff ( ) const

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

◆ D() [1/2]

tmp<volScalarField> D ( ) const

Return the turbulent diffusivity.

Multiplies the phase-fraction gradient

◆ transfersMass()

bool transfersMass ( ) const

Return true if there is mass transfer.

◆ dmdt()

tmp<volScalarField> dmdt ( ) const

Return the interfacial mass flow rate.

◆ solve() [1/2]

virtual void solve ( )
virtual

Solve for the phase fractions.

Reimplemented from phaseSystem.

◆ rho()

tmp<volScalarField> rho ( ) const

Return the mixture density.

◆ U()

tmp<volVectorField> U ( ) const

Return the mixture velocity.

◆ Kd() [2/2]

tmp<volScalarField> Kd ( ) const

Return the drag coefficient.

◆ Kdf() [2/2]

tmp<surfaceScalarField> Kdf ( ) const

Return the face drag coefficient.

◆ Vm() [2/2]

tmp<volScalarField> Vm ( ) const

Return the virtual mass coefficient.

◆ Vmf() [2/2]

tmp<surfaceScalarField> Vmf ( ) const

Return the face virtual mass coefficient.

◆ Kh()

tmp<volScalarField> Kh ( ) const

Return the heat transfer coefficient.

◆ F() [2/2]

tmp<volVectorField> F ( ) const

Return the combined force (lift + wall-lubrication)

◆ Ff() [2/2]

tmp<surfaceScalarField> Ff ( ) const

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

◆ D() [2/2]

tmp<volScalarField> D ( ) const

Return the turbulent diffusivity.

Multiplies the phase-fraction gradient

◆ solve() [2/2]

void solve ( )
virtual

Solve for the two-phase-fractions.

Reimplemented from phaseSystem.

◆ correct()

void correct ( )
virtual

Correct two-phase properties other than turbulence.

Reimplemented from phaseSystem.

◆ correctTurbulence()

void correctTurbulence ( )
virtual

Correct two-phase turbulence.

Reimplemented from phaseSystem.

◆ read()

bool read ( )
virtual

Read base phaseProperties dictionary.

Reimplemented from phaseSystem.

◆ drag() [2/2]

const dragModel& drag ( const phaseModel phase) const

Return the drag model for the given phase.

◆ virtualMass() [2/2]

const virtualMassModel& virtualMass ( const phaseModel phase) const

Return the virtual mass model for the given phase.

◆ sigma() [2/2]

const dimensionedScalar& sigma ( ) const

Return the surface tension coefficient.

◆ mesh()

const Foam::fvMesh & mesh ( ) const
inline

Return the mesh.

Definition at line 28 of file twoPhaseSystemI.H.

References twoPhaseSystem::otherPhase(), twoPhaseSystem::phase1(), twoPhaseSystem::phase1_, twoPhaseSystem::phase2(), and twoPhaseSystem::phase2_.

Here is the call graph for this function:

◆ phase1() [3/4]

const phaseModel& phase1 ( ) const
inline

Return phase model 1.

◆ phase1() [4/4]

phaseModel& phase1 ( )
inline

Return non-const access to phase model 1.

◆ phase2() [3/4]

const phaseModel& phase2 ( ) const
inline

Return phase model 2.

◆ phase2() [4/4]

phaseModel& phase2 ( )
inline

Return non-const access to phase model 2.

◆ otherPhase() [2/2]

const phaseModel& otherPhase ( const phaseModel phase) const
inline

Return the phase not given as an argument.

◆ phi() [1/2]

const Foam::surfaceScalarField & phi ( ) const
inline

Return the mixture flux.

Definition at line 74 of file twoPhaseSystemI.H.

◆ phi() [2/2]

Foam::surfaceScalarField & phi ( )
inline

Return non-const access to the the mixture flux.

Definition at line 80 of file twoPhaseSystemI.H.

◆ dgdt() [1/2]

const Foam::volScalarField & dgdt ( ) const
inline

Return the dilatation term.

Definition at line 86 of file twoPhaseSystemI.H.

◆ dgdt() [2/2]

Foam::volScalarField & dgdt ( )
inline

Return non-const access to the dilatation parameter.

Definition at line 92 of file twoPhaseSystemI.H.

◆ pPrimeByA()

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

Return non-const access to the dispersion diffusivity.

Definition at line 98 of file twoPhaseSystemI.H.

Member Data Documentation

◆ phase1_

phaseModel& phase1_
protected

Phase model 1.

Definition at line 92 of file twoPhaseSystem.H.

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

◆ phase2_

phaseModel& phase2_
protected

Phase model 2.

Definition at line 95 of file twoPhaseSystem.H.

Referenced by twoPhaseSystem::mesh(), twoPhaseSystem::otherPhase(), and twoPhaseSystem::phase2().


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