Helper class to manage multi-specie phase properties. More...
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 word & | stateLabel () 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 word & | name (const label speciei) const |
Return const access to a specie name. More... | |
const scalarField & | Y () 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 | |
Istream & | operator>> (Istream &, phaseProperties &) |
Ostream & | operator<< (Ostream &, const phaseProperties &) |
Helper class to manage multi-specie phase properties.
Definition at line 60 of file phaseProperties.H.
enum phaseType |
Phase type enumeration.
Enumerator | |
---|---|
GAS | |
LIQUID | |
SOLID | |
UNKNOWN |
Definition at line 67 of file phaseProperties.H.
phaseProperties | ( | ) |
Null constructor.
Definition at line 179 of file phaseProperties.C.
phaseProperties | ( | Istream & | is | ) |
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().
~phaseProperties | ( | ) |
Destructor.
Definition at line 191 of file phaseProperties.C.
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, Foam::nl, and Foam::reorder().
Foam::phaseProperties::phaseType phase | ( | ) | const |
Return const access to the phase type.
Definition at line 244 of file phaseProperties.C.
Referenced by CompositionModel< CloudType >::Cp(), CompositionModel< CloudType >::ha(), CompositionModel< CloudType >::hs(), CompositionModel< CloudType >::L(), and CompositionModel< CloudType >::X().
const Foam::word & stateLabel | ( | ) | const |
Return const access to the phase state label.
Definition at line 250 of file phaseProperties.C.
Foam::word phaseTypeName | ( | ) | const |
Return word representation of the phase type.
Definition at line 256 of file phaseProperties.C.
const Foam::List< Foam::word > & names | ( | ) | const |
Return the list of specie names.
Definition at line 262 of file phaseProperties.C.
const Foam::word & name | ( | const label | speciei | ) | const |
Return const access to a specie name.
Definition at line 268 of file phaseProperties.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.
const Foam::scalarField & Y | ( | ) | const |
Return const access to all specie mass fractions.
Definition at line 282 of file phaseProperties.C.
Foam::scalar & Y | ( | const label | speciei | ) |
Return non-const access to a specie mass fraction.
Definition at line 288 of file phaseProperties.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.
Foam::label carrierId | ( | const label | speciei | ) | const |
Return the carrier id for a given specie.
Definition at line 302 of file phaseProperties.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.
Referenced by CompositionModel< CloudType >::Cp(), CompositionModel< CloudType >::ha(), CompositionModel< CloudType >::hs(), and CompositionModel< CloudType >::X().
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 316 of file phaseProperties.C.
References forAll.
|
friend |
|
friend |
|
static |
Corresponding word representations for phase type enumerations.
Definition at line 76 of file phaseProperties.H.
Referenced by Foam::operator<<(), Foam::operator>>(), and phaseProperties::phaseProperties().