Public Member Functions | Private Member Functions | Private Attributes
SingleMixtureFraction< CloudType > Class Template Reference

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

Inheritance diagram for SingleMixtureFraction< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for SingleMixtureFraction< CloudType >:
Collaboration graph
[legend]

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 scalarFieldYMixture0 () 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 autoPtr< CompositionModel< CloudType > > clone () const=0
 Construct and return a clone. More...
 
virtual ~CompositionModel ()
 Destructor. More...
 
const SLGThermothermo () const
 Return the thermo database. More...
 
const basicSpecieMixturecarrier () const
 Return the carrier components (wrapper function) More...
 
const liquidMixturePropertiesliquids () const
 Return the global (additional) liquids. More...
 
const solidMixturePropertiessolids () const
 Return the global (additional) solids. More...
 
const phasePropertiesListphaseProps () const
 Return the list of phase properties. More...
 
label nPhase () const
 Return the number of phases. More...
 
const wordListphaseTypes () const
 Return the list of phase type names. More...
 
const wordListstateLabels () const
 Return the list of state labels (s), (l), (g) etc. More...
 
const wordListcomponentNames (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 scalarFieldY0 (const label phaseI) const
 Return the list of phase phaseI mass fractions. More...
 
tmp< scalarFieldX (const label phaseI, const scalarField &Y) const
 Return the list of phase phaseI volume fractions fractions. More...
 
virtual const scalarFieldYMixture0 () 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...
 

Private Member Functions

void constructIds ()
 Construct the indices and check correct specification of. More...
 

Private Attributes

label idGas_
 Gas. More...
 
label idLiquid_
 Liquid. More...
 
label idSolid_
 Solid. More...
 
scalarField YMixture0_
 Phase component total fractions. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from CompositionModel< CloudType >
static autoPtr< CompositionModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. 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]

Construct copy.

Definition at line 123 of file SingleMixtureFraction.C.

◆ ~SingleMixtureFraction()

Destructor.

Definition at line 138 of file SingleMixtureFraction.C.

Member Function Documentation

◆ constructIds()

void constructIds
private

Construct the indices and check correct specification of.

1 gas, 1 liquid and 1 solid

Definition at line 31 of file SingleMixtureFraction.C.

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

Here is the call graph for this function:

◆ TypeName()

TypeName ( "singleMixtureFraction"  )

Runtime type information.

◆ clone()

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

Construct and return a clone.

Definition at line 95 of file SingleMixtureFraction.H.

◆ YMixture0()

const Foam::scalarField & YMixture0
virtual

Return the list of mixture mass fractions.

Definition at line 146 of file SingleMixtureFraction.C.

◆ idGas()

Foam::label idGas
virtual

Gas id.

Definition at line 153 of file SingleMixtureFraction.C.

◆ idLiquid()

Foam::label idLiquid
virtual

Liquid id.

Definition at line 160 of file SingleMixtureFraction.C.

◆ idSolid()

Foam::label idSolid
virtual

Solid id.

Definition at line 167 of file SingleMixtureFraction.C.

Field Documentation

◆ idGas_

label idGas_
private

Gas.

Definition at line 58 of file SingleMixtureFraction.H.

◆ idLiquid_

label idLiquid_
private

Liquid.

Definition at line 61 of file SingleMixtureFraction.H.

◆ idSolid_

label idSolid_
private

Solid.

Definition at line 64 of file SingleMixtureFraction.H.

◆ YMixture0_

scalarField YMixture0_
private

Phase component total fractions.

Definition at line 70 of file SingleMixtureFraction.H.


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