From 133c19b7de5a5583b26c7f3cff938226e8dc9c08 Mon Sep 17 00:00:00 2001 From: Katherina Baber Date: Thu, 7 Oct 2010 09:56:14 +0000 Subject: [PATCH] added units to doxygen documentation for components folder (to be continued) added an overloaded update function to boxelementvolumevariables.hh to allow the solution vector to be passed to the function --- dumux/material/components/brine.hh | 62 +++++++++--------- dumux/material/components/ch4.hh | 54 +++++++-------- dumux/material/components/component.hh | 71 +++++++++++--------- dumux/material/components/h2.hh | 46 ++++++------- dumux/material/components/h2o.hh | 76 +++++++++++----------- dumux/material/components/iapws/common.hh | 7 +- dumux/material/components/iapws/region1.hh | 64 +++++++++--------- dumux/material/components/iapws/region2.hh | 62 +++++++++--------- dumux/material/components/iapws/region4.hh | 4 +- 9 files changed, 228 insertions(+), 218 deletions(-) diff --git a/dumux/material/components/brine.hh b/dumux/material/components/brine.hh index ada0429d5..4cad8cf03 100644 --- a/dumux/material/components/brine.hh +++ b/dumux/material/components/brine.hh @@ -18,7 +18,7 @@ * * \ingroup Components * - * \brief A class for the brine fluid properties + * \brief A class for the brine fluid properties,. */ #ifndef DUMUX_BRINE_HH #define DUMUX_BRINE_HH @@ -34,10 +34,10 @@ namespace Dumux * * \ingroup Components * - * \brief A class for the brine fluid properties + * \brief A class for the brine fluid properties. * * \tparam Scalar The type used for scalar values - * \tparam H2O ??? + * \tparam H2O Static polymorphism: the Brine class can access all properties of the H2O class */ template class Brine : public Component > @@ -53,9 +53,9 @@ public: { return "Brine"; } /*! - * \brief The mass in [kg] of one mole of brine. + * \brief The molar mass in [kg/mol] of brine. * - * This assumes that the salt is pure NaCl + * This assumes that the salt is pure NaCl. */ static Scalar molarMass() { @@ -66,13 +66,13 @@ public: }; /*! - * \brief Returns the critical temperature [K] of brine + * \brief Returns the critical temperature [K] of brine. */ static Scalar criticalTemperature() { return H2O::criticalTemperature(); /* [K] */ } /*! - * \brief Returns the critical pressure [Pa] of brine + * \brief Returns the critical pressure [Pa] of brine. */ static Scalar criticalPressure() { return H2O::criticalPressure(); /* [N/m^2] */ } @@ -90,10 +90,10 @@ public: { return H2O::triplePressure(); /* [N/m^2] */ } /*! - * \brief The vapor pressure in [N/m^2] of pure brine + * \brief The vapor pressure in [Pa] of pure brine * at a given temperature. * - * \param T temperature of component + * \param T temperature of component in [K] */ static Scalar vaporPressure(Scalar T) @@ -102,8 +102,8 @@ public: /*! * \brief Specific enthalpy of gaseous brine [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) @@ -112,8 +112,8 @@ public: /*! * \brief Specific enthalpy of liquid brine [J/kg]. * - * \param T temperature of component - * \param p pressure of component + * \param T temperature of component in [K] + * \param p pressure of component in [Pa] * * Equations given in: - Palliser & McKibbin 1997 * - Michaelides 1981 @@ -181,8 +181,8 @@ public: /*! * \brief Specific internal energy of 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 gasInternalEnergy(Scalar temperature, Scalar pressure) @@ -193,8 +193,8 @@ public: /*! * \brief Specific internal energy of liquid brine [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) @@ -207,8 +207,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) { return H2O::gasDensity(temperature, pressure); } @@ -216,8 +216,8 @@ public: /*! * \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 + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] * * Equations given in: - Batzle & Wang (1992) * - cited by: Adams & Bachu in Geofluids (2002) 2, 257-271 @@ -245,20 +245,20 @@ public: } /*! - * \brief The pressure of steam at a given density and temperature [Pa]. + * \brief The pressure of steam in [Pa] at a given density and temperature. * - * \param temperature temperature of component - * \param density denstiy of component + * \param temperature temperature of component in [K] + * \param density denstiy of component in [kg/m^3] */ static Scalar gasPressure(Scalar temperature, Scalar density) { return H2O::gasPressure(temperature, density); } /*! - * \brief The pressure of liquid water at a given density and - * temperature [Pa]. + * \brief The pressure of liquid water 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) { @@ -297,8 +297,8 @@ public: /*! * \brief The dynamic viscosity [N/m^3*s] of pure brine. * - * \param temperature temperature of component - * \param pressure pressure of component + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] * * Equation given in: - Batzle & Wang (1992) * - cited by: Bachu & Adams (2002) @@ -319,7 +319,7 @@ public: template /*! - * \brief Default value for the salinity of the brine. + * \brief Default value for the salinity of the brine (dimensionless). */ Scalar Brine::salinity = 0.1; // also needs to be adapted in CO2 solubility table! diff --git a/dumux/material/components/ch4.hh b/dumux/material/components/ch4.hh index 579366291..7c571f2dc 100644 --- a/dumux/material/components/ch4.hh +++ b/dumux/material/components/ch4.hh @@ -17,7 +17,7 @@ * * \ingroup Components * - * \brief Properties of methone (\f$CH_4\f$). + * \brief Properties of methane (\f$CH_4\f$). */ #ifndef DUMUX_CH4_HH #define DUMUX_CH4_HH @@ -52,7 +52,7 @@ public: { return "CH4"; } /*! - * \brief The mass in [kg/mol] of one of molecular methane. + * \brief The molar mass in [kg/mol] of molecular methane. */ static Scalar molarMass() { return 16.043e-3;} @@ -85,7 +85,7 @@ public: * \brief The vapor pressure in [Pa] of pure molecular methane * 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 for CH4"); } @@ -94,8 +94,8 @@ 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 + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] */ static Scalar gasDensity(Scalar temperature, Scalar pressure) { @@ -104,10 +104,10 @@ public: } /*! - * \brief The pressure of gaseous CH4 at a given density and temperature [Pa]. + * \brief The pressure of gaseous CH4 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) { @@ -118,18 +118,18 @@ 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 + * \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 CH4"); } /*! - * \brief The pressure of liquid methane at a given density and - * temperature [Pa]. - * - * \param temperature temperature of component - * \param density density of component + * \brief The pressure of liquid methane in [Pa] at a given density and + * temperature. + * + * \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 CH4"); } @@ -137,8 +137,8 @@ public: /*! * \brief Specific enthalpy [J/kg] of pure methane 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, 671 @@ -168,8 +168,8 @@ public: /*! * \brief Specific enthalpy [J/kg] of pure liquid CH4. * - * \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 CH4"); } @@ -177,8 +177,8 @@ public: /*! * \brief Specific enthalpy [J/kg] of pure methane 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) @@ -192,8 +192,8 @@ public: /*! * \brief Specific enthalpy [J/kg] of pure liquid CH4. * - * \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 CH4"); } @@ -201,8 +201,8 @@ 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 + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] * * See: * @@ -236,8 +236,8 @@ public: /*! * \brief The dynamic liquid viscosity [N/m^3*s] of pure CH4. * - * \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 CH4"); } diff --git a/dumux/material/components/component.hh b/dumux/material/components/component.hh index f7ea4dbe3..fb046850c 100644 --- a/dumux/material/components/component.hh +++ b/dumux/material/components/component.hh @@ -39,39 +39,48 @@ namespace Dumux * \brief Abstract base class of a pure chemical species. * * \tparam Scalar The type used for scalar values - * \tparam Implementation ??? + * \tparam Implementation Necessary for static polymorphism */ template class Component { public: /*! - * \internal + * \brief A default routine for initialization, not needed for components and must not be called. + * + * \param tempMin The minimum of the temperature range in [K] + * \param tempMax The maximum of the temperature range in [K] + * \param nTemp The number of entries/steps within the temperature range + * \param pressMin The minimum of the pressure range in [Pa] + * \param pressMax The maximum of the pressure range in [Pa] + * \param 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!" */ static void init(Scalar tempMin, Scalar tempMax, unsigned nTemp, Scalar pressMin, Scalar pressMax, unsigned nPress) { Dune::dwarn << "No init routine defined - make sure that this is not necessary!" << std::endl; } /*! - * \brief A human readable name for the compoent. + * \brief A human readable name for the component. */ static const char *name() { DUNE_THROW(Dune::NotImplemented, "Component::name()"); } /*! - * \brief The mass in [kg] of one mole of the component. + * \brief The molar mass in [kg] of the component. */ static Scalar molarMass() { DUNE_THROW(Dune::NotImplemented, "Component::molarMass()"); } /*! - * \brief Returns the critical temperature in [K] 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 in [Pa] of the component + * \brief Returns the critical pressure in [Pa] of the component. */ static Scalar criticalPressure() { DUNE_THROW(Dune::NotImplemented, "Component::criticalPressure()"); } @@ -89,55 +98,55 @@ public: { DUNE_THROW(Dune::NotImplemented, "Component::triplePressure()"); } /*! - * \brief The vapor pressure in [N/m^2] of the component at a given - * temperature. + * \brief The vapor pressure in [Pa] of the component at a given + * temperature in [K]. * - * \param T temperature of the component + * \param T temperature of the component in [K] */ 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. + * \brief The density in [kg/m^3] of the component at a given pressure in [Pa] and temperature in [K]. * - * \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) { DUNE_THROW(Dune::NotImplemented, "Component::density()"); } /*! - * \brief The density [kg/m^3] of the liquid component at a given pressure and temperature. + * \brief The density [kg/m^3] of the liquid component at a given pressure in [Pa] and temperature in [K]. * - * \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, "Component::density()"); } /*! - * \brief Specific enthalpy [J/kg] of pure the pure component in gas. + * \brief Specific enthalpy [J/kg] of the pure component in 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 gasEnthalpy(Scalar temperature, Scalar pressure) { DUNE_THROW(Dune::NotImplemented, "Component::gasEnthalpy()"); } /*! - * \brief Specific enthalpy [J/kg] of pure the pure component in liquid. + * \brief Specific enthalpy [J/kg] of the pure component in liquid. * - * \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) { DUNE_THROW(Dune::NotImplemented, "Component::liquidEnthalpy()"); } /*! - * \brief Specific internal energy [J/kg] of pure the pure component in gas. + * \brief Specific internal energy [J/kg] of the pure component in 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) { DUNE_THROW(Dune::NotImplemented, "Component::gasInternalEnergy()"); } @@ -145,17 +154,17 @@ public: /*! * \brief Specific internal energy [J/kg] of pure the pure component in liquid. * - * \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) { DUNE_THROW(Dune::NotImplemented, "Component::liquidInternalEnergy()"); } /*! - * \brief The dynamic viscosity [Pa s] of the pure component at a given pressure and temperature. + * \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 - * \param pressure pressure of component + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] */ static Scalar gasViscosity(Scalar temperature, Scalar pressure) { DUNE_THROW(Dune::NotImplemented, "Component::gasViscosity()"); } @@ -163,8 +172,8 @@ public: /*! * \brief The dynamic liquid viscosity [N/m^3*s] of the pure component. * - * \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, "Component::liquidViscosity()"); } diff --git a/dumux/material/components/h2.hh b/dumux/material/components/h2.hh index 4e14c87ff..68c24fc76 100644 --- a/dumux/material/components/h2.hh +++ b/dumux/material/components/h2.hh @@ -52,19 +52,19 @@ public: { return "H2"; } /*! - * \brief The mass in [kg/mol] of one of molecular hydrogen. + * \brief The molar mass in [kg/mol] of molecular hydrogen. */ static Scalar molarMass() { return 1.0e-3; } /*! - * \brief Returns the critical temperature [K] of molecular hydrogen + * \brief Returns the critical temperature [K] of molecular hydrogen. */ static Scalar criticalTemperature() { return 33.2; /* [K] */ } /*! - * \brief Returns the critical pressure [Pa] of molecular hydrogen + * \brief Returns the critical pressure [Pa] of molecular hydrogen. */ static Scalar criticalPressure() { return 13.0e5; /* [N/m^2] */ } @@ -85,7 +85,7 @@ public: * \brief The vapor pressure in [Pa] of pure molecular hydrogen * at a given temperature. * - *\param temperature temperature of component + *\param temperature temperature of component in [K] * * Taken from: * @@ -113,8 +113,8 @@ 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 + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] */ static Scalar gasDensity(Scalar temperature, Scalar pressure) { @@ -123,10 +123,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) { @@ -137,8 +137,8 @@ public: /*! * \brief Specific enthalpy [J/kg] of pure hydrogen 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 @@ -168,18 +168,18 @@ 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 + * \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 H2"); } /*! - * \brief The pressure of liquid hydrogen at a given density and - * temperature [Pa]. + * \brief The pressure of liquid hydrogen 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 H2"); } @@ -187,8 +187,8 @@ public: /*! * \brief Specific enthalpy [J/kg] of pure liquid 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 liquidEnthalpy(Scalar temperature, Scalar pressure) { DUNE_THROW(Dune::NotImplemented, "liquidEnthalpy for H2"); } @@ -196,8 +196,8 @@ 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 + *\param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] * * See: * @@ -231,8 +231,8 @@ public: /*! * \brief The dynamic liquid viscosity [N/m^3*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 H2"); } diff --git a/dumux/material/components/h2o.hh b/dumux/material/components/h2o.hh index 9ec08f3bf..2c33667b5 100644 --- a/dumux/material/components/h2o.hh +++ b/dumux/material/components/h2o.hh @@ -71,19 +71,19 @@ public: { return "H2O"; } /*! - * \brief The mass in [kg] of one mole of water. + * \brief The molar mass in [kg] of water. */ static Scalar molarMass() { return Common::molarMass; } /*! - * \brief Returns the critical temperature [K] of water + * \brief Returns the critical temperature [K] of water. */ static Scalar criticalTemperature() { return Common::criticalTemperature; } /*! - * \brief Returns the critical pressure [Pa] of water + * \brief Returns the critical pressure [Pa] of water. */ static Scalar criticalPressure() { return Common::criticalPressure; } @@ -104,7 +104,7 @@ public: * \brief The vapor pressure in [N/m^2] of pure water * at a given temperature. * - *\param T temperature of component + *\param T temperature of component in [K] * * See: * @@ -125,8 +125,8 @@ public: /*! * \brief Specific enthalpy of water 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] * * See: * @@ -175,8 +175,8 @@ public: /*! * \brief Specific enthalpy of liquid water [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] * * See: * @@ -216,8 +216,8 @@ public: /*! * \brief Specific isobaric heat capacity of water 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] * * See: * @@ -251,8 +251,8 @@ public: /*! * \brief Specific isobaric heat capacity of liquid water [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] * * See: * @@ -284,8 +284,8 @@ public: /*! * \brief Specific internal energy of liquid water [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] * * See: * @@ -341,8 +341,8 @@ public: /*! * \brief Specific internal energy of steam and water vapor [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] * * See: * @@ -414,8 +414,8 @@ public: /*! * \brief Specific isochoric heat capacity of liquid water [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] * * See: * @@ -448,8 +448,8 @@ public: /*! * \brief Specific isochoric heat capacity of steam and water vapor [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] * * See: * @@ -480,10 +480,10 @@ public: } /*! - * \brief The density of steam at a given pressure and temperature [kg/m^3]. + * \brief The density of steam in [kg/m^3] 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: * @@ -552,10 +552,10 @@ public: } /*! - * \brief The pressure of steam at a given density and temperature [Pa]. + * \brief The pressure of steam in [Pa] at a given density and temperature. * - * \param temperature temperature of component - * \param density of component + * \param temperature temperature of component in [K] + * \param density of component in [kg/m^3] * * See: * @@ -595,10 +595,10 @@ public: } /*! - * \brief The density of pure water at a given pressure and temperature [kg/m^3]. + * \brief The density of pure water in [kg/m^3] 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: * @@ -654,11 +654,11 @@ public: } /*! - * \brief The pressure of liquid water at a given density and - * temperature [Pa]. + * \brief The pressure of liquid water 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] * * See: * @@ -694,10 +694,10 @@ public: /*! * \brief The dynamic viscosity [N/m^3*s] of steam. * - * \param temperature temperature of component - * \param pressure pressure of component + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] * - * This method is only valid if pressure is below or at the vapour + * This method is only valid if pressure is below or at the vapor * pressure of water. * * See: @@ -721,8 +721,8 @@ public: /*! * \brief The dynamic viscosity [N/m^3*s] of pure water. * - * \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: * diff --git a/dumux/material/components/iapws/common.hh b/dumux/material/components/iapws/common.hh index 99074f81e..67836c1c6 100644 --- a/dumux/material/components/iapws/common.hh +++ b/dumux/material/components/iapws/common.hh @@ -46,8 +46,9 @@ namespace IAPWS * * \ingroup IAPWS * - * \brief Implements relations common for all regions of the IAPWS '97 + * \brief Implements relations which are common for all regions of the IAPWS '97 * formulation. + * * \tparam Scalar The type used for scalar values * * See: @@ -87,8 +88,8 @@ public: * This relation is valid for all regions of the IAPWS '97 * formulation. * - * \param temperature temperature of component - * \param rho density of component + * \param temperature temperature of component in [K] + * \param rho density of component in [kg/m^3] * * See: * diff --git a/dumux/material/components/iapws/region1.hh b/dumux/material/components/iapws/region1.hh index 71087f4b0..44ede6e3c 100644 --- a/dumux/material/components/iapws/region1.hh +++ b/dumux/material/components/iapws/region1.hh @@ -55,10 +55,10 @@ class Region1 public: /*! * \brief Returns true if IAPWS region 1 applies for a - * (temperature, pressure) pair. + * (temperature in [K], pressure in [Pa]) pair. * - * \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 bool isValid(Scalar temperature, Scalar pressure) { @@ -79,54 +79,54 @@ public: } /*! - * \brief Returns the reduced temperature [K] for IAPWS region 1. + * \brief Returns the reduced temperature for IAPWS region 1. * - * \param temperature temperature of component + * \param temperature temperature of component in [K] */ static Scalar tau(Scalar temperature) { return 1386.0 / temperature; } /*! * \brief Returns the derivative of the reduced temperature to the - * temperature for IAPWS region 1. + * temperature for IAPWS region 1 in [1/K]. * - * \param temperature temperature of component + * \param temperature temperature of component in [K] */ static Scalar dtau_dT(Scalar temperature) { return - 1386.0 / (temperature*temperature); } /*! - * \brief Returns the reduced pressure [Pa] for IAPWS region 1. + * \brief Returns the reduced pressure for IAPWS region 1. * - * \param pressure pressure of component + * \param pressure pressure of component in [Pa] */ static Scalar pi(Scalar pressure) { return pressure / 16.53e6; } /*! * \brief Returns the derivative of the reduced pressure to the - * pressure for IAPWS region 1. + * pressure for IAPWS region 1 in [1/Pa]. * - * \param pressure temperature of component + * \param pressure temperature of component in [Pa] */ static Scalar dpi_dp(Scalar pressure) { return 1.0 / 16.53e6; } /*! * \brief Returns the derivative of the pressure to the - * reduced pressure for IAPWS region 1. + * reduced pressure for IAPWS region 1 in [Pa]. * - * \param pressure pressure of component + * \param pressure pressure of component in [Pa] */ static Scalar dp_dpi(Scalar pressure) { return 16.53e6; } /*! - * \brief The gibbs free energy for IAPWS region 1 (i.e. liquid) + * \brief The Gibbs free energy (dimensionless) for IAPWS region 1 (i.e. liquid) * - * \param temperature temperature of component - * \param pressure pressure of component + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] * * IAPWS: "Revised Release on the IAPWS Industrial Formulation * 1997 for the Thermodynamic Properties of Water and Steam", @@ -147,11 +147,11 @@ public: /*! - * \brieg The partial derivative of the gibbs free energy to the - * normalized temperature for IAPWS region 1 (i.e. liquid) + * \brieg The partial derivative of the Gibbs free energy to the + * normalized temperature for IAPWS region 1 (i.e. liquid) (dimensionless). * - * \param temperature temperature of component - * \param pressure pressure of component + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] * * IAPWS: "Revised Release on the IAPWS Industrial Formulation * 1997 for the Thermodynamic Properties of Water and Steam", @@ -175,11 +175,11 @@ public: } /*! - * \brief The partial derivative of the gibbs free energy to the - * normalized pressure for IAPWS region 1 (i.e. liquid) + * \brief The partial derivative of the Gibbs free energy to the + * normalized pressure for IAPWS region 1 (i.e. liquid) dimensionless). * - * \param temperature temperature of component - * \param pressure pressure of component + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] * * IAPWS: "Revised Release on the IAPWS Industrial Formulation * 1997 for the Thermodynamic Properties of Water and Steam", @@ -203,12 +203,12 @@ public: } /*! - * \brief The partial derivative of the gibbs free energy to the + * \brief The partial derivative of the Gibbs free energy to the * normalized pressure and to the normalized temperature - * for IAPWS region 1 (i.e. liquid water) + * for IAPWS region 1 (i.e. liquid water) (dimensionless). * - * \param temperature temperature of component - * \param pressure pressure of component + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] * * IAPWS: "Revised Release on the IAPWS Industrial Formulation * 1997 for the Thermodynamic Properties of Water and Steam", @@ -233,12 +233,12 @@ public: } /*! - * \brief The second partial derivative of the gibbs free energy + * \brief The second partial derivative of the Gibbs free energy * to the normalized pressure for IAPWS region 1 - * (i.e. liquid water) + * (i.e. liquid water) (dimensionless). * - * \param temperature temperature of component - * \param pressure pressure of component + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] * * IAPWS: "Revised Release on the IAPWS Industrial Formulation * 1997 for the Thermodynamic Properties of Water and Steam", diff --git a/dumux/material/components/iapws/region2.hh b/dumux/material/components/iapws/region2.hh index c3a63bdf3..e05606b1b 100644 --- a/dumux/material/components/iapws/region2.hh +++ b/dumux/material/components/iapws/region2.hh @@ -56,11 +56,11 @@ class Region2 { public: /*! - * \brief Returns true iff IAPWS region 2 applies for a + * \brief Returns true if IAPWS region 2 applies for a * (temperature, pressure) pair. * - * \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 bool isValid(Scalar temperature, Scalar pressure) { @@ -77,7 +77,7 @@ public: } /*! - * \brief Returns the reduced temperature for IAPWS region 2. + * \brief Returns the reduced temperature (dimensionless) for IAPWS region 2. * * \param temperature temperature of component */ @@ -88,43 +88,43 @@ public: * \brief Returns the derivative of the reduced temperature to the * temperature for IAPWS region 2. * - * \param temperature temperature of component + * \param temperature temperature of component in [K] */ static Scalar dtau_dT(Scalar temperature) { return - 540.0 / (temperature*temperature); } /*! - * \brief Returns the reduced pressure for IAPWS region 2. + * \brief Returns the reduced pressure (dimensionless) for IAPWS region 2. * - * \param pressure pressure of component + * \param pressure pressure of component in [Pa] */ static Scalar pi(Scalar pressure) { return pressure / 1e6; } /*! * \brief Returns the derivative of the reduced pressure to the - * pressure for IAPWS region 2. + * pressure for IAPWS region 2 in [1/Pa]. * - * \param pressure pressure of component + * \param pressure pressure of component in [Pa] */ static Scalar dpi_dp(Scalar pressure) { return 1.0 / 1e6; } /*! * \brief Returns the derivative of the pressure to the - * reduced pressure for IAPWS region 2. + * reduced pressure for IAPWS region 2 (dimensionless). * - * \param pressure pressure of component + * \param pressure pressure of component in [Pa] */ static Scalar dp_dpi(Scalar pressure) { return 1e6; } /*! - * \brief The gibbs free energy for IAPWS region 2 (i.e. sub-critical - * steam) + * \brief The Gibbs free energy for IAPWS region 2 (i.e. sub-critical + * steam) (dimensionless). * - * \param temperature temperature of component - * \param pressure pressure of component + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] * * IAPWS: "Revised Release on the IAPWS Industrial Formulation * 1997 for the Thermodynamic Properties of Water and Steam", @@ -152,12 +152,12 @@ public: } /*! - * \brief The partial derivative of the gibbs free energy to the + * \brief The partial derivative of the Gibbs free energy to the * normalized temperature for IAPWS region 2 (i.e. sub-critical - * steam) + * steam) dimensionless). * - * \param temperature temperature of component - * \param pressure pressure of component + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] * * IAPWS: "Revised Release on the IAPWS Industrial Formulation * 1997 for the Thermodynamic Properties of Water and Steam", @@ -190,12 +190,12 @@ public: } /*! - * \brief The partial derivative of the gibbs free energy to the + * \brief The partial derivative of the Gibbs free energy to the * normalized pressure for IAPWS region 2 (i.e. sub-critical - * steam) + * steam) (dimensionless). * - * \param temperature temperature of component - * \param pressure pressure of component + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] * * IAPWS: "Revised Release on the IAPWS Industrial Formulation * 1997 for the Thermodynamic Properties of Water and Steam", @@ -222,12 +222,12 @@ public: } /*! - * \brief The partial derivative of the gibbs free energy to the + * \brief The partial derivative of the Gibbs free energy to the * normalized pressure and to the normalized temperature - * for IAPWS region 2 (i.e. sub-critical steam) + * for IAPWS region 2 (i.e. sub-critical steam) (dimensionless). * - * \param temperature temperature of component - * \param pressure pressure of component + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] * * IAPWS: "Revised Release on the IAPWS Industrial Formulation * 1997 for the Thermodynamic Properties of Water and Steam", @@ -255,12 +255,12 @@ public: } /*! - * \brief The second partial derivative of the gibbs free energy + * \brief The second partial derivative of the Gibbs free energy * to the normalized pressure for IAPWS region 2 - * (i.e. sub-critical steam) + * (i.e. sub-critical steam) (dimensionless). * - * \param temperature temperature of component - * \param pressure pressure of component + * \param temperature temperature of component in [K] + * \param pressure pressure of component in [Pa] * * IAPWS: "Revised Release on the IAPWS Industrial Formulation * 1997 for the Thermodynamic Properties of Water and Steam", diff --git a/dumux/material/components/iapws/region4.hh b/dumux/material/components/iapws/region4.hh index dd4238ba3..f59541a48 100644 --- a/dumux/material/components/iapws/region4.hh +++ b/dumux/material/components/iapws/region4.hh @@ -55,10 +55,10 @@ class Region4 { public: /*! - * \brief Returns the saturation pressure of pure water at a given + * \brief Returns the saturation pressure in [Pa] of pure water at a given * temperature. * - *\param temperature temperature of component + *\param temperature temperature of component in [K] * * The saturation pressure is often also called vapor pressure. */