A fluid system for single phase models. More...

#include <SinglePhaseFluidSystem.hpp>

Inheritance diagram for Opm::SinglePhaseFluidSystem< Scalar, Fluid >:

Classes
struct	ParameterCache
	The type of the fluid system's parameter cache. More...

Public Types
typedef Scalar	Scalar
	The type used for scalar quantities. More...

Static Public Member Functions
static const char *	phaseName (unsigned phaseIdx)
	Return the human readable name of a fluid phase. More...

static bool	isLiquid (unsigned)
	Return whether a phase is liquid. More...

static bool	isCompressible (unsigned)
	Returns true if and only if a fluid phase is assumed to be compressible. More...

static bool	isIdealMixture (unsigned)
	Returns true if and only if a fluid phase is assumed to be an ideal gas. More...

static bool	isIdealGas (unsigned)
	Returns true if and only if a fluid phase is assumed to be an ideal mixture. More...

static const char *	componentName (unsigned compIdx)
	Return the human readable name of a component. More...

static Scalar	molarMass (unsigned)
	Return the molar mass of a component in [kg/mol]. More...

static Scalar	criticalTemperature (unsigned)
	Critical temperature of a component [K]. More...

static Scalar	criticalPressure (unsigned)
	Critical pressure of a component [Pa]. More...

static Scalar	acentricFactor (unsigned)
	The acentric factor of a component []. More...

static void	init ()
	Initialize the fluid system's static parameters. More...

template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>
static LhsEval	density (const FluidState &fluidState, const ParameterCache< ParamCacheEval > &, unsigned phaseIdx)
	Calculate the density [kg/m^3] of a fluid phase. More...

template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>
static LhsEval	viscosity (const FluidState &fluidState, const ParameterCache< ParamCacheEval > &, unsigned phaseIdx)
	Calculate the dynamic viscosity of a fluid phase [Pa*s]. More...

template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>
static LhsEval	fugacityCoefficient (const FluidState &, const ParameterCache< ParamCacheEval > &, unsigned phaseIdx, unsigned compIdx)
	Calculate the fugacity coefficient [Pa] of an individual component in a fluid phase. More...

template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>
static LhsEval	enthalpy (const FluidState &fluidState, const ParameterCache< ParamCacheEval > &, unsigned phaseIdx)
	Given a phase's composition, temperature, pressure and density, calculate its specific enthalpy [J/kg]. More...

template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>
static LhsEval	thermalConductivity (const FluidState &fluidState, const ParameterCache< ParamCacheEval > &, unsigned phaseIdx)
	Thermal conductivity of a fluid phase [W/(m K)]. More...

template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>
static LhsEval	heatCapacity (const FluidState &fluidState, const ParameterCache< ParamCacheEval > &, unsigned phaseIdx)
	Specific isobaric heat capacity of a fluid phase [J/kg]. More...

static LhsEval	density (const FluidState &, const ParamCache &, unsigned)
	Calculate the density [kg/m^3] of a fluid phase. More...

static LhsEval	fugacityCoefficient (const FluidState &, ParamCache &, unsigned, unsigned)
	Calculate the fugacity coefficient [Pa] of an individual component in a fluid phase. More...

static LhsEval	viscosity (const FluidState &, ParamCache &, unsigned)
	Calculate the dynamic viscosity of a fluid phase [Pa*s]. More...

static LhsEval	diffusionCoefficient (const FluidState &, ParamCache &, unsigned, unsigned)
	Calculate the binary molecular diffusion coefficient for a component in a fluid phase [mol^2 * s / (kg*m^3)]. More...

static LhsEval	enthalpy (const FluidState &, ParamCache &, unsigned)
	Given a phase's composition, temperature, pressure and density, calculate its specific enthalpy [J/kg]. More...

static LhsEval	thermalConductivity (const FluidState &, ParamCache &, unsigned)
	Thermal conductivity of a fluid phase [W/(m K)]. More...

static LhsEval	heatCapacity (const FluidState &, ParamCache &, unsigned)
	Specific isobaric heat capacity of a fluid phase [J/kg]. More...

static unsigned	phaseIsActive (unsigned)
	Returns whether a fluid phase is active. More...

Static Public Attributes
static const int	numPhases = 1
	Number of fluid phases in the fluid system. More...

static const int	numComponents = 1
	Number of chemical species in the fluid system. More...

Detailed Description

template<class Scalar, class Fluid>
class Opm::SinglePhaseFluidSystem< Scalar, Fluid >

A fluid system for single phase models.

The fluid is defined as a template parameter. For existing components the Opm::LiquidPhase<Component> and Opm::GasPhase<Component> may be used.

Member Typedef Documentation

◆ Scalar

typedef Scalar Opm::BaseFluidSystem< Scalar , SinglePhaseFluidSystem< Scalar, Fluid > >::Scalar

inherited

The type used for scalar quantities.

Member Function Documentation

◆ acentricFactor()

template<class Scalar , class Fluid >

static Scalar Opm::SinglePhaseFluidSystem< Scalar, Fluid >::acentricFactor ( unsigned )

inlinestatic

The acentric factor of a component [].

Parameters

compIdx The index of the component to consider

◆ componentName()

template<class Scalar , class Fluid >

static const char * Opm::SinglePhaseFluidSystem< Scalar, Fluid >::componentName ( unsigned compIdx )

inlinestatic

Return the human readable name of a component.

References Opm::SinglePhaseFluidSystem< Scalar, Fluid >::numComponents.

◆ criticalPressure()

template<class Scalar , class Fluid >

static Scalar Opm::SinglePhaseFluidSystem< Scalar, Fluid >::criticalPressure ( unsigned )

inlinestatic

Critical pressure of a component [Pa].

Parameters

compIdx The index of the component to consider

◆ criticalTemperature()

template<class Scalar , class Fluid >

static Scalar Opm::SinglePhaseFluidSystem< Scalar, Fluid >::criticalTemperature ( unsigned )

inlinestatic

Critical temperature of a component [K].

Parameters

compIdx The index of the component to consider

◆ density() [1/2]

static LhsEval Opm::BaseFluidSystem< Scalar , SinglePhaseFluidSystem< Scalar, Fluid > >::density	(	const FluidState &	,
		const ParamCache &	,
		unsigned
	)

inlinestaticinherited

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

◆ density() [2/2]

template<class Scalar , class Fluid >

template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>

static LhsEval Opm::SinglePhaseFluidSystem< Scalar, Fluid >::density	(	const FluidState &	fluidState,
		const ParameterCache< ParamCacheEval > &	,
		unsigned	phaseIdx
	)

inlinestatic

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

References Opm::SinglePhaseFluidSystem< Scalar, Fluid >::numPhases.

◆ diffusionCoefficient()

static LhsEval Opm::BaseFluidSystem< Scalar , SinglePhaseFluidSystem< Scalar, Fluid > >::diffusionCoefficient	(	const FluidState &	,
		ParamCache &	,
		unsigned	,
		unsigned
	)

inlinestaticinherited

Calculate the binary molecular diffusion coefficient for a component in a fluid phase [mol^2 * s / (kg*m^3)].

Molecular diffusion of a compoent $\kappa$ is caused by a gradient of the mole fraction and follows the law

$J = - D \mathbf{grad} x^\kappa_\alpha$

where $x_\alpha^\kappa$ is the component's mole fraction in phase $\alpha$ , $D$ is the diffusion coefficient and $J$ is the diffusive flux.

◆ enthalpy() [1/2]

static LhsEval Opm::BaseFluidSystem< Scalar , SinglePhaseFluidSystem< Scalar, Fluid > >::enthalpy	(	const FluidState &	,
		ParamCache &	,
		unsigned
	)

inlinestaticinherited

Given a phase's composition, temperature, pressure and density, calculate its specific enthalpy [J/kg].

◆ enthalpy() [2/2]

template<class Scalar , class Fluid >

template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>

static LhsEval Opm::SinglePhaseFluidSystem< Scalar, Fluid >::enthalpy	(	const FluidState &	fluidState,
		const ParameterCache< ParamCacheEval > &	,
		unsigned	phaseIdx
	)

inlinestatic

Given a phase's composition, temperature, pressure and density, calculate its specific enthalpy [J/kg].

References Opm::SinglePhaseFluidSystem< Scalar, Fluid >::numPhases.

◆ fugacityCoefficient() [1/2]

template<class Scalar , class Fluid >

template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>

static LhsEval Opm::SinglePhaseFluidSystem< Scalar, Fluid >::fugacityCoefficient	(	const FluidState &	,
		const ParameterCache< ParamCacheEval > &	,
		unsigned	phaseIdx,
		unsigned	compIdx
	)

inlinestatic

Calculate the fugacity coefficient [Pa] of an individual component in a fluid phase.

The fugacity coefficient $\phi_\kappa$ is connected to the fugacity $f_\kappa$ and the component's molarity $x_\kappa$ by means of the relation

$f_\kappa = \phi_\kappa\,x_{\kappa}$

References Opm::SinglePhaseFluidSystem< Scalar, Fluid >::numComponents, and Opm::SinglePhaseFluidSystem< Scalar, Fluid >::numPhases.

◆ fugacityCoefficient() [2/2]

static LhsEval Opm::BaseFluidSystem< Scalar , SinglePhaseFluidSystem< Scalar, Fluid > >::fugacityCoefficient	(	const FluidState &	,
		ParamCache &	,
		unsigned	,
		unsigned
	)

inlinestaticinherited

Calculate the fugacity coefficient [Pa] of an individual component in a fluid phase.

The fugacity coefficient $\phi_\kappa$ is connected to the fugacity $f_\kappa$ and the component's molarity $x_\kappa$ by means of the relation

$f_\kappa = \phi_\kappa\,x_{\kappa}$

◆ heatCapacity() [1/2]

static LhsEval Opm::BaseFluidSystem< Scalar , SinglePhaseFluidSystem< Scalar, Fluid > >::heatCapacity	(	const FluidState &	,
		ParamCache &	,
		unsigned
	)

inlinestaticinherited

Specific isobaric heat capacity of a fluid phase [J/kg].

◆ heatCapacity() [2/2]

template<class Scalar , class Fluid >

template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>

static LhsEval Opm::SinglePhaseFluidSystem< Scalar, Fluid >::heatCapacity	(	const FluidState &	fluidState,
		const ParameterCache< ParamCacheEval > &	,
		unsigned	phaseIdx
	)

inlinestatic

Specific isobaric heat capacity of a fluid phase [J/kg].

References Opm::SinglePhaseFluidSystem< Scalar, Fluid >::numPhases.

◆ init()

template<class Scalar , class Fluid >

static void Opm::SinglePhaseFluidSystem< Scalar, Fluid >::init ( )

inlinestatic

Initialize the fluid system's static parameters.

◆ isCompressible()

template<class Scalar , class Fluid >

static bool Opm::SinglePhaseFluidSystem< Scalar, Fluid >::isCompressible ( unsigned )

inlinestatic

Returns true if and only if a fluid phase is assumed to be compressible.

Compressible means that the partial derivative of the density to the fluid pressure is always larger than zero.

◆ isIdealGas()

template<class Scalar , class Fluid >

static bool Opm::SinglePhaseFluidSystem< Scalar, Fluid >::isIdealGas ( unsigned )

inlinestatic

Returns true if and only if a fluid phase is assumed to be an ideal mixture.

We define an ideal mixture as a fluid phase where the fugacity coefficients of all components times the pressure of the phase are independent on the fluid composition. This assumption is true if Henry's law and Rault's law apply. If you are unsure what this function should return, it is safe to return false. The only damage done will be (slightly) increased computation times in some cases.

◆ isIdealMixture()

template<class Scalar , class Fluid >

static bool Opm::SinglePhaseFluidSystem< Scalar, Fluid >::isIdealMixture ( unsigned )

inlinestatic

Returns true if and only if a fluid phase is assumed to be an ideal gas.

◆ isLiquid()

template<class Scalar , class Fluid >

static bool Opm::SinglePhaseFluidSystem< Scalar, Fluid >::isLiquid ( unsigned )

inlinestatic

Return whether a phase is liquid.

◆ molarMass()

template<class Scalar , class Fluid >

static Scalar Opm::SinglePhaseFluidSystem< Scalar, Fluid >::molarMass ( unsigned )

inlinestatic

Return the molar mass of a component in [kg/mol].

◆ phaseIsActive()

static unsigned Opm::BaseFluidSystem< Scalar , SinglePhaseFluidSystem< Scalar, Fluid > >::phaseIsActive ( unsigned )

inlinestaticinherited

Returns whether a fluid phase is active.

◆ phaseName()

template<class Scalar , class Fluid >

static const char * Opm::SinglePhaseFluidSystem< Scalar, Fluid >::phaseName ( unsigned phaseIdx )

inlinestatic

Return the human readable name of a fluid phase.

References Opm::SinglePhaseFluidSystem< Scalar, Fluid >::numPhases.

◆ thermalConductivity() [1/2]

static LhsEval Opm::BaseFluidSystem< Scalar , SinglePhaseFluidSystem< Scalar, Fluid > >::thermalConductivity	(	const FluidState &	,
		ParamCache &	,
		unsigned
	)

inlinestaticinherited

Thermal conductivity of a fluid phase [W/(m K)].

◆ thermalConductivity() [2/2]

template<class Scalar , class Fluid >

template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>

static LhsEval Opm::SinglePhaseFluidSystem< Scalar, Fluid >::thermalConductivity	(	const FluidState &	fluidState,
		const ParameterCache< ParamCacheEval > &	,
		unsigned	phaseIdx
	)

inlinestatic

Thermal conductivity of a fluid phase [W/(m K)].

References Opm::SinglePhaseFluidSystem< Scalar, Fluid >::numPhases.

◆ viscosity() [1/2]

static LhsEval Opm::BaseFluidSystem< Scalar , SinglePhaseFluidSystem< Scalar, Fluid > >::viscosity	(	const FluidState &	,
		ParamCache &	,
		unsigned
	)

inlinestaticinherited

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

◆ viscosity() [2/2]

template<class Scalar , class Fluid >

template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>

static LhsEval Opm::SinglePhaseFluidSystem< Scalar, Fluid >::viscosity	(	const FluidState &	fluidState,
		const ParameterCache< ParamCacheEval > &	,
		unsigned	phaseIdx
	)

inlinestatic

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

References Opm::SinglePhaseFluidSystem< Scalar, Fluid >::numPhases.

Member Data Documentation

◆ numComponents

template<class Scalar , class Fluid >

const int Opm::SinglePhaseFluidSystem< Scalar, Fluid >::numComponents = 1

static

Number of chemical species in the fluid system.

Referenced by Opm::SinglePhaseFluidSystem< Scalar, Fluid >::componentName(), and Opm::SinglePhaseFluidSystem< Scalar, Fluid >::fugacityCoefficient().

◆ numPhases

template<class Scalar , class Fluid >

const int Opm::SinglePhaseFluidSystem< Scalar, Fluid >::numPhases = 1

static

Number of fluid phases in the fluid system.

Referenced by Opm::SinglePhaseFluidSystem< Scalar, Fluid >::density(), Opm::SinglePhaseFluidSystem< Scalar, Fluid >::enthalpy(), Opm::SinglePhaseFluidSystem< Scalar, Fluid >::fugacityCoefficient(), Opm::SinglePhaseFluidSystem< Scalar, Fluid >::heatCapacity(), Opm::SinglePhaseFluidSystem< Scalar, Fluid >::phaseName(), Opm::SinglePhaseFluidSystem< Scalar, Fluid >::thermalConductivity(), and Opm::SinglePhaseFluidSystem< Scalar, Fluid >::viscosity().

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

SinglePhaseFluidSystem.hpp

Classes

Public Types

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ Scalar

Member Function Documentation

◆ acentricFactor()

◆ componentName()

◆ criticalPressure()

◆ criticalTemperature()

◆ density() [1/2]

◆ density() [2/2]

◆ diffusionCoefficient()

◆ enthalpy() [1/2]

◆ enthalpy() [2/2]

◆ fugacityCoefficient() [1/2]

◆ fugacityCoefficient() [2/2]

◆ heatCapacity() [1/2]

◆ heatCapacity() [2/2]

◆ init()

◆ isCompressible()

◆ isIdealGas()

◆ isIdealMixture()

◆ isLiquid()

◆ molarMass()

◆ phaseIsActive()

◆ phaseName()

◆ thermalConductivity() [1/2]

◆ thermalConductivity() [2/2]

◆ viscosity() [1/2]

◆ viscosity() [2/2]

Member Data Documentation

◆ numComponents

◆ numPhases