Skip to content
GitLab
Commit ffe2ccac authored by Simon Scholz's avatar Simon Scholz
Browse files

[doxygen] fix doxygen in components

parent 8a60ddfd
Hide whitespace changes
Inline Side-by-side
dumux/material/components/CMakeLists.txt
View file @ ffe2ccac
......@@ -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
......
dumux/material/components/CaO.hh
View file @ ffe2ccac
......@@ -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>
......
dumux/material/components/CaO2H2.hh
View file @ ffe2ccac
......@@ -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>
......
dumux/material/components/air.hh
View file @ ffe2ccac
......@@ -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
......
dumux/material/components/benzene.hh
View file @ ffe2ccac
......@@ -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$
......
dumux/material/components/brine.hh
View file @ ffe2ccac
......@@ -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$
......
dumux/material/components/ch4.hh
View file @ ffe2ccac
......@@ -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;
}
};
......
dumux/material/components/co2.hh
View file @ ffe2ccac
......@@ -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)
{
......
dumux/material/components/co2tablereader.hh
View file @ ffe2ccac
......@@ -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.
*/
......
dumux/material/components/component.hh
View file @ ffe2ccac
......@@ -19,7 +19,6 @@
/*!
* \file
*
* \ingroup Components
* \brief Abstract base class of a pure chemical species.
*/
......
dumux/material/components/constant.hh
View file @ ffe2ccac
......@@ -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; }
......
dumux/material/components/h2.hh
View file @ ffe2ccac
......@@ -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:
......
dumux/material/components/h2o.hh
View file @ ffe2ccac
......@@ -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");
......
dumux/material/components/heavyoil.hh
View file @ ffe2ccac
......@@ -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$
......
dumux/material/components/iapws/common.hh
View file @ ffe2ccac
......@@ -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 ;
......
dumux/material/components/iapws/region1.hh
View file @ ffe2ccac
......@@ -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
......
dumux/material/components/iapws/region2.hh
View file @ ffe2ccac
......@@ -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
......
dumux/material/components/iapws/region4.hh
View file @ ffe2ccac
......@@ -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:
......
dumux/material/components/lnapl.hh
View file @ ffe2ccac
......@@ -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$
......
dumux/material/components/mesitylene.hh
View file @ ffe2ccac
......@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup Components
*
* \brief Properties of mesitylene.
*
*/
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment