Public Member Functions | Protected Attributes | List of all members
VoFPatchTransfer Class Reference

Transfer mass between the film and the VoF in the continuous phase. More...

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

Public Member Functions

 TypeName ("VoFPatchTransfer")
 
 VoFPatchTransfer (surfaceFilmRegionModel &film, const dictionary &dict)
 
virtual ~VoFPatchTransfer ()
 
virtual void correct (scalarField &availableMass, scalarField &massToTransfer)
 
virtual void correct (scalarField &availableMass, scalarField &massToTransfer, scalarField &energyToTransfer)
 
virtual void patchTransferredMassTotals (scalarField &patchMasses) const
 
- Public Member Functions inherited from transferModel
 TypeName ("transferModel")
 
 declareRunTimeSelectionTable (autoPtr, transferModel, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict),(film, dict))
 
 transferModel (surfaceFilmRegionModel &film)
 
 transferModel (const word &modelType, surfaceFilmRegionModel &film, const dictionary &dict)
 
virtual ~transferModel ()
 
virtual scalar transferredMassTotal () const
 
- Public Member Functions inherited from filmSubModelBase
 filmSubModelBase (surfaceFilmRegionModel &film)
 
 filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 
 filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType)
 
virtual ~filmSubModelBase ()
 
virtual bool writeTime () const
 
const surfaceFilmRegionModelfilm () const
 
surfaceFilmRegionModelfilm ()
 
template<class FilmType >
const FilmType & filmType () const
 
- Public Member Functions inherited from subModelBase
 subModelBase (dictionary &properties)
 
 subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 
 subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
 
 subModelBase (const subModelBase &smb)
 
virtual ~subModelBase ()
 
const wordmodelName () const
 
const dictionarydict () const
 
const wordbaseName () const
 
const wordmodelType () const
 
const dictionarycoeffDict () const
 
const dictionaryproperties () const
 
virtual bool defaultCoeffs (const bool printMsg) const
 
virtual bool active () const
 
virtual void cacheFields (const bool store)
 
virtual fileName localPath () const
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
void getBaseProperty (const word &entryName, Type &value) const
 
template<class Type >
void setBaseProperty (const word &entryName, const Type &value)
 
bool getModelDict (const word &entryName, dictionary &dict) const
 
template<class Type >
void getModelProperty (const word &entryName, Type &value) const
 
template<class Type >
Type getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
void setModelProperty (const word &entryName, const Type &value)
 
virtual void write (Ostream &os) const
 

Protected Attributes

scalar deltaFactorToVoF_
 
scalar deltaFactorToFilm_
 
scalar alphaToVoF_
 
scalar alphaToFilm_
 
scalar transferRateCoeff_
 
labelList patchIDs_
 
scalarField patchTransferredMasses_
 
- Protected Attributes inherited from filmSubModelBase
surfaceFilmRegionModelfilmModel_
 
- Protected Attributes inherited from subModelBase
const word modelName_
 
dictionaryproperties_
 
const dictionary dict_
 
const word baseName_
 
const word modelType_
 
const dictionary coeffDict_
 

Additional Inherited Members

- Static Public Member Functions inherited from transferModel
static autoPtr< transferModelNew (surfaceFilmRegionModel &film, const dictionary &dict, const word &modelType)
 
- Protected Member Functions inherited from transferModel
void addToTransferredMass (const scalar dMass)
 
void correct ()
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 

Detailed Description

Transfer mass between the film and the VoF in the continuous phase.

Source files

Definition at line 50 of file VoFPatchTransfer.H.

Constructor & Destructor Documentation

◆ VoFPatchTransfer()

VoFPatchTransfer ( surfaceFilmRegionModel film,
const dictionary dict 
)

◆ ~VoFPatchTransfer()

virtual ~VoFPatchTransfer ( )
virtual

Member Function Documentation

◆ TypeName()

TypeName ( "VoFPatchTransfer"  )

◆ correct() [1/2]

virtual void correct ( scalarField availableMass,
scalarField massToTransfer 
)
virtual

Implements transferModel.

◆ correct() [2/2]

virtual void correct ( scalarField availableMass,
scalarField massToTransfer,
scalarField energyToTransfer 
)
virtual

Reimplemented from transferModel.

◆ patchTransferredMassTotals()

virtual void patchTransferredMassTotals ( scalarField patchMasses) const
virtual

Reimplemented from transferModel.

Member Data Documentation

◆ deltaFactorToVoF_

scalar deltaFactorToVoF_
protected

Definition at line 67 of file VoFPatchTransfer.H.

◆ deltaFactorToFilm_

scalar deltaFactorToFilm_
protected

Definition at line 71 of file VoFPatchTransfer.H.

◆ alphaToVoF_

scalar alphaToVoF_
protected

Definition at line 74 of file VoFPatchTransfer.H.

◆ alphaToFilm_

scalar alphaToFilm_
protected

Definition at line 77 of file VoFPatchTransfer.H.

◆ transferRateCoeff_

scalar transferRateCoeff_
protected

Definition at line 80 of file VoFPatchTransfer.H.

◆ patchIDs_

labelList patchIDs_
protected

Definition at line 83 of file VoFPatchTransfer.H.

◆ patchTransferredMasses_

scalarField patchTransferredMasses_
protected

Definition at line 86 of file VoFPatchTransfer.H.


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