diff --git a/dumux/material/components/CMakeLists.txt b/dumux/material/components/CMakeLists.txt
index 7716160c7c5902cb32517bbbe69e4aa8f540f777..6427f4bda3e49102b4a1bed1ba71e6f935e90add 100644
--- a/dumux/material/components/CMakeLists.txt
+++ b/dumux/material/components/CMakeLists.txt
@@ -5,14 +5,18 @@ install(FILES
air.hh
benzene.hh
brine.hh
+CaO.hh
+CaO2H2.hh
ch4.hh
co2.hh
-co2tables.inc
co2tablereader.hh
+co2tables.inc
component.hh
+constant.hh
dnapl.hh
h2.hh
h2o.hh
+heavyoil.hh
lnapl.hh
mesitylene.hh
n2.hh
diff --git a/dumux/material/components/CaO.hh b/dumux/material/components/CaO.hh
index 6ae7bbda2c4f4ffbb7340f48c52d4ca08f1afa61..ab6cf89c520ee3582c9a3af6fd82970916b2f676 100644
--- a/dumux/material/components/CaO.hh
+++ b/dumux/material/components/CaO.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Material properties of pure Calcium-Oxide \f$CaO\f$.
*/
#ifndef DUMUX_CAO_HH
@@ -36,6 +34,7 @@
namespace Dumux
{
/*!
+ * \ingroup Components
* \brief A class for the CaO properties
*/
template <class Scalar>
diff --git a/dumux/material/components/CaO2H2.hh b/dumux/material/components/CaO2H2.hh
index 423ce4de32709c4927b479af49a37068c843fab4..cc484ca1019ca8d549f5e37909f953772145bafc 100644
--- a/dumux/material/components/CaO2H2.hh
+++ b/dumux/material/components/CaO2H2.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Material properties of pure Calciumhydroxide \f$CaO2H2\f$.
*/
#ifndef DUMUX_CAO2H2_HH
@@ -36,6 +34,7 @@
namespace Dumux
{
/*!
+ * \ingroup Components
* \brief A class for the CaO2H2 properties
*/
template <class Scalar>
diff --git a/dumux/material/components/air.hh b/dumux/material/components/air.hh
index 17b41f670298c846f78571ac8198a70e0dcfd002..a22328a918a8985f70f6cb866cea6bb04ef36f53 100644
--- a/dumux/material/components/air.hh
+++ b/dumux/material/components/air.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief A simple class for the air fluid properties
*/
#ifndef DUMUX_AIR_HH
@@ -34,7 +32,6 @@ namespace Dumux
{
/*!
* \ingroup Components
- *
* \brief A class for the air fluid properties
*
* \tparam Scalar The type used for scalar values
diff --git a/dumux/material/components/benzene.hh b/dumux/material/components/benzene.hh
index 645dc1eb79a20631faf9f6887c7263016c727d2b..4aa834036b376fcb1e95a89f46f0bb35b0fa643e 100644
--- a/dumux/material/components/benzene.hh
+++ b/dumux/material/components/benzene.hh
@@ -32,7 +32,6 @@ namespace Dumux
{
/*!
* \ingroup Components
- *
* \brief A simple benzene component (LNAPL).
*
* \tparam Scalar The type used for scalar values
@@ -124,7 +123,7 @@ public:
}
/*!
- * \brief The density of steam at a given pressure and temperature \f$\mathrm{[kg/m^3]}\f$.
+ * \brief The density of benzene steam at a given pressure and temperature \f$\mathrm{[kg/m^3]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
@@ -148,7 +147,7 @@ public:
}
/*!
- * \brief The dynamic viscosity \f$\mathrm{[Pa*s]}\f$ of steam.
+ * \brief The dynamic viscosity \f$\mathrm{[Pa*s]}\f$ of benzene steam.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
diff --git a/dumux/material/components/brine.hh b/dumux/material/components/brine.hh
index b4103b5c9227e8c4e6352da3e890aa39d19f763c..73c9926423fd73c36e13a65f06b3cb88f435cfb7 100644
--- a/dumux/material/components/brine.hh
+++ b/dumux/material/components/brine.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief A class for the brine fluid properties,.
*/
#ifndef DUMUX_BRINE_HH
@@ -37,9 +35,7 @@
namespace Dumux
{
/*!
- *
* \ingroup Components
- *
* \brief A class for the brine fluid properties.
*
* \tparam Scalar The type used for scalar values
@@ -125,9 +121,9 @@ public:
* \param salinity The mass fraction of salt
*
* Equations given in:
- * - Palliser & McKibbin (1998) \cite palliser1998 <BR>
- * - Michaelides (1981) \cite michaelides1981 <BR>
- * - Daubert & Danner (1989) \cite daubert1989
+ * - Palliser & McKibbin (1998) \cite palliser1998 <BR>
+ * - Michaelides (1981) \cite michaelides1981 <BR>
+ * - Daubert & Danner (1989) \cite daubert1989
*
*/
static const Scalar liquidEnthalpy(Scalar T,
@@ -179,7 +175,7 @@ public:
}
/*!
- * \brief Specific isobaric heat capacity of liquid water \f$\mathrm{[J/kg]}\f$.
+ * \brief Specific isobaric heat capacity of brine \f$\mathrm{[J/kg]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
@@ -317,7 +313,7 @@ public:
{ return H2O::gasPressure(temperature, density); }
/*!
- * \brief The pressure of liquid water in \f$\mathrm{[Pa]}\f$ at a given density and
+ * \brief The pressure of brine in \f$\mathrm{[Pa]}\f$ at a given density and
* temperature.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
diff --git a/dumux/material/components/ch4.hh b/dumux/material/components/ch4.hh
index dcf1b2d65849c24d6b059d97e49b6183e289488b..81b8e275d777181d1e8c4ea1a988ba6224a87d82 100644
--- a/dumux/material/components/ch4.hh
+++ b/dumux/material/components/ch4.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Properties of methane \f$CH_4\f$.
*/
#ifndef DUMUX_CH4_HH
@@ -37,9 +35,7 @@ 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>
@@ -227,7 +223,7 @@ public:
2.16178*exp(- 2.43787*Tstar);
Scalar mu = 40.785*Fc*sqrt(M*temperature)/(pow(Vc, 2./3)*Omega_v);
- // convertion from micro poise to Pa s
+ // conversion from micro poise to Pa s
return mu/1e6 / 10;
}
};
diff --git a/dumux/material/components/co2.hh b/dumux/material/components/co2.hh
index 39bdfd6cbdd554eea8318b4bdac8e05e54089732..02b340a4dc7828c98f833ba7ea592e110b29b930 100644
--- a/dumux/material/components/co2.hh
+++ b/dumux/material/components/co2.hh
@@ -19,7 +19,6 @@
/*!
* \file
* \ingroup Components
- *
* \brief A class for the CO2 fluid properties
*/
#ifndef DUMUX_CO2_HH
@@ -119,7 +118,7 @@ public:
/*!
* \brief The vapor pressure in \f$\mathrm{[Pa]}\f$ of pure CO2
* at a given temperature.
- *
+ * \param T the temperature \f$\mathrm{[K]}\f$
* See:
*
* R. Span and W. Wagner (1996, pp. 1509-1596) \cite span1996
@@ -147,6 +146,8 @@ public:
/*!
* \brief Specific enthalpy of gaseous CO2 \f$\mathrm{[J/kg]}\f$.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar gasEnthalpy(Scalar temperature,
Scalar pressure)
@@ -163,6 +164,8 @@ public:
/*!
* \brief Specific enthalpy of liquid CO2 \f$\mathrm{[J/kg]}\f$.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidEnthalpy(Scalar temperature,
Scalar pressure)
@@ -179,6 +182,8 @@ public:
/*!
* \brief Specific internal energy of CO2 \f$\mathrm{[J/kg]}\f$.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar gasInternalEnergy(Scalar temperature,
Scalar pressure)
@@ -191,6 +196,8 @@ public:
/*!
* \brief Specific internal energy of liquid CO2 \f$\mathrm{[J/kg]}\f$.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidInternalEnergy(Scalar temperature,
Scalar pressure)
@@ -203,7 +210,9 @@ public:
/*!
* \brief The density of CO2 at a given pressure and temperature \f$\mathrm{[kg/m^3]}\f$.
- */
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the pressure \f$\mathrm{[Pa]}\f$
+ */
static Scalar gasDensity(Scalar temperature, Scalar pressure)
{
if ((temperature < criticalTemperature() || pressure < criticalPressure()) && !warningThrown)
@@ -218,6 +227,8 @@ public:
/*!
* \brief The density of pure CO2 at a given pressure and temperature \f$\mathrm{[kg/m^3]}\f$.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidDensity(Scalar temperature, Scalar pressure)
{
diff --git a/dumux/material/components/co2tablereader.hh b/dumux/material/components/co2tablereader.hh
index 7ae96b9f6ef51b0826875edd3f1b0f3da26b15e2..dfabfb4d82904fc9a9eac98e470ee2e6b52e1db8 100644
--- a/dumux/material/components/co2tablereader.hh
+++ b/dumux/material/components/co2tablereader.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Components
* \brief A generic template for tabulated material laws that depend
* on two parameters.
*/
@@ -30,6 +30,7 @@
namespace Dumux {
/*!
+ * \ingroup Components
* \brief A generic template for tabulated material laws that depend
* on two parameters.
*/
diff --git a/dumux/material/components/component.hh b/dumux/material/components/component.hh
index 8958e76cc6f252ce3ca4d2dce846f9501e84917e..a8e9a82bb47948ab6410f6c9d6c36cb8a2c79610 100644
--- a/dumux/material/components/component.hh
+++ b/dumux/material/components/component.hh
@@ -19,7 +19,6 @@
/*!
* \file
- *
* \ingroup Components
* \brief Abstract base class of a pure chemical species.
*/
diff --git a/dumux/material/components/constant.hh b/dumux/material/components/constant.hh
index a96705977dd981a3f9dcb115ddbb918308eb84a3..878255a52dbf47a2017f79f17115c0dc4d8b7635 100644
--- a/dumux/material/components/constant.hh
+++ b/dumux/material/components/constant.hh
@@ -33,7 +33,6 @@ namespace Components {
/*!
* \ingroup Components
- *
* \brief A component which returns run time specified values
* for all fluid properties.
*
@@ -59,7 +58,7 @@ public:
{ return false; }
/*!
- * \brief Returns true if the gas phase viscostiy is constant
+ * \brief Returns true if the gas phase viscosity is constant
*/
static constexpr bool gasViscosityIsConstant()
{ return true; }
@@ -77,7 +76,7 @@ public:
{ return false; }
/*!
- * \brief Returns true if the liquid phase viscostiy is constant
+ * \brief Returns true if the liquid phase viscosity is constant
*/
static constexpr bool liquidViscosityIsConstant()
{ return true; }
diff --git a/dumux/material/components/h2.hh b/dumux/material/components/h2.hh
index f3b3792f8113fc841f36eb0ceddc4c465b082946..5b705b67ed7df2109433a3f71ef18ee9282d138d 100644
--- a/dumux/material/components/h2.hh
+++ b/dumux/material/components/h2.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Properties of pure molecular hydrogen \f$H_2\f$.
*/
#ifndef DUMUX_H2_HH
@@ -37,7 +35,6 @@ namespace Dumux
/*!
* \ingroup Components
- *
* \brief Properties of pure molecular hydrogen \f$H_2\f$.
*
* \tparam Scalar The type used for scalar values
@@ -161,6 +158,8 @@ public:
*
* This is equivalent to the partial derivative of the specific
* enthalpy to the temperature.
+ * \param T temperature of component in \f$\mathrm{[K]}\f$
+ * \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
*
* See: R. Reid, et al. (1987, pp 154, 657, 665) \cite reid1987
*/
@@ -184,7 +183,7 @@ public:
/*!
* \brief The dynamic viscosity \f$\mathrm{[Pa*s]}\f$ of \f$H_2\f$ at a given pressure and temperature.
*
- *\param temperature temperature of component in \f$\mathrm{[K]}\f$
+ * \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
*
* See:
diff --git a/dumux/material/components/h2o.hh b/dumux/material/components/h2o.hh
index acf9c76d58b658abf5eb0990ec98d1905eada017..c92a63868e675253da219cd48eaaec6472811763 100644
--- a/dumux/material/components/h2o.hh
+++ b/dumux/material/components/h2o.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Material properties of pure water \f$H_2O\f$.
*/
#ifndef DUMUX_H2O_HH
@@ -44,9 +42,7 @@ namespace Dumux
{
/*!
* \ingroup Components
- *
* \brief Material properties of pure water \f$H_2O\f$.
- *
* \tparam Scalar The type used for scalar values
*
* See:
@@ -351,7 +347,7 @@ public:
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
* 1997 for the Thermodynamic Properties of Water and Steam",
* http://www.iapws.org/relguide/IF97-Rev.pdf \cite IAPWS1997
- */
+ */
static Scalar gasInternalEnergy(Scalar temperature, Scalar pressure)
{
Region2::checkValidityRange(temperature, pressure, "Internal energy");
@@ -446,7 +442,7 @@ public:
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
* 1997 for the Thermodynamic Properties of Water and Steam",
* http://www.iapws.org/relguide/IF97-Rev.pdf \cite IAPWS1997
- */
+ */
static Scalar gasHeatCapacityConstVolume(Scalar temperature, Scalar pressure)
{
Region2::checkValidityRange(temperature, pressure, "Heat capacity for a constant volume");
diff --git a/dumux/material/components/heavyoil.hh b/dumux/material/components/heavyoil.hh
index d759f0de704a4e237a13e68d3a29a68fa81b9397..c866c8e6535b3f7e264f0eb550952decffd4716c 100644
--- a/dumux/material/components/heavyoil.hh
+++ b/dumux/material/components/heavyoil.hh
@@ -18,10 +18,8 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
- * \brief Properties of heavyoil.
+ * \brief Properties of the component heavyoil.
*
*/
#ifndef DUMUX_HEAVYOIL_HH
@@ -35,7 +33,7 @@ namespace Dumux
{
/*!
* \ingroup Components
- * \brief heavyoil
+ * \brief Properties of the component heavyoil
*
* \tparam Scalar The type used for scalar values
*/
@@ -220,8 +218,6 @@ public:
/*!
* \brief The saturation vapor pressure in \f$\mathrm{[Pa]}\f$ of
*
- *
- *
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
*/
static Scalar vaporPressure(Scalar temperature)
@@ -330,7 +326,7 @@ public:
}
/*!
- * \brief
+ * \brief The (ideal) gas density of heavyoil vapor at a given temperature and pressure \f$\mathrm{[kg/m^3]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
diff --git a/dumux/material/components/iapws/common.hh b/dumux/material/components/iapws/common.hh
index 24406440fab76abaddca9bc5c2e903ef3705e182..19349c8eda636360eaa1a3a50b74a72a3afde988 100644
--- a/dumux/material/components/iapws/common.hh
+++ b/dumux/material/components/iapws/common.hh
@@ -18,12 +18,9 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup IAPWS
- *
* \brief Implements relations common for all regions of the IAPWS '97
* formulation.
- *
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
@@ -46,7 +43,6 @@ namespace IAPWS
/*!
*
* \ingroup IAPWS
- *
* \brief Implements relations which are common for all regions of the IAPWS '97
* formulation.
*
@@ -152,18 +148,18 @@ public:
}
/*!
- * \brief Thermal conductivity \f$\mathrm{[[W/(m*K)]}\f$ water (IAPWS) .
- *
- * Implementation taken from:
- * freesteam - IAPWS-IF97 steam tables library
- * copyright (C) 2004-2009 John Pye
- *
- * Appendix B: Recommended Interpolating equation for Industrial Use
- * see http://www.iapws.org/relguide/thcond.pdf
- *
- * \param T absolute temperature in \f$\mathrm{[K]}\f$
- * \param rho density of water in \f$\mathrm{[kg/m^3]}\f$
- */
+ * \brief Thermal conductivity \f$\mathrm{[[W/(m*K)]}\f$ water (IAPWS) .
+ *
+ * Implementation taken from:
+ * freesteam - IAPWS-IF97 steam tables library
+ * copyright (C) 2004-2009 John Pye
+ *
+ * Appendix B: Recommended Interpolating equation for Industrial Use
+ * see http://www.iapws.org/relguide/thcond.pdf
+ *
+ * \param T absolute temperature in \f$\mathrm{[K]}\f$
+ * \param rho density of water in \f$\mathrm{[kg/m^3]}\f$
+ */
static Scalar thermalConductivityIAPWS(const Scalar T, const Scalar rho)
{
Scalar thcond_tstar = 647.26 ;
diff --git a/dumux/material/components/iapws/region1.hh b/dumux/material/components/iapws/region1.hh
index eefff15ef6b318d27b7ce8f35b0061b5e03e8926..bdc4f9960565f2365cb3dd262dc52e502a4276d1 100644
--- a/dumux/material/components/iapws/region1.hh
+++ b/dumux/material/components/iapws/region1.hh
@@ -18,11 +18,8 @@
*****************************************************************************/
/*!
* \file
- *
- *\ingroup IAPWS
- *
+ * \ingroup IAPWS
* \brief Implements the equations for region 1 of the IAPWS '97 formulation.
- *
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
@@ -42,11 +39,8 @@ namespace IAPWS
{
/*!
* \ingroup IAPWS
- *
* \brief Implements the equations for region 1 of the IAPWS '97 formulation.
- *
* \tparam Scalar The type used for scalar values
- *
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
diff --git a/dumux/material/components/iapws/region2.hh b/dumux/material/components/iapws/region2.hh
index a7bfe45cfa39d94fb3ed3031cbe7f7c827645e71..33c50889caa448daa5efe9607edcabcae2637115 100644
--- a/dumux/material/components/iapws/region2.hh
+++ b/dumux/material/components/iapws/region2.hh
@@ -19,11 +19,8 @@
/*!
* \file
- *
* \ingroup IAPWS
- *
* \brief Implements the equations for region 2 of the IAPWS '97 formulation.
- *
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
@@ -42,13 +39,9 @@ namespace Dumux
namespace IAPWS
{
/*!
- *
* \ingroup IAPWS
- *
* \brief Implements the equations for region 2 of the IAPWS '97 formulation.
- *
* \tparam Scalar The type used for scalar values
- *
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
diff --git a/dumux/material/components/iapws/region4.hh b/dumux/material/components/iapws/region4.hh
index e3496ed8af951808da6fec4fff7a0c658c8fe8f5..ca5fdb6b6cde522bca9859d8d655ec6a8102d53f 100644
--- a/dumux/material/components/iapws/region4.hh
+++ b/dumux/material/components/iapws/region4.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
- *\ingroup IAPWS
- *
+ * \ingroup IAPWS
* \brief Implements the equations for region 4 of the IAPWS '97 formulation.
*
* See:
@@ -42,9 +40,7 @@ namespace IAPWS
/*!
* \ingroup IAPWS
- *
* \brief Implements the equations for region 4 of the IAPWS '97 formulation.
- *
* \tparam Scalar The type used for scalar values
*
* See:
diff --git a/dumux/material/components/lnapl.hh b/dumux/material/components/lnapl.hh
index eb7b3416e905e8369669ad293c0d28dcb73cb011..67d1be4302b1fe59664abf8c0ee827dc63ec6c34 100644
--- a/dumux/material/components/lnapl.hh
+++ b/dumux/material/components/lnapl.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *\ingroup Components
+ * \ingroup Components
* \brief A simple implementation of a LNAPL.
*/
#ifndef DUMUX_LNAPL_HH
@@ -31,7 +31,6 @@ namespace Dumux
{
/*!
* \ingroup Components
- *
* \brief A simple implementation of a LNAPL, e.g. a kind of oil
*
* \tparam Scalar The type used for scalar values
@@ -54,7 +53,7 @@ public:
{ return false; }
/*!
- * \brief Rough estimate of the density of oil \f$\mathrm{[kg/m^3]}\f$.
+ * \brief Rough estimate of the liquid density of oil \f$\mathrm{[kg/m^3]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
@@ -65,7 +64,7 @@ public:
}
/*!
- * \brief Rough estimate of the viscosity of oil in \f$\mathrm{[Pa*s]}\f$.
+ * \brief Rough estimate of the liquid viscosity of oil in \f$\mathrm{[Pa*s]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
diff --git a/dumux/material/components/mesitylene.hh b/dumux/material/components/mesitylene.hh
index 73af118f97947c29c97ca22146430c0ff404036e..524b754cd12b572aacb5e441f5c3d916c0ced1f6 100644
--- a/dumux/material/components/mesitylene.hh
+++ b/dumux/material/components/mesitylene.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Properties of mesitylene.
*
*/
diff --git a/dumux/material/components/n2.hh b/dumux/material/components/n2.hh
index 28a3f4b57b1468bbdd710b7af97a194bf7044124..c137c6f29bfdb90dafc8ccf24cc645ec01c1c0c2 100644
--- a/dumux/material/components/n2.hh
+++ b/dumux/material/components/n2.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Properties of pure molecular nitrogen \f$N_2\f$.
*/
#ifndef DUMUX_N2_HH
@@ -36,8 +34,7 @@ namespace Dumux
{
/*!
- * \ingroup Components
- *
+ * \ingroup Componentss
* \brief Properties of pure molecular nitrogen \f$N_2\f$.
*
* \tparam Scalar The type used for scalar values
@@ -88,7 +85,7 @@ public:
* \brief The vapor pressure in \f$\mathrm{[Pa]}\f$ of pure molecular nitrogen
* at a given temperature.
*
- *\param T temperature of component in \f$\mathrm{[K]}\f$
+ * \param T temperature of component in \f$\mathrm{[K]}\f$
*
* Taken from:
*
diff --git a/dumux/material/components/nacl.hh b/dumux/material/components/nacl.hh
index 6f6acdfa468d45f7b3ccb96bc9285c4b6b259729..66d3c241632c3196b61eee883c88db60f4d3c424 100644
--- a/dumux/material/components/nacl.hh
+++ b/dumux/material/components/nacl.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Material properties of pure salt \f$NaCl\f$.
*/
#ifndef DUMUX_NACL_HH
@@ -36,6 +34,7 @@
namespace Dumux
{
/*!
+ * \ingroup Components
* \brief A class for the NaCl properties
*/
template <class Scalar>
@@ -60,6 +59,8 @@ public:
/*!
* \brief The diffusion Coefficient \f$\mathrm{[m^2/s]}\f$ of NaCl in water.
+ * \param temperature absolute temperature in \f$\mathrm{[K]}\f$
+ * \param pressure of the phase in \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidDiffCoeff(Scalar temperature, Scalar pressure)
{
diff --git a/dumux/material/components/o2.hh b/dumux/material/components/o2.hh
index af9d3273da7ca629bc389aacc9382a91c49787bf..8d2d5955973b3fc108a51f825b54af99505a056b 100644
--- a/dumux/material/components/o2.hh
+++ b/dumux/material/components/o2.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Properties of pure molecular oxygen \f$O_2\f$.
*/
#ifndef DUMUX_O2_HH
@@ -37,7 +35,6 @@ namespace Dumux
/*!
* \ingroup Components
- *
* \brief Properties of pure molecular oxygen \f$O_2\f$.
*
* \tparam Scalar The type used for scalar values
@@ -173,6 +170,8 @@ public:
*
* This is equivalent to the partial derivative of the specific
* enthalpy to the temperature.
+ * \param T absolute temperature in \f$\mathrm{[K]}\f$
+ * \param pressure of the phase in \f$\mathrm{[Pa]}\f$
*
* See: R. Reid, et al. (1987, pp 154, 657, 665) \cite reid1987
*/
diff --git a/dumux/material/components/simpleco2.hh b/dumux/material/components/simpleco2.hh
index 083e81a281e316d55793b4c2d4adfbbf9a73058a..90c533a7e98e209bd0a734f4d170b800d3775442 100644
--- a/dumux/material/components/simpleco2.hh
+++ b/dumux/material/components/simpleco2.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief A simple class for the \f$CO_2\f$ fluid properties
*/
#ifndef DUMUX_SIMPLE_CO2_HH
@@ -36,7 +34,6 @@ namespace Dumux
{
/*!
* \ingroup Components
- *
* \brief A class for the \f$CO_2\f$ fluid properties
*
* \tparam Scalar The type used for scalar values
@@ -136,7 +133,7 @@ public:
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
- */
+ */
static Scalar gasDensity(Scalar temperature, Scalar pressure)
{
// Assume an ideal gas
@@ -164,7 +161,7 @@ public:
/*!
* \brief The dynamic viscosity \f$\mathrm{[Pa*s]}\f$ of \f$CO_2\f$ at a given pressure and temperature.
*
- *\param temperature temperature of component in \f$\mathrm{[K]}\f$
+ * \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
*
* See:
diff --git a/dumux/material/components/simpleh2o.hh b/dumux/material/components/simpleh2o.hh
index 6cbd4b28079c700ba2eb54c975f3aaeaf09f35d8..00851dccdaf7aaac1e4ec7f6e057fa827b2ff2b8 100644
--- a/dumux/material/components/simpleh2o.hh
+++ b/dumux/material/components/simpleh2o.hh
@@ -35,7 +35,6 @@ namespace Dumux
{
/*!
* \ingroup Components
- *
* \brief A much simpler (and thus potentially less buggy) version of
* pure water.
*
@@ -288,26 +287,32 @@ public:
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
* source: http://webbook.nist.gov/cgi/fluid.cgi?ID=C7732185&Action=Page
* @ T= 281.15K (8°C) , p=0.1MPa)
+ * \param temperature absolute temperature in \f$\mathrm{[K]}\f$
+ * \param pressure of the phase in \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidHeatCapacity(Scalar temperature, Scalar pressure)
{
return 4.2e3;
}
- /*!
+ /*!
* \brief Thermal conductivity \f$\mathrm{[[W/(m*K)]}\f$ of water.
* source: http://webbook.nist.gov/cgi/fluid.cgi?ID=C7732185&Action=Page
* @ T= 372.76K (99.6°C) , p=0.1MPa)
+ * \param temperature absolute temperature in \f$\mathrm{[K]}\f$
+ * \param pressure of the phase in \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidThermalConductivity(Scalar temperature, Scalar pressure)
{
return 0.679;
}
- /*!
+ /*!
* \brief Thermal conductivity \f$\mathrm{[[W/(m*K)]}\f$ of steam.
* source: http://webbook.nist.gov/cgi/fluid.cgi?ID=C7732185&Action=Page
* @ T= 372.76K (99.6°C) , p=0.1MPa)
+ * \param temperature absolute temperature in \f$\mathrm{[K]}\f$
+ * \param pressure of the phase in \f$\mathrm{[Pa]}\f$
*/
static Scalar gasThermalConductivity(Scalar temperature, Scalar pressure)
{
diff --git a/dumux/material/components/tabulatedcomponent.hh b/dumux/material/components/tabulatedcomponent.hh
index e8fea2d548bb00df383bdc87df2859559a0cfece..feeb2c47d976854c464fa21ca800120713be43e2 100644
--- a/dumux/material/components/tabulatedcomponent.hh
+++ b/dumux/material/components/tabulatedcomponent.hh
@@ -40,7 +40,6 @@ namespace Dumux
/*!
* \ingroup Components
- *
* \brief Tabulates all thermodynamic properties of a given
* untabulated chemical species.
*
diff --git a/dumux/material/components/unit.hh b/dumux/material/components/unit.hh
index 807653b60843b9dc0bbbffc70e6c85fc1ae2e2d4..ee7fa7484fdbc499eeb59b7e6f6321ee5895f3c9 100644
--- a/dumux/material/components/unit.hh
+++ b/dumux/material/components/unit.hh
@@ -31,7 +31,6 @@ namespace Dumux
{
/*!
* \ingroup Components
- *
* \brief A component using a value of one for all fluid properties.
*
* \tparam Scalar The type used for scalar values
diff --git a/dumux/material/components/xylene.hh b/dumux/material/components/xylene.hh
index 4b2f245cf11b27b151d76da22b4302b221f23349..ce5a7a9af44deb60fd4bed64da317ecd666c4dae 100644
--- a/dumux/material/components/xylene.hh
+++ b/dumux/material/components/xylene.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Properties of xylene.
*/
#ifndef DUMUX_XYLENE_HH
@@ -36,7 +34,7 @@ namespace Dumux
{
/*!
* \ingroup Components
- * \brief xylene
+ * \brief Properties of xylene.
*
* \tparam Scalar The type used for scalar values
*/
@@ -98,7 +96,6 @@ public:
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
*/
-
static Scalar vaporPressure(Scalar temperature)
{
const Scalar A = 7.00909;
@@ -254,7 +251,7 @@ public:
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
- */
+ */
static Scalar molarGasDensity(Scalar temperature, Scalar pressure)
{
return (gasDensity(temperature, pressure) / molarMass());