phaseTransferModel Class Reference
Inheritance diagram for phaseTransferModel:
Collaboration diagram for phaseTransferModel:

Public Member Functions

 TypeName ("phaseTransferModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, phaseTransferModel, dictionary,(const dictionary &dict, const phaseInterface &interface),(dict, interface))
 
 phaseTransferModel (const dictionary &dict, const phaseInterface &interface)
 Construct from a dictionary and an interface. More...
 
virtual ~phaseTransferModel ()
 Destructor. More...
 
virtual bool mixture () const
 Whether or not there is a mass transfer rate for the mixture. More...
 
virtual tmp< volScalarFielddmdtf () const
 The mass transfer rate for the mixture. More...
 
virtual tmp< volScalarFieldd2mdtdpf () const
 The mass transfer rate derivative w.r.t pressure for the mixture. More...
 
virtual const hashedWordListspecies () const
 The list of individual species that are transferred. More...
 
virtual HashPtrTable< volScalarFielddmidtf () const
 The mass transfer rate for individual species. More...
 
bool writeData (Ostream &os) const
 Dummy write for regIOobject. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Copy constructor. More...
 
 regIOobject (const regIOobject &&)
 Move constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
virtual bool global () const
 Return true if object is global, i.e. same for all processors. More...
 
virtual bool globalFile () const
 Return true if object is global, i.e. same for all processors. More...
 
const fileNamecaseName () const
 
fileName path () const
 Return complete path. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const
 Is this object registered with the registry? More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool read=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
virtual bool read ()
 Read object. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool dependenciesModified () const
 Return true if the object's dependencies have been modified. More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 Assign to IOobject. More...
 
void operator= (const regIOobject &)=delete
 Disallow default assignment. More...
 
const fileNamecaseName (const bool global) const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName (const bool global) const
 
fileNameinstance () const
 Return the instance directory, constant, system, <time> etc. More...
 
void updateInstance () const
 If the instance is a time directory update to the current time. More...
 
const fileNamelocal () const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName relativePath () const
 Return the path relative to the case directory. More...
 
fileName relativeObjectPath () const
 Return complete relativePath + object name. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read header of local object without type-checking. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 

Static Public Member Functions

static autoPtr< phaseTransferModelNew (const dictionary &dict, const phaseInterface &interface)
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 

Static Public Attributes

static const dimensionSet dimDmdt
 Mass transfer rate dimensions. More...
 
static const dimensionSet dimD2mdtdp
 Mass transfer rate derivative w.r.t pressure dimensions. More...
 
static const bool correctFixedFluxBCs = false
 Does this model require correcting on fixed flux boundaries? More...
 
static const hashedWordList noSpecies_
 Empty species list. More...
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static constexpr const char * foamFile = "FoamFile"
 Keyword for the FoamFile header sub-dictionary. More...
 
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 

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...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
 Read header, check readOpt flags and read data if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType)
 Read header using typeGlobalFile to find file. More...
 

Detailed Description

Source files

Definition at line 54 of file phaseTransferModel.H.

Constructor & Destructor Documentation

◆ phaseTransferModel()

phaseTransferModel ( const dictionary dict,
const phaseInterface interface 
)

Construct from a dictionary and an interface.

Definition at line 48 of file phaseTransferModel.C.

◆ ~phaseTransferModel()

~phaseTransferModel ( )
virtual

Destructor.

Definition at line 68 of file phaseTransferModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "phaseTransferModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
phaseTransferModel  ,
dictionary  ,
(const dictionary &dict, const phaseInterface &interface)  ,
(dict, interface)   
)

◆ New()

Foam::autoPtr< Foam::phaseTransferModel > New ( const dictionary dict,
const phaseInterface interface 
)
static

◆ mixture()

bool mixture ( ) const
virtual

Whether or not there is a mass transfer rate for the mixture.

Reimplemented in deposition, and cavitation.

Definition at line 74 of file phaseTransferModel.C.

Referenced by blendedPhaseTransferModel::mixture().

Here is the caller graph for this function:

◆ dmdtf()

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

The mass transfer rate for the mixture.

Reimplemented in deposition, and cavitation.

Definition at line 80 of file phaseTransferModel.C.

Referenced by blendedPhaseTransferModel::dmdtf().

Here is the caller graph for this function:

◆ d2mdtdpf()

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

The mass transfer rate derivative w.r.t pressure for the mixture.

Reimplemented in cavitation.

Definition at line 86 of file phaseTransferModel.C.

Referenced by blendedPhaseTransferModel::d2mdtdpf().

Here is the caller graph for this function:

◆ species()

const Foam::hashedWordList & species ( ) const
virtual

The list of individual species that are transferred.

Reimplemented in reactionDriven.

Definition at line 92 of file phaseTransferModel.C.

Referenced by blendedPhaseTransferModel::species().

Here is the caller graph for this function:

◆ dmidtf()

Foam::HashPtrTable< Foam::volScalarField > dmidtf ( ) const
virtual

The mass transfer rate for individual species.

Reimplemented in reactionDriven.

Definition at line 99 of file phaseTransferModel.C.

Referenced by blendedPhaseTransferModel::dmidtf().

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream os) const
virtual

Dummy write for regIOobject.

Implements regIOobject.

Definition at line 105 of file phaseTransferModel.C.

References IOstream::good().

Here is the call graph for this function:

Member Data Documentation

◆ dimDmdt

const Foam::dimensionSet dimDmdt
static
Initial value:
=
const dimensionSet dimTime
const dimensionSet dimDensity

Mass transfer rate dimensions.

Definition at line 82 of file phaseTransferModel.H.

Referenced by blendedPhaseTransferModel::dmdtf(), and blendedPhaseTransferModel::dmidtf().

◆ dimD2mdtdp

const Foam::dimensionSet dimD2mdtdp
static
Initial value:

Mass transfer rate derivative w.r.t pressure dimensions.

Definition at line 85 of file phaseTransferModel.H.

Referenced by blendedPhaseTransferModel::d2mdtdpf().

◆ correctFixedFluxBCs

const bool correctFixedFluxBCs = false
static

Does this model require correcting on fixed flux boundaries?

Definition at line 88 of file phaseTransferModel.H.

◆ noSpecies_

const Foam::hashedWordList noSpecies_
static
Initial value:
=
A wordList with hashed indices for faster lookup by name.

Empty species list.

Definition at line 91 of file phaseTransferModel.H.


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