phaseProperties Class Reference

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

Collaboration diagram for phaseProperties:

Public Types

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

Public Member Functions

 phaseProperties ()
 Null constructor. More...
 
 phaseProperties (Istream &)
 Construct from Istream. More...
 
 ~phaseProperties ()
 Destructor. More...
 
void reorder (const wordList &gasNames, const wordList &liquidNames, const wordList &solidNames)
 Reorder species to be consistent with the corresponding. More...
 
phaseType phase () const
 Return const access to the phase type. More...
 
const wordstateLabel () const
 Return const access to the phase state label. More...
 
word phaseTypeName () const
 Return word representation of the phase type. More...
 
const List< word > & names () const
 Return the list of specie names. More...
 
const wordname (const label speciei) const
 Return const access to a specie name. More...
 
const scalarFieldY () const
 Return const access to all specie mass fractions. More...
 
scalar & Y (const label speciei)
 Return non-const access to a specie mass fraction. More...
 
label carrierId (const label speciei) const
 Return the carrier id for a given specie. More...
 
label id (const word &specieName) const
 Return the id of a specie in the local list by name. More...
 

Static Public Attributes

static const NamedEnum< phaseType, 4 > phaseTypeNames
 Corresponding word representations for phase type enumerations. More...
 

Friends

Istreamoperator>> (Istream &, phaseProperties &)
 
Ostreamoperator<< (Ostream &, const phaseProperties &)
 

Detailed Description

Helper class to manage multi-specie phase properties.

Source files

Definition at line 60 of file phaseProperties.H.

Member Enumeration Documentation

◆ phaseType

enum phaseType

Phase type enumeration.

Enumerator
GAS 
LIQUID 
SOLID 
UNKNOWN 

Definition at line 67 of file phaseProperties.H.

Constructor & Destructor Documentation

◆ phaseProperties() [1/2]

Null constructor.

Definition at line 178 of file phaseProperties.C.

◆ phaseProperties() [2/2]

Construct from Istream.

Definition at line 31 of file phasePropertiesIO.C.

References IOstream::check(), forAllConstIter(), entry::keyword(), dictionary::null, phaseProperties::phaseTypeNames, and List< T >::setSize().

Here is the call graph for this function:

◆ ~phaseProperties()

Destructor.

Definition at line 190 of file phaseProperties.C.

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 197 of file phaseProperties.C.

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

Here is the call graph for this function:

◆ phase()

◆ stateLabel()

const Foam::word & stateLabel ( ) const

Return const access to the phase state label.

Definition at line 249 of file phaseProperties.C.

◆ phaseTypeName()

Foam::word phaseTypeName ( ) const

Return word representation of the phase type.

Definition at line 255 of file phaseProperties.C.

References phaseProperties::phaseTypeNames.

◆ names()

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

Return the list of specie names.

Definition at line 261 of file phaseProperties.C.

◆ name()

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

Return const access to a specie name.

Definition at line 267 of file phaseProperties.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and List< T >::size().

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 281 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 287 of file phaseProperties.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and List< T >::size().

Here is the call graph for this function:

◆ carrierId()

Foam::label carrierId ( const label  speciei) const

◆ 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 315 of file phaseProperties.C.

References forAll.

Friends And Related Function Documentation

◆ operator>>

Istream& operator>> ( Istream ,
phaseProperties  
)
friend

◆ operator<<

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

Member Data Documentation

◆ phaseTypeNames

const Foam::NamedEnum< Foam::phaseProperties::phaseType, 4 > phaseTypeNames
static

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