Templated reacting parcel composition model class Consists of carrier species (via thermo package), and additional liquids and solids. More...

Inheritance diagram for CompositionModel< CloudType >:

[legend]

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

	declareRunTimeSelectionTable (autoPtr, CompositionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table. More...

	CompositionModel (CloudType &owner)
	Construct null from owner. More...

	CompositionModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from dictionary. More...

	CompositionModel (const CompositionModel< CloudType > &cm)
	Construct copy. More...

virtual autoPtr< CompositionModel< CloudType > >	clone () const =0
	Construct and return a clone. More...

virtual	~CompositionModel ()
	Destructor. More...

const SLGThermo &	thermo () const
	Return the thermo database. More...

const basicSpecieMixture &	carrier () const
	Return the carrier components (wrapper function) More...

const liquidMixtureProperties &	liquids () const
	Return the global (additional) liquids. More...

const solidMixtureProperties &	solids () const
	Return the global (additional) solids. More...

const phasePropertiesList &	phaseProps () const
	Return the list of phase properties. More...

label	nPhase () const
	Return the number of phases. More...

const wordList &	phaseTypes () const
	Return the list of phase type names. More...

const wordList &	stateLabels () const
	Return the list of state labels (s), (l), (g) etc. More...

const wordList &	componentNames (const label phaseI) const
	Return the list of component names for phaseI. More...

label	carrierId (const word &cmptName, const bool allowNotFound=false) const
	Return global id of component cmptName in carrier thermo. More...

label	localId (const label phaseI, const word &cmptName, const bool allowNotFound=false) const
	Return local id of component cmptName in phase phaseI. More...

label	localToCarrierId (const label phaseI, const label id, const bool allowNotFound=false) const
	Return carrier id of component given local id. More...

const scalarField &	Y0 (const label phaseI) const
	Return the list of phase phaseI mass fractions. More...

tmp< scalarField >	X (const label phaseI, const scalarField &Y) const
	Return the list of phase phaseI volume fractions fractions. More...

virtual const scalarField &	YMixture0 () const =0
	Return the list of mixture mass fractions. More...

virtual label	idGas () const =0
	Gas id. More...

virtual label	idLiquid () const =0
	Liquid id. More...

virtual label	idSolid () const =0
	Solid id. More...

virtual scalar	H (const label phaseI, const scalarField &Y, const scalar p, const scalar T) const
	Return total enthalpy for the phase phaseI. More...

virtual scalar	Hs (const label phaseI, const scalarField &Y, const scalar p, const scalar T) const
	Return sensible enthalpy for the phase phaseI. More...

virtual scalar	Hc (const label phaseI, const scalarField &Y, const scalar p, const scalar T) const
	Return chemical enthalpy for the phase phaseI. More...

virtual scalar	Cp (const label phaseI, const scalarField &Y, const scalar p, const scalar T) const
	Return specific heat capacity for the phase phaseI. More...

virtual scalar	L (const label phaseI, const scalarField &Y, const scalar p, const scalar T) const
	Return latent heat for the phase phaseI. More...

virtual scalar	rho (const scalarField &Ygas, const scalarField &Yliq, const scalarField &Ysol, const scalar T, const scalar p) const
	Return rho of the full composition. More...

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

Detailed Description

template<class CloudType>
class Foam::CompositionModel< CloudType >

Templated reacting parcel composition model class Consists of carrier species (via thermo package), and additional liquids and solids.

Source files

Definition at line 58 of file ReactingCloud.H.

Constructor & Destructor Documentation

◆ CompositionModel() [1/3]

CompositionModel ( CloudType & owner )

Construct null from owner.

Definition at line 34 of file CompositionModel.C.

◆ CompositionModel() [2/3]

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

Construct from dictionary.

Definition at line 44 of file CompositionModel.C.

◆ CompositionModel() [3/3]

CompositionModel ( const CompositionModel< CloudType > & cm )

Construct copy.

Definition at line 64 of file CompositionModel.C.

◆ ~CompositionModel()

~CompositionModel ( )

virtual

Destructor.

Definition at line 77 of file CompositionModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "compositionModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

◆ clone()

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

pure virtual

Construct and return a clone.

Implemented in SingleMixtureFraction< CloudType >, SinglePhaseMixture< CloudType >, and NoComposition< CloudType >.

◆ New()

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

static

Selector.

Definition at line 36 of file CompositionModelNew.C.

◆ thermo()

const Foam::SLGThermo & thermo ( ) const

Return the thermo database.

Definition at line 84 of file CompositionModel.C.

◆ carrier()

const Foam::basicSpecieMixture & carrier ( ) const

Return the carrier components (wrapper function)

Definition at line 92 of file CompositionModel.C.

◆ liquids()

const Foam::liquidMixtureProperties & liquids ( ) const

Return the global (additional) liquids.

Definition at line 100 of file CompositionModel.C.

◆ solids()

const Foam::solidMixtureProperties & solids ( ) const

Return the global (additional) solids.

Definition at line 108 of file CompositionModel.C.

◆ phaseProps()

const Foam::phasePropertiesList & phaseProps ( ) const

Return the list of phase properties.

Definition at line 116 of file CompositionModel.C.

◆ nPhase()

Foam::label nPhase ( ) const

Return the number of phases.

Definition at line 123 of file CompositionModel.C.

◆ phaseTypes()

const Foam::wordList & phaseTypes ( ) const

Return the list of phase type names.

If only 1 phase, return the component names of that phase

Definition at line 130 of file CompositionModel.C.

◆ stateLabels()

const Foam::wordList & stateLabels ( ) const

Return the list of state labels (s), (l), (g) etc.

Definition at line 145 of file CompositionModel.C.

◆ componentNames()

const Foam::wordList & componentNames ( const label phaseI ) const

Return the list of component names for phaseI.

Definition at line 153 of file CompositionModel.C.

◆ carrierId()

Foam::label carrierId	(	const word &	cmptName,
		const bool	allowNotFound = `false`
	)		const

Return global id of component cmptName in carrier thermo.

Definition at line 161 of file CompositionModel.C.

◆ localId()

Foam::label localId	(	const label	phaseI,
		const word &	cmptName,
		const bool	allowNotFound = `false`
	)		const

Return local id of component cmptName in phase phaseI.

Definition at line 183 of file CompositionModel.C.

◆ localToCarrierId()

Foam::label localToCarrierId	(	const label	phaseI,
		const label	id,
		const bool	allowNotFound = `false`
	)		const

Return carrier id of component given local id.

Definition at line 204 of file CompositionModel.C.

◆ Y0()

const Foam::scalarField & Y0 ( const label phaseI ) const

Return the list of phase phaseI mass fractions.

Definition at line 226 of file CompositionModel.C.

◆ X()

Foam::tmp< Foam::scalarField > X	(	const label	phaseI,
		const scalarField &	Y
	)		const

Return the list of phase phaseI volume fractions fractions.

based on supplied mass fractions Y

Definition at line 236 of file CompositionModel.C.

◆ YMixture0()

virtual const scalarField& YMixture0 ( ) const

pure virtual

Return the list of mixture mass fractions.

If only 1 phase, return component fractions of that phase

Implemented in SingleMixtureFraction< CloudType >, SinglePhaseMixture< CloudType >, and NoComposition< CloudType >.

◆ idGas()

virtual label idGas ( ) const

pure virtual

Gas id.

Implemented in SingleMixtureFraction< CloudType >, SinglePhaseMixture< CloudType >, and NoComposition< CloudType >.

◆ idLiquid()

virtual label idLiquid ( ) const

pure virtual

Liquid id.

Implemented in SingleMixtureFraction< CloudType >, SinglePhaseMixture< CloudType >, and NoComposition< CloudType >.

◆ idSolid()

virtual label idSolid ( ) const

pure virtual

Solid id.

Implemented in SingleMixtureFraction< CloudType >, SinglePhaseMixture< CloudType >, and NoComposition< CloudType >.

◆ H()

Foam::scalar H	(	const label	phaseI,
		const scalarField &	Y,
		const scalar	p,
		const scalar	T
	)		const

virtual

Return total enthalpy for the phase phaseI.

Definition at line 283 of file CompositionModel.C.

◆ Hs()

Foam::scalar Hs	(	const label	phaseI,
		const scalarField &	Y,
		const scalar	p,
		const scalar	T
	)		const

virtual

Return sensible enthalpy for the phase phaseI.

Definition at line 337 of file CompositionModel.C.

◆ Hc()

Foam::scalar Hc	(	const label	phaseI,
		const scalarField &	Y,
		const scalar	p,
		const scalar	T
	)		const

virtual

Return chemical enthalpy for the phase phaseI.

Definition at line 392 of file CompositionModel.C.

◆ Cp()

Foam::scalar Cp	(	const label	phaseI,
		const scalarField &	Y,
		const scalar	p,
		const scalar	T
	)		const

virtual

Return specific heat capacity for the phase phaseI.

Definition at line 443 of file CompositionModel.C.

◆ L()

Foam::scalar L	(	const label	phaseI,
		const scalarField &	Y,
		const scalar	p,
		const scalar	T
	)		const

virtual

Return latent heat for the phase phaseI.

Definition at line 493 of file CompositionModel.C.

◆ rho()

Foam::scalar rho	(	const scalarField &	Ygas,
		const scalarField &	Yliq,
		const scalarField &	Ysol,
		const scalar	T,
		const scalar	p
	)		const

virtual

Return rho of the full composition.

Definition at line 544 of file CompositionModel.C.

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

src/lagrangian/intermediate/clouds/Templates/ReactingCloud/ReactingCloud.H
src/lagrangian/intermediate/submodels/Reacting/CompositionModel/CompositionModel/CompositionModel.H
src/lagrangian/intermediate/submodels/Reacting/CompositionModel/CompositionModel/CompositionModel.C
src/lagrangian/intermediate/submodels/Reacting/CompositionModel/CompositionModel/CompositionModelNew.C

Public Member Functions

Static Public Member Functions

Detailed Description

template<class CloudType> class Foam::CompositionModel< CloudType >

Constructor & Destructor Documentation

◆ CompositionModel() [1/3]

◆ CompositionModel() [2/3]

◆ CompositionModel() [3/3]

◆ ~CompositionModel()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ thermo()

◆ carrier()

◆ liquids()

◆ solids()

◆ phaseProps()

◆ nPhase()

◆ phaseTypes()

◆ stateLabels()

◆ componentNames()

◆ carrierId()

◆ localId()

◆ localToCarrierId()

◆ Y0()

◆ X()

◆ YMixture0()

◆ idGas()

◆ idLiquid()

◆ idSolid()

◆ H()

◆ Hs()

◆ Hc()

◆ Cp()

◆ L()

◆ rho()

template<class CloudType>
class Foam::CompositionModel< CloudType >