Templated parcel multi-phase, multi-component class. More...

Inheritance diagram for SingleMixtureFraction< CloudType >:

Collaboration diagram for SingleMixtureFraction< CloudType >:

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

	SingleMixtureFraction (const dictionary &dict, CloudType &owner)
	Construct from dictionary. More...

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

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

virtual	~SingleMixtureFraction ()
	Destructor. More...

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

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

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

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

Public Member Functions inherited from CompositionModel< CloudType >
	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	~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...

scalarField	X (const label phaseI, const scalarField &Y) const
	Return the list of phase phaseI volume fractions fractions. 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...

Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)
	Construct null from owner cloud. More...

	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner cloud without name. More...

	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner cloud with name. More...

	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
	Construct as copy. More...

virtual	~CloudSubModelBase ()
	Destructor. More...

const CloudType &	owner () const
	Return const access to the owner cloud. More...

virtual bool	writeTime () const
	Flag to indicate when to write a property. More...

CloudType &	owner ()
	Return non-const access to the owner cloud for manipulation. More...

virtual void	write (Ostream &os) const
	Write. More...

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)
	Construct as copy. 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 bool	active () const
	Return the model 'active' status - default active = true. 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...

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for. More...

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

Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line. More...

Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud. 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...

Detailed Description

template<class CloudType>
class Foam::SingleMixtureFraction< CloudType >

Templated parcel multi-phase, multi-component class.

Source files

Definition at line 49 of file SingleMixtureFraction.H.

Constructor & Destructor Documentation

◆ SingleMixtureFraction() [1/2]

SingleMixtureFraction	(	const dictionary &	dict,
		CloudType &	owner
	)

Construct from dictionary.

Definition at line 85 of file SingleMixtureFraction.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::mag(), Foam::nl, and Foam::sum().

Here is the call graph for this function:

◆ SingleMixtureFraction() [2/2]

SingleMixtureFraction ( const SingleMixtureFraction< CloudType > & cm )

Construct copy.

Definition at line 123 of file SingleMixtureFraction.C.

◆ ~SingleMixtureFraction()

~SingleMixtureFraction ( )

virtual

Destructor.

Definition at line 138 of file SingleMixtureFraction.C.

Referenced by SingleMixtureFraction< CloudType >::clone().

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "singleMixtureFraction" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Implements CompositionModel< CloudType >.

Definition at line 95 of file SingleMixtureFraction.H.

References SingleMixtureFraction< CloudType >::idGas(), SingleMixtureFraction< CloudType >::idLiquid(), SingleMixtureFraction< CloudType >::idSolid(), SingleMixtureFraction< CloudType >::YMixture0(), and SingleMixtureFraction< CloudType >::~SingleMixtureFraction().

Here is the call graph for this function:

◆ YMixture0()

const Foam::scalarField & YMixture0 ( ) const

virtual

Return the list of mixture mass fractions.

Implements CompositionModel< CloudType >.

Definition at line 146 of file SingleMixtureFraction.C.

Referenced by SingleMixtureFraction< CloudType >::clone().

Here is the caller graph for this function:

◆ idGas()

Foam::label idGas ( ) const

virtual

Gas id.

Implements CompositionModel< CloudType >.

Definition at line 153 of file SingleMixtureFraction.C.

Referenced by SingleMixtureFraction< CloudType >::clone().

Here is the caller graph for this function:

◆ idLiquid()

Foam::label idLiquid ( ) const

virtual

Liquid id.

Implements CompositionModel< CloudType >.

Definition at line 160 of file SingleMixtureFraction.C.

Referenced by SingleMixtureFraction< CloudType >::clone().

Here is the caller graph for this function:

◆ idSolid()

Foam::label idSolid ( ) const

virtual

Solid id.

Implements CompositionModel< CloudType >.

Definition at line 167 of file SingleMixtureFraction.C.

Referenced by SingleMixtureFraction< CloudType >::clone().

Here is the caller graph for this function:

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

src/lagrangian/intermediate/submodels/Reacting/CompositionModel/SingleMixtureFraction/SingleMixtureFraction.H
src/lagrangian/intermediate/submodels/Reacting/CompositionModel/SingleMixtureFraction/SingleMixtureFraction.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::SingleMixtureFraction< CloudType >

Constructor & Destructor Documentation

◆ SingleMixtureFraction() [1/2]

◆ SingleMixtureFraction() [2/2]

◆ ~SingleMixtureFraction()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ YMixture0()

◆ idGas()

◆ idLiquid()

◆ idSolid()

template<class CloudType>
class Foam::SingleMixtureFraction< CloudType >