Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation > Class Template Reference

Module for the modular fluid state which stores the phase compositions explicitly in terms of mole fractions. More...

#include <FluidStateCompositionModules.hpp>

Inheritance diagram for Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >:
Inheritance graph

Public Member Functions

 FluidStateExplicitCompositionModule ()
 
const Scalar & moleFraction (unsigned phaseIdx, unsigned compIdx) const
 The mole fraction of a component in a phase []. More...
 
Scalar massFraction (unsigned phaseIdx, unsigned compIdx) const
 The mass fraction of a component in a phase []. More...
 
const Scalar & averageMolarMass (unsigned phaseIdx) const
 The mean molar mass of a fluid phase [kg/mol]. More...
 
Scalar molarity (unsigned phaseIdx, unsigned compIdx) const
 The concentration of a component in a phase [mol/m^3]. More...
 
void setMoleFraction (unsigned phaseIdx, unsigned compIdx, const Scalar &value)
 Set the mole fraction of a component in a phase [] and update the average molar mass [kg/mol] according to the current composition of the phase. More...
 
template<class FluidState >
void assign (const FluidState &fs)
 Retrieve all parameters from an arbitrary fluid state. More...
 
void checkDefined () const
 Make sure that all attributes are defined. More...
 

Protected Member Functions

const Implementation & asImp_ () const
 

Protected Attributes

Scalar moleFraction_ [numPhases][numComponents]
 
Scalar averageMolarMass_ [numPhases]
 
Scalar sumMoleFractions_ [numPhases]
 

Detailed Description

template<class Scalar, class FluidSystem, class Implementation>
class Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >

Module for the modular fluid state which stores the phase compositions explicitly in terms of mole fractions.

Constructor & Destructor Documentation

template<class Scalar, class FluidSystem, class Implementation>
Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::FluidStateExplicitCompositionModule ( )
inline

Member Function Documentation

template<class Scalar, class FluidSystem, class Implementation>
const Implementation& Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::asImp_ ( ) const
inlineprotected
template<class Scalar, class FluidSystem, class Implementation>
template<class FluidState >
void Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::assign ( const FluidState &  fs)
inline

Retrieve all parameters from an arbitrary fluid state.

template<class Scalar, class FluidSystem, class Implementation>
const Scalar& Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::averageMolarMass ( unsigned  phaseIdx) const
inline

The mean molar mass of a fluid phase [kg/mol].

The average molar mass is the mean mass of one mole of the fluid at current composition. It is defined as the sum of the component's molar masses weighted by the current mole fraction:

\[ \bar M_\alpha = \sum_\kappa M^\kappa x_\alpha^\kappa \]

template<class Scalar, class FluidSystem, class Implementation>
void Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::checkDefined ( ) const
inline

Make sure that all attributes are defined.

This method does not do anything if the program is not run under valgrind. If it is, then valgrind will print an error message if some attributes of the object have not been properly defined.

template<class Scalar, class FluidSystem, class Implementation>
Scalar Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::massFraction ( unsigned  phaseIdx,
unsigned  compIdx 
) const
inline

The mass fraction of a component in a phase [].

template<class Scalar, class FluidSystem, class Implementation>
Scalar Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::molarity ( unsigned  phaseIdx,
unsigned  compIdx 
) const
inline

The concentration of a component in a phase [mol/m^3].

This quantity is often called "molar concentration" or just "concentration", but there are many other (though less common) measures for concentration.

http://en.wikipedia.org/wiki/Concentration

template<class Scalar, class FluidSystem, class Implementation>
const Scalar& Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::moleFraction ( unsigned  phaseIdx,
unsigned  compIdx 
) const
inline
template<class Scalar, class FluidSystem, class Implementation>
void Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::setMoleFraction ( unsigned  phaseIdx,
unsigned  compIdx,
const Scalar &  value 
)
inline

Set the mole fraction of a component in a phase [] and update the average molar mass [kg/mol] according to the current composition of the phase.

Member Data Documentation


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