Base class for surface film phase change models. More...

#include <phaseChangeModel.H>

Inheritance diagram for phaseChangeModel:

[legend]

Collaboration diagram for phaseChangeModel:

Public Member Functions
	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	correctModel (const scalar dt, scalarField &availableMass, scalarField &dMass, scalarField &dEnergy)=0
	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.

Static Public Member Functions
static autoPtr< phaseChangeModel >	New (surfaceFilmRegionModel &film, const dictionary &dict)
	Return a reference to the selected phase change model.

Protected Attributes
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
Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info.
Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line.

Detailed Description

Base class for surface film phase change models.

Source files

Definition at line 53 of file phaseChangeModel.H.

Constructor & Destructor Documentation

◆ phaseChangeModel() [1/2]

phaseChangeModel ( surfaceFilmRegionModel & film )

Construct null.

Definition at line 39 of file phaseChangeModel.C.

References filmSubModelBase::film(), filmSubModelBase::filmSubModelBase(), latestMassPC_, and totalMassPC_.

Here is the call graph for this function:

◆ phaseChangeModel() [2/2]

phaseChangeModel	(	const word &	modelType,
		surfaceFilmRegionModel &	film,
		const dictionary &	dict )

Construct from type name, dictionary and surface film model.

Definition at line 50 of file phaseChangeModel.C.

References subModelBase::dict(), filmSubModelBase::film(), filmSubModelBase::filmSubModelBase(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, latestMassPC_, subModelBase::modelType(), and totalMassPC_.

Here is the call graph for this function:

◆ ~phaseChangeModel()

~phaseChangeModel ( )

virtual

Destructor.

Definition at line 65 of file phaseChangeModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "phaseChangeModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		phaseChangeModel	,
		dictionary	,
		(surfaceFilmRegionModel &film, const dictionary &dict)	,
		(film, dict)	)

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

Here is the call graph for this function:

◆ New()

autoPtr< phaseChangeModel > New	(	surfaceFilmRegionModel &	film,
		const dictionary &	dict )

static

Return a reference to the selected phase change model.

Definition at line 35 of file phaseChangeModelNew.C.

References subModelBase::dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and subModelBase::modelType().

Referenced by waxSolventEvaporation::waxSolventEvaporation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ correct()

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

virtual

Correct.

Definition at line 71 of file phaseChangeModel.C.

References subModelBase::active(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), correctModel(), subModelBase::getModelProperty(), latestMassPC_, GeometricField< Type, PatchField, GeoMesh >::primitiveField(), Foam::returnReduce(), subModelBase::setModelProperty(), Foam::sum(), totalMassPC_, and filmSubModelBase::writeTime().

Here is the call graph for this function:

◆ correctModel()

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

pure virtual

Correct.

Implemented in noPhaseChange, solidification, standardPhaseChange, and waxSolventEvaporation.

References os().

Referenced by correct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ info()

void info ( Ostream & os ) const

virtual

Provide some feedback.

Definition at line 108 of file phaseChangeModel.C.

References filmSubModelBase::filmModel_, subModelBase::getModelProperty(), Foam::indent(), latestMassPC_, Foam::nl, os(), Foam::returnReduce(), and totalMassPC_.

Here is the call graph for this function:

Member Data Documentation

◆ latestMassPC_

scalar latestMassPC_

protected

Latest mass transfer due to phase change.

Definition at line 79 of file phaseChangeModel.H.

Referenced by correct(), info(), phaseChangeModel(), and phaseChangeModel().

◆ totalMassPC_

scalar totalMassPC_

protected

Total mass transfer due to phase change.

Definition at line 84 of file phaseChangeModel.H.

Referenced by correct(), info(), phaseChangeModel(), and phaseChangeModel().

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

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ phaseChangeModel() [1/2]

◆ phaseChangeModel() [2/2]

◆ ~phaseChangeModel()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ correct()

◆ correctModel()

◆ info()

Member Data Documentation

◆ latestMassPC_

◆ totalMassPC_