Abstract base class of a pure chemical species. More...

#include <Component.hpp>

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

Public Types
typedef ScalarT	Scalar

Static Public Member Functions
static void	init (Scalar, Scalar, unsigned, Scalar, Scalar, unsigned)
	A default routine for initialization, not needed for components and must not be called. More...

static bool	gasIsCompressible ()
	Returns true iff the gas phase is assumed to be compressible. More...

static bool	gasIsIdeal ()
	Returns true iff the gas phase is assumed to be ideal. More...

static bool	liquidIsCompressible ()
	Returns true iff the liquid phase is assumed to be compressible. More...

static const char *	name ()
	A human readable name for the component. More...

static Scalar	molarMass ()
	The molar mass in $\mathrm{[kg]}$ of the component. More...

static Scalar	criticalTemperature ()
	Returns the critical temperature in $\mathrm{[K]}$ of the component. More...

static Scalar	criticalPressure ()
	Returns the critical pressure in $\mathrm{[Pa]}$ of the component. More...

static Scalar	acentricFactor ()
	Returns the acentric factor of the component. More...

static Scalar	criticalVolume ()
	Returns the critical volume in $\mathrm{[m2/kmol]}$ of the component. More...

static Scalar	tripleTemperature ()
	Returns the temperature in $\mathrm{[K]}$ at the component's triple point. More...

static Scalar	triplePressure ()
	Returns the pressure in $\mathrm{[Pa]}$ at the component's triple point. More...

template<class Evaluation >
static Evaluation	vaporPressure (const Evaluation &)
	The vapor pressure in $\mathrm{[Pa]}$ of the component at a given temperature in $\mathrm{[K]}$ . More...

template<class Evaluation >
static Evaluation	gasDensity (const Evaluation &, const Evaluation &)
	The density in $\mathrm{[kg/m^3]}$ of the component at a given pressure in $\mathrm{[Pa]}$ and temperature in $\mathrm{[K]}$ . More...

template<class Evaluation >
static Evaluation	liquidDensity (const Evaluation &, const Evaluation &)
	The density $\mathrm{[kg/m^3]}$ of the liquid component at a given pressure in $\mathrm{[Pa]}$ and temperature in $\mathrm{[K]}$ . More...

template<class Evaluation >
static Evaluation	gasEnthalpy (const Evaluation &, const Evaluation &)
	Specific enthalpy $\mathrm{[J/kg]}$ of the pure component in gas. More...

template<class Evaluation >
static Evaluation	liquidEnthalpy (const Evaluation &, const Evaluation &)
	Specific enthalpy $\mathrm{[J/kg]}$ of the pure component in liquid. More...

template<class Evaluation >
static Evaluation	gasInternalEnergy (const Evaluation &, const Evaluation &)
	Specific internal energy $\mathrm{[J/kg]}$ of the pure component in gas. More...

template<class Evaluation >
static Evaluation	liquidInternalEnergy (const Evaluation &, const Evaluation &)
	Specific internal energy $\mathrm{[J/kg]}$ of pure the pure component in liquid. More...

template<class Evaluation >
static Evaluation	gasViscosity (const Evaluation &, const Evaluation &)
	The dynamic viscosity $\mathrm{[Pa*s]}$ of the pure component at a given pressure in $\mathrm{[Pa]}$ and temperature in $\mathrm{[K]}$ . More...

template<class Evaluation >
static Evaluation	liquidViscosity (const Evaluation &, const Evaluation &)
	The dynamic liquid viscosity $\mathrm{[Pa*s]}$ of the pure component. More...

template<class Evaluation >
static Evaluation	gasThermalConductivity (const Evaluation &, const Evaluation &)
	Thermal conductivity of the component [W/(m^2 K/m)] as a gas. More...

template<class Evaluation >
static Evaluation	liquidThermalConductivity (const Evaluation &, const Evaluation &)
	Thermal conductivity of the component [W/(m^2 K/m)] as a liquid. More...

template<class Evaluation >
static Evaluation	gasHeatCapacity (const Evaluation &, const Evaluation &)
	Specific isobaric heat capacity of the component [J/kg] as a gas. More...

template<class Evaluation >
static Evaluation	liquidHeatCapacity (const Evaluation &, const Evaluation &)
	Specific isobaric heat capacity of the component [J/kg] as a liquid. More...

Static Public Attributes
static const bool	isTabulated = false

Detailed Description

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

Abstract base class of a pure chemical species.

Template Parameters

ScalarT	The type used for scalar values
Implementation	Necessary for static polymorphism

Member Typedef Documentation

◆ Scalar

template<class ScalarT , class Implementation >

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

Member Function Documentation

◆ acentricFactor()

template<class ScalarT , class Implementation >

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

inlinestatic

Returns the acentric factor of the component.

Referenced by Opm::PengRobinson< Scalar >::ambroseWalton_().

◆ criticalPressure()

template<class ScalarT , class Implementation >

static Scalar Opm::Component< ScalarT, Implementation >::criticalPressure ( )

inlinestatic

Returns the critical pressure in $\mathrm{[Pa]}$ of the component.

Referenced by Opm::PengRobinson< Scalar >::ambroseWalton_(), Opm::PengRobinson< Scalar >::computeVaporPressure(), Opm::GasPhase< Scalar, ComponentT >::criticalPressure(), and Opm::LiquidPhase< Scalar, ComponentT >::criticalPressure().

◆ criticalTemperature()

template<class ScalarT , class Implementation >

static Scalar Opm::Component< ScalarT, Implementation >::criticalTemperature ( )

inlinestatic

Returns the critical temperature in $\mathrm{[K]}$ of the component.

Referenced by Opm::PengRobinson< Scalar >::ambroseWalton_(), Opm::PengRobinson< Scalar >::computeVaporPressure(), Opm::GasPhase< Scalar, ComponentT >::criticalTemperature(), and Opm::LiquidPhase< Scalar, ComponentT >::criticalTemperature().

◆ criticalVolume()

template<class ScalarT , class Implementation >

static Scalar Opm::Component< ScalarT, Implementation >::criticalVolume ( )

inlinestatic

Returns the critical volume in $\mathrm{[m2/kmol]}$ of the component.

◆ gasDensity()

template<class ScalarT , class Implementation >

template<class Evaluation >

static Evaluation Opm::Component< ScalarT, Implementation >::gasDensity	(	const Evaluation &	,
		const Evaluation &
	)

inlinestatic

The density in $\mathrm{[kg/m^3]}$ of the component at a given pressure in $\mathrm{[Pa]}$ and temperature in $\mathrm{[K]}$ .

Parameters

temperature	temperature of component in $\mathrm{[K]}$
pressure	pressure of component in $\mathrm{[Pa]}$

Referenced by Opm::GasPhase< Scalar, ComponentT >::density().

◆ gasEnthalpy()

template<class ScalarT , class Implementation >

template<class Evaluation >

static Evaluation Opm::Component< ScalarT, Implementation >::gasEnthalpy	(	const Evaluation &	,
		const Evaluation &
	)

inlinestatic

Specific enthalpy $\mathrm{[J/kg]}$ of the pure component in gas.

Parameters

temperature	temperature of component in $\mathrm{[K]}$
pressure	pressure of component in $\mathrm{[Pa]}$

Referenced by Opm::GasPhase< Scalar, ComponentT >::enthalpy().

◆ gasHeatCapacity()

template<class ScalarT , class Implementation >

template<class Evaluation >

static Evaluation Opm::Component< ScalarT, Implementation >::gasHeatCapacity	(	const Evaluation &	,
		const Evaluation &
	)

inlinestatic

Specific isobaric heat capacity of the component [J/kg] as a gas.

Referenced by Opm::GasPhase< Scalar, ComponentT >::heatCapacity().

◆ gasInternalEnergy()

template<class ScalarT , class Implementation >

template<class Evaluation >

static Evaluation Opm::Component< ScalarT, Implementation >::gasInternalEnergy	(	const Evaluation &	,
		const Evaluation &
	)

inlinestatic

Specific internal energy $\mathrm{[J/kg]}$ of the pure component in gas.

Parameters

temperature	temperature of component in $\mathrm{[K]}$
pressure	pressure of component in $\mathrm{[Pa]}$

Referenced by Opm::GasPhase< Scalar, ComponentT >::internalEnergy().

◆ gasIsCompressible()

template<class ScalarT , class Implementation >

static bool Opm::Component< ScalarT, Implementation >::gasIsCompressible ( )

inlinestatic

Returns true iff the gas phase is assumed to be compressible.

Referenced by Opm::GasPhase< Scalar, ComponentT >::isCompressible().

◆ gasIsIdeal()

template<class ScalarT , class Implementation >

static bool Opm::Component< ScalarT, Implementation >::gasIsIdeal ( )

inlinestatic

Returns true iff the gas phase is assumed to be ideal.

Referenced by Opm::GasPhase< Scalar, ComponentT >::isIdealGas().

◆ gasThermalConductivity()

template<class ScalarT , class Implementation >

template<class Evaluation >

static Evaluation Opm::Component< ScalarT, Implementation >::gasThermalConductivity	(	const Evaluation &	,
		const Evaluation &
	)

inlinestatic

Thermal conductivity of the component [W/(m^2 K/m)] as a gas.

Referenced by Opm::GasPhase< Scalar, ComponentT >::thermalConductivity().

◆ gasViscosity()

template<class ScalarT , class Implementation >

template<class Evaluation >

static Evaluation Opm::Component< ScalarT, Implementation >::gasViscosity	(	const Evaluation &	,
		const Evaluation &
	)

inlinestatic

The dynamic viscosity $\mathrm{[Pa*s]}$ of the pure component at a given pressure in $\mathrm{[Pa]}$ and temperature in $\mathrm{[K]}$ .

Parameters

temperature	temperature of component in $\mathrm{[K]}$
pressure	pressure of component in $\mathrm{[Pa]}$

Referenced by Opm::GasPhase< Scalar, ComponentT >::viscosity().

◆ init()

template<class ScalarT , class Implementation >

static void Opm::Component< ScalarT, Implementation >::init	(	Scalar	,
		Scalar	,
		unsigned	,
		Scalar	,
		Scalar	,
		unsigned
	)

inlinestatic

A default routine for initialization, not needed for components and must not be called.

Parameters

tempMin	The minimum of the temperature range in $\mathrm{[K]}$
tempMax	The maximum of the temperature range in $\mathrm{[K]}$
nTemp	The number of entries/steps within the temperature range
pressMin	The minimum of the pressure range in $\mathrm{[Pa]}$
pressMax	The maximum of the pressure range in $\mathrm{[Pa]}$
nPress	The number of entries/steps within the pressure range

This function throws a warning when called: "No init routine defined - make sure that this is not necessary!"

◆ liquidDensity()

template<class ScalarT , class Implementation >

template<class Evaluation >

static Evaluation Opm::Component< ScalarT, Implementation >::liquidDensity	(	const Evaluation &	,
		const Evaluation &
	)

inlinestatic

The density $\mathrm{[kg/m^3]}$ of the liquid component at a given pressure in $\mathrm{[Pa]}$ and temperature in $\mathrm{[K]}$ .

Parameters

temperature	temperature of component in $\mathrm{[K]}$
pressure	pressure of component in $\mathrm{[Pa]}$

Referenced by Opm::LiquidPhase< Scalar, ComponentT >::density().

◆ liquidEnthalpy()

template<class ScalarT , class Implementation >

template<class Evaluation >

static Evaluation Opm::Component< ScalarT, Implementation >::liquidEnthalpy	(	const Evaluation &	,
		const Evaluation &
	)

inlinestatic

Specific enthalpy $\mathrm{[J/kg]}$ of the pure component in liquid.

Parameters

temperature	temperature of component in $\mathrm{[K]}$
pressure	pressure of component in $\mathrm{[Pa]}$

Referenced by Opm::LiquidPhase< Scalar, ComponentT >::enthalpy().

◆ liquidHeatCapacity()

template<class ScalarT , class Implementation >

template<class Evaluation >

static Evaluation Opm::Component< ScalarT, Implementation >::liquidHeatCapacity	(	const Evaluation &	,
		const Evaluation &
	)

inlinestatic

Specific isobaric heat capacity of the component [J/kg] as a liquid.

Referenced by Opm::LiquidPhase< Scalar, ComponentT >::heatCapacity().

◆ liquidInternalEnergy()

template<class ScalarT , class Implementation >

template<class Evaluation >

static Evaluation Opm::Component< ScalarT, Implementation >::liquidInternalEnergy	(	const Evaluation &	,
		const Evaluation &
	)

inlinestatic

Specific internal energy $\mathrm{[J/kg]}$ of pure the pure component in liquid.

Parameters

temperature	temperature of component in $\mathrm{[K]}$
pressure	pressure of component in $\mathrm{[Pa]}$

Referenced by Opm::LiquidPhase< Scalar, ComponentT >::internalEnergy().

◆ liquidIsCompressible()

template<class ScalarT , class Implementation >

static bool Opm::Component< ScalarT, Implementation >::liquidIsCompressible ( )

inlinestatic

Returns true iff the liquid phase is assumed to be compressible.

Referenced by Opm::LiquidPhase< Scalar, ComponentT >::isCompressible().

◆ liquidThermalConductivity()

template<class ScalarT , class Implementation >

template<class Evaluation >

static Evaluation Opm::Component< ScalarT, Implementation >::liquidThermalConductivity	(	const Evaluation &	,
		const Evaluation &
	)

inlinestatic

Thermal conductivity of the component [W/(m^2 K/m)] as a liquid.

Referenced by Opm::LiquidPhase< Scalar, ComponentT >::thermalConductivity().

◆ liquidViscosity()

template<class ScalarT , class Implementation >

template<class Evaluation >

static Evaluation Opm::Component< ScalarT, Implementation >::liquidViscosity	(	const Evaluation &	,
		const Evaluation &
	)

inlinestatic

The dynamic liquid viscosity $\mathrm{[Pa*s]}$ of the pure component.

Parameters

temperature	temperature of component in $\mathrm{[K]}$
pressure	pressure of component in $\mathrm{[Pa]}$

Referenced by Opm::LiquidPhase< Scalar, ComponentT >::viscosity().

◆ molarMass()

template<class ScalarT , class Implementation >

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

inlinestatic

The molar mass in $\mathrm{[kg]}$ of the component.

Referenced by Opm::GasPhase< Scalar, ComponentT >::molarMass(), and Opm::LiquidPhase< Scalar, ComponentT >::molarMass().

◆ name()

template<class ScalarT , class Implementation >

static const char * Opm::Component< ScalarT, Implementation >::name ( )

inlinestatic

A human readable name for the component.

Referenced by Opm::GasPhase< Scalar, ComponentT >::name(), and Opm::LiquidPhase< Scalar, ComponentT >::name().

◆ triplePressure()

template<class ScalarT , class Implementation >

static Scalar Opm::Component< ScalarT, Implementation >::triplePressure ( )

inlinestatic

Returns the pressure in $\mathrm{[Pa]}$ at the component's triple point.

Referenced by Opm::GasPhase< Scalar, ComponentT >::triplePressure(), and Opm::LiquidPhase< Scalar, ComponentT >::triplePressure().

◆ tripleTemperature()

template<class ScalarT , class Implementation >

static Scalar Opm::Component< ScalarT, Implementation >::tripleTemperature ( )

inlinestatic

Returns the temperature in $\mathrm{[K]}$ at the component's triple point.

Referenced by Opm::GasPhase< Scalar, ComponentT >::tripleTemperature(), and Opm::LiquidPhase< Scalar, ComponentT >::tripleTemperature().

◆ vaporPressure()

template<class ScalarT , class Implementation >

template<class Evaluation >

static Evaluation Opm::Component< ScalarT, Implementation >::vaporPressure ( const Evaluation & )

inlinestatic

The vapor pressure in $\mathrm{[Pa]}$ of the component at a given temperature in $\mathrm{[K]}$ .

Parameters

temperature temperature of the component in $\mathrm{[K]}$

Referenced by Opm::GasPhase< Scalar, ComponentT >::vaporPressure(), and Opm::LiquidPhase< Scalar, ComponentT >::vaporPressure().

Member Data Documentation

◆ isTabulated

template<class ScalarT , class Implementation >

const bool Opm::Component< ScalarT, Implementation >::isTabulated = false

static

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

Component.hpp

Public Types

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ Scalar

Member Function Documentation

◆ acentricFactor()

◆ criticalPressure()

◆ criticalTemperature()

◆ criticalVolume()

◆ gasDensity()

◆ gasEnthalpy()

◆ gasHeatCapacity()

◆ gasInternalEnergy()

◆ gasIsCompressible()

◆ gasIsIdeal()

◆ gasThermalConductivity()

◆ gasViscosity()

◆ init()

◆ liquidDensity()

◆ liquidEnthalpy()

◆ liquidHeatCapacity()

◆ liquidInternalEnergy()

◆ liquidIsCompressible()

◆ liquidThermalConductivity()

◆ liquidViscosity()

◆ molarMass()

◆ name()

◆ triplePressure()

◆ tripleTemperature()

◆ vaporPressure()

Member Data Documentation

◆ isTabulated