Implements a "tailor-made" fluid state class for the black-oil model. More...

#include <BlackOilFluidState.hpp>

Public Types
enum	{ numPhases = FluidSystem::numPhases }

enum	{ numComponents = FluidSystem::numComponents }

using	Scalar = ScalarT

Public Member Functions
void	checkDefined () const
	Make sure that all attributes are defined. More...

template<class FluidState >
void	assign (const FluidState &fs)
	Retrieve all parameters from an arbitrary fluid state. More...

void	setPvtRegionIndex (unsigned newPvtRegionIdx)
	Set the index of the fluid region. More...

void	setPressure (unsigned phaseIdx, const Scalar &p)
	Set the pressure of a fluid phase [-]. More...

void	setSaturation (unsigned phaseIdx, const Scalar &S)
	Set the saturation of a fluid phase [-]. More...

void	setPc (unsigned phaseIdx, const Scalar &pc)
	Set the capillary pressure of a fluid phase [-]. More...

void	setTotalSaturation (const Scalar &value)
	Set the total saturation used for sequential methods. More...

void	setTemperature (const Scalar &value)
	Set the temperature [K]. More...

void	setEnthalpy (unsigned phaseIdx, const Scalar &value)
	Set the specific enthalpy [J/kg] of a given fluid phase. More...

void	setInvB (unsigned phaseIdx, const Scalar &b)

void	setDensity (unsigned phaseIdx, const Scalar &rho)

void	setRs (const Scalar &newRs)
	Set the gas dissolution factor [m^3/m^3] of the oil phase. More...

void	setRv (const Scalar &newRv)
	Set the oil vaporization factor [m^3/m^3] of the gas phase. More...

void	setRvw (const Scalar &newRvw)
	Set the water vaporization factor [m^3/m^3] of the gas phase. More...

void	setSaltConcentration (const Scalar &newSaltConcentration)
	Set the salt concentration. More...

void	setSaltSaturation (const Scalar &newSaltSaturation)
	Set the solid salt saturation. More...

const Scalar &	pressure (unsigned phaseIdx) const
	Return the pressure of a fluid phase [Pa]. More...

const Scalar &	saturation (unsigned phaseIdx) const
	Return the saturation of a fluid phase [-]. More...

const Scalar &	pc (unsigned phaseIdx) const
	Return the capillary pressure of a fluid phase [-]. More...

const Scalar &	totalSaturation () const
	Return the total saturation needed for sequential. More...

const Scalar &	temperature (unsigned) const
	Return the temperature [K]. More...

const Scalar &	invB (unsigned phaseIdx) const
	Return the inverse formation volume factor of a fluid phase [-]. More...

const Scalar &	Rs () const
	Return the gas dissulition factor of oil [m^3/m^3]. More...

const Scalar &	Rv () const
	Return the oil vaporization factor of gas [m^3/m^3]. More...

const Scalar &	Rvw () const
	Return the water vaporization factor of gas [m^3/m^3]. More...

const Scalar &	saltConcentration () const
	Return the concentration of salt in water. More...

const Scalar &	saltSaturation () const
	Return the saturation of solid salt. More...

unsigned short	pvtRegionIndex () const
	Return the PVT region where the current fluid state is assumed to be part of. More...

Scalar	density (unsigned phaseIdx) const
	Return the density [kg/m^3] of a given fluid phase. More...

const Scalar &	enthalpy (unsigned phaseIdx) const
	Return the specific enthalpy [J/kg] of a given fluid phase. More...

Scalar	internalEnergy (unsigned phaseIdx) const
	Return the specific internal energy [J/kg] of a given fluid phase. More...

Scalar	molarDensity (unsigned phaseIdx) const
	Return the molar density of a fluid phase [mol/m^3]. More...

Scalar	molarVolume (unsigned phaseIdx) const
	Return the molar volume of a fluid phase [m^3/mol]. More...

Scalar	viscosity (unsigned phaseIdx) const
	Return the dynamic viscosity of a fluid phase [Pa s]. More...

Scalar	massFraction (unsigned phaseIdx, unsigned compIdx) const
	Return the mass fraction of a component in a fluid phase [-]. More...

Scalar	moleFraction (unsigned phaseIdx, unsigned compIdx) const
	Return the mole fraction of a component in a fluid phase [-]. More...

Scalar	molarity (unsigned phaseIdx, unsigned compIdx) const
	Return the partial molar density of a component in a fluid phase [mol / m^3]. More...

Scalar	averageMolarMass (unsigned phaseIdx) const
	Return the partial molar density of a fluid phase [kg / mol]. More...

Scalar	fugacityCoefficient (unsigned phaseIdx, unsigned compIdx) const
	Return the fugacity coefficient of a component in a fluid phase [-]. More...

Scalar	fugacity (unsigned phaseIdx, unsigned compIdx) const
	Return the fugacity of a component in a fluid phase [Pa]. More...

Detailed Description

template<class ScalarT, class FluidSystem, bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>
class Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >

Implements a "tailor-made" fluid state class for the black-oil model.

I.e., it uses exactly the same quantities which are used by the ECL blackoil model. Further quantities are computed "on the fly" and are accessing them is thus relatively slow.

Member Typedef Documentation

◆ Scalar

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

using Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::Scalar = ScalarT

Member Enumeration Documentation

◆ anonymous enum

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

anonymous enum

Enumerator
numPhases

◆ anonymous enum

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

anonymous enum

Enumerator
numComponents

Member Function Documentation

◆ assign()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

template<class FluidState >

void Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::assign ( const FluidState & fs )

inline

Retrieve all parameters from an arbitrary fluid state.

◆ averageMolarMass()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

Scalar Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::averageMolarMass ( unsigned phaseIdx ) const

inline

Return the partial molar density of a fluid phase [kg / mol].

References Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::moleFraction(), and Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::numComponents.

◆ checkDefined()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

void Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::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.

References Opm::Valgrind::CheckDefined().

◆ density()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

Scalar Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::density ( unsigned phaseIdx ) const

inline

Return the density [kg/m^3] of a given fluid phase.

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::internalEnergy(), and Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::molarDensity().

◆ enthalpy()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

const Scalar & Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::enthalpy ( unsigned phaseIdx ) const

inline

Return the specific enthalpy [J/kg] of a given fluid phase.

If the EnableEnergy property is not set to true, this method will throw an exception!

◆ fugacity()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

Scalar Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::fugacity	(	unsigned	phaseIdx,
		unsigned	compIdx
	)		const

inline

Return the fugacity of a component in a fluid phase [Pa].

References Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::fugacityCoefficient(), Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::moleFraction(), and Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::pressure().

◆ fugacityCoefficient()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

Scalar Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::fugacityCoefficient	(	unsigned	phaseIdx,
		unsigned	compIdx
	)		const

inline

Return the fugacity coefficient of a component in a fluid phase [-].

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::fugacity().

◆ internalEnergy()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

Scalar Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::internalEnergy ( unsigned phaseIdx ) const

inline

Return the specific internal energy [J/kg] of a given fluid phase.

If the EnableEnergy property is not set to true, this method will throw an exception!

References Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::density(), and Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::pressure().

◆ invB()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

const Scalar & Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::invB ( unsigned phaseIdx ) const

inline

Return the inverse formation volume factor of a fluid phase [-].

This factor expresses the change of density of a pure phase due to increased pressure and temperature at reservoir conditions compared to surface conditions.

◆ massFraction()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

Scalar Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::massFraction	(	unsigned	phaseIdx,
		unsigned	compIdx
	)		const

inline

Return the mass fraction of a component in a fluid phase [-].

References Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::Rs(), and Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::Rv().

◆ molarDensity()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

Scalar Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::molarDensity ( unsigned phaseIdx ) const

inline

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

References Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::density(), and Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::moleFraction().

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::molarity(), and Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::molarVolume().

◆ molarity()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

Scalar Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::molarity	(	unsigned	phaseIdx,
		unsigned	compIdx
	)		const

inline

Return the partial molar density of a component in a fluid phase [mol / m^3].

References Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::molarDensity(), and Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::moleFraction().

◆ molarVolume()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

Scalar Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::molarVolume ( unsigned phaseIdx ) const

inline

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

This is equivalent to the inverse of the molar density.

References Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::molarDensity().

◆ moleFraction()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

Scalar Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::moleFraction	(	unsigned	phaseIdx,
		unsigned	compIdx
	)		const

inline

Return the mole fraction of a component in a fluid phase [-].

References Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::Rs(), and Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::Rv().

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::averageMolarMass(), Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::fugacity(), Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::molarDensity(), and Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::molarity().

◆ pc()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

const Scalar & Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::pc ( unsigned phaseIdx ) const

inline

Return the capillary pressure of a fluid phase [-].

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::setPc().

◆ pressure()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

const Scalar & Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::pressure ( unsigned phaseIdx ) const

inline

Return the pressure of a fluid phase [Pa].

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::fugacity(), and Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::internalEnergy().

◆ pvtRegionIndex()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

unsigned short Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::pvtRegionIndex ( ) const

inline

Return the PVT region where the current fluid state is assumed to be part of.

This is an ECL specfic concept. It is basically a kludge to account for the fact that the fluids components treated by the black-oil model exhibit different compositions in different parts of the reservoir, while the black-oil model always treats them as "oil", "gas" and "water".

◆ Rs()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

const Scalar & Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::Rs ( ) const

inline

Return the gas dissulition factor of oil [m^3/m^3].

I.e., the amount of gas which is present in the oil phase in terms of cubic meters of gas at surface conditions per cubic meter of liquid oil at surface conditions. This method is specific to the black-oil model.

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::massFraction(), and Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::moleFraction().

◆ Rv()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

const Scalar & Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::Rv ( ) const

inline

Return the oil vaporization factor of gas [m^3/m^3].

I.e., the amount of oil which is present in the gas phase in terms of cubic meters of liquid oil at surface conditions per cubic meter of gas at surface conditions. This method is specific to the black-oil model.

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::massFraction(), and Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::moleFraction().

◆ Rvw()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

const Scalar & Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::Rvw ( ) const

inline

Return the water vaporization factor of gas [m^3/m^3].

I.e., the amount of water which is present in the gas phase in terms of cubic meters of liquid water at surface conditions per cubic meter of gas at surface conditions. This method is specific to the black-oil model.

◆ saltConcentration()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

const Scalar & Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::saltConcentration ( ) const

inline

Return the concentration of salt in water.

◆ saltSaturation()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

const Scalar & Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::saltSaturation ( ) const

inline

Return the saturation of solid salt.

◆ saturation()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

const Scalar & Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::saturation ( unsigned phaseIdx ) const

inline

Return the saturation of a fluid phase [-].

◆ setDensity()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

void Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::setDensity	(	unsigned	phaseIdx,
		const Scalar &	rho
	)

inline

\ brief Set the density of a fluid phase

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::assign().

◆ setEnthalpy()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

void Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::setEnthalpy	(	unsigned	phaseIdx,
		const Scalar &	value
	)

inline

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

If the enableEnergy template argument is not set to true, this method will throw an exception!

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::assign().

◆ setInvB()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

void Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::setInvB	(	unsigned	phaseIdx,
		const Scalar &	b
	)

inline

\ brief Set the inverse formation volume factor of a fluid phase

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::assign().

◆ setPc()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

void Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::setPc	(	unsigned	phaseIdx,
		const Scalar &	pc
	)

inline

Set the capillary pressure of a fluid phase [-].

References Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::pc().

◆ setPressure()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

void Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::setPressure	(	unsigned	phaseIdx,
		const Scalar &	p
	)

inline

Set the pressure of a fluid phase [-].

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::assign().

◆ setPvtRegionIndex()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

void Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::setPvtRegionIndex ( unsigned newPvtRegionIdx )

inline

Set the index of the fluid region.

This determines which tables are used to compute the quantities that are computed on the fly.

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::assign().

◆ setRs()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

void Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::setRs ( const Scalar & newRs )

inline

Set the gas dissolution factor [m^3/m^3] of the oil phase.

This quantity is very specific to the black-oil model.

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::assign().

◆ setRv()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

void Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::setRv ( const Scalar & newRv )

inline

Set the oil vaporization factor [m^3/m^3] of the gas phase.

This quantity is very specific to the black-oil model.

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::assign().

◆ setRvw()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

void Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::setRvw ( const Scalar & newRvw )

inline

Set the water vaporization factor [m^3/m^3] of the gas phase.

This quantity is very specific to the black-oil model.

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::assign().

◆ setSaltConcentration()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

void Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::setSaltConcentration ( const Scalar & newSaltConcentration )

inline

Set the salt concentration.

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::assign().

◆ setSaltSaturation()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

void Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::setSaltSaturation ( const Scalar & newSaltSaturation )

inline

Set the solid salt saturation.

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::assign().

◆ setSaturation()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

void Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::setSaturation	(	unsigned	phaseIdx,
		const Scalar &	S
	)

inline

Set the saturation of a fluid phase [-].

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::assign().

◆ setTemperature()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

void Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::setTemperature ( const Scalar & value )

inline

Set the temperature [K].

If neither the enableTemperature nor the enableEnergy template arguments are set to true, this method will throw an exception!

Referenced by Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::assign().

◆ setTotalSaturation()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

void Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::setTotalSaturation ( const Scalar & value )

inline

Set the total saturation used for sequential methods.

◆ temperature()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

const Scalar & Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::temperature ( unsigned ) const

inline

Return the temperature [K].

◆ totalSaturation()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

const Scalar & Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::totalSaturation ( ) const

inline

Return the total saturation needed for sequential.

◆ viscosity()

template<class ScalarT , class FluidSystem , bool enableTemperature = false, bool enableEnergy = false, bool enableDissolution = true, bool enableEvaporation = false, bool enableBrine = false, bool enableSaltPrecipitation = false, unsigned numStoragePhases = FluidSystem::numPhases>

Scalar Opm::BlackOilFluidState< ScalarT, FluidSystem, enableTemperature, enableEnergy, enableDissolution, enableEvaporation, enableBrine, enableSaltPrecipitation, numStoragePhases >::viscosity ( unsigned phaseIdx ) const

inline

Return the dynamic viscosity of a fluid phase [Pa s].

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

BlackOilFluidState.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ Scalar

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Member Function Documentation

◆ assign()

◆ averageMolarMass()

◆ checkDefined()

◆ density()

◆ enthalpy()

◆ fugacity()

◆ fugacityCoefficient()

◆ internalEnergy()

◆ invB()

◆ massFraction()

◆ molarDensity()

◆ molarity()

◆ molarVolume()

◆ moleFraction()

◆ pc()

◆ pressure()

◆ pvtRegionIndex()

◆ Rs()

◆ Rv()

◆ Rvw()

◆ saltConcentration()

◆ saltSaturation()

◆ saturation()

◆ setDensity()

◆ setEnthalpy()

◆ setInvB()

◆ setPc()

◆ setPressure()

◆ setPvtRegionIndex()

◆ setRs()

◆ setRv()

◆ setRvw()

◆ setSaltConcentration()

◆ setSaltSaturation()

◆ setSaturation()

◆ setTemperature()

◆ setTotalSaturation()

◆ temperature()

◆ totalSaturation()

◆ viscosity()