waxSolventEvaporation Class Reference
Inheritance diagram for waxSolventEvaporation:
[legend]
Collaboration diagram for waxSolventEvaporation:
[legend]

Public Member Functions

 TypeName ("waxSolventEvaporation")
 Runtime type information. More...
 
 waxSolventEvaporation (surfaceFilmRegionModel &film, const dictionary &dict)
 Construct from surface film model. More...
 
virtual ~waxSolventEvaporation ()
 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)
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 

Protected Attributes

uniformDimensionedScalarField Wwax_
 Molecular weight of wax [kg/kmol]. More...
 
uniformDimensionedScalarField Wsolvent_
 Molecular weight of liquid [kg/kmol]. More...
 
uniformDimensionedScalarField Ysolvent0_
 Initial solvent mass-fraction. More...
 
volScalarField Ysolvent_
 Solvent mass-fraction. More...
 
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...
 
bool YInfZero_
 Switch to treat YInf as zero. More...
 
autoPtr< Function1< scalar > > activityCoeff_
 Activity coefficient as a function of solvent mole fraction. 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

Definition at line 56 of file waxSolventEvaporation.H.

Constructor & Destructor Documentation

◆ waxSolventEvaporation()

Construct from surface film model.

Definition at line 80 of file waxSolventEvaporation.C.

◆ ~waxSolventEvaporation()

~waxSolventEvaporation ( )
virtual

Destructor.

Definition at line 143 of file waxSolventEvaporation.C.

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 61 of file waxSolventEvaporation.C.

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

Referenced by waxSolventEvaporation::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 150 of file waxSolventEvaporation.C.

References waxSolventEvaporation::activityCoeff_, filmThermoModel::D(), Foam::fvm::ddt(), delta, surfaceFilmRegionModel::delta(), waxSolventEvaporation::deltaMin_, Foam::dimDensity, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVelocity, Foam::fvm::div(), Foam::endl(), filmSubModelBase::film(), forAll, surfaceFilmRegionModel::hs(), waxSolventEvaporation::L_, Foam::mag(), singleLayerRegion::magSf(), GeometricField< Type, PatchField, GeoMesh >::max(), Foam::max(), GeometricField< Type, PatchField, GeoMesh >::min(), Foam::min(), filmThermoModel::name(), IOobject::NO_READ, IOobject::NO_WRITE, phi, filmThermoModel::pv(), Foam::Re(), regionModel::regionMesh(), fvMatrix< Type >::relax(), rho, surfaceFilmRegionModel::rho(), waxSolventEvaporation::Sh(), fvMatrix< Type >::solve(), Foam::fvm::Sp(), T, surfaceFilmRegionModel::T(), filmThermoModel::Tb(), waxSolventEvaporation::TbFactor_, fvMesh::time(), Time::timeName(), surfaceFilmRegionModel::Us(), dimensioned< Type >::value(), WarningInFunction, waxSolventEvaporation::Wsolvent_, waxSolventEvaporation::Wwax_, waxSolventEvaporation::Ysolvent0_, waxSolventEvaporation::Ysolvent_, and Foam::Zero.

Referenced by waxSolventEvaporation::correctModel().

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

◆ TypeName()

TypeName ( "waxSolventEvaporation"  )

Runtime type information.

◆ correctModel() [2/2]

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

Correct.

Implements phaseChangeModel.

Definition at line 380 of file waxSolventEvaporation.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ Wwax_

Molecular weight of wax [kg/kmol].

Definition at line 74 of file waxSolventEvaporation.H.

Referenced by waxSolventEvaporation::correctModel().

◆ Wsolvent_

uniformDimensionedScalarField Wsolvent_
protected

Molecular weight of liquid [kg/kmol].

Definition at line 77 of file waxSolventEvaporation.H.

Referenced by waxSolventEvaporation::correctModel().

◆ Ysolvent0_

uniformDimensionedScalarField Ysolvent0_
protected

Initial solvent mass-fraction.

Definition at line 80 of file waxSolventEvaporation.H.

Referenced by waxSolventEvaporation::correctModel().

◆ Ysolvent_

volScalarField Ysolvent_
protected

Solvent mass-fraction.

Definition at line 83 of file waxSolventEvaporation.H.

Referenced by waxSolventEvaporation::correctModel().

◆ deltaMin_

const scalar deltaMin_
protected

Minimum film height for model to be active.

Definition at line 86 of file waxSolventEvaporation.H.

Referenced by waxSolventEvaporation::correctModel().

◆ L_

const scalar L_
protected

Length scale [m].

Definition at line 89 of file waxSolventEvaporation.H.

Referenced by waxSolventEvaporation::correctModel().

◆ TbFactor_

const scalar TbFactor_
protected

Boiling temperature factor.

Used to set max limit on temperature to Tb*TbFactor

Definition at line 93 of file waxSolventEvaporation.H.

Referenced by waxSolventEvaporation::correctModel().

◆ YInfZero_

bool YInfZero_
protected

Switch to treat YInf as zero.

Definition at line 96 of file waxSolventEvaporation.H.

Referenced by waxSolventEvaporation::correctModel().

◆ activityCoeff_

autoPtr<Function1<scalar> > activityCoeff_
protected

Activity coefficient as a function of solvent mole fraction.

Definition at line 99 of file waxSolventEvaporation.H.

Referenced by waxSolventEvaporation::correctModel().


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