standardPhaseChange Class Reference

Standard phase change model with modification for boiling. More...

Inheritance diagram for standardPhaseChange:
[legend]
Collaboration diagram for standardPhaseChange:
[legend]

Public Member Functions

 TypeName ("standardPhaseChange")
 Runtime type information. More...
 
 standardPhaseChange (surfaceFilmRegionModel &film, const dictionary &dict)
 Construct from surface film model. More...
 
virtual ~standardPhaseChange ()=default
 Destructor. More...
 
virtual void correctModel (const scalar dt, scalarField &availableMass, scalarField &dMass, scalarField &dEnergy)
 Correct. More...
 
- Public Member Functions inherited from phaseChangeModel
 TypeName ("phaseChangeModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, phaseChangeModel, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict),(film, dict))
 
 phaseChangeModel (surfaceFilmRegionModel &film)
 Construct null. More...
 
 phaseChangeModel (const word &modelType, surfaceFilmRegionModel &film, const dictionary &dict)
 Construct from type name, dictionary and surface film model. More...
 
virtual ~phaseChangeModel ()
 Destructor. More...
 
virtual void correct (const scalar dt, scalarField &availableMass, volScalarField &dMass, volScalarField &dEnergy)
 Correct. More...
 
virtual void correctModel (const scalar dt, scalarField &availableMass, scalarField &dMass, scalarField &dEnergy)=0
 Correct. More...
 
virtual void info (Ostream &os) const
 Provide some feedback. More...
 
- Public Member Functions inherited from filmSubModelBase
 filmSubModelBase (surfaceFilmRegionModel &film)
 Construct null. More...
 
 filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from film film without name. More...
 
 filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from film film with name. More...
 
virtual ~filmSubModelBase ()
 Destructor. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
const surfaceFilmRegionModelfilm () const
 Return const access to the film surface film model. More...
 
surfaceFilmRegionModelfilm ()
 Return the reference to the film surface film model. More...
 
template<class FilmType >
const FilmType & filmType () const
 
- Public Member Functions inherited from subModelBase
 subModelBase (dictionary &properties)
 Construct null. More...
 
 subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from components without name. More...
 
 subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from components with name. More...
 
 subModelBase (const subModelBase &smb)
 Construct as copy. More...
 
virtual ~subModelBase ()
 Destructor. More...
 
const wordmodelName () const
 Return const access to the name of the sub-model. More...
 
const dictionarydict () const
 Return const access to the cloud dictionary. More...
 
const wordbaseName () const
 Return const access to the base name of the sub-model. More...
 
const wordmodelType () const
 Return const access to the sub-model type. More...
 
const dictionarycoeffDict () const
 Return const access to the coefficients dictionary. More...
 
const dictionaryproperties () const
 Return const access to the properties dictionary. More...
 
virtual bool defaultCoeffs (const bool printMsg) const
 Returns true if defaultCoeffs is true and outputs on printMsg. More...
 
virtual bool active () const
 Return the model 'active' status - default active = true. More...
 
virtual void cacheFields (const bool store)
 Cache dependent sub-model fields. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
virtual fileName localPath () const
 Output directory. More...
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 Retrieve generic property from the base model. More...
 
template<class Type >
void getBaseProperty (const word &entryName, Type &value) const
 Retrieve generic property from the base model. More...
 
template<class Type >
void setBaseProperty (const word &entryName, const Type &value)
 Add generic property to the base model. More...
 
bool getModelDict (const word &entryName, dictionary &dict) const
 Retrieve dictionary, return true if set. More...
 
template<class Type >
bool getModelProperty (const word &entryName, Type &value) const
 Retrieve generic property from the sub-model. More...
 
template<class Type >
Type getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 Retrieve generic property from the sub-model. More...
 
template<class Type >
void setModelProperty (const word &entryName, const Type &value)
 Add generic property to the sub-model. More...
 
virtual void write (Ostream &os) const
 Write. More...
 

Protected Member Functions

scalar Sh (const scalar Re, const scalar Sc) const
 Return Sherwood number as a function of Reynolds and Schmidt numbers. More...
 
template<class YInfType >
void correctModel (const scalar dt, scalarField &availableMass, scalarField &dMass, scalarField &dEnergy, YInfType YInf)
 
 standardPhaseChange (const standardPhaseChange &)=delete
 No copy construct. More...
 
void operator= (const standardPhaseChange &)=delete
 No copy assignment. More...
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 

Protected Attributes

const scalar deltaMin_
 Minimum film height for model to be active. More...
 
const scalar L_
 Length scale / [m]. More...
 
const scalar TbFactor_
 Boiling temperature factor / []. More...
 
Switch YInfZero_
 Switch to treat YInf as zero. More...
 
- Protected Attributes inherited from phaseChangeModel
scalar latestMassPC_
 Latest mass transfer due to phase change. More...
 
scalar totalMassPC_
 Total mass transfer due to phase change. More...
 
- Protected Attributes inherited from filmSubModelBase
surfaceFilmRegionModelfilmModel_
 Reference to the film surface film model. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionaryproperties_
 Reference to properties dictionary e.g. for restart. More...
 
const dictionary dict_
 Copy of dictionary used during construction. More...
 
const word baseName_
 Name of the sub-model base class. More...
 
const word modelType_
 Type of the sub-model. More...
 
const dictionary coeffDict_
 Coefficients dictionary. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from phaseChangeModel
static autoPtr< phaseChangeModelNew (surfaceFilmRegionModel &film, const dictionary &dict)
 Return a reference to the selected phase change model. More...
 

Detailed Description

Standard phase change model with modification for boiling.

Source files

Definition at line 54 of file standardPhaseChange.H.

Constructor & Destructor Documentation

◆ standardPhaseChange() [1/2]

standardPhaseChange ( const standardPhaseChange )
protecteddelete

No copy construct.

◆ standardPhaseChange() [2/2]

standardPhaseChange ( surfaceFilmRegionModel film,
const dictionary dict 
)

Construct from surface film model.

Definition at line 75 of file standardPhaseChange.C.

◆ ~standardPhaseChange()

virtual ~standardPhaseChange ( )
virtualdefault

Destructor.

Member Function Documentation

◆ Sh()

scalar Sh ( const scalar  Re,
const scalar  Sc 
) const
protected

Return Sherwood number as a function of Reynolds and Schmidt numbers.

Definition at line 56 of file standardPhaseChange.C.

References Foam::cbrt(), Foam::pow(), Foam::Re(), and Foam::sqrt().

Referenced by standardPhaseChange::correctModel().

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

◆ correctModel() [1/2]

void correctModel ( const scalar  dt,
scalarField availableMass,
scalarField dMass,
scalarField dEnergy,
YInfType  YInf 
)
protected

Definition at line 92 of file standardPhaseChange.C.

References Cp, filmThermoModel::Cp(), filmThermoModel::D(), delta, surfaceFilmRegionModel::delta(), standardPhaseChange::deltaMin_, filmSubModelBase::film(), forAll, filmThermoModel::hl(), surfaceFilmRegionModel::hs(), standardPhaseChange::L_, Foam::mag(), singleLayerRegion::magSf(), Foam::max(), Foam::min(), filmThermoModel::name(), filmThermoModel::pv(), Foam::Re(), rho, surfaceFilmRegionModel::rho(), standardPhaseChange::Sh(), T, surfaceFilmRegionModel::T(), filmThermoModel::Tb(), standardPhaseChange::TbFactor_, surfaceFilmRegionModel::Us(), and filmThermoModel::W().

Referenced by standardPhaseChange::correctModel().

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

◆ operator=()

void operator= ( const standardPhaseChange )
protecteddelete

No copy assignment.

◆ TypeName()

TypeName ( "standardPhaseChange"  )

Runtime type information.

◆ correctModel() [2/2]

void correctModel ( const scalar  dt,
scalarField availableMass,
scalarField dMass,
scalarField dEnergy 
)
virtual

Correct.

Implements phaseChangeModel.

Definition at line 200 of file standardPhaseChange.C.

References standardPhaseChange::correctModel(), filmSubModelBase::film(), baseIOdictionary::name(), and standardPhaseChange::YInfZero_.

Here is the call graph for this function:

Member Data Documentation

◆ deltaMin_

const scalar deltaMin_
protected

Minimum film height for model to be active.

Definition at line 63 of file standardPhaseChange.H.

Referenced by standardPhaseChange::correctModel().

◆ L_

const scalar L_
protected

Length scale / [m].

Definition at line 66 of file standardPhaseChange.H.

Referenced by standardPhaseChange::correctModel().

◆ TbFactor_

const scalar TbFactor_
protected

Boiling temperature factor / [].

Used to set max limit on temperature to Tb*TbFactor

Definition at line 70 of file standardPhaseChange.H.

Referenced by standardPhaseChange::correctModel().

◆ YInfZero_

Switch YInfZero_
protected

Switch to treat YInf as zero.

Definition at line 73 of file standardPhaseChange.H.

Referenced by standardPhaseChange::correctModel().


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