Public Member Functions | Private Member Functions | Private Attributes
incompressibleThreePhaseMixture Class Reference
Inheritance diagram for incompressibleThreePhaseMixture:
Inheritance graph
[legend]
Collaboration diagram for incompressibleThreePhaseMixture:
Collaboration graph
[legend]

Public Member Functions

 incompressibleThreePhaseMixture (const volVectorField &U, const surfaceScalarField &phi)
 Construct from components. More...
 
 ~incompressibleThreePhaseMixture ()
 Destructor. More...
 
const word phase1Name () const
 
const word phase2Name () const
 
const word phase3Name () const
 
const volScalarFieldalpha1 () const
 
volScalarFieldalpha1 ()
 
const volScalarFieldalpha2 () const
 
volScalarFieldalpha2 ()
 
const volScalarFieldalpha3 () const
 
volScalarFieldalpha3 ()
 
const dimensionedScalarrho1 () const
 Return const-access to phase1 density. More...
 
const dimensionedScalarrho2 () const
 Return const-access to phase2 density. More...
 
const dimensionedScalarrho3 () const
 Return const-access to phase3 density. More...
 
const volVectorFieldU () const
 Return the velocity. More...
 
const surfaceScalarFieldphi () const
 Return the flux. More...
 
const viscosityModelnuModel1 () const
 Return const-access to phase1 viscosityModel. More...
 
const viscosityModelnuModel2 () const
 Return const-access to phase2 viscosityModel. More...
 
const viscosityModelnuModel3 () const
 Return const-access to phase3 viscosityModel. More...
 
tmp< volScalarFieldmu () const
 Return the dynamic laminar viscosity. More...
 
tmp< surfaceScalarFieldmuf () const
 Return the face-interpolated dynamic laminar viscosity. More...
 
tmp< volScalarFieldnu () const
 Return the kinematic laminar viscosity. More...
 
tmp< scalarFieldnu (const label patchi) const
 Return the laminar viscosity for patch. More...
 
tmp< surfaceScalarFieldnuf () const
 Return the face-interpolated dynamic laminar viscosity. More...
 
void correct ()
 Correct the laminar viscosity. More...
 
bool read ()
 Read base transportProperties dictionary. More...
 
- Public Member Functions inherited from IOdictionary
 TypeName ("dictionary")
 
 IOdictionary (const IOobject &)
 Construct given an IOobject. More...
 
 IOdictionary (const IOobject &, const dictionary &)
 Construct given an IOobject and dictionary. More...
 
 IOdictionary (const IOobject &, Istream &)
 Construct given an IOobject and Istream. More...
 
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...
 
 IOobject (const IOobject &io, const word &name)
 Construct as copy resetting name. 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 (T *a)
 Construct given initial T. More...
 
 ILList (Istream &)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &)
 Construct as copy. More...
 
 ILList (const ILList< LListBase, T > &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 (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 > &)
 
- Public Member Functions inherited from transportModel
 TypeName ("transportModel")
 Runtime type information. More...
 
 transportModel ()
 Construct from components. More...
 
virtual ~transportModel ()
 Destructor. More...
 

Private Member Functions

void calcNu ()
 Calculate and return the laminar viscosity. More...
 

Private Attributes

word phase1Name_
 
word phase2Name_
 
word phase3Name_
 
volScalarField alpha1_
 
volScalarField alpha2_
 
volScalarField alpha3_
 
const volVectorFieldU_
 
const surfaceScalarFieldphi_
 
volScalarField nu_
 
autoPtr< viscosityModelnuModel1_
 
autoPtr< viscosityModelnuModel2_
 
autoPtr< viscosityModelnuModel3_
 
dimensionedScalar rho1_
 
dimensionedScalar rho2_
 
dimensionedScalar rho3_
 

Additional Inherited Members

- 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...
 
- 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 void replaceFileName (const word &from, const word &to)
 
- Static Public Member Functions inherited from dictionary
static autoPtr< dictionaryNew (Istream &)
 Construct top-level dictionary on freestore from Istream. 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 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...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Source files

Definition at line 51 of file incompressibleThreePhaseMixture.H.

Constructor & Destructor Documentation

◆ incompressibleThreePhaseMixture()

Construct from components.

◆ ~incompressibleThreePhaseMixture()

Destructor.

Definition at line 99 of file incompressibleThreePhaseMixture.H.

Member Function Documentation

◆ calcNu()

void calcNu ( )
private

Calculate and return the laminar viscosity.

Referenced by incompressibleThreePhaseMixture::correct().

Here is the caller graph for this function:

◆ phase1Name()

const word phase1Name ( ) const
inline

◆ phase2Name()

const word phase2Name ( ) const
inline

◆ phase3Name()

const word phase3Name ( ) const
inline

◆ alpha1() [1/2]

const volScalarField& alpha1 ( ) const
inline

◆ alpha1() [2/2]

volScalarField& alpha1 ( )
inline

◆ alpha2() [1/2]

const volScalarField& alpha2 ( ) const
inline

Definition at line 130 of file incompressibleThreePhaseMixture.H.

References incompressibleThreePhaseMixture::alpha2_.

Referenced by threePhaseInterfaceProperties::sigma().

Here is the caller graph for this function:

◆ alpha2() [2/2]

volScalarField& alpha2 ( )
inline

◆ alpha3() [1/2]

const volScalarField& alpha3 ( ) const
inline

Definition at line 140 of file incompressibleThreePhaseMixture.H.

References incompressibleThreePhaseMixture::alpha3_.

Referenced by threePhaseInterfaceProperties::sigma().

Here is the caller graph for this function:

◆ alpha3() [2/2]

volScalarField& alpha3 ( )
inline

◆ rho1()

const dimensionedScalar& rho1 ( ) const
inline

Return const-access to phase1 density.

Definition at line 151 of file incompressibleThreePhaseMixture.H.

References incompressibleThreePhaseMixture::rho1_.

◆ rho2()

const dimensionedScalar& rho2 ( ) const
inline

Return const-access to phase2 density.

Definition at line 157 of file incompressibleThreePhaseMixture.H.

References incompressibleThreePhaseMixture::rho2_.

◆ rho3()

const dimensionedScalar& rho3 ( ) const
inline

Return const-access to phase3 density.

Definition at line 163 of file incompressibleThreePhaseMixture.H.

References incompressibleThreePhaseMixture::rho3_.

◆ U()

const volVectorField& U ( ) const
inline

Return the velocity.

Definition at line 169 of file incompressibleThreePhaseMixture.H.

References incompressibleThreePhaseMixture::U_.

◆ phi()

const surfaceScalarField& phi ( ) const
inline

Return the flux.

Definition at line 175 of file incompressibleThreePhaseMixture.H.

References incompressibleThreePhaseMixture::phi_.

◆ nuModel1()

const viscosityModel& nuModel1 ( ) const
inline

Return const-access to phase1 viscosityModel.

Definition at line 181 of file incompressibleThreePhaseMixture.H.

References incompressibleThreePhaseMixture::nuModel1_.

◆ nuModel2()

const viscosityModel& nuModel2 ( ) const
inline

Return const-access to phase2 viscosityModel.

Definition at line 187 of file incompressibleThreePhaseMixture.H.

References incompressibleThreePhaseMixture::nuModel2_.

◆ nuModel3()

const viscosityModel& nuModel3 ( ) const
inline

Return const-access to phase3 viscosityModel.

Definition at line 193 of file incompressibleThreePhaseMixture.H.

References incompressibleThreePhaseMixture::nuModel3_.

◆ mu()

tmp<volScalarField> mu ( ) const

Return the dynamic laminar viscosity.

◆ muf()

tmp<surfaceScalarField> muf ( ) const

Return the face-interpolated dynamic laminar viscosity.

◆ nu() [1/2]

tmp<volScalarField> nu ( ) const
inlinevirtual

Return the kinematic laminar viscosity.

Implements transportModel.

Definition at line 205 of file incompressibleThreePhaseMixture.H.

References incompressibleThreePhaseMixture::nu_.

◆ nu() [2/2]

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

Return the laminar viscosity for patch.

Implements transportModel.

Definition at line 211 of file incompressibleThreePhaseMixture.H.

References GeometricField::boundaryField(), incompressibleThreePhaseMixture::nu_, and patchi.

Here is the call graph for this function:

◆ nuf()

tmp<surfaceScalarField> nuf ( ) const

Return the face-interpolated dynamic laminar viscosity.

◆ correct()

void correct ( )
inlinevirtual

Correct the laminar viscosity.

Implements transportModel.

Definition at line 220 of file incompressibleThreePhaseMixture.H.

References incompressibleThreePhaseMixture::calcNu().

Referenced by immiscibleIncompressibleThreePhaseMixture::correct().

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

◆ read()

bool read ( )
virtual

Read base transportProperties dictionary.

Implements transportModel.

Field Documentation

◆ phase1Name_

word phase1Name_
private

◆ phase2Name_

word phase2Name_
private

◆ phase3Name_

word phase3Name_
private

◆ alpha1_

volScalarField alpha1_
private

◆ alpha2_

volScalarField alpha2_
private

◆ alpha3_

volScalarField alpha3_
private

◆ U_

const volVectorField& U_
private

◆ phi_

const surfaceScalarField& phi_
private

◆ nu_

volScalarField nu_
private

◆ nuModel1_

autoPtr<viscosityModel> nuModel1_
private

◆ nuModel2_

autoPtr<viscosityModel> nuModel2_
private

◆ nuModel3_

autoPtr<viscosityModel> nuModel3_
private

◆ rho1_

dimensionedScalar rho1_
private

◆ rho2_

dimensionedScalar rho2_
private

◆ rho3_

dimensionedScalar rho3_
private

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