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

Inheritance diagram for phaseChangeModel:

[legend]

Collaboration diagram for phaseChangeModel:

Public Member Functions
	TypeName ("phaseChange")
	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...

	phaseChangeModel (const phaseChangeModel &)=delete
	Disallow default bitwise copy construction. 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...

void	operator= (const phaseChangeModel &)=delete
	Disallow default bitwise assignment. 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 surfaceFilmRegionModel &	film () const
	Return const access to the film surface film model. More...

surfaceFilmRegionModel &	film ()
	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)
	Copy constructor. More...

virtual	~subModelBase ()
	Destructor. More...

const word &	modelName () const
	Return const access to the name of the sub-model. More...

const dictionary &	dict () const
	Return const access to the cloud dictionary. More...

const word &	baseName () const
	Return const access to the base name of the sub-model. More...

const word &	modelType () const
	Return const access to the sub-model type. More...

const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary. More...

const dictionary &	properties () 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 void	cacheFields (const bool store)
	Cache dependent sub-model fields. More...

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< 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...

template<class Type >
void	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=pTraits< 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...

void	operator= (const subModelBase &)=delete
	Disallow default bitwise assignment. More...

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

Protected Attributes
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
surfaceFilmRegionModel &	filmModel_
	Reference to the film surface film model. More...

Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model. More...

dictionary &	properties_
	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
Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line. More...

Detailed Description

Base class for surface film phase change models.

Source files

Definition at line 55 of file phaseChangeModel.H.

Constructor & Destructor Documentation

◆ phaseChangeModel() [1/3]

phaseChangeModel ( surfaceFilmRegionModel & film )

Construct null.

Definition at line 45 of file phaseChangeModel.C.

◆ phaseChangeModel() [2/3]

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

Construct from type name, dictionary and surface film model.

Definition at line 56 of file phaseChangeModel.C.

◆ phaseChangeModel() [3/3]

phaseChangeModel ( const phaseChangeModel & )

delete

Disallow default bitwise copy construction.

◆ ~phaseChangeModel()

~phaseChangeModel ( )

virtual

Destructor.

Definition at line 70 of file phaseChangeModel.C.

References phaseChangeModel::correct().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "phaseChange" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

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

static

Return a reference to the selected phase change model.

Definition at line 40 of file phaseChangeModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::found(), Foam::Info, dictionary::lookupEntryPtrBackwardsCompatible(), Foam::nl, and dictionary::subDict().

Here is the call graph for this function:

◆ correct()

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

virtual

Correct.

Reimplemented in noPhaseChange.

Definition at line 77 of file phaseChangeModel.C.

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

Referenced by phaseChangeModel::~phaseChangeModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ correctModel()

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

pure virtual

Correct.

Implemented in waxSolventEvaporation, standardPhaseChange, solidification, and noPhaseChange.

Referenced by phaseChangeModel::correct().

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 TimeState::deltaTValue(), filmSubModelBase::filmModel_, Foam::indent(), phaseChangeModel::latestMassPC_, Foam::nl, Foam::returnReduce(), regionModel::time(), and phaseChangeModel::totalMassPC_.

Here is the call graph for this function:

◆ operator=()

void operator= ( const phaseChangeModel & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ latestMassPC_

scalar latestMassPC_

protected

Latest mass transfer due to phase change.

Definition at line 64 of file phaseChangeModel.H.

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

◆ totalMassPC_

scalar totalMassPC_

protected

Total mass transfer due to phase change.

Definition at line 67 of file phaseChangeModel.H.

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

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/3]

◆ phaseChangeModel() [2/3]

◆ phaseChangeModel() [3/3]

◆ ~phaseChangeModel()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ correct()

◆ correctModel()

◆ info()

◆ operator=()

Member Data Documentation

◆ latestMassPC_

◆ totalMassPC_