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

Inheritance diagram for CompositionModel:

[legend]

Collaboration diagram for CompositionModel:

[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 caoacity 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...

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

Private Attributes
const SLGThermo &	thermo_
	Reference to the thermo database. More...

phasePropertiesList	phaseProps_
	List of phase properties. More...

Detailed Description

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

Source files

Definition at line 52 of file ReactingCloud.H.

Constructor & Destructor Documentation

◆ CompositionModel() [1/3]

CompositionModel ( CloudType & owner )

Construct null from owner.

Definition at line 31 of file CompositionModel.C.

◆ CompositionModel() [2/3]

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

Construct from dictionary.

Definition at line 41 of file CompositionModel.C.

◆ CompositionModel() [3/3]

CompositionModel ( const CompositionModel< CloudType > & cm )

Construct copy.

Definition at line 61 of file CompositionModel.C.

◆ ~CompositionModel()

~CompositionModel ( )

virtual

Destructor.

Definition at line 74 of file CompositionModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "compositionModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		CompositionModel	,
		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.

◆ New()

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

static

Selector.

Definition at line 33 of file CompositionModelNew.C.

◆ thermo()

const Foam::SLGThermo & thermo ( ) const

Return the thermo database.

Definition at line 81 of file CompositionModel.C.

◆ carrier()

const Foam::basicSpecieMixture & carrier ( ) const

Return the carrier components (wrapper function)

Definition at line 89 of file CompositionModel.C.

◆ liquids()

const Foam::liquidMixtureProperties & liquids ( ) const

Return the global (additional) liquids.

Definition at line 97 of file CompositionModel.C.

◆ solids()

const Foam::solidMixtureProperties & solids ( ) const

Return the global (additional) solids.

Definition at line 105 of file CompositionModel.C.

◆ phaseProps()

const Foam::phasePropertiesList & phaseProps ( ) const

Return the list of phase properties.

Definition at line 113 of file CompositionModel.C.

◆ nPhase()

Foam::label nPhase ( ) const

Return the number of phases.

Definition at line 120 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 127 of file CompositionModel.C.

◆ stateLabels()

const Foam::wordList & stateLabels ( ) const

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

Definition at line 142 of file CompositionModel.C.

◆ componentNames()

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

Return the list of component names for phaseI.

Definition at line 150 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 158 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 180 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 201 of file CompositionModel.C.

◆ Y0()

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

Return the list of phase phaseI mass fractions.

Definition at line 223 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 233 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

◆ idGas()

virtual label idGas ( ) const

pure virtual

Gas id.

◆ idLiquid()

virtual label idLiquid ( ) const

pure virtual

Liquid id.

◆ idSolid()

virtual label idSolid ( ) const

pure virtual

Solid id.

◆ 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 277 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 331 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 386 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 caoacity for the phase phaseI.

Definition at line 437 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 487 of file CompositionModel.C.

Field Documentation

◆ thermo_

const SLGThermo& thermo_

private

Reference to the thermo database.

Definition at line 67 of file CompositionModel.H.

◆ phaseProps_

phasePropertiesList phaseProps_

private

List of phase properties.

Definition at line 70 of file CompositionModel.H.

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

Private Attributes

Detailed Description

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()

Field Documentation

◆ thermo_

◆ phaseProps_