Base class for phase change models. More...

Inheritance diagram for phaseChange:

[legend]

Collaboration diagram for phaseChange:

Public Member Functions
	TypeName ("phaseChange")
	Runtime type information. More...

	phaseChange (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict, const wordList &species)
	Construct from explicit source name and mesh. More...

const ThermoRefPair< basicThermo > &	thermos () const
	Return the thermo references. More...

const ThermoRefPair< fluidThermo >	fluidThermos (const bool, const bool) const
	Return the fluid thermo references. More...

const ThermoRefPair< multicomponentThermo >	multicomponentThermos (const bool, const bool) const
	Return the multicomponent thermo references. More...

const ThermoRefPair< fluidMulticomponentThermo >	fluidMulticomponentThermos (const bool, const bool) const
	Return the fluid multicomponent thermo references. More...

const Pair< word > &	heNames () const
	Return the names of the energy fields. More...

const hashedWordList &	species () const
	Return the names of the transferring species. Empty if neither. More...

const labelPair &	specieis (const label mDoti=-1) const
	Return the indices of the transferring specie in the two. More...

virtual tmp< DimensionedField< scalar, fvMesh > >	Tchange () const
	Return the temperature at which the phases are considered to be. More...

virtual tmp< DimensionedField< scalar, fvMesh > >	Lfraction () const
	Return the fraction of the latent heat that is transferred into. More...

tmp< DimensionedField< scalar, fvMesh > >	L (const label mDoti=-1) const
	Return the latent heat. More...

tmp< DimensionedField< scalar, fvMesh > >	L (const volScalarField::Internal &Tchange, const label mDoti=-1) const
	Return the latent heat for a given changing temperature. More...

tmp< scalarField >	L (const label patchi, const scalarField &Tchange, const label mDoti=-1) const
	Return the latent heat for a patch and a given changing. More...

virtual tmp< DimensionedField< scalar, fvMesh > >	mDot () const
	Return the total phase change rate. More...

virtual tmp< DimensionedField< scalar, fvMesh > >	mDot (const label mDoti) const
	Return the mass transfer rate of a specie. More...

void	addSup (const volScalarField &alpha, const volScalarField &rho, const volScalarField &heOrYi, fvMatrix< scalar > &eqn) const
	Override the energy equation to add the phase change heat, or. More...

virtual bool	read (const dictionary &dict)
	Read source dictionary. More...

Public Member Functions inherited from massTransfer
	TypeName ("massTransfer")
	Runtime type information. More...

	massTransfer (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from explicit source name and mesh. More...

virtual bool	addsSupToField (const word &fieldName) const
	Return true if the fvModel adds a source term to the given. More...

const Pair< word > &	phaseNames () const
	Return the names of the phases. More...

const Pair< word > &	alphaNames () const
	Return the names of the volume fraction fields. More...

const Pair< word > &	rhoNames () const
	Return the names of the density fields. More...

virtual tmp< DimensionedField< scalar, fvMesh > >	S (const word &fieldName) const
	Return the source value. More...

virtual void	addSup (fvMatrix< scalar > &eqn) const
	Add a source term to a field-less proxy equation. More...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_FIELD_SUP)
	Add a source term to an equation. More...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_RHO_FIELD_SUP)
	Add a source term to a compressible equation. More...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_ALPHA_RHO_FIELD_SUP)
	Add a source term to a phase equation. More...

template<class Type >
const Foam::VolField< Type > &	otherField (const VolField< Type > &field) const

Public Member Functions inherited from fvSpecificSource
	TypeName ("fvSpecificSource")
	Runtime type information. More...

	fvSpecificSource (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from explicit source name and mesh. More...

virtual	~fvSpecificSource ()
	Destructor. More...

virtual bool	movePoints ()
	Update for mesh motion. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

Public Member Functions inherited from fvSource
	TypeName ("fvSource")
	Runtime type information. More...

	fvSource (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from explicit source name and mesh. More...

	fvSource (const fvSource &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvSource ()
	Destructor. More...

virtual wordList	addSupFields () const final
	Return the list of fields for which the fvModel adds source term. More...

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

Public Member Functions inherited from fvModel
	TypeName ("fvModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, fvModel, dictionary,(const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict),(name, modelType, mesh, dict))

	fvModel (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from components. More...

autoPtr< fvModel >	clone () const
	Return clone. More...

virtual	~fvModel ()
	Destructor. More...

const word &	name () const
	Return const access to the source name. More...

const word &	keyword () const
	Return name as the keyword. More...

const fvMesh &	mesh () const
	Return const access to the mesh database. More...

const dictionary &	coeffs (const dictionary &) const
	Return the coefficients sub-dictionary. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const
	Add a source term to an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const VolField< Type > &field) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const
	Return source for a compressible equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a compressible equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const
	Return source for an equation with a second time derivative. More...

virtual void	preUpdateMesh ()
	Prepare for mesh update. More...

virtual void	correct ()
	Correct the fvModel. More...

virtual bool	write (const bool write=true) const
	Write fvModel data. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
const Foam::word &	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

template<class AlphaRhoFieldType >
const Foam::word &	fieldName (const AlphaRhoFieldType &alphaRhoField)

template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const

Protected Member Functions
wordList	readSpecie (const dictionary &dict, const bool required) const
	Read the names of the transferring specie. More...

wordList	readSpecies (const dictionary &dict, const bool required) const
	Read the names of the transferring species. More...

void	reReadSpecie (const dictionary &dict) const
	Re-read the names of the transferring specie. More...

void	reReadSpecies (const dictionary &dict) const
	Re-read the names of the transferring species. More...

void	setSpecies (const word &name, const word &modelType, const wordList &species)
	Set the names of the transferring species. More...

void	setSpecies (const wordList &species)
	Set the names of the transferring species. More...

void	reSetSpecies (const wordList &species)
	Re-set the names of the transferring species. More...

const volScalarField &	p () const
	Access the pressure field. More...

Protected Member Functions inherited from massTransfer
const Pair< word >	lookupPhaseNames (const dictionary &dict) const
	Lookup the phase names. More...

const Pair< word >	lookupPhaseFieldNames (const dictionary &dict, const word &name) const
	Lookup the phase field names. More...

tmp< volScalarField::Internal >	rho (const label i) const
	Return the density. More...

template<class Type >
const VolField< Type > &	otherField (const VolField< Type > &field) const
	Return the corresponding field in the other phase, or a null. More...

template<class Type >
void	addSupType (const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to an equation. More...

void	addSupType (const volScalarField &alphaOrField, fvMatrix< scalar > &eqn) const
	Add a source term to a scalar equation. More...

template<class Type >
void	addSupType (const volScalarField &alphaOrRho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a compressible equation. More...

void	addSupType (const volScalarField &alphaOrRho, const volScalarField &rhoOrField, fvMatrix< scalar > &eqn) const
	Add a source term to a compressible scalar equation. More...

template<class Type >
void	addSupType (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a phase equation. More...

Protected Member Functions inherited from fvSpecificSource
template<class Type >
void	addSupType (const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to an equation. More...

template<class Type >
void	addSupType (const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a compressible equation. More...

template<class Type >
void	addSupType (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a phase equation. More...

Protected Member Functions inherited from fvModel
template<class Type >
void	addSupType (const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to an equation. More...

template<class Type >
void	addSupType (const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a compressible equation. More...

template<class Type >
void	addSupType (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a phase equation. More...

template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const
	Return a source for an equation. More...

Static Protected Member Functions
static tmp< volScalarField >	vifToVf (const tmp< DimensionedField< scalar, fvMesh >> &tvif)
	Add a boundary field to the given internal field. More...

static tmp< DimensionedField< scalar, fvMesh > >	vfToVif (const tmp< volScalarField > &tvf)
	Remove the boundary field from the given geometric field. More...

Static Protected Member Functions inherited from massTransfer
static label	index (const Pair< word > &names, const word &name)
	Get the index of the name in the given pair, or -1. More...

static label	sign (const Pair< word > &names, const word &name)
	Get the sign associated with the name in the given pair; i.e., -1. More...

Additional Inherited Members
Static Public Member Functions inherited from fvSource
static void	infoField (const word &name, const dimensionSet &dims, const scalarField &field, const bool print=true)
	Print min/average/max information for a given field. More...

static void	infoField (const word &name, const DimensionedField< scalar, fvMesh > &field, const bool print=true)
	Print min/average/max information for a given field. More...

static void	infoField (const DimensionedField< scalar, fvMesh > &field, const bool print=true)
	Print min/average/max information for a given field. More...

Static Public Member Functions inherited from fvModel
static const dictionary &	coeffs (const word &modelType, const dictionary &)
	Return the coefficients sub-dictionary for a given model type. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the dimensions of the matrix of a source term. More...

static const dimensionSet &	sourceDims (const dimensionSet &ds)
	Return the dimensions of the matrix of a source term (base. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the name of the field associated with a source term. More...

template<class AlphaRhoFieldType >
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField)
	Return the name of the field associated with a source term (base. More...

static const word &	fieldName ()
	Return the name of the field associated with a source term. Special. More...

static autoPtr< fvModel >	New (const word &name, const fvMesh &mesh, const dictionary &dict)
	Return a reference to the selected fvModel. More...

Static Public Attributes inherited from fvModel
static const wordHashSet	keywords
	The keywords read by this class. More...

Detailed Description

Base class for phase change models.

Source files

Definition at line 58 of file phaseChange.H.

Constructor & Destructor Documentation

◆ phaseChange()

phaseChange	(	const word &	name,
		const word &	modelType,
		const fvMesh &	mesh,
		const dictionary &	dict,
		const wordList &	species
	)

Construct from explicit source name and mesh.

Definition at line 269 of file phaseChange.C.

References fvModel::coeffs(), dict, fvModel::name(), Foam::notNull(), phaseChange::setSpecies(), and phaseChange::species().

Here is the call graph for this function:

Member Function Documentation

◆ readSpecie()

Foam::wordList readSpecie	(	const dictionary &	dict,
		const bool	required
	)		const

protected

Read the names of the transferring specie.

Definition at line 51 of file phaseChange.C.

References dict.

◆ readSpecies()

Foam::wordList readSpecies	(	const dictionary &	dict,
		const bool	required
	)		const

protected

Read the names of the transferring species.

Definition at line 73 of file phaseChange.C.

References dict, Foam::exit(), Foam::FatalError, and FatalIOErrorInFunction.

Here is the call graph for this function:

◆ reReadSpecie()

void reReadSpecie ( const dictionary & dict ) const

protected

Re-read the names of the transferring specie.

Definition at line 107 of file phaseChange.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and Foam::type().

Here is the call graph for this function:

◆ reReadSpecies()

void reReadSpecies ( const dictionary & dict ) const

protected

Re-read the names of the transferring species.

Definition at line 118 of file phaseChange.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and Foam::type().

Here is the call graph for this function:

◆ setSpecies() [1/2]

void setSpecies	(	const word &	name,
		const word &	modelType,
		const wordList &	species
	)

protected

Set the names of the transferring species.

Definition at line 129 of file phaseChange.C.

References ThermoRefPair< ThermoType >::both(), ThermoRefPair< ThermoType >::either(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Pair< Type >::first(), forAll, Foam::name(), Pair< Type >::second(), List< T >::size(), ThermoRefPair< ThermoType >::thermos(), and ThermoRefPair< ThermoType >::valid().

Referenced by massDiffusionLimitedPhaseChange::massDiffusionLimitedPhaseChange(), and phaseChange::phaseChange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSpecies() [2/2]

void setSpecies ( const wordList & species )

protected

Set the names of the transferring species.

Definition at line 200 of file phaseChange.C.

References Foam::name(), and Foam::type().

Here is the call graph for this function:

◆ reSetSpecies()

void reSetSpecies ( const wordList & species )

protected

Re-set the names of the transferring species.

Definition at line 206 of file phaseChange.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::type().

Here is the call graph for this function:

◆ p()

const Foam::volScalarField & p ( ) const

protected

Access the pressure field.

Definition at line 217 of file phaseChange.C.

References objectRegistry::lookupObject(), and mesh.

Here is the call graph for this function:

◆ vifToVf()

Foam::tmp< Foam::volScalarField > vifToVf ( const tmp< DimensionedField< scalar, fvMesh >> & tvif )

staticprotected

Add a boundary field to the given internal field.

Definition at line 231 of file phaseChange.C.

◆ vfToVif()

Foam::tmp< Foam::volScalarField::Internal > vfToVif ( const tmp< volScalarField > & tvf )

staticprotected

Remove the boundary field from the given geometric field.

Definition at line 254 of file phaseChange.C.

References tmp< T >::clear(), and tmp< T >::ptr().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "phaseChange" )

Runtime type information.

◆ thermos()

const Foam::ThermoRefPair< Foam::basicThermo > & thermos ( ) const

inline

Return the thermo references.

Definition at line 32 of file phaseChangeI.H.

◆ fluidThermos()

const Foam::ThermoRefPair< Foam::fluidThermo > fluidThermos	(	const bool	firstRequired,
		const bool	secondRequired
	)		const

Return the fluid thermo references.

Definition at line 294 of file phaseChange.C.

◆ multicomponentThermos()

const Foam::ThermoRefPair< Foam::multicomponentThermo > multicomponentThermos	(	const bool	firstRequired,
		const bool	secondRequired
	)		const

Return the multicomponent thermo references.

Definition at line 311 of file phaseChange.C.

◆ fluidMulticomponentThermos()

const Foam::ThermoRefPair< Foam::fluidMulticomponentThermo > fluidMulticomponentThermos	(	const bool	firstRequired,
		const bool	secondRequired
	)		const

Return the fluid multicomponent thermo references.

Definition at line 328 of file phaseChange.C.

◆ heNames()

const Foam::Pair< Foam::word > & heNames ( ) const

inline

Return the names of the energy fields.

Definition at line 38 of file phaseChangeI.H.

◆ species()

const Foam::hashedWordList & species ( ) const

inline

Return the names of the transferring species. Empty if neither.

thermo is multicomponent.

Definition at line 44 of file phaseChangeI.H.

Referenced by phaseChange::phaseChange().

Here is the caller graph for this function:

◆ specieis()

const Foam::labelPair & specieis ( const label mDoti = -1 ) const

Return the indices of the transferring specie in the two.

phases, or -1 if the phase is not multicomponent

Definition at line 344 of file phaseChange.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::type().

Here is the call graph for this function:

◆ Tchange()

Foam::tmp< Foam::volScalarField::Internal > Tchange ( ) const

virtual

Return the temperature at which the phases are considered to be.

changing. By default this is considered to be the temperature of the "source" phase (i.e., the phase for which mDot is negative), but this can be overridden to account for heat transfer modelling or similar.

Reimplemented in massDiffusionLimitedPhaseChange.

Definition at line 371 of file phaseChange.C.

References Foam::dimTemperature, forAll, mesh, Foam::name(), DimensionedField< Type, GeoMesh, PrimitiveField >::New(), tmp< T >::ref(), and DimensionedField< Type, GeoMesh, PrimitiveField >::T().

Here is the call graph for this function:

◆ Lfraction()

Foam::tmp< Foam::volScalarField::Internal > Lfraction ( ) const

virtual

Return the fraction of the latent heat that is transferred into.

the second phase. By default this is weighted by the phase thermal conductivities, but this can be overridden to account for heat transfer modelling or similar.

Reimplemented in wallCondensation, wallBoiling, phaseSurfaceCondensation, phaseSurfaceBoiling, multiphaseEulerCavitation, massDiffusionLimitedPhaseChange, and heatTransferLimitedPhaseChange.

Definition at line 401 of file phaseChange.C.