Public Types | Static Public Member Functions | Static Public Attributes | List of all members
Opm::NullComponent< Scalar > Class Template Reference

A component that only throws exceptions. More...

#include <NullComponent.hpp>

Inheritance diagram for Opm::NullComponent< Scalar >:
Inheritance graph

Public Types

typedef Scalar 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...
 
static Evaluation vaporPressure (const Evaluation &)
 The vapor pressure in $\mathrm{[Pa]}$ of the component at a given temperature in $\mathrm{[K]}$. More...
 
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...
 
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...
 
static Evaluation gasEnthalpy (const Evaluation &, const Evaluation &)
 Specific enthalpy $\mathrm{[J/kg]}$ of the pure component in gas. More...
 
static Evaluation liquidEnthalpy (const Evaluation &, const Evaluation &)
 Specific enthalpy $\mathrm{[J/kg]}$ of the pure component in liquid. More...
 
static Evaluation gasInternalEnergy (const Evaluation &, const Evaluation &)
 Specific internal energy $\mathrm{[J/kg]}$ of the pure component in gas. More...
 
static Evaluation liquidInternalEnergy (const Evaluation &, const Evaluation &)
 Specific internal energy $\mathrm{[J/kg]}$ of pure the pure component in liquid. More...
 
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...
 
static Evaluation liquidViscosity (const Evaluation &, const Evaluation &)
 The dynamic liquid viscosity $\mathrm{[Pa*s]}$ of the pure component. More...
 
static Evaluation gasThermalConductivity (const Evaluation &, const Evaluation &)
 Thermal conductivity of the component [W/(m^2 K/m)] as a gas. More...
 
static Evaluation liquidThermalConductivity (const Evaluation &, const Evaluation &)
 Thermal conductivity of the component [W/(m^2 K/m)] as a liquid. More...
 
static Evaluation gasHeatCapacity (const Evaluation &, const Evaluation &)
 Specific isobaric heat capacity of the component [J/kg] as a gas. More...
 
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
 

Detailed Description

template<class Scalar>
class Opm::NullComponent< Scalar >

A component that only throws exceptions.

Its main purpose is to make things compile and give runtime errors if it is actually used.

Member Typedef Documentation

◆ Scalar

typedef Scalar Opm::Component< Scalar , NullComponent< Scalar > >::Scalar
inherited

Member Function Documentation

◆ acentricFactor()

static Scalar Opm::Component< Scalar , NullComponent< Scalar > >::acentricFactor ( )
inlinestaticinherited

Returns the acentric factor of the component.

◆ criticalPressure()

static Scalar Opm::Component< Scalar , NullComponent< Scalar > >::criticalPressure ( )
inlinestaticinherited

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

◆ criticalTemperature()

static Scalar Opm::Component< Scalar , NullComponent< Scalar > >::criticalTemperature ( )
inlinestaticinherited

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

◆ criticalVolume()

static Scalar Opm::Component< Scalar , NullComponent< Scalar > >::criticalVolume ( )
inlinestaticinherited

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

◆ gasDensity()

static Evaluation Opm::Component< Scalar , NullComponent< Scalar > >::gasDensity ( const Evaluation &  ,
const Evaluation &   
)
inlinestaticinherited

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

◆ gasEnthalpy()

static Evaluation Opm::Component< Scalar , NullComponent< Scalar > >::gasEnthalpy ( const Evaluation &  ,
const Evaluation &   
)
inlinestaticinherited

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

Parameters
temperaturetemperature of component in $\mathrm{[K]}$
pressurepressure of component in $\mathrm{[Pa]}$

◆ gasHeatCapacity()

static Evaluation Opm::Component< Scalar , NullComponent< Scalar > >::gasHeatCapacity ( const Evaluation &  ,
const Evaluation &   
)
inlinestaticinherited

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

◆ gasInternalEnergy()

static Evaluation Opm::Component< Scalar , NullComponent< Scalar > >::gasInternalEnergy ( const Evaluation &  ,
const Evaluation &   
)
inlinestaticinherited

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

◆ gasIsCompressible()

static bool Opm::Component< Scalar , NullComponent< Scalar > >::gasIsCompressible ( )
inlinestaticinherited

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

◆ gasIsIdeal()

static bool Opm::Component< Scalar , NullComponent< Scalar > >::gasIsIdeal ( )
inlinestaticinherited

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

◆ gasThermalConductivity()

static Evaluation Opm::Component< Scalar , NullComponent< Scalar > >::gasThermalConductivity ( const Evaluation &  ,
const Evaluation &   
)
inlinestaticinherited

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

◆ gasViscosity()

static Evaluation Opm::Component< Scalar , NullComponent< Scalar > >::gasViscosity ( const Evaluation &  ,
const Evaluation &   
)
inlinestaticinherited

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

◆ init()

static void Opm::Component< Scalar , NullComponent< Scalar > >::init ( Scalar  ,
Scalar  ,
unsigned  ,
Scalar  ,
Scalar  ,
unsigned   
)
inlinestaticinherited

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!"

◆ liquidDensity()

static Evaluation Opm::Component< Scalar , NullComponent< Scalar > >::liquidDensity ( const Evaluation &  ,
const Evaluation &   
)
inlinestaticinherited

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

◆ liquidEnthalpy()

static Evaluation Opm::Component< Scalar , NullComponent< Scalar > >::liquidEnthalpy ( const Evaluation &  ,
const Evaluation &   
)
inlinestaticinherited

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

Parameters
temperaturetemperature of component in $\mathrm{[K]}$
pressurepressure of component in $\mathrm{[Pa]}$

◆ liquidHeatCapacity()

static Evaluation Opm::Component< Scalar , NullComponent< Scalar > >::liquidHeatCapacity ( const Evaluation &  ,
const Evaluation &   
)
inlinestaticinherited

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

◆ liquidInternalEnergy()

static Evaluation Opm::Component< Scalar , NullComponent< Scalar > >::liquidInternalEnergy ( const Evaluation &  ,
const Evaluation &   
)
inlinestaticinherited

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

◆ liquidIsCompressible()

static bool Opm::Component< Scalar , NullComponent< Scalar > >::liquidIsCompressible ( )
inlinestaticinherited

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

◆ liquidThermalConductivity()

static Evaluation Opm::Component< Scalar , NullComponent< Scalar > >::liquidThermalConductivity ( const Evaluation &  ,
const Evaluation &   
)
inlinestaticinherited

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

◆ liquidViscosity()

static Evaluation Opm::Component< Scalar , NullComponent< Scalar > >::liquidViscosity ( const Evaluation &  ,
const Evaluation &   
)
inlinestaticinherited

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

Parameters
temperaturetemperature of component in $\mathrm{[K]}$
pressurepressure of component in $\mathrm{[Pa]}$

◆ molarMass()

static Scalar Opm::Component< Scalar , NullComponent< Scalar > >::molarMass ( )
inlinestaticinherited

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

◆ name()

static const char * Opm::Component< Scalar , NullComponent< Scalar > >::name ( )
inlinestaticinherited

A human readable name for the component.

◆ triplePressure()

static Scalar Opm::Component< Scalar , NullComponent< Scalar > >::triplePressure ( )
inlinestaticinherited

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

◆ tripleTemperature()

static Scalar Opm::Component< Scalar , NullComponent< Scalar > >::tripleTemperature ( )
inlinestaticinherited

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

◆ vaporPressure()

static Evaluation Opm::Component< Scalar , NullComponent< Scalar > >::vaporPressure ( const Evaluation &  )
inlinestaticinherited

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

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

Member Data Documentation

◆ isTabulated

const bool Opm::Component< Scalar , NullComponent< Scalar > >::isTabulated
staticinherited
The documentation for this class was generated from the following file: