Dumux::Components::Base< ScalarType, Component > Class Template Reference

Base class for all components Components provide the thermodynamic relations for the liquid, gaseous and/or solid state of a single chemical species or a fixed mixture of species. Fluid systems use components to compute thermodynamic quantities of phases. More...

#include <dumux/material/components/base.hh>

Inheritance diagram for Dumux::Components::Base< ScalarType, Component >:

Description

template<class ScalarType, class Component>
class Dumux::Components::Base< ScalarType, Component >

Base class for all components Components provide the thermodynamic relations for the liquid, gaseous and/or solid state of a single chemical species or a fixed mixture of species. Fluid systems use components to compute thermodynamic quantities of phases.

Public Types
using	Scalar = ScalarType
	export the scalar type used by the component More...

Static Public Member Functions
static void	init (Scalar tempMin, Scalar tempMax, unsigned nTemp, Scalar pressMin, Scalar pressMax, unsigned nPress)
	A default routine for initialization, not needed for components and must not be called. More...
template<class C = Component>
static std::string	name ()
	A human readable name for the component. More...
template<class C = Component>
static constexpr Scalar	molarMass ()
	The molar mass in \(\mathrm{[kg/mol]}\) of the component. More...
template<class C = Component>
static constexpr Scalar	criticalTemperature ()
	Returns the critical temperature in \(\mathrm{[K]}\) of the component. More...
template<class C = Component>
static constexpr Scalar	criticalPressure ()
	Returns the critical pressure in \(\mathrm{[Pa]}\) of the component. More...
template<class C = Component>
static constexpr Scalar	tripleTemperature ()
	Returns the temperature in \(\mathrm{[K]}\) at the component's triple point. More...
template<class C = Component>
static constexpr Scalar	triplePressure ()
	Returns the pressure in \(\mathrm{[Pa]}\) at the component's triple point. More...
template<class C = Component>
static Scalar	vaporPressure (Scalar t)
	The vapor pressure in \(\mathrm{[Pa]}\) of the component at a given temperature in \(\mathrm{[K]}\). More...

Static Public Attributes
static constexpr bool	isTabulated = false
	if the component relies on tabulated values More...

Member Typedef Documentation

Scalar

template<class ScalarType , class Component >

using Dumux::Components::Base< ScalarType, Component >::Scalar = ScalarType

export the scalar type used by the component

Member Function Documentation

criticalPressure()

template<class ScalarType , class Component >

template<class C = Component>

static constexpr Scalar Dumux::Components::Base< ScalarType, Component >::criticalPressure ( )

inlinestaticconstexpr

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

criticalTemperature()

template<class ScalarType , class Component >

template<class C = Component>

static constexpr Scalar Dumux::Components::Base< ScalarType, Component >::criticalTemperature ( )

inlinestaticconstexpr

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

init()

template<class ScalarType , class Component >

static void Dumux::Components::Base< ScalarType, Component >::init ( Scalar  tempMin, Scalar  tempMax, unsigned  nTemp, Scalar  pressMin, Scalar  pressMax, unsigned  nPress  )

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

molarMass()

template<class ScalarType , class Component >

template<class C = Component>

static constexpr Scalar Dumux::Components::Base< ScalarType, Component >::molarMass ( )

inlinestaticconstexpr

The molar mass in \(\mathrm{[kg/mol]}\) of the component.

name()

template<class ScalarType , class Component >

template<class C = Component>

static std::string Dumux::Components::Base< ScalarType, Component >::name ( )

inlinestatic

A human readable name for the component.

Note

Mandatory for all components

triplePressure()

template<class ScalarType , class Component >

template<class C = Component>

static constexpr Scalar Dumux::Components::Base< ScalarType, Component >::triplePressure ( )

inlinestaticconstexpr

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

tripleTemperature()

template<class ScalarType , class Component >

template<class C = Component>

static constexpr Scalar Dumux::Components::Base< ScalarType, Component >::tripleTemperature ( )

inlinestaticconstexpr

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

vaporPressure()

template<class ScalarType , class Component >

template<class C = Component>

static Scalar Dumux::Components::Base< ScalarType, Component >::vaporPressure ( Scalar  t )

inlinestatic

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

Parameters

t	temperature of the component in \(\mathrm{[K]}\)

Member Data Documentation

isTabulated

template<class ScalarType , class Component >

constexpr bool Dumux::Components::Base< ScalarType, Component >::isTabulated = false

staticconstexpr

if the component relies on tabulated values

---

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

• components/base.hh