Templated phase change model class. More...

#include <PhaseChangeModel.H>

Inheritance diagram for PhaseChangeModel< CloudType >:

[legend]

Collaboration diagram for PhaseChangeModel< CloudType >:

[legend]

Public Types
enum	enthalpyTransferType { etLatentHeat , etEnthalpyDifference }
	Enthalpy transfer type. More...
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for.

Public Member Functions
	TypeName ("phaseChangeModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, PhaseChangeModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table.
	PhaseChangeModel (CloudType &owner)
	Construct null from owner.
	PhaseChangeModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from dictionary.
	PhaseChangeModel (const PhaseChangeModel< CloudType > &pcm)
	Construct copy.
virtual autoPtr< PhaseChangeModel< CloudType > >	clone () const =0
	Construct and return a clone.
virtual	~PhaseChangeModel ()=default
	Destructor.
const enthalpyTransferType &	enthalpyTransfer () const
	Return the enthalpy transfer type enumeration.
virtual void	calculate (const scalar dt, const label celli, const scalar Re, const scalar Pr, const scalar d, const scalar nu, const scalar rho, const scalar T, const scalar Ts, const scalar pc, const scalar Tc, const scalarField &X, const scalarField &solMass, const scalarField &liqMass, scalarField &dMassPC) const =0
	Update model.
virtual scalar	dh (const label idc, const label idl, const scalar p, const scalar T) const
	Return the enthalpy per unit mass.
virtual scalar	Tvap (const scalarField &X) const
	Return vapourisation temperature.
virtual scalar	TMax (const scalar p, const scalarField &X) const
	Return maximum/limiting temperature.
void	addToPhaseChangeMass (const scalar dMass)
	Add to phase change mass.
virtual void	info ()
	Write injection info.
Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)
	Construct null from owner cloud.
	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner cloud without name.
	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner cloud with name.
	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
	Construct as copy.
virtual	~CloudSubModelBase ()=default
	Destructor.
const CloudType &	owner () const
	Return const access to the owner cloud.
virtual bool	writeTime () const
	Flag to indicate when to write a property.
virtual fileName	localPath () const
	Output directory.
CloudType &	owner ()
	Return non-const access to the owner cloud for manipulation.
virtual void	write (Ostream &os) const
	Write to os.
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.
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.

Static Public Member Functions
static autoPtr< PhaseChangeModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector.

Static Public Attributes
static const wordList	enthalpyTransferTypeNames
	Name representations of enthalpy transfer types.

Protected Member Functions
enthalpyTransferType	wordToEnthalpyTransfer (const word &etName) const
	Convert word to enthalpy transfer type.
scalar	Sh () const
	Sherwood number.
Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line.

Protected Attributes
enthalpyTransferType	enthalpyTransfer_
	Enthalpy transfer type enumeration.
scalar	dMass_
	Mass of lagrangian phase converted.
Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud.
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.

Detailed Description

template<class CloudType>
class Foam::PhaseChangeModel< CloudType >

Templated phase change model class.

Source files

Definition at line 55 of file PhaseChangeModel.H.

Member Enumeration Documentation

◆ enthalpyTransferType

template<class CloudType>

enum enthalpyTransferType

Enthalpy transfer type.

Enumerator
etLatentHeat
etEnthalpyDifference

Definition at line 66 of file PhaseChangeModel.H.

Constructor & Destructor Documentation

◆ PhaseChangeModel() [1/3]

template<class CloudType>

PhaseChangeModel ( CloudType & owner )

Construct null from owner.

Definition at line 59 of file PhaseChangeModel.C.

References CloudSubModelBase< CloudType >::CloudSubModelBase(), dMass_, enthalpyTransfer_, etLatentHeat, and CloudSubModelBase< CloudType >::owner().

Referenced by declareRunTimeSelectionTable(), LiquidEvapFuchsKnudsen< CloudType >::dh(), LiquidEvaporation< CloudType >::dh(), LiquidEvaporationBoil< CloudType >::dh(), LiquidEvapFuchsKnudsen< CloudType >::LiquidEvapFuchsKnudsen(), LiquidEvapFuchsKnudsen< CloudType >::LiquidEvapFuchsKnudsen(), LiquidEvaporation< CloudType >::LiquidEvaporation(), LiquidEvaporation< CloudType >::LiquidEvaporation(), LiquidEvaporationBoil< CloudType >::LiquidEvaporationBoil(), LiquidEvaporationBoil< CloudType >::LiquidEvaporationBoil(), NoPhaseChange< CloudType >::NoPhaseChange(), NoPhaseChange< CloudType >::NoPhaseChange(), and PhaseChangeModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PhaseChangeModel() [2/3]

template<class CloudType>

PhaseChangeModel	(	const dictionary &	dict,
		CloudType &	owner,
		const word &	type )

Construct from dictionary.

Definition at line 83 of file PhaseChangeModel.C.

References CloudSubModelBase< CloudType >::CloudSubModelBase(), subModelBase::coeffDict(), subModelBase::dict(), dMass_, enthalpyTransfer_, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, CloudSubModelBase< CloudType >::owner(), and wordToEnthalpyTransfer().

Here is the call graph for this function:

◆ PhaseChangeModel() [3/3]

template<class CloudType>

PhaseChangeModel ( const PhaseChangeModel< CloudType > & pcm )

Construct copy.

Definition at line 71 of file PhaseChangeModel.C.

References CloudSubModelBase< CloudType >::CloudSubModelBase(), dMass_, enthalpyTransfer_, and PhaseChangeModel().

Here is the call graph for this function:

◆ ~PhaseChangeModel()

template<class CloudType>

virtual ~PhaseChangeModel ( )

virtualdefault

Destructor.

References subModelBase::dict(), and CloudSubModelBase< CloudType >::owner().

Here is the call graph for this function:

Member Function Documentation

◆ wordToEnthalpyTransfer()

template<class CloudType>

Foam::PhaseChangeModel< CloudType >::enthalpyTransferType wordToEnthalpyTransfer ( const word & etName ) const

protected

Convert word to enthalpy transfer type.

Definition at line 37 of file PhaseChangeModel.C.

References enthalpyTransferTypeNames, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, and Foam::nl.

Referenced by PhaseChangeModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Sh()

template<class CloudType>

scalar Sh ( ) const

protected

Sherwood number.

◆ TypeName()

template<class CloudType>

TypeName ( "phaseChangeModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

template<class CloudType>

declareRunTimeSelectionTable	(	autoPtr	,
		PhaseChangeModel< CloudType >	,
		dictionary	,
		(const dictionary &dict, CloudType &owner)	,
		(dict, owner)	)

Declare runtime constructor selection table.

References subModelBase::dict(), CloudSubModelBase< CloudType >::owner(), and PhaseChangeModel().

Here is the call graph for this function:

◆ clone()

template<class CloudType>

virtual autoPtr< PhaseChangeModel< CloudType > > clone ( ) const

pure virtual

Construct and return a clone.

Implemented in LiquidEvapFuchsKnudsen< CloudType >, LiquidEvaporation< CloudType >, LiquidEvaporationBoil< CloudType >, and NoPhaseChange< CloudType >.

◆ New()

template<class CloudType>

Foam::autoPtr< Foam::PhaseChangeModel< CloudType > > New	(	const dictionary &	dict,
		CloudType &	owner )

static

Selector.

Definition at line 28 of file PhaseChangeModelNew.C.

References subModelBase::dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, subModelBase::modelType(), and CloudSubModelBase< CloudType >::owner().

Here is the call graph for this function:

◆ enthalpyTransfer()

template<class CloudType>

const Foam::PhaseChangeModel< CloudType >::enthalpyTransferType & enthalpyTransfer ( ) const

Return the enthalpy transfer type enumeration.

Definition at line 103 of file PhaseChangeModel.C.

References enthalpyTransfer_.

◆ calculate()

template<class CloudType>

virtual void calculate	(	const scalar	dt,
		const label	celli,
		const scalar	Re,
		const scalar	Pr,
		const scalar	d,
		const scalar	nu,
		const scalar	rho,
		const scalar	T,
		const scalar	Ts,
		const scalar	pc,
		const scalar	Tc,
		const scalarField &	X,
		const scalarField &	solMass,
		const scalarField &	liqMass,
		scalarField &	dMassPC ) const

pure virtual

Update model.

Implemented in LiquidEvapFuchsKnudsen< CloudType >, LiquidEvaporation< CloudType >, LiquidEvaporationBoil< CloudType >, and NoPhaseChange< CloudType >.

References nu, p, Pr(), Foam::Re(), rho, and Foam::T().

Here is the call graph for this function:

◆ dh()

template<class CloudType>

Foam::scalar dh	(	const label	idc,
		const label	idl,
		const scalar	p,
		const scalar	T ) const

virtual

Return the enthalpy per unit mass.

Reimplemented in LiquidEvapFuchsKnudsen< CloudType >, LiquidEvaporation< CloudType >, and LiquidEvaporationBoil< CloudType >.

Definition at line 110 of file PhaseChangeModel.C.

References p, and Foam::T().

Here is the call graph for this function:

◆ Tvap()

template<class CloudType>

Foam::scalar Tvap ( const scalarField & X ) const

virtual

Return vapourisation temperature.

Reimplemented in LiquidEvapFuchsKnudsen< CloudType >, LiquidEvaporation< CloudType >, and LiquidEvaporationBoil< CloudType >.

Definition at line 134 of file PhaseChangeModel.C.

◆ TMax()

template<class CloudType>

Foam::scalar TMax	(	const scalar	p,
		const scalarField &	X ) const

virtual

Return maximum/limiting temperature.

Reimplemented in LiquidEvapFuchsKnudsen< CloudType >, LiquidEvaporation< CloudType >, and LiquidEvaporationBoil< CloudType >.

Definition at line 123 of file PhaseChangeModel.C.

References p.

◆ addToPhaseChangeMass()

template<class CloudType>

void addToPhaseChangeMass ( const scalar dMass )

Add to phase change mass.

Definition at line 141 of file PhaseChangeModel.C.

References dMass_.

◆ info()

template<class CloudType>

void info ( )

virtual

Write injection info.

Reimplemented from CloudSubModelBase< CloudType >.

Definition at line 148 of file PhaseChangeModel.C.

References dMass_, subModelBase::getBaseProperty(), CloudSubModelBase< CloudType >::info(), Log_, Foam::nl, Foam::returnReduce(), subModelBase::setBaseProperty(), and CloudSubModelBase< CloudType >::writeTime().

Here is the call graph for this function:

Member Data Documentation

◆ enthalpyTransferTypeNames

template<class CloudType>

const Foam::wordList enthalpyTransferTypeNames

static

Initial value:

{
    "latentHeat", "enthalpyDifference"
}

Name representations of enthalpy transfer types.

Definition at line 75 of file PhaseChangeModel.H.

Referenced by wordToEnthalpyTransfer().

◆ enthalpyTransfer_

template<class CloudType>

enthalpyTransferType enthalpyTransfer_

protected

Enthalpy transfer type enumeration.

Definition at line 85 of file PhaseChangeModel.H.

Referenced by enthalpyTransfer(), PhaseChangeModel(), PhaseChangeModel(), and PhaseChangeModel().

◆ dMass_

template<class CloudType>

scalar dMass_

protected

Mass of lagrangian phase converted.

Definition at line 93 of file PhaseChangeModel.H.

Referenced by addToPhaseChangeMass(), info(), PhaseChangeModel(), PhaseChangeModel(), and PhaseChangeModel().

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

src/lagrangian/intermediate/clouds/Templates/ReactingCloud/ReactingCloud.H
src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/PhaseChangeModel/PhaseChangeModel.H
src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/PhaseChangeModel/PhaseChangeModel.C
src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/PhaseChangeModel/PhaseChangeModelNew.C

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ enthalpyTransferType

Constructor & Destructor Documentation

◆ PhaseChangeModel() [1/3]

◆ PhaseChangeModel() [2/3]

◆ PhaseChangeModel() [3/3]

◆ ~PhaseChangeModel()

Member Function Documentation

◆ wordToEnthalpyTransfer()

◆ Sh()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ enthalpyTransfer()

◆ calculate()

◆ dh()

◆ Tvap()

◆ TMax()

◆ addToPhaseChangeMass()

◆ info()

Member Data Documentation

◆ enthalpyTransferTypeNames

◆ enthalpyTransfer_

◆ dMass_