Commit 3564e8f0 authored by Katherina Baber's avatar Katherina Baber
Browse files

finished doxygen documentation


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4425 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 2d545c8c
......@@ -286,7 +286,7 @@ public:
}
/*!
* \brief The dynamic viscosity [N/m^3*s] of steam.
* \brief The dynamic viscosity [Pa*s] of steam.
*
* \param temperature temperature of component
* \param pressure pressure of component
......@@ -295,7 +295,7 @@ public:
{ return H2O::gasViscosity(temperature, pressure); };
/*!
* \brief The dynamic viscosity [N/m^3*s] of pure brine.
* \brief The dynamic viscosity [Pa*s] of pure brine.
*
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
......
......@@ -17,7 +17,7 @@
*
* \ingroup Components
*
* \brief Properties of methane (\f$CH_4\f$).
* \brief Properties of methane \f$CH_4\f$.
*/
#ifndef DUMUX_CH4_HH
#define DUMUX_CH4_HH
......@@ -234,7 +234,7 @@ public:
}
/*!
* \brief The dynamic liquid viscosity [N/m^3*s] of pure CH4.
* \brief The dynamic liquid viscosity [Pa s] of pure CH4.
*
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
......
......@@ -161,7 +161,7 @@ public:
{ DUNE_THROW(Dune::NotImplemented, "Component::liquidInternalEnergy()"); }
/*!
* \brief The dynamic viscosity [Pa s] of the pure component at a given pressure in [Pa] and temperature in [K].
* \brief The dynamic viscosity [Pa*s] of the pure component at a given pressure in [Pa] and temperature in [K].
*
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
......@@ -170,7 +170,7 @@ public:
{ DUNE_THROW(Dune::NotImplemented, "Component::gasViscosity()"); }
/*!
* \brief The dynamic liquid viscosity [N/m^3*s] of the pure component.
* \brief The dynamic liquid viscosity [Pa*s] of the pure component.
*
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
......
......@@ -194,7 +194,7 @@ public:
{ DUNE_THROW(Dune::NotImplemented, "liquidEnthalpy for H2"); }
/*!
* \brief The dynamic viscosity [Pa s] of H2 at a given pressure and temperature.
* \brief The dynamic viscosity [Pa*s] of H2 at a given pressure and temperature.
*
*\param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
......@@ -229,7 +229,7 @@ public:
}
/*!
* \brief The dynamic liquid viscosity [N/m^3*s] of pure H2.
* \brief The dynamic liquid viscosity [Pa*s] of pure H2.
*
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
......
......@@ -71,7 +71,7 @@ public:
{ return "H2O"; }
/*!
* \brief The molar mass in [kg] of water.
* \brief The molar mass in [kg/mol] of water.
*/
static Scalar molarMass()
{ return Common::molarMass; }
......@@ -101,7 +101,7 @@ public:
{ return Common::triplePressure; }
/*!
* \brief The vapor pressure in [N/m^2] of pure water
* \brief The vapor pressure in [Pa] of pure water
* at a given temperature.
*
*\param T temperature of component in [K]
......@@ -692,7 +692,7 @@ public:
}
/*!
* \brief The dynamic viscosity [N/m^3*s] of steam.
* \brief The dynamic viscosity [Pa*s] of steam.
*
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
......@@ -719,7 +719,7 @@ public:
};
/*!
* \brief The dynamic viscosity [N/m^3*s] of pure water.
* \brief The dynamic viscosity [Pa*s] of pure water.
*
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
......
......@@ -53,7 +53,7 @@ public:
{ return "N2"; }
/*!
* \brief The mass in [kg/mol] of one of molecular nitrogen.
* \brief The molar mass in [kg/mol] of molecular nitrogen.
*/
static Scalar molarMass()
{ return 28.0134e-3;}
......@@ -65,7 +65,7 @@ public:
{ return 126.192; /* [K] */ }
/*!
* \brief Returns the critical pressure [Pa] of molecular nitrogen
* \brief Returns the critical pressure [Pa] of molecular nitrogen.
*/
static Scalar criticalPressure()
{ return 3.39858e6; /* [N/m^2] */ }
......@@ -86,7 +86,7 @@ public:
* \brief The vapor pressure in [Pa] of pure molecular nitrogen
* at a given temperature.
*
*\param T temperature of component
*\param T temperature of component in [K]
*
* Taken from:
*
......@@ -123,8 +123,8 @@ public:
/*!
* \brief The density [kg/m^3] of N2 gas at a given pressure and temperature.
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static Scalar gasDensity(Scalar temperature, Scalar pressure)
{
......@@ -133,10 +133,10 @@ public:
}
/*!
* \brief The pressure of gaseous N2 at a given density and temperature [Pa].
* \brief The pressure of gaseous N2 in [Pa] at a given density and temperature.
*
* \param temperature temperature of component
* \param density density of component
* \param temperature temperature of component in [K]
* \param density density of component in [kg/m^3]
*/
static Scalar gasPressure(Scalar temperature, Scalar density)
{
......@@ -147,18 +147,18 @@ public:
/*!
* \brief The density [kg/m^3] of N2 gas at a given pressure and temperature.
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static Scalar liquidDensity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "liquidDensity for N2"); }
/*!
* \brief The pressure of liquid nitrogen at a given density and
* temperature [Pa].
* \brief The pressure of liquid nitrogen in [Pa] at a given density and
* temperature.
*
* \param temperature temperature of component
* \param density density of component
* \param temperature temperature of component in [K]
* \param density density of component in [kg/m^3]
*/
static Scalar liquidPressure(Scalar temperature, Scalar density)
{ DUNE_THROW(Dune::NotImplemented, "liquidPressure for N2"); }
......@@ -166,8 +166,8 @@ public:
/*!
* \brief Specific enthalpy [J/kg] of pure nitrogen gas.
*
* \param T temperature of component
* \param pressure pressure of component
* \param T temperature of component in [K]
* \param pressure pressure of component in [Pa]
*
* See: R. Reid, et al.: The Properties of Gases and Liquids, 4th
* edition, McGraw-Hill, 1987, pp 154, 657, 665
......@@ -197,8 +197,8 @@ public:
/*!
* \brief Specific enthalpy [J/kg] of pure liquid N2.
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static Scalar liquidEnthalpy(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "liquidEnthalpy for N2"); }
......@@ -206,8 +206,8 @@ public:
/*!
* \brief Specific enthalpy [J/kg] of pure nitrogen gas.
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static const Scalar gasInternalEnergy(Scalar temperature,
Scalar pressure)
......@@ -221,17 +221,17 @@ public:
/*!
* \brief Specific enthalpy [J/kg] of pure liquid N2.
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static Scalar liquidInternalEnergy(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "liquidInternalEnergy of N2"); }
/*!
* \brief The dynamic viscosity [Pa s] of N2 at a given pressure and temperature.
* \brief The dynamic viscosity [Pa*s] of N2 at a given pressure and temperature.
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*
* See:
*
......@@ -263,10 +263,10 @@ public:
}
/*!
* \brief The dynamic liquid viscosity [N/m^3*s] of pure N2.
* \brief The dynamic liquid viscosity [Pa*s] of pure N2.
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static Scalar liquidViscosity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "liquidViscosity for N2"); }
......
......@@ -52,7 +52,7 @@ public:
{ return "O2"; }
/*!
* \brief The mass in [kg] of one mole of molecular oxygen.
* \brief The molar mass in [kg/mol] of molecular oxygen.
*/
static Scalar molarMass()
{ return 32e-3; }
......@@ -82,10 +82,10 @@ public:
{ return 148.0; /* [N/m^2] */ }
/*!
* \brief The vapor pressure in [N/m^2] of pure molecular oxygen
* \brief The vapor pressure in [Pa] of pure molecular oxygen
* at a given temperature.
*
* \param T temperature of component
* \param T temperature of component in [K]
*
* Taken from:
*
......@@ -121,8 +121,8 @@ public:
/*!
* \brief The density in [kg/m^3] of pure O2 at a given pressure and temperature.
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*
* \todo density liquid oxygen
*/
......@@ -133,10 +133,10 @@ public:
}
/*!
* \brief The pressure of gaseous N2 at a given density and temperature [Pa].
* \brief The pressure of gaseous N2 in [Pa] at a given density and temperature.
*
* \param temperature temperature of component
* \param density density of component
* \param temperature temperature of component in [K]
* \param density density of component in [kg/m^3]
*/
static Scalar gasPressure(Scalar temperature, Scalar density)
{
......@@ -147,8 +147,8 @@ public:
/*!
* \brief Specific enthalpy [J/kg] of pure oxygen gas.
*
* \param T temperature of component
* \param pressure pressure of component
* \param T temperature of component in [K]
* \param pressure pressure of component in [Pa]
*
* See: R. Reid, et al.: The Properties of Gases and Liquids, 4th
* edition, McGraw-Hill, 1987, pp 154, 657, 665
......@@ -178,18 +178,18 @@ public:
/*!
* \brief The density [kg/m^3] of gaseous O2 at a given pressure and temperature.
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static Scalar liquidDensity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "liquidDensity for O2"); }
/*!
* \brief The pressure of liquid oxygen at a given density and
* \brief The pressure of liquid oxygen in [Pa] at a given density and
* temperature [Pa].
*
* \param temperature temperature of component
* \param density density of component
* \param temperature temperature of component in [K]
* \param density density of component in [kg/m^3]
*/
static Scalar liquidPressure(Scalar temperature, Scalar density)
{ DUNE_THROW(Dune::NotImplemented, "liquidPressure for O2"); }
......@@ -204,10 +204,10 @@ public:
{ DUNE_THROW(Dune::NotImplemented, "liquidEnthalpy for O2"); }
/*!
* \brief The dynamic viscosity [Pa s] of N2 at a given pressure and temperature.
* \brief The dynamic viscosity [Pa*s] of N2 at a given pressure and temperature.
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*
* See:
*
......@@ -239,10 +239,10 @@ public:
}
/*!
* \brief The dynamic liquid viscosity [N/m^3*s] of pure H2.
* \brief The dynamic liquid viscosity [Pa*s] of pure H2.
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static Scalar liquidViscosity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "liquidViscosity for O2"); }
......
......@@ -15,7 +15,7 @@
/*!
* \file
*\ingroup Components
* \brief Properties of pure water \f$H_2O\f$.
* \brief Rough estimate of some oil for testing purposes.
*/
#ifndef DUMUX_OIL_HH
#define DUMUX_OIL_HH
......@@ -47,8 +47,8 @@ public:
/*!
* \brief Rough estimate of the density of oil [kg/m^3].
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static Scalar liquidDensity(Scalar temperature, Scalar pressure)
{
......@@ -56,10 +56,10 @@ public:
}
/*!
* \brief Rough estimate of the viscosity of oil kg/(ms).
* \brief Rough estimate of the viscosity of oil in [Pa*s].
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static Scalar liquidViscosity(Scalar temperature, Scalar pressure)
{
......
......@@ -51,7 +51,7 @@ public:
{ return "CO2"; }
/*!
* \brief The mass in [kg] of one mole of CO2.
* \brief The molar mass in [kg/mol] of CO2.
*/
static Scalar molarMass()
{ return 44e-3; }
......@@ -81,10 +81,10 @@ public:
{ return 5.11e5; /* [N/m^2] */ }
/*!
* \brief The vapor pressure in [N/m^2] of pure CO2
* \brief The vapor pressure in [Pa] of pure CO2
* at a given temperature.
*
* \param T temperature of component
* \param T temperature of component in [K]
*/
static Scalar vaporPressure(Scalar T)
{ DUNE_THROW(Dune::NotImplemented, "vaporPressure of simple CO2"); }
......@@ -92,8 +92,8 @@ public:
/*!
* \brief Specific enthalpy of gaseous CO2 [J/kg].
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static const Scalar gasEnthalpy(Scalar temperature,
Scalar pressure)
......@@ -102,8 +102,8 @@ public:
/*!
* \brief Specific enthalpy of liquid CO2 [J/kg].
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static const Scalar liquidEnthalpy(Scalar temperature,
Scalar pressure)
......@@ -112,8 +112,8 @@ public:
/*!
* \brief Specific internal energy of CO2 [J/kg].
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static const Scalar gasInternalEnergy(Scalar temperature,
Scalar pressure)
......@@ -126,8 +126,8 @@ public:
/*!
* \brief Specific internal energy of liquid CO2 [J/kg].
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static const Scalar liquidInternalEnergy(Scalar temperature,
Scalar pressure)
......@@ -136,8 +136,8 @@ public:
/*!
* \brief The density of CO2 at a given pressure and temperature [kg/m^3].
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static Scalar gasDensity(Scalar temperature, Scalar pressure)
{
......@@ -148,8 +148,8 @@ public:
/*!
* \brief The pressure of gaseous CO2 at a given density and temperature [Pa].
*
* \param temperature temperature of component
* \param density density of component
* \param temperature temperature of component in [K]
* \param density density of component in [kg/m^3]
*/
static Scalar gasPressure(Scalar temperature, Scalar density)
{
......@@ -160,27 +160,27 @@ public:
/*!
* \brief The density of pure CO2 at a given pressure and temperature [kg/m^3].
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static Scalar liquidDensity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "liquidDensity of simple CO2"); }
/*!
* \brief The pressure of liquid CO2 at a given density and
* temperature [Pa].
* \brief The pressure of liquid CO2 in [Pa] at a given density and
* temperature.
*
* \param temperature temperature of component
* \param density density of component
* \param temperature temperature of component in [K]
* \param density density of component in [kg/m^3]
*/
static Scalar liquidPressure(Scalar temperature, Scalar density)
{ DUNE_THROW(Dune::NotImplemented, "liquidPressure for simple CO2"); }
/*!
* \brief The dynamic viscosity [Pa s] of CO2 at a given pressure and temperature.
* \brief The dynamic viscosity [Pa*s] of CO2 at a given pressure and temperature.
*
*\param temperature temperature of component
* \param pressure pressure of component
*\param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*
* See:
*
......@@ -212,10 +212,10 @@ public:
}
/*!
* \brief The dynamic viscosity [N/m^3*s] of pure CO2.
* \brief The dynamic viscosity [Pa*s] of pure CO2.
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static Scalar liquidViscosity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "liquidViscosity of simple CO2"); }
......
......@@ -47,7 +47,7 @@ public:
{ return "TCE"; }
/*!
* \brief The mass in [kg] of one mole of TCE.
* \brief The molar mass in [kg/mol] of TCE.
*/
static Scalar molarMass()
{
......@@ -71,7 +71,7 @@ public:
};
/*!
* \brief Returns the temperature [K]at TCE's triple point.
* \brief Returns the temperature [K] at TCE's triple point.
*/
static Scalar tripleTemperature()
{
......@@ -87,10 +87,10 @@ public:
};
/*!
* \brief The vapor pressure in [N/m^2] of pure TCE
* \brief The vapor pressure in [Pa] of pure TCE
* at a given temperature.
*
* \param T temperature of component
* \param T temperature of component in [K]
*/
static Scalar vaporPressure(Scalar T)
{
......@@ -99,8 +99,8 @@ public:
/*!
* \brief Specific enthalpy of TCE steam [J/kg].
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static const Scalar gasEnthalpy(Scalar temperature,
Scalar pressure)
......@@ -111,8 +111,8 @@ public:
/*!
* \brief Specific enthalpy of liquid TCE [J/kg].
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static const Scalar liquidEnthalpy(Scalar temperature,
Scalar pressure)
......@@ -123,8 +123,8 @@ 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
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static Scalar gasDensity(Scalar temperature, Scalar pressure)
{
......@@ -136,8 +136,8 @@ public:
/*!
* \brief The density of pure TCE at a given pressure and temperature [kg/m^3].
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static Scalar liquidDensity(Scalar temperature, Scalar pressure)
{
......@@ -145,11 +145,11 @@ public:
}
/*!
* \brief The dynamic viscosity [N/m^3*s] of steam.
* \brief The dynamic viscosity [Pa*s] of steam.
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param regularize defines if the functions is regularized or not, set to true by default
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
* \param regularize defines, if the functions is regularized or not, set to true by default
*/
static Scalar gasViscosity(Scalar temperature, Scalar pressure, bool regularize=true)
{
......@@ -157,10 +157,10 @@ public:
};
/*!
* \brief The dynamic viscosity [N/m^3*s] of pure TCE.
* \brief The dynamic viscosity [Pa*s] of pure TCE.
*
* \param temperature temperature of component
* \param pressure pressure of component
* \param temperature temperature of component in [K]
* \param pressure pressure of component in [Pa]
*/
static Scalar liquidViscosity(Scalar temperature, Scalar pressure)
{
......
......@@ -54,7 +54,7 @@ public:
{ return "H2O"; }
/*!
* \brief The mass in [kg] of one mole of water.
* \brief The molar mass in [kg/mol] of water.
*/
static Scalar molarMass()