FreeFOAM The Cross-Platform CFD Toolkit
phaseProperties Class Reference

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

#include <lagrangianIntermediate/phaseProperties.H>


Detailed Description

+ Collaboration diagram for phaseProperties:

List of all members.

Public Types

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

Public Member Functions

 phaseProperties ()
 Null constructor.
 phaseProperties (Istream &)
 Construct from Istream.
 phaseProperties (const phaseProperties &)
 Construct as copy.
 ~phaseProperties ()
 Destructor.
void initialiseGlobalIds (const wordList &gasNames, const wordList &liquidNames, const wordList &solidNames)
 Initialise the global ids.
phaseType phase () const
 Return const access to the phase type.
const wordstateLabel () 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 component names.
const wordname (const label cmptI) const
 Return const access to a component name.
const scalarFieldY () const
 Return const access to all component mass fractions.
scalar & Y (const label cmptI)
 Return non-const access to a component mass fraction.
const labelListglobalIds () const
 Return const access to the global ids.
const labelListglobalCarrierIds () const
 Return const access to the map to the carrier global ids.
label globalId (const word &cmptName) const
 Return the global id of a component in the local list by name.
label id (const word &cmptName) const
 Return the id of a component in the local list by name.

Static Public Attributes

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

Friends

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

Member Enumeration Documentation

enum phaseType

Phase type enumeration.

Enumerator:
GAS 
LIQUID 
SOLID 
UNKNOWN 

Definition at line 60 of file phaseProperties.H.


Constructor & Destructor Documentation

Null constructor.

Definition at line 163 of file phaseProperties.C.

Construct as copy.

Definition at line 174 of file phaseProperties.C.

Destructor.

Definition at line 187 of file phaseProperties.C.


Member Function Documentation

void initialiseGlobalIds ( const wordList gasNames,
const wordList liquidNames,
const wordList solidNames 
)

Initialise the global ids.

Definition at line 194 of file phaseProperties.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, forAll, Foam::nl, and WarningIn.

const Foam::word & stateLabel ( ) const

Return const access to the phase state label.

Definition at line 254 of file phaseProperties.C.

Foam::word phaseTypeName ( ) const

Return word representation of the phase type.

Definition at line 260 of file phaseProperties.C.

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

Return the list of component names.

Definition at line 266 of file phaseProperties.C.

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

Return const access to a component name.

Definition at line 272 of file phaseProperties.C.

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

const Foam::scalarField & Y ( ) const

Return const access to all component mass fractions.

Definition at line 291 of file phaseProperties.C.

Foam::scalar & Y ( const label  cmptI)

Return non-const access to a component mass fraction.

Definition at line 297 of file phaseProperties.C.

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

const Foam::labelList & globalCarrierIds ( ) const

Return const access to the map to the carrier global ids.

Definition at line 338 of file phaseProperties.C.

Foam::label globalId ( const word cmptName) const

Return the global id of a component in the local list by name.

Returns -1 if not found

Definition at line 316 of file phaseProperties.C.

Foam::label id ( const word cmptName) const

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

Returns -1 if not found

Definition at line 344 of file phaseProperties.C.

References forAll.


Friends And Related Function Documentation

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

Member Data Documentation

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

Corresponding word representations for phase type enumerations.

Definition at line 69 of file phaseProperties.H.

Referenced by phaseProperties::phaseProperties().


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