The base class for all fluid systems. More...

#include <BaseFluidSystem.hpp>

Inheritance diagram for Opm::BaseFluidSystem< ScalarT, Implementation >:

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

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

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

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

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

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

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

static const char *	componentName (unsigned)
	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	acentricFactor (unsigned)
	Return the acetntric 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 ParamCache >
static LhsEval	density (const FluidState &, const ParamCache &, unsigned)
	Calculate the density [kg/m^3] of a fluid phase. More...

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

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

template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCache >
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...

template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCache >
static LhsEval	enthalpy (const FluidState &, ParamCache &, unsigned)
	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 ParamCache >
static LhsEval	thermalConductivity (const FluidState &, ParamCache &, unsigned)
	Thermal conductivity of a fluid phase [W/(m K)]. More...

template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCache >
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	numComponents = -1000
	Number of chemical species in the fluid system. More...

static const int	numPhases = -2000
	Number of fluid phases in the fluid system. More...

Detailed Description

template<class ScalarT, class Implementation>
class Opm::BaseFluidSystem< ScalarT, Implementation >

The base class for all fluid systems.

Member Typedef Documentation

◆ Scalar

template<class ScalarT , class Implementation >

typedef ScalarT Opm::BaseFluidSystem< ScalarT, Implementation >::Scalar

The type used for scalar quantities.

Member Function Documentation

◆ acentricFactor()

template<class ScalarT , class Implementation >

static Scalar Opm::BaseFluidSystem< ScalarT, Implementation >::acentricFactor ( unsigned )

inlinestatic

Return the acetntric factor of a component.

◆ componentName()

template<class ScalarT , class Implementation >

static const char * Opm::BaseFluidSystem< ScalarT, Implementation >::componentName ( unsigned )

inlinestatic

Return the human readable name of a component.

◆ density()

template<class ScalarT , class Implementation >

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

static LhsEval Opm::BaseFluidSystem< ScalarT, Implementation >::density	(	const FluidState &	,
		const ParamCache &	,
		unsigned
	)

inlinestatic

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

◆ diffusionCoefficient()

template<class ScalarT , class Implementation >

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

static LhsEval Opm::BaseFluidSystem< ScalarT, Implementation >::diffusionCoefficient	(	const FluidState &	,
		ParamCache &	,
		unsigned	,
		unsigned
	)

inlinestatic

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()

template<class ScalarT , class Implementation >

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

static LhsEval Opm::BaseFluidSystem< ScalarT, Implementation >::enthalpy	(	const FluidState &	,
		ParamCache &	,
		unsigned
	)

inlinestatic

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

◆ fugacityCoefficient()

template<class ScalarT , class Implementation >

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

static LhsEval Opm::BaseFluidSystem< ScalarT, Implementation >::fugacityCoefficient	(	const FluidState &	,
		ParamCache &	,
		unsigned	,
		unsigned
	)

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}$

◆ heatCapacity()

template<class ScalarT , class Implementation >

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

static LhsEval Opm::BaseFluidSystem< ScalarT, Implementation >::heatCapacity	(	const FluidState &	,
		ParamCache &	,
		unsigned
	)

inlinestatic

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

◆ init()

template<class ScalarT , class Implementation >

static void Opm::BaseFluidSystem< ScalarT, Implementation >::init ( )

inlinestatic

Initialize the fluid system's static parameters.

◆ isCompressible()

template<class ScalarT , class Implementation >

static bool Opm::BaseFluidSystem< ScalarT, Implementation >::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 ScalarT , class Implementation >

static bool Opm::BaseFluidSystem< ScalarT, Implementation >::isIdealGas ( unsigned )

inlinestatic

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

◆ isIdealMixture()

template<class ScalarT , class Implementation >

static bool Opm::BaseFluidSystem< ScalarT, Implementation >::isIdealMixture ( 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.

◆ isLiquid()

template<class ScalarT , class Implementation >

static bool Opm::BaseFluidSystem< ScalarT, Implementation >::isLiquid ( unsigned )

inlinestatic

Return whether a phase is liquid.

◆ molarMass()

template<class ScalarT , class Implementation >

static Scalar Opm::BaseFluidSystem< ScalarT, Implementation >::molarMass ( unsigned )

inlinestatic

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

◆ phaseIsActive()

template<class ScalarT , class Implementation >

static unsigned Opm::BaseFluidSystem< ScalarT, Implementation >::phaseIsActive ( unsigned )

inlinestatic

Returns whether a fluid phase is active.

◆ phaseName()

template<class ScalarT , class Implementation >

static char * Opm::BaseFluidSystem< ScalarT, Implementation >::phaseName ( unsigned )

inlinestatic

Return the human readable name of a fluid phase.

◆ thermalConductivity()

template<class ScalarT , class Implementation >

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

static LhsEval Opm::BaseFluidSystem< ScalarT, Implementation >::thermalConductivity	(	const FluidState &	,
		ParamCache &	,
		unsigned
	)

inlinestatic

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

◆ viscosity()

template<class ScalarT , class Implementation >

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

static LhsEval Opm::BaseFluidSystem< ScalarT, Implementation >::viscosity	(	const FluidState &	,
		ParamCache &	,
		unsigned
	)

inlinestatic

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

Member Data Documentation

◆ numComponents

template<class ScalarT , class Implementation >

const int Opm::BaseFluidSystem< ScalarT, Implementation >::numComponents = -1000

static

Number of chemical species in the fluid system.

◆ numPhases

template<class ScalarT , class Implementation >

const int Opm::BaseFluidSystem< ScalarT, Implementation >::numPhases = -2000

static

Number of fluid phases in the fluid system.

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

BaseFluidSystem.hpp

Classes

Public Types

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ Scalar

Member Function Documentation

◆ acentricFactor()

◆ componentName()

◆ density()

◆ diffusionCoefficient()

◆ enthalpy()

◆ fugacityCoefficient()

◆ heatCapacity()

◆ init()

◆ isCompressible()

◆ isIdealGas()

◆ isIdealMixture()

◆ isLiquid()

◆ molarMass()

◆ phaseIsActive()

◆ phaseName()

◆ thermalConductivity()

◆ viscosity()

Member Data Documentation

◆ numComponents

◆ numPhases