Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Opm::ImmiscibleFluidState< Scalar, FluidSystem, false > Class Template Reference

#include <ImmiscibleFluidState.hpp>

Inheritance diagram for Opm::ImmiscibleFluidState< Scalar, FluidSystem, false >:
Inheritance graph

Public Types

enum  
 
enum  
 
typedef Scalar Scalar
 
enum  
 

Public Member Functions

 ImmiscibleFluidState ()
 
void checkDefined () const
 Make sure that all attributes are defined. More...
 
void assign (const FluidState &fs)
 Retrieve all parameters from an arbitrary fluid state. More...
 
const Scalar & pressure (unsigned phaseIdx) const
 The pressure of a fluid phase [Pa]. More...
 
void setPressure (unsigned phaseIdx, const Scalar &value)
 Set the pressure of a phase [Pa]. More...
 
const Scalar & temperature (unsigned) const
 The temperature of a fluid phase [-]. More...
 
void setTemperature (const Scalar &value)
 Set the temperature of a phase [-]. More...
 
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...
 
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...
 
const Scalar & fugacityCoefficient (unsigned phaseIdx, unsigned compIdx) const
 The fugacity coefficient of a component in a phase []. More...
 
Scalar fugacity (unsigned phaseIdx, unsigned compIdx) const
 The fugacity of a component in a phase [Pa]. More...
 
void setFugacityCoefficient (unsigned phaseIdx, unsigned compIdx, const Scalar &value)
 Set the fugacity of a component in a phase []. More...
 
const Scalar & saturation (unsigned phaseIdx) const
 The saturation of a fluid phase [-]. More...
 
void setSaturation (unsigned phaseIdx, const Scalar &value)
 Set the saturation of a phase [-]. More...
 
const Scalar & density (unsigned phaseIdx) const
 The density of a fluid phase [kg/m^3]. More...
 
Scalar molarDensity (unsigned phaseIdx) const
 The molar density of a fluid phase [mol/m^3]. More...
 
Scalar molarVolume (unsigned phaseIdx) const
 The molar volume of a fluid phase [m^3/mol]. More...
 
void setDensity (unsigned phaseIdx, const Scalar &value)
 Set the density of a phase [kg/m^3]. More...
 
const Scalar & viscosity (unsigned phaseIdx) const
 The viscosity of a fluid phase [-]. More...
 
void setViscosity (unsigned phaseIdx, Scalar value)
 Set the dynamic viscosity of a phase [Pa s]. More...
 
const Scalar & internalEnergy (unsigned) const
 The specific internal energy of a fluid phase [J/kg]. More...
 
const Scalar & enthalpy (unsigned) const
 The specific enthalpy of a fluid phase [J/kg]. More...
 

Protected Member Functions

const ImmiscibleFluidState< Scalar, FluidSystem, false > & asImp_ () const
 
const ImmiscibleFluidState< Scalar, FluidSystem, false > & asImp_ () const
 
const ImmiscibleFluidState< Scalar, FluidSystem, false > & asImp_ () const
 

Protected Attributes

Scalar pressure_ [numPhases]
 
Scalar temperature_
 
Scalar fugacityCoefficient_ [numPhases][numComponents]
 
Scalar saturation_ [numPhases]
 
Scalar density_ [numPhases]
 
Scalar viscosity_ [numPhases]
 

Member Typedef Documentation

◆ Scalar

typedef Scalar Opm::ModularFluidState< Scalar , numPhasesV, numComponentsV, FluidStateExplicitPressureModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateEquilibriumTemperatureModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateImmiscibleCompositionModule< Scalar, FluidSystem, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateExplicitFugacityModule< Scalar, FluidSystem::numPhases, FluidSystem::numComponents, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateExplicitSaturationModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateExplicitDensityModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateExplicitViscosityModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateNullEnthalpyModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > >::Scalar
inherited

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

◆ anonymous enum

anonymous enum
inherited

◆ anonymous enum

anonymous enum
inherited

Constructor & Destructor Documentation

◆ ImmiscibleFluidState()

template<class Scalar , class FluidSystem >
Opm::ImmiscibleFluidState< Scalar, FluidSystem, false >::ImmiscibleFluidState ( )
inline

Member Function Documentation

◆ asImp_() [1/3]

const ImmiscibleFluidState< Scalar, FluidSystem, false > & Opm::FluidStateImmiscibleCompositionModule< Scalar, FluidSystem, ImmiscibleFluidState< Scalar, FluidSystem, false > >::asImp_ ( ) const
inlineprotectedinherited

◆ asImp_() [2/3]

const ImmiscibleFluidState< Scalar, FluidSystem, false > & Opm::FluidStateExplicitDensityModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::asImp_ ( ) const
inlineprotectedinherited

◆ asImp_() [3/3]

const ImmiscibleFluidState< Scalar, FluidSystem, false > & Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, ImmiscibleFluidState< Scalar, FluidSystem, false > >::asImp_ ( ) const
inlineprotectedinherited

◆ assign()

void Opm::ModularFluidState< Scalar , numPhasesV, numComponentsV, FluidStateExplicitPressureModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateEquilibriumTemperatureModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateImmiscibleCompositionModule< Scalar, FluidSystem, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateExplicitFugacityModule< Scalar, FluidSystem::numPhases, FluidSystem::numComponents, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateExplicitSaturationModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateExplicitDensityModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateExplicitViscosityModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateNullEnthalpyModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > >::assign ( const FluidState &  fs)
inlineinherited

Retrieve all parameters from an arbitrary fluid state.

◆ averageMolarMass()

Scalar Opm::FluidStateImmiscibleCompositionModule< Scalar, FluidSystem, ImmiscibleFluidState< Scalar, FluidSystem, false > >::averageMolarMass ( unsigned  phaseIdx) const
inlineinherited

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

The average mass is the mean molar mass of a molecule 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 \]

◆ checkDefined()

void Opm::ModularFluidState< Scalar , numPhasesV, numComponentsV, FluidStateExplicitPressureModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateEquilibriumTemperatureModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateImmiscibleCompositionModule< Scalar, FluidSystem, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateExplicitFugacityModule< Scalar, FluidSystem::numPhases, FluidSystem::numComponents, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateExplicitSaturationModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateExplicitDensityModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateExplicitViscosityModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > , FluidStateNullEnthalpyModule< Scalar, FluidSystem::numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > > >::checkDefined ( ) const
inlineinherited

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.

◆ density()

const Scalar & Opm::FluidStateExplicitDensityModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::density ( unsigned  phaseIdx) const
inlineinherited

The density of a fluid phase [kg/m^3].

◆ enthalpy()

const Scalar & Opm::FluidStateNullEnthalpyModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::enthalpy ( unsigned  ) const
inlineinherited

The specific enthalpy of a fluid phase [J/kg].

◆ fugacity()

Scalar Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, ImmiscibleFluidState< Scalar, FluidSystem, false > >::fugacity ( unsigned  phaseIdx,
unsigned  compIdx 
) const
inlineinherited

The fugacity of a component in a phase [Pa].

◆ fugacityCoefficient()

const Scalar & Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, ImmiscibleFluidState< Scalar, FluidSystem, false > >::fugacityCoefficient ( unsigned  phaseIdx,
unsigned  compIdx 
) const
inlineinherited

The fugacity coefficient of a component in a phase [].

◆ internalEnergy()

const Scalar & Opm::FluidStateNullEnthalpyModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::internalEnergy ( unsigned  ) const
inlineinherited

The specific internal energy of a fluid phase [J/kg].

◆ massFraction()

Scalar Opm::FluidStateImmiscibleCompositionModule< Scalar, FluidSystem, ImmiscibleFluidState< Scalar, FluidSystem, false > >::massFraction ( unsigned  phaseIdx,
unsigned  compIdx 
) const
inlineinherited

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

◆ molarDensity()

Scalar Opm::FluidStateExplicitDensityModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::molarDensity ( unsigned  phaseIdx) const
inlineinherited

The molar density of a fluid phase [mol/m^3].

◆ molarity()

Scalar Opm::FluidStateImmiscibleCompositionModule< Scalar, FluidSystem, ImmiscibleFluidState< Scalar, FluidSystem, false > >::molarity ( unsigned  phaseIdx,
unsigned  compIdx 
) const
inlineinherited

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

◆ molarVolume()

Scalar Opm::FluidStateExplicitDensityModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::molarVolume ( unsigned  phaseIdx) const
inlineinherited

The molar volume of a fluid phase [m^3/mol].

◆ moleFraction()

Scalar Opm::FluidStateImmiscibleCompositionModule< Scalar, FluidSystem, ImmiscibleFluidState< Scalar, FluidSystem, false > >::moleFraction ( unsigned  phaseIdx,
unsigned  compIdx 
) const
inlineinherited

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

◆ pressure()

const Scalar & Opm::FluidStateExplicitPressureModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::pressure ( unsigned  phaseIdx) const
inlineinherited

The pressure of a fluid phase [Pa].

◆ saturation()

const Scalar & Opm::FluidStateExplicitSaturationModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::saturation ( unsigned  phaseIdx) const
inlineinherited

The saturation of a fluid phase [-].

◆ setDensity()

void Opm::FluidStateExplicitDensityModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::setDensity ( unsigned  phaseIdx,
const Scalar &  value 
)
inlineinherited

Set the density of a phase [kg/m^3].

◆ setFugacityCoefficient()

void Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, ImmiscibleFluidState< Scalar, FluidSystem, false > >::setFugacityCoefficient ( unsigned  phaseIdx,
unsigned  compIdx,
const Scalar &  value 
)
inlineinherited

Set the fugacity of a component in a phase [].

◆ setPressure()

void Opm::FluidStateExplicitPressureModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::setPressure ( unsigned  phaseIdx,
const Scalar &  value 
)
inlineinherited

Set the pressure of a phase [Pa].

◆ setSaturation()

void Opm::FluidStateExplicitSaturationModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::setSaturation ( unsigned  phaseIdx,
const Scalar &  value 
)
inlineinherited

Set the saturation of a phase [-].

◆ setTemperature()

void Opm::FluidStateEquilibriumTemperatureModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::setTemperature ( const Scalar &  value)
inlineinherited

Set the temperature of a phase [-].

◆ setViscosity()

void Opm::FluidStateExplicitViscosityModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::setViscosity ( unsigned  phaseIdx,
Scalar  value 
)
inlineinherited

Set the dynamic viscosity of a phase [Pa s].

◆ temperature()

const Scalar & Opm::FluidStateEquilibriumTemperatureModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::temperature ( unsigned  ) const
inlineinherited

The temperature of a fluid phase [-].

◆ viscosity()

const Scalar & Opm::FluidStateExplicitViscosityModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::viscosity ( unsigned  phaseIdx) const
inlineinherited

The viscosity of a fluid phase [-].

Member Data Documentation

◆ density_

Scalar Opm::FluidStateExplicitDensityModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::density_[numPhases]
protectedinherited

◆ fugacityCoefficient_

Scalar Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, ImmiscibleFluidState< Scalar, FluidSystem, false > >::fugacityCoefficient_[numPhases][numComponents]
protectedinherited

◆ pressure_

Scalar Opm::FluidStateExplicitPressureModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::pressure_[numPhases]
protectedinherited

◆ saturation_

Scalar Opm::FluidStateExplicitSaturationModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::saturation_[numPhases]
protectedinherited

◆ temperature_

Scalar Opm::FluidStateEquilibriumTemperatureModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::temperature_
protectedinherited

◆ viscosity_

Scalar Opm::FluidStateExplicitViscosityModule< Scalar, numPhases, ImmiscibleFluidState< Scalar, FluidSystem, false > >::viscosity_[numPhases]
protectedinherited
The documentation for this class was generated from the following file: