#include <waxSolventEvaporation.H>

Inheritance diagram for waxSolventEvaporation:

Collaboration diagram for waxSolventEvaporation:

[legend]

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

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

Protected Attributes
uniformDimensionedScalarField	Wwax_
	Molecular weight of wax [kg/kmol].
uniformDimensionedScalarField	Wsolvent_
	Molecular weight of liquid [kg/kmol].
uniformDimensionedScalarField	Ysolvent0_
	Initial solvent mass-fraction.
volScalarField	Ysolvent_
	Solvent mass-fraction.
const scalar	deltaMin_
	Minimum film height for model to be active.
const scalar	L_
	Length scale [m].
const scalar	TbFactor_
	Boiling temperature factor.
bool	YInfZero_
	Switch to treat YInf as zero.
autoPtr< Function1< scalar > >	activityCoeff_
	Activity coefficient as a function of solvent mole fraction.
Protected Attributes inherited from phaseChangeModel
scalar	latestMassPC_
	Latest mass transfer due to phase change.
scalar	totalMassPC_
	Total mass transfer due to phase change.
Protected Attributes inherited from filmSubModelBase
surfaceFilmRegionModel &	filmModel_
	Reference to the film surface film model.
Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model.
dictionary &	properties_
	Reference to properties dictionary e.g. for restart.
const dictionary	dict_
	Copy of dictionary used during construction.
const word	baseName_
	Name of the sub-model base class.
const word	modelType_
	Type of the sub-model.
const dictionary	coeffDict_
	Coefficients dictionary.

Additional Inherited Members
Static Public Member Functions inherited from phaseChangeModel
static autoPtr< phaseChangeModel >	New (surfaceFilmRegionModel &film, const dictionary &dict)
	Return a reference to the selected phase change model.
Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info.

Detailed Description

Definition at line 52 of file waxSolventEvaporation.H.

Constructor & Destructor Documentation

◆ waxSolventEvaporation() [1/2]

waxSolventEvaporation ( const waxSolventEvaporation & )

protecteddelete

No copy construct.

References waxSolventEvaporation().

Referenced by operator=(), and waxSolventEvaporation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ waxSolventEvaporation() [2/2]

waxSolventEvaporation	(	surfaceFilmRegionModel &	film,
		const dictionary &	dict )

Construct from surface film model.

Definition at line 73 of file waxSolventEvaporation.C.

References activityCoeff_, subModelBase::coeffDict_, deltaMin_, subModelBase::dict(), filmSubModelBase::film(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, L_, phaseChangeModel::New(), TbFactor_, timeName, Wsolvent_, Wwax_, YInfZero_, Ysolvent0_, and Ysolvent_.

Here is the call graph for this function:

◆ ~waxSolventEvaporation()

~waxSolventEvaporation ( )

virtual

Destructor.

Definition at line 144 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 54 of file waxSolventEvaporation.C.

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

Referenced by correctModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ correctModel() [1/2]

template<class YInfType>

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

protected

Definition at line 151 of file waxSolventEvaporation.C.

References activityCoeff_, filmThermoModel::D(), Foam::fvm::ddt(), delta, deltaMin_, Foam::dimDensity, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, Foam::dimVelocity, Foam::fvm::div(), Foam::endl(), filmSubModelBase::film(), filmSubModelBase::filmType(), forAll, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, L_, Foam::mag(), Foam::max(), Foam::min(), filmThermoModel::name(), GeometricField< scalar, fvPatchField, volMesh >::New(), phi, filmThermoModel::pv(), Foam::Re(), fvMatrix< Type >::relax(), rho, IOobject::scopedName(), Sh(), fvMatrix< Type >::solve(), Foam::fvm::Sp(), Foam::T(), filmThermoModel::Tb(), TbFactor_, WarningInFunction, Wsolvent_, Wwax_, Ysolvent0_, Ysolvent_, and Foam::Zero.

Referenced by correctModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const waxSolventEvaporation & )

protecteddelete

No copy assignment.

References waxSolventEvaporation().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "waxSolventEvaporation" )

Runtime type information.

References subModelBase::dict(), and filmSubModelBase::film().

Here is the call graph for this function:

◆ correctModel() [2/2]

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

virtual

Correct.

Implements phaseChangeModel.

Definition at line 366 of file waxSolventEvaporation.C.

References correctModel(), filmSubModelBase::film(), filmSubModelBase::filmType(), and YInfZero_.

Here is the call graph for this function:

Member Data Documentation

◆ Wwax_

uniformDimensionedScalarField Wwax_

protected

Molecular weight of wax [kg/kmol].

Definition at line 63 of file waxSolventEvaporation.H.

Referenced by correctModel(), and waxSolventEvaporation().

◆ Wsolvent_

uniformDimensionedScalarField Wsolvent_

protected

Molecular weight of liquid [kg/kmol].

Definition at line 68 of file waxSolventEvaporation.H.

Referenced by correctModel(), and waxSolventEvaporation().

◆ Ysolvent0_

uniformDimensionedScalarField Ysolvent0_

protected

Initial solvent mass-fraction.

Definition at line 73 of file waxSolventEvaporation.H.

Referenced by correctModel(), and waxSolventEvaporation().

◆ Ysolvent_

volScalarField Ysolvent_

protected

Solvent mass-fraction.

Definition at line 78 of file waxSolventEvaporation.H.

Referenced by correctModel(), and waxSolventEvaporation().

◆ deltaMin_

const scalar deltaMin_

protected

Minimum film height for model to be active.

Definition at line 83 of file waxSolventEvaporation.H.

Referenced by correctModel(), and waxSolventEvaporation().

◆ L_

const scalar L_

protected

Length scale [m].

Definition at line 88 of file waxSolventEvaporation.H.

Referenced by correctModel(), and waxSolventEvaporation().

◆ TbFactor_

const scalar TbFactor_

protected

Boiling temperature factor.

Used to set max limit on temperature to Tb*TbFactor

Definition at line 95 of file waxSolventEvaporation.H.

Referenced by correctModel(), and waxSolventEvaporation().

◆ YInfZero_

bool YInfZero_

protected

Switch to treat YInf as zero.

Definition at line 100 of file waxSolventEvaporation.H.

Referenced by correctModel(), and waxSolventEvaporation().

◆ activityCoeff_

autoPtr<Function1<scalar> > activityCoeff_

protected

Activity coefficient as a function of solvent mole fraction.

Definition at line 105 of file waxSolventEvaporation.H.

Referenced by correctModel(), and waxSolventEvaporation().

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

src/regionModels/surfaceFilmModels/submodels/thermo/phaseChangeModel/waxSolventEvaporation/waxSolventEvaporation.H
src/regionModels/surfaceFilmModels/submodels/thermo/phaseChangeModel/waxSolventEvaporation/waxSolventEvaporation.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ waxSolventEvaporation() [1/2]

◆ waxSolventEvaporation() [2/2]

◆ ~waxSolventEvaporation()

Member Function Documentation

◆ Sh()

◆ correctModel() [1/2]

◆ operator=()

◆ TypeName()

◆ correctModel() [2/2]

Member Data Documentation

◆ Wwax_

◆ Wsolvent_

◆ Ysolvent0_

◆ Ysolvent_

◆ deltaMin_

◆ L_

◆ TbFactor_

◆ YInfZero_

◆ activityCoeff_