FreeFOAM The Cross-Platform CFD Toolkit
SingleMixtureFraction< CloudType > Class Template Reference

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

#include <lagrangianIntermediate/SingleMixtureFraction.H>


Detailed Description

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

Templated parcel multi-phase, multi-component class.

Source files

Definition at line 50 of file SingleMixtureFraction.H.

+ Inheritance diagram for SingleMixtureFraction< CloudType >:
+ Collaboration diagram for SingleMixtureFraction< CloudType >:

List of all members.

Public Member Functions

 TypeName ("SingleMixtureFraction")
 Runtime type information.
 SingleMixtureFraction (const dictionary &dict, CloudType &owner)
 Construct from dictionary.
virtual ~SingleMixtureFraction ()
 Destructor.
const scalarFieldYGas0 () const
 Return the list of gas mass fractions.
scalar YGasTot0 () const
 Return the total gas mass fraction.
const scalarFieldYLiquid0 () const
 Return the list of liquid mass fractions.
scalar YLiquidTot0 () const
 Return the total liquid mass fraction.
const scalarFieldYSolid0 () const
 Return the list of solid mass fractions.
scalar YSolidTot0 () const
 Return the total solid mass fraction.
virtual const scalarFieldYMixture0 () const
 Return the list of mixture mass fractions.
virtual label idGas () const
 Gas id.
virtual label idLiquid () const
 Liquid id.
virtual label idSolid () const
 Solid id.
- Public Member Functions inherited from CompositionModel< CloudType >
 TypeName ("CompositionModel")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, CompositionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table.
 CompositionModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from dictionary.
virtual ~CompositionModel ()
 Destructor.
const CloudType & owner () const
 Return the cloud object.
const dictionarydict () const
 Return the cloud dictionary.
const dictionarycoeffDict () const
 Return the coefficients dictionary.
const multiComponentMixture
< typename
CloudType::thermoType > & 
mcCarrierThermo () const
 Return the carrier phase thermo package.
const liquidMixtureliquids () const
 Return the global (additional) liquids.
const solidMixturesolids () const
 Return the global (additional) solids.
const phasePropertiesListphaseProps () const
 Return the list of phase properties.
label nPhase () const
 Return the number of phases.
const wordListphaseTypes () const
 Return the list of phase type names.
const wordListstateLabels () const
 Return the list of state labels (s), (l), (g) etc.
const wordListcomponentNames (const label phaseI) const
 Return the list of component names for phaseI.
label globalCarrierId (const word &cmptName) const
 Return global id of component cmptName in carrier thermo.
label globalId (const label phaseI, const word &cmptName) const
 Return global id of component cmptName in phase phaseI.
const labelListglobalIds (const label phaseI) const
 Return global ids of for phase phaseI.
label localId (const label phaseI, const word &cmptName) const
 Return local id of component cmptName in phase phaseI.
label localToGlobalCarrierId (const label phaseI, const label id) const
 Return global carrier id of component given local id.
const scalarFieldY0 (const label phaseI) const
 Return the list of phase phaseI mass fractions.
scalarField X (const label phaseI, const scalarField &Y) const
 Return the list of phase phaseI volume fractions fractions.
virtual scalar H (const label phaseI, const scalarField &Y, const scalar p, const scalar T) const
 Return total enthalpy for the phase phaseI.
virtual scalar Hs (const label phaseI, const scalarField &Y, const scalar p, const scalar T) const
 Return sensible enthalpy for the phase phaseI.
virtual scalar Hc (const label phaseI, const scalarField &Y, const scalar p, const scalar T) const
 Return chemical enthalpy for the phase phaseI.
virtual scalar cp (const label phaseI, const scalarField &Y, const scalar p, const scalar T) const
 Return specific heat caoacity for the phase phaseI.
virtual scalar L (const label phaseI, const scalarField &Y, const scalar p, const scalar T) const
 Return latent heat for the phase phaseI.

Additional Inherited Members

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

Constructor & Destructor Documentation

SingleMixtureFraction ( const dictionary dict,
CloudType &  owner 
)

Construct from dictionary.

Definition at line 88 of file SingleMixtureFraction.C.

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

~SingleMixtureFraction ( )
virtual

Destructor.

Definition at line 141 of file SingleMixtureFraction.C.


Member Function Documentation

TypeName ( "SingleMixtureFraction< CloudType >"  )

Runtime type information.

const Foam::scalarField & YGas0 ( ) const

Return the list of gas mass fractions.

Definition at line 149 of file SingleMixtureFraction.C.

scalar YGasTot0 ( ) const

Return the total gas mass fraction.

const Foam::scalarField & YLiquid0 ( ) const

Return the list of liquid mass fractions.

Definition at line 157 of file SingleMixtureFraction.C.

scalar YLiquidTot0 ( ) const

Return the total liquid mass fraction.

const Foam::scalarField & YSolid0 ( ) const

Return the list of solid mass fractions.

Definition at line 165 of file SingleMixtureFraction.C.

scalar YSolidTot0 ( ) const

Return the total solid mass fraction.

const Foam::scalarField & YMixture0 ( ) const
virtual

Return the list of mixture mass fractions.

Implements CompositionModel< CloudType >.

Definition at line 173 of file SingleMixtureFraction.C.

Foam::label idGas ( ) const
virtual

Gas id.

Implements CompositionModel< CloudType >.

Definition at line 180 of file SingleMixtureFraction.C.

Foam::label idLiquid ( ) const
virtual

Liquid id.

Implements CompositionModel< CloudType >.

Definition at line 187 of file SingleMixtureFraction.C.

Foam::label idSolid ( ) const
virtual

Solid id.

Implements CompositionModel< CloudType >.

Definition at line 194 of file SingleMixtureFraction.C.


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