Loading...
Searching...
No Matches
phaseProperties Class Reference

Helper class to manage multi-specie phase properties. More...

#include <phaseProperties.H>

Collaboration diagram for phaseProperties:
Collaboration graph
[legend]

Public Types

enum  phaseType { GAS , LIQUID , SOLID , UNKNOWN }
 Phase type enumeration. More...

Public Member Functions

 phaseProperties ()
 Default construct, as 'UNKNOWN' state.
 phaseProperties (Istream &is)
 Construct from Istream.
void reorder (const wordList &gasNames, const wordList &liquidNames, const wordList &solidNames)
 Reorder species to be consistent with the corresponding.
phaseType phase () const
 Return const access to the phase type.
const word & stateLabel () const
 Return const access to the phase state label.
word phaseTypeName () const
 Return word representation of the phase type.
const List< word > & names () const
 Return the list of specie names.
const word & name (const label speciei) const
 Return const access to a specie name.
const scalarField & Y () const
 Return const access to all specie mass fractions.
scalar & Y (const label speciei)
 Return non-const access to a specie mass fraction.
const labelList & carrierIds () const
 Return const access to the map to the carrier ids.
label id (const word &specieName) const
 Return the id of a specie in the local list by name.

Static Public Attributes

static const Enum< phaseType > phaseTypeNames
 Corresponding word representations for phase type enumerations.

Friends

Istream & operator>> (Istream &, phaseProperties &)
Ostream & operator<< (Ostream &, const phaseProperties &)

Detailed Description

Helper class to manage multi-specie phase properties.

Source files

Definition at line 56 of file phaseProperties.H.

Member Enumeration Documentation

◆ phaseType

enum phaseType

Phase type enumeration.

Enumerator
GAS 
LIQUID 
SOLID 
UNKNOWN 

Definition at line 65 of file phaseProperties.H.

Constructor & Destructor Documentation

◆ phaseProperties() [1/2]

phaseProperties ( )

Default construct, as 'UNKNOWN' state.

Definition at line 175 of file phaseProperties.C.

References UNKNOWN.

Referenced by operator<<, operator>>, and phaseProperties().

Here is the caller graph for this function:

◆ phaseProperties() [2/2]

phaseProperties ( Istream & is)
explicit

Construct from Istream.

Definition at line 26 of file phasePropertiesIO.C.

References phaseProperties().

Here is the call graph for this function:

Member Function Documentation

◆ reorder()

void reorder ( const wordList & gasNames,
const wordList & liquidNames,
const wordList & solidNames )

Reorder species to be consistent with the corresponding.

phase specie name list

Definition at line 187 of file phaseProperties.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, GAS, LIQUID, Foam::nl, phaseTypeNames, Foam::reorder(), SOLID, and solidNames().

Here is the call graph for this function:

◆ phase()

Foam::phaseProperties::phaseType phase ( ) const

Return const access to the phase type.

Definition at line 235 of file phaseProperties.C.

Referenced by CompositionModel< CloudType >::Cp(), CompositionModel< Foam::ReactingCloud< Foam::DSMCCloud< dsmcParcel > > >::H(), CompositionModel< CloudType >::Hc(), and CompositionModel< CloudType >::L().

Here is the caller graph for this function:

◆ stateLabel()

const Foam::word & stateLabel ( ) const

Return const access to the phase state label.

Definition at line 241 of file phaseProperties.C.

◆ phaseTypeName()

Foam::word phaseTypeName ( ) const

Return word representation of the phase type.

Definition at line 247 of file phaseProperties.C.

References phaseTypeNames.

◆ names()

const Foam::List< Foam::word > & names ( ) const

Return the list of specie names.

Definition at line 253 of file phaseProperties.C.

◆ name()

const Foam::word & name ( const label speciei) const

Return const access to a specie name.

Definition at line 259 of file phaseProperties.C.

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

Here is the call graph for this function:

◆ Y() [1/2]

const Foam::scalarField & Y ( ) const

Return const access to all specie mass fractions.

Definition at line 273 of file phaseProperties.C.

◆ Y() [2/2]

Foam::scalar & Y ( const label speciei)

Return non-const access to a specie mass fraction.

Definition at line 279 of file phaseProperties.C.

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

Here is the call graph for this function:

◆ carrierIds()

const Foam::labelList & carrierIds ( ) const

Return const access to the map to the carrier ids.

Definition at line 293 of file phaseProperties.C.

Referenced by CompositionModel< CloudType >::Cp(), CompositionModel< Foam::ReactingCloud< Foam::DSMCCloud< dsmcParcel > > >::H(), CompositionModel< CloudType >::Hc(), CompositionModel< Foam::ReactingCloud< Foam::DSMCCloud< dsmcParcel > > >::rho(), and CompositionModel< Foam::ReactingCloud< Foam::DSMCCloud< dsmcParcel > > >::X().

Here is the caller graph for this function:

◆ id()

Foam::label id ( const word & specieName) const

Return the id of a specie in the local list by name.

Returns -1 if not found

Definition at line 299 of file phaseProperties.C.

References UList< T >::find().

Here is the call graph for this function:

◆ operator>>

Istream & operator>> ( Istream & ,
phaseProperties &  )
friend

References phaseProperties().

◆ operator<<

Ostream & operator<< ( Ostream & ,
const phaseProperties &  )
friend

References phaseProperties().

Member Data Documentation

◆ phaseTypeNames

const Foam::Enum< Foam::phaseProperties::phaseType > phaseTypeNames
static

Corresponding word representations for phase type enumerations.

Definition at line 76 of file phaseProperties.H.

Referenced by phaseTypeName(), and reorder().

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