Public Member Functions | List of all members
NoComposition< CloudType > Class Template Reference
Lagrangian particle models » Submodels » Reacting » Composition

Dummy class for 'none' option - will raise an error if any functions are called that require return values. More...

Inheritance diagram for NoComposition< CloudType >:
[legend]
Collaboration diagram for NoComposition< CloudType >:
[legend]

Public Member Functions

 TypeName ("none")
 Runtime type information. More...
 
 NoComposition (const dictionary &dict, CloudType &owner)
 Construct from dictionary. More...
 
 NoComposition (const NoComposition< CloudType > &cm)
 Construct copy. More...
 
virtual autoPtr< CompositionModel< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~NoComposition ()
 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...
 
tmp< 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 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...
 

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::NoComposition< CloudType >

Dummy class for 'none' option - will raise an error if any functions are called that require return values.

Source files

Definition at line 55 of file NoComposition.H.

Constructor & Destructor Documentation

◆ NoComposition() [1/2]

NoComposition ( const dictionary &  dict,
CloudType &  owner 
)

Construct from dictionary.

Definition at line 34 of file NoComposition.C.

◆ NoComposition() [2/2]

NoComposition ( const NoComposition< CloudType > &  cm)

Construct copy.

Definition at line 45 of file NoComposition.C.

◆ ~NoComposition()

~NoComposition ( )
virtual

Destructor.

Definition at line 56 of file NoComposition.C.

Member Function Documentation

◆ TypeName()

TypeName ( "none"  )

Runtime type information.

◆ clone()

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

Construct and return a clone.

Implements CompositionModel< CloudType >.

Definition at line 74 of file NoComposition.H.

◆ YMixture0()

const Foam::scalarField & YMixture0 ( ) const
virtual

Return the list of mixture mass fractions.

If only 1 phase, return component fractions of that phase

Implements CompositionModel< CloudType >.

Definition at line 63 of file NoComposition.C.

◆ idGas()

Foam::label idGas ( ) const
virtual

Gas id.

Implements CompositionModel< CloudType >.

Definition at line 70 of file NoComposition.C.

◆ idLiquid()

Foam::label idLiquid ( ) const
virtual

Liquid id.

Implements CompositionModel< CloudType >.

Definition at line 77 of file NoComposition.C.

◆ idSolid()

Foam::label idSolid ( ) const
virtual

Solid id.

Implements CompositionModel< CloudType >.

Definition at line 84 of file NoComposition.C.

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