Commit c23c77ca authored by Katherina Baber's avatar Katherina Baber
Browse files

doxygen documentation for components folder


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4337 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 755c0b19
......@@ -16,6 +16,8 @@
/*!
* \file
*
* \ingroup Components
*
* \brief A class for the brine fluid properties
*/
#ifndef DUMUX_BRINE_HH
......@@ -29,7 +31,13 @@
namespace Dumux
{
/*!
*
* \ingroup Components
*
* \brief A class for the brine fluid properties
*
* \tparam Scalar The type used for scalar values
* \tparam H2O ???
*/
template <class Scalar, class H2O>
class Brine : public Component<Scalar, Brine<Scalar, H2O> >
......@@ -70,7 +78,7 @@ public:
{ return H2O::criticalPressure(); /* [N/m^2] */ }
/*!
* \brief Returns the temperature [K]at brine's triple point.
* \brief Returns the temperature [K] at brine's triple point.
*/
static Scalar tripleTemperature()
{ return H2O::tripleTemperature(); /* [K] */ }
......@@ -84,12 +92,18 @@ public:
/*!
* \brief The vapor pressure in [N/m^2] of pure brine
* at a given temperature.
*
* \param T temperature of component
*/
static Scalar vaporPressure(Scalar T)
{ return H2O::vaporPressure(T); /* [N/m^2] */ }
/*!
* \brief Specific enthalpy of gaseous brine [J/kg].
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static const Scalar gasEnthalpy(Scalar temperature,
Scalar pressure)
......@@ -97,6 +111,10 @@ public:
/*!
* \brief Specific enthalpy of liquid brine [J/kg].
*
* \param T temperature of component
* \param p pressure of component
*
* Equations given in: - Palliser & McKibbin 1997
* - Michaelides 1981
* - Daubert & Danner 1989
......@@ -162,6 +180,9 @@ public:
/*!
* \brief Specific internal energy of steam [J/kg].
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static const Scalar gasInternalEnergy(Scalar temperature,
Scalar pressure)
......@@ -171,6 +192,9 @@ public:
/*!
* \brief Specific internal energy of liquid brine [J/kg].
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static const Scalar liquidInternalEnergy(Scalar temperature,
Scalar pressure)
......@@ -182,12 +206,19 @@ public:
/*!
* \brief The density of steam at a given pressure and temperature [kg/m^3].
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static Scalar gasDensity(Scalar temperature, Scalar pressure)
{ return H2O::gasDensity(temperature, pressure); }
/*!
* \brief The density of pure brine at a given pressure and temperature [kg/m^3].
*
* \param temperature temperature of component
* \param pressure pressure of component
*
* Equations given in: - Batzle & Wang (1992)
* - cited by: Adams & Bachu in Geofluids (2002) 2, 257-271
*/
......@@ -215,6 +246,9 @@ public:
/*!
* \brief The pressure of steam at a given density and temperature [Pa].
*
* \param temperature temperature of component
* \param density denstiy of component
*/
static Scalar gasPressure(Scalar temperature, Scalar density)
{ return H2O::gasPressure(temperature, density); }
......@@ -222,6 +256,9 @@ public:
/*!
* \brief The pressure of liquid water at a given density and
* temperature [Pa].
*
* \param temperature temperature of component
* \param density density of component
*/
static Scalar liquidPressure(Scalar temperature, Scalar density)
{
......@@ -250,12 +287,19 @@ public:
/*!
* \brief The dynamic viscosity [N/m^3*s] of steam.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static Scalar gasViscosity(Scalar temperature, Scalar pressure)
{ return H2O::gasViscosity(temperature, pressure); };
/*!
* \brief The dynamic viscosity [N/m^3*s] of pure brine.
*
* \param temperature temperature of component
* \param pressure pressure of component
*
* Equation given in: - Batzle & Wang (1992)
* - cited by: Bachu & Adams (2002)
* "Equations of State for basin geofluids"
......@@ -274,6 +318,9 @@ public:
};
template <class Scalar, class H2O>
/*!
* \brief Default value for the salinity of the brine.
*/
Scalar Brine<Scalar, H2O>::salinity = 0.1; // also needs to be adapted in CO2 solubility table!
} // end namepace
......
......@@ -15,6 +15,8 @@
/*!
* \file
*
* \ingroup Components
*
* \brief Properties of methone (\f$CH_4\f$).
*/
#ifndef DUMUX_CH4_HH
......@@ -30,7 +32,11 @@ namespace Dumux
{
/*!
* \ingroup Components
*
* \brief Properties of pure molecular methane \f$CH_4\f$.
*
* \tparam Scalar The type used for scalar values
*/
template <class Scalar>
class CH4 : public Component<Scalar, CH4<Scalar> >
......@@ -78,6 +84,8 @@ public:
/*!
* \brief The vapor pressure in [Pa] of pure molecular methane
* at a given temperature.
*
*\param T temperature of component
*/
static Scalar vaporPressure(Scalar T)
{ DUNE_THROW(Dune::NotImplemented, "vaporPressure for CH4"); }
......@@ -85,6 +93,9 @@ public:
/*!
* \brief The density [kg/m^3] of CH4 gas at a given pressure and temperature.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static Scalar gasDensity(Scalar temperature, Scalar pressure)
{
......@@ -92,8 +103,11 @@ public:
return IdealGas::density(molarMass(), temperature, pressure);
}
/*
/*!
* \brief The pressure of gaseous CH4 at a given density and temperature [Pa].
*
* \param temperature temperature of component
* \param density density of component
*/
static Scalar gasPressure(Scalar temperature, Scalar density)
{
......@@ -103,13 +117,19 @@ public:
/*!
* \brief The density [kg/m^3] of CH4 gas at a given pressure and temperature.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static Scalar liquidDensity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "liquidDensity for CH4"); }
/*
/*!
* \brief The pressure of liquid methane at a given density and
* temperature [Pa].
*
* \param temperature temperature of component
* \param density density of component
*/
static Scalar liquidPressure(Scalar temperature, Scalar density)
{ DUNE_THROW(Dune::NotImplemented, "liquidPressure for CH4"); }
......@@ -117,6 +137,9 @@ public:
/*!
* \brief Specific enthalpy [J/kg] of pure methane gas.
*
* \param T temperature of component
* \param pressure pressure of component
*
* See: R. Reid, et al.: The Properties of Gases and Liquids, 4th
* edition, McGraw-Hill, 1987, pp 154, 657, 671
*/
......@@ -144,12 +167,18 @@ public:
/*!
* \brief Specific enthalpy [J/kg] of pure liquid CH4.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static Scalar liquidEnthalpy(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "liquidEnthalpy for CH4"); }
/*!
* \brief Specific enthalpy [J/kg] of pure methane gas.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static const Scalar gasInternalEnergy(Scalar temperature,
Scalar pressure)
......@@ -162,6 +191,9 @@ public:
/*!
* \brief Specific enthalpy [J/kg] of pure liquid CH4.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static Scalar liquidInternalEnergy(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "liquidInternalEnergy of CH4"); }
......@@ -169,6 +201,9 @@ public:
/*!
* \brief The dynamic viscosity [Pa s] of CH4 at a given pressure and temperature.
*
* \param temperature temperature of component
* \param pressure pressure of component
*
* See:
*
* See: R. Reid, et al.: The Properties of Gases and Liquids, 4th
......@@ -200,6 +235,9 @@ public:
/*!
* \brief The dynamic liquid viscosity [N/m^3*s] of pure CH4.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static Scalar liquidViscosity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "liquidViscosity for CH4"); }
......
......@@ -13,9 +13,17 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \defgroup Material
*/
/*!
* \ingroup Material
* \defgroup Components
*/
/*!
* \file
*
* \ingroup Components
* \brief Abstract base class of a pure chemical species.
*/
#ifndef DUMUX_COMPONENT_HH
......@@ -27,15 +35,22 @@ namespace Dumux
{
/*!
* \ingroup Components
* \brief Abstract base class of a pure chemical species.
*
* \tparam Scalar The type used for scalar values
* \tparam Implementation ???
*/
template <class Scalar, class Implementation>
class Component
{
public:
/*!
* \internal
*/
static void init(Scalar tempMin, Scalar tempMax, unsigned nTemp,
Scalar pressMin, Scalar pressMax, unsigned nPress)
{ Dune::dwarn << "No init routine defined - make shure that this is not necessary!" << std::endl; }
{ Dune::dwarn << "No init routine defined - make sure that this is not necessary!" << std::endl; }
/*!
* \brief A human readable name for the compoent.
......@@ -50,25 +65,25 @@ public:
{ DUNE_THROW(Dune::NotImplemented, "Component::molarMass()"); }
/*!
* \brief Returns the critical temperature of the component
* \brief Returns the critical temperature in [K] of the component
*/
static Scalar criticalTemperature()
{ DUNE_THROW(Dune::NotImplemented, "Component::criticalTemperature()"); }
/*!
* \brief Returns the critical pressure of the component
* \brief Returns the critical pressure in [Pa] of the component
*/
static Scalar criticalPressure()
{ DUNE_THROW(Dune::NotImplemented, "Component::criticalPressure()"); }
/*!
* \brief Returns the temperature at the component's triple point.
* \brief Returns the temperature in [K] at the component's triple point.
*/
static Scalar tripleTemperature()
{ DUNE_THROW(Dune::NotImplemented, "Component::tripleTemperature()"); }
/*!
* \brief Returns the pressure at the component's triple point.
* \brief Returns the pressure in [Pa] at the component's triple point.
*/
static Scalar triplePressure()
{ DUNE_THROW(Dune::NotImplemented, "Component::triplePressure()"); }
......@@ -76,54 +91,80 @@ public:
/*!
* \brief The vapor pressure in [N/m^2] of the component at a given
* temperature.
*
* \param T temperature of the component
*/
static Scalar vaporPressure(Scalar T)
{ DUNE_THROW(Dune::NotImplemented, "Component::vaporPressure()"); }
/*!
* \brief The density [kg/m^3] of the component at a given pressure and temperature.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static Scalar gasDensity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "Component::density()"); }
/*!
* \brief The density [kg/m^3] of the liquid component at a given pressure and temperature.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static Scalar liquidDensity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "Component::density()"); }
/*!
* \brief Specific enthalpy [J/kg] of pure the pure component in gas.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static const Scalar gasEnthalpy(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "Component::gasEnthalpy()"); }
/*!
* \brief Specific enthalpy [J/kg] of pure the pure component in liquid.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static const Scalar liquidEnthalpy(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "Component::liquidEnthalpy()"); }
/*!
* \brief Specific internal energy [J/kg] of pure the pure component in gas.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static const Scalar gasInternalEnergy(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "Component::gasInternalEnergy()"); }
/*!
* \brief Specific internal energy [J/kg] of pure the pure component in liquid.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static const Scalar liquidInternalEnergy(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "Component::liquidInternalEnergy()"); }
/*!
* \brief The dynamic viscosity [Pa s] of the pure component at a given pressure and temperature.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static Scalar gasViscosity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "Component::gasViscosity()"); }
/*!
* \brief The dynamic liquid viscosity [N/m^3*s] of the pure component.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static Scalar liquidViscosity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "Component::liquidViscosity()"); }
......
......@@ -15,6 +15,8 @@
/*!
* \file
*
* \ingroup Components
*
* \brief Properties of pure molecular nitrogen \f$H_2\f$.
*/
#ifndef DUMUX_H2_HH
......@@ -30,7 +32,11 @@ namespace Dumux
{
/*!
* \ingroup Components
*
* \brief Properties of pure molecular hydrogen \f$H_2\f$.
*
* \tparam Scalar The type used for scalar values
*/
template <class Scalar>
class H2 : public Component<Scalar, H2<Scalar> >
......@@ -79,6 +85,8 @@ public:
* \brief The vapor pressure in [Pa] of pure molecular hydrogen
* at a given temperature.
*
*\param temperature temperature of component
*
* Taken from:
*
* See: R. Reid, et al.: The Properties of Gases and Liquids, 4th
......@@ -104,6 +112,9 @@ public:
/*!
* \brief The density [kg/m^3] of H2 at a given pressure and temperature.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static Scalar gasDensity(Scalar temperature, Scalar pressure)
{
......@@ -111,8 +122,11 @@ public:
return IdealGas::density(molarMass(), temperature, pressure);
}
/*
/*!
* \brief The pressure of gaseous N2 at a given density and temperature [Pa].
*
* \param temperature temperature of component
* \param density density of component
*/
static Scalar gasPressure(Scalar temperature, Scalar density)
{
......@@ -123,6 +137,9 @@ public:
/*!
* \brief Specific enthalpy [J/kg] of pure hydrogen gas.
*
* \param T temperature of component
* \param pressure pressure of component
*
* See: R. Reid, et al.: The Properties of Gases and Liquids, 4th
* edition, McGraw-Hill, 1987, pp 154, 657, 665
*/
......@@ -150,19 +167,28 @@ public:
/*!
* \brief The density [kg/m^3] of liquid hydrogen at a given pressure and temperature.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static Scalar liquidDensity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "liquidDensity for H2"); }
/*
/*!
* \brief The pressure of liquid hydrogen at a given density and
* temperature [Pa].
*
* \param temperature temperature of component
* \param density density of component
*/
static Scalar liquidPressure(Scalar temperature, Scalar density)
{ DUNE_THROW(Dune::NotImplemented, "liquidPressure for H2"); }
/*!
* \brief Specific enthalpy [J/kg] of pure liquid H2 .
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static Scalar liquidEnthalpy(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "liquidEnthalpy for H2"); }
......@@ -170,6 +196,9 @@ public:
/*!
* \brief The dynamic viscosity [Pa s] of H2 at a given pressure and temperature.
*
*\param temperature temperature of component
* \param pressure pressure of component
*
* See:
*
* See: R. Reid, et al.: The Properties of Gases and Liquids, 4th
......@@ -201,6 +230,9 @@ public:
/*!
* \brief The dynamic liquid viscosity [N/m^3*s] of pure H2.
*
* \param temperature temperature of component
* \param pressure pressure of component
*/
static Scalar liquidViscosity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "liquidViscosity for H2"); }
......
......@@ -16,6 +16,8 @@
/*!
* \file
*
* \ingroup Components
*
* \brief Material properties of pure water \f$H_2O\f$.
*/
#ifndef DUMUX_H2O_HH
......@@ -38,8 +40,12 @@
namespace Dumux
{
/*!
* \ingroup Components
*
* \brief Material properties of pure water \f$H_2O\f$.
*
* \tparam Scalar The type used for scalar values
*
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
......@@ -83,7 +89,7 @@ public:
{ return Common::criticalPressure; }
/*!
* \brief Returns the temperature [K]at water's triple point.
* \brief Returns the temperature [K] at water's triple point.
*/
static Scalar tripleTemperature()
{ return Common::tripleTemperature; }
......@@ -98,6 +104,8 @@ public:
* \brief The vapor pressure in [N/m^2] of pure water
* at a given temperature.
*
*\param T temperature of component
*
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
......@@ -117,6 +125,9 @@ public:
/*!
* \brief Specific enthalpy of water steam [J/kg].
*
* \param temperature temperature of component
* \param pressure pressure of component
*
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
......@@ -164,6 +175,9 @@ public:
/*!
* \brief Specific enthalpy of liquid water [J/kg].
*
* \param temperature temperature of component
* \param pressure pressure of component
*
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
......@@ -202,6 +216,9 @@ public:
/*!
* \brief Specific isobaric heat capacity of water steam [J/kg].
*
* \param temperature temperature of component
* \param pressure pressure of component
*
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
......@@ -234,6 +251,9 @@ public:
/*!
* \brief Specific isobaric heat capacity of liquid water [J/kg].
*
* \param temperature temperature of component
* \param pressure pressure of component
*
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
......@@ -264,6 +284,9 @@ public:
/*!
* \brief Specific internal energy of liquid water [J/kg].
*
* \param temperature temperature of component
* \param pressure pressure of component
*
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
......@@ -318,6 +341,9 @@ public:
/*!
* \brief Specific internal energy of steam and water vapor [J/kg].
*
* \param temperature temperature of component
* \param pressure pressure of component
*
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
......@@ -388,6 +414,9 @@ public:
/*!
* \brief Specific isochoric heat capacity of liquid water [J/kg].
*
* \param temperature temperature of component
* \param pressure pressure of component
*
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
......@@ -419,6 +448,9 @@ public:
/*!