Opm::NonEquilibriumFluidState< Scalar, FluidSystem, true > Class Template Reference

#include <NonEquilibriumFluidState.hpp>

Inheritance diagram for Opm::NonEquilibriumFluidState< Scalar, FluidSystem, true >:
Inheritance graph

Public Types

enum  
 
enum  
 
typedef Scalar Scalar
 

Public Member Functions

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 Scalarpressure (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 Scalartemperature (unsigned phaseIdx) const
 The temperature of a fluid phase [-]. More...
 
void setTemperature (unsigned phaseIdx, const Scalar &value)
 Set the temperature of a phase [-]. More...
 
const ScalarmoleFraction (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 ScalaraverageMolarMass (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...
 
void setCompressFactor (unsigned phaseIdx, const Scalar &value)
 
Scalar compressFactor (unsigned phaseIdx) const
 
const ScalarK (unsigned compIdx) const
 
void setKvalue (unsigned compIdx, const Scalar &value)
 Set the K value of a component [-]. More...
 
const ScalarL () const
 The L value of a composition [-]. More...
 
void setLvalue (const Scalar &value)
 Set the L value [-]. More...
 
Scalar wilsonK_ (unsigned compIdx) const
 Wilson formula to calculate K. More...
 
const ScalarfugacityCoefficient (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 Scalarsaturation (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 Scalardensity (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 Scalarviscosity (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 Scalarenthalpy (unsigned phaseIdx) const
 The specific enthalpy of a fluid phase [J/kg]. More...
 
Scalar internalEnergy (unsigned phaseIdx) const
 The specific internal energy of a fluid phase [J/kg]. More...
 
void setEnthalpy (unsigned phaseIdx, const Scalar &value)
 Set the specific enthalpy of a phase [J/kg]. More...
 

Protected Member Functions

const NonEquilibriumFluidState< Scalar, FluidSystem, true > & asImp_ () const
 
const NonEquilibriumFluidState< Scalar, FluidSystem, true > & asImp_ () const
 
const NonEquilibriumFluidState< Scalar, FluidSystem, true > & asImp_ () const
 
const NonEquilibriumFluidState< Scalar, FluidSystem, true > & asImp_ () const
 

Protected Attributes

Scalar pressure_ [numPhases]
 
Scalar temperature_ [numPhases]
 
std::array< std::array< Scalar, numComponents >, numPhasesmoleFraction_
 
std::array< Scalar, numPhasesaverageMolarMass_
 
std::array< Scalar, numPhasessumMoleFractions_
 
std::array< Scalar, numPhasesZ_
 
std::array< Scalar, numComponentsK_
 
Scalar L_
 
Scalar fugacityCoefficient_ [numPhases][numComponents]
 
Scalar saturation_ [numPhases]
 
Scalar density_ [numPhases]
 
Scalar viscosity_ [numPhases]
 
Scalar enthalpy_ [numPhases]
 

Member Typedef Documentation

◆ Scalar

typedef Scalar Opm::ModularFluidState< Scalar , numPhasesV, numComponentsV, FluidStateExplicitPressureModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitTemperatureModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitFugacityModule< Scalar, FluidSystem::numPhases, FluidSystem::numComponents, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitSaturationModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitDensityModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitViscosityModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitEnthalpyModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > >::Scalar
inherited

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

◆ anonymous enum

anonymous enum
inherited

Member Function Documentation

◆ asImp_() [1/4]

const NonEquilibriumFluidState< Scalar, FluidSystem, true > & Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::asImp_ ( ) const
inlineprotectedinherited

◆ asImp_() [2/4]

const NonEquilibriumFluidState< Scalar, FluidSystem, true > & Opm::FluidStateExplicitDensityModule< Scalar, numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::asImp_ ( ) const
inlineprotectedinherited

◆ asImp_() [3/4]

const NonEquilibriumFluidState< Scalar, FluidSystem, true > & Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::asImp_ ( ) const
inlineprotectedinherited

◆ asImp_() [4/4]

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

◆ assign()

void Opm::ModularFluidState< Scalar , numPhasesV, numComponentsV, FluidStateExplicitPressureModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitTemperatureModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitFugacityModule< Scalar, FluidSystem::numPhases, FluidSystem::numComponents, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitSaturationModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitDensityModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitViscosityModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitEnthalpyModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > >::assign ( const FluidState &  fs)
inlineinherited

Retrieve all parameters from an arbitrary fluid state.

◆ averageMolarMass()

const Scalar & Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::averageMolarMass ( unsigned  phaseIdx) const
inlineinherited

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 \]

◆ checkDefined()

void Opm::ModularFluidState< Scalar , numPhasesV, numComponentsV, FluidStateExplicitPressureModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitTemperatureModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitFugacityModule< Scalar, FluidSystem::numPhases, FluidSystem::numComponents, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitSaturationModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitDensityModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitViscosityModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > , FluidStateExplicitEnthalpyModule< Scalar, FluidSystem::numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > > >::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.

◆ compressFactor()

Scalar Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::compressFactor ( unsigned  phaseIdx) const
inlineinherited

◆ density()

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

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

◆ enthalpy()

const Scalar & Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::enthalpy ( unsigned  phaseIdx) const
inlineinherited

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

◆ fugacity()

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

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

◆ fugacityCoefficient()

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

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

◆ internalEnergy()

Scalar Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::internalEnergy ( unsigned  phaseIdx) const
inlineinherited

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

◆ K()

const Scalar & Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::K ( unsigned  compIdx) const
inlineinherited

◆ L()

const Scalar & Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::L ( ) const
inlineinherited

The L value of a composition [-].

◆ massFraction()

Scalar Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::massFraction ( unsigned  phaseIdx,
unsigned  compIdx 
) const
inlineinherited

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

◆ molarDensity()

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

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

◆ molarity()

Scalar Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::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, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::molarVolume ( unsigned  phaseIdx) const
inlineinherited

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

◆ moleFraction()

const Scalar & Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::moleFraction ( unsigned  phaseIdx,
unsigned  compIdx 
) const
inlineinherited

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

◆ pressure()

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

The pressure of a fluid phase [Pa].

◆ saturation()

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

The saturation of a fluid phase [-].

◆ setCompressFactor()

void Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::setCompressFactor ( unsigned  phaseIdx,
const Scalar &  value 
)
inlineinherited

◆ setDensity()

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

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

◆ setEnthalpy()

void Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::setEnthalpy ( unsigned  phaseIdx,
const Scalar &  value 
)
inlineinherited

Set the specific enthalpy of a phase [J/kg].

◆ setFugacityCoefficient()

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

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

◆ setKvalue()

void Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::setKvalue ( unsigned  compIdx,
const Scalar &  value 
)
inlineinherited

Set the K value of a component [-].

◆ setLvalue()

void Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::setLvalue ( const Scalar &  value)
inlineinherited

Set the L value [-].

◆ setMoleFraction()

void Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::setMoleFraction ( unsigned  phaseIdx,
unsigned  compIdx,
const Scalar &  value 
)
inlineinherited

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.

◆ setPressure()

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

Set the pressure of a phase [Pa].

◆ setSaturation()

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

Set the saturation of a phase [-].

◆ setTemperature()

void Opm::FluidStateExplicitTemperatureModule< Scalar, numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::setTemperature ( unsigned  phaseIdx,
const Scalar &  value 
)
inlineinherited

Set the temperature of a phase [-].

◆ setViscosity()

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

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

◆ temperature()

const Scalar & Opm::FluidStateExplicitTemperatureModule< Scalar, numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::temperature ( unsigned  phaseIdx) const
inlineinherited

The temperature of a fluid phase [-].

◆ viscosity()

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

The viscosity of a fluid phase [-].

◆ wilsonK_()

Scalar Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::wilsonK_ ( unsigned  compIdx) const
inlineinherited

Wilson formula to calculate K.

Member Data Documentation

◆ averageMolarMass_

std::array<Scalar,numPhases> Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::averageMolarMass_
protectedinherited

◆ density_

Scalar Opm::FluidStateExplicitDensityModule< Scalar, numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::density_[numPhases]
protectedinherited

◆ enthalpy_

Scalar Opm::FluidStateExplicitEnthalpyModule< Scalar, numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::enthalpy_[numPhases]
protectedinherited

◆ fugacityCoefficient_

◆ K_

std::array<Scalar,numComponents> Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::K_
protectedinherited

◆ L_

Scalar Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::L_
protectedinherited

◆ moleFraction_

std::array<std::array<Scalar,numComponents>,numPhases> Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::moleFraction_
protectedinherited

◆ pressure_

Scalar Opm::FluidStateExplicitPressureModule< Scalar, numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::pressure_[numPhases]
protectedinherited

◆ saturation_

Scalar Opm::FluidStateExplicitSaturationModule< Scalar, numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::saturation_[numPhases]
protectedinherited

◆ sumMoleFractions_

std::array<Scalar,numPhases> Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::sumMoleFractions_
protectedinherited

◆ temperature_

Scalar Opm::FluidStateExplicitTemperatureModule< Scalar, numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::temperature_[numPhases]
protectedinherited

◆ viscosity_

Scalar Opm::FluidStateExplicitViscosityModule< Scalar, numPhases, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::viscosity_[numPhases]
protectedinherited

◆ Z_

std::array<Scalar,numPhases> Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, NonEquilibriumFluidState< Scalar, FluidSystem, true > >::Z_
protectedinherited

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