Public Types | Static Public Member Functions | Static Public Attributes | List of all members
Opm::Component< ScalarT, Implementation > Class Template Reference

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

#include <Component.hpp>

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

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 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
ScalarTThe type used for scalar values
ImplementationNecessary for static polymorphism

Member Typedef Documentation

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

Member Function Documentation

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::LiquidPhase< Scalar, ComponentT >::criticalPressure(), and Opm::GasPhase< Scalar, ComponentT >::criticalPressure().

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::LiquidPhase< Scalar, ComponentT >::criticalTemperature(), and Opm::GasPhase< Scalar, ComponentT >::criticalTemperature().

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
temperaturetemperature of component in $\mathrm{[K]}$
pressurepressure of component in $\mathrm{[Pa]}$

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

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
temperaturetemperature of component in $\mathrm{[K]}$
pressurepressure of component in $\mathrm{[Pa]}$

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

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

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
temperaturetemperature of component in $\mathrm{[K]}$
pressurepressure of component in $\mathrm{[Pa]}$

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

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

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

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

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
temperaturetemperature of component in $\mathrm{[K]}$
pressurepressure of component in $\mathrm{[Pa]}$

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

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
tempMinThe minimum of the temperature range in $\mathrm{[K]}$
tempMaxThe maximum of the temperature range in $\mathrm{[K]}$
nTempThe number of entries/steps within the temperature range
pressMinThe minimum of the pressure range in $\mathrm{[Pa]}$
pressMaxThe maximum of the pressure range in $\mathrm{[Pa]}$
nPressThe 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!"

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
temperaturetemperature of component in $\mathrm{[K]}$
pressurepressure of component in $\mathrm{[Pa]}$

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

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
temperaturetemperature of component in $\mathrm{[K]}$
pressurepressure of component in $\mathrm{[Pa]}$

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

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

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
temperaturetemperature of component in $\mathrm{[K]}$
pressurepressure of component in $\mathrm{[Pa]}$

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

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

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

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
temperaturetemperature of component in $\mathrm{[K]}$
pressurepressure of component in $\mathrm{[Pa]}$

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

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::LiquidPhase< Scalar, ComponentT >::molarMass(), and Opm::GasPhase< Scalar, ComponentT >::molarMass().

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

A human readable name for the component.

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

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::LiquidPhase< Scalar, ComponentT >::triplePressure(), and Opm::GasPhase< Scalar, ComponentT >::triplePressure().

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::LiquidPhase< Scalar, ComponentT >::tripleTemperature(), and Opm::GasPhase< Scalar, ComponentT >::tripleTemperature().

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
temperaturetemperature of the component in $\mathrm{[K]}$

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

Member Data Documentation

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: