diff --git a/dumux/material/components/brine.hh b/dumux/material/components/brine.hh index 4cad8cf03186217aa761f0f29af94f667990eba0..f1305ce6c35c2aae4bfb619531269dfb106f94e2 100644 --- a/dumux/material/components/brine.hh +++ b/dumux/material/components/brine.hh @@ -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] diff --git a/dumux/material/components/ch4.hh b/dumux/material/components/ch4.hh index 7c571f2dcb741f2b4b67031517b271318845b946..e7f3888cba077b1d6728a30a8334f77733ad560e 100644 --- a/dumux/material/components/ch4.hh +++ b/dumux/material/components/ch4.hh @@ -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] diff --git a/dumux/material/components/component.hh b/dumux/material/components/component.hh index fb046850c24f31b19237423055aebe6c4af90721..982d44512b5ffbc4512bc8aff2ce9943a4040ad7 100644 --- a/dumux/material/components/component.hh +++ b/dumux/material/components/component.hh @@ -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] diff --git a/dumux/material/components/h2.hh b/dumux/material/components/h2.hh index 68c24fc76707a4c4297ea16fd355a0042bbd46c4..465075eb2c5f7047687696e41a1ef9d4d0fa0a3e 100644 --- a/dumux/material/components/h2.hh +++ b/dumux/material/components/h2.hh @@ -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] diff --git a/dumux/material/components/h2o.hh b/dumux/material/components/h2o.hh index 2c33667b5b89556d03b360a995d554ee98cc5a57..9b47c294692a5206ed1ea0d3aa574fadbbcaf4a0 100644 --- a/dumux/material/components/h2o.hh +++ b/dumux/material/components/h2o.hh @@ -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] diff --git a/dumux/material/components/n2.hh b/dumux/material/components/n2.hh index b7bc736700cd5e622d3962731fef7c4d4454c616..ad1b64325ef4a0dc4920a1f5646d1c8b860063aa 100644 --- a/dumux/material/components/n2.hh +++ b/dumux/material/components/n2.hh @@ -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"); } diff --git a/dumux/material/components/o2.hh b/dumux/material/components/o2.hh index 8723840f41b588c1bd711139dd780adf867c92c7..987371fa143edecf2e00fb3aadeb48ffe5ee2de5 100644 --- a/dumux/material/components/o2.hh +++ b/dumux/material/components/o2.hh @@ -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"); } diff --git a/dumux/material/components/oil.hh b/dumux/material/components/oil.hh index e77e4ba0d6ab07701645a49e7126b02009147b71..4fc2f4912ff4e5eed77b61ebc5490ec70399ccbd 100644 --- a/dumux/material/components/oil.hh +++ b/dumux/material/components/oil.hh @@ -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) { diff --git a/dumux/material/components/simpleco2.hh b/dumux/material/components/simpleco2.hh index 1c1db74b2e4fbcd48ad2132550d8ea501f625192..d1e123d24aa0a3bfaca2ff22f83d422aeebbb26f 100644 --- a/dumux/material/components/simpleco2.hh +++ b/dumux/material/components/simpleco2.hh @@ -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"); } diff --git a/dumux/material/components/simplednapl.hh b/dumux/material/components/simplednapl.hh index aec42ca97dd22055a023833a24b82907bafaea4b..71514927d75d65983a34a74f61ba9d9a162013bf 100644 --- a/dumux/material/components/simplednapl.hh +++ b/dumux/material/components/simplednapl.hh @@ -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) { diff --git a/dumux/material/components/simpleh2o.hh b/dumux/material/components/simpleh2o.hh index f5e37ec8831a51280e5c71f792f17613997581a7..5343fb9327693df3a8543d8f68483eff7434774f 100644 --- a/dumux/material/components/simpleh2o.hh +++ b/dumux/material/components/simpleh2o.hh @@ -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() { return 18e-3; } @@ -84,10 +84,10 @@ public: { return 611.657; /* [N/m^2] */ } /*! - * \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 + *\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] */ static const Scalar gasEnthalpy(Scalar temperature, Scalar pressure) @@ -135,8 +135,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] */ static const Scalar liquidEnthalpy(Scalar temperature, Scalar pressure) @@ -147,8 +147,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) @@ -161,8 +161,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] */ static const Scalar liquidInternalEnergy(Scalar temperature, Scalar pressure) @@ -173,8 +173,8 @@ public: /*! * \brief The density [kg/m^3] of steam 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) { @@ -183,10 +183,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 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) { @@ -197,8 +197,8 @@ public: /*! * \brief The density of pure water 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) { @@ -206,10 +206,10 @@ public: } /*! - * \brief The pressure of water at a given density and temperature [Pa]. + * \brief The pressure of 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) { @@ -218,11 +218,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) { @@ -230,10 +230,10 @@ 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 - * \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) { diff --git a/dumux/material/components/tabulatedcomponent.hh b/dumux/material/components/tabulatedcomponent.hh index 21dc673678621e8b70dc09e02cf0e9d4180b08de..82c2e68d063bc64bcfbf1e8f1c751f50f85d7e6a 100644 --- a/dumux/material/components/tabulatedcomponent.hh +++ b/dumux/material/components/tabulatedcomponent.hh @@ -57,11 +57,11 @@ public: /*! * \brief Initialize the tables. * - * \param tempMin The minimum of the temperature range - * \param tempMax The maximum of the temperature range + * \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 - * \param pressMax The maximum of the pressure 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 */ static void init(Scalar tempMin, Scalar tempMax, unsigned nTemp, @@ -188,13 +188,13 @@ public: } /*! - * \brief A human readable name for the compoment. + * \brief A human readable name for the component. */ static const char *name() { return RawComponent::name(); } /*! - * \brief The mass in [kg] of one mole of the component. + * \brief The molar mass in [kg/mol] of the component. */ static Scalar molarMass() { return RawComponent::molarMass(); } @@ -224,7 +224,7 @@ public: { return RawComponent::triplePressure(); } /*! - * \brief The vapor pressure in [N/m^2] of the component at a given + * \brief The vapor pressure in [Pa] of the component at a given * temperature. * * \param T temperature of component @@ -241,8 +241,8 @@ public: /*! * \brief Specific enthalpy of the gas [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) { @@ -260,8 +260,8 @@ public: /*! * \brief Specific internal energy of the liquid [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) { @@ -279,8 +279,8 @@ public: /*! * \brief Specific internal energy of the gas [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) { @@ -298,8 +298,8 @@ public: /*! * \brief Specific enthalpy of the liquid [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) { @@ -316,10 +316,10 @@ public: /*! - * \brief The pressure of gas at a given density and temperature [Pa]. + * \brief The pressure of gas 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) { @@ -336,10 +336,10 @@ public: }; /*! - * \brief The pressure of liquid at a given density and temperature [Pa]. + * \brief The pressure of liquid 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) { @@ -359,8 +359,8 @@ public: * \brief The density of gas 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) { @@ -379,8 +379,8 @@ public: * \brief The density of liquid 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) { @@ -396,10 +396,10 @@ public: } /*! - * \brief The dynamic viscosity [N/m^3*s] of gas. + * \brief The dynamic viscosity [Pa*s] of 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 Scalar gasViscosity(Scalar temperature, Scalar pressure) { @@ -415,10 +415,10 @@ public: }; /*! - * \brief The dynamic viscosity [N/m^3*s] of liquid. + * \brief The dynamic viscosity [Pa*s] of 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 Scalar liquidViscosity(Scalar temperature, Scalar pressure) { diff --git a/dumux/material/components/unit.hh b/dumux/material/components/unit.hh index 81f4f55c04ab85ae79cc95e62d2e7305972ceb24..743be27ba8797ce10e56d2f1d449f66975f61be5 100644 --- a/dumux/material/components/unit.hh +++ b/dumux/material/components/unit.hh @@ -16,7 +16,7 @@ /*! * \file * \ingroup Components - * \brief Properties of pure water \f$H_2O\f$. + * \brief Rough estimate of water \f$H_2O\f$ for testing purposes. */ #ifndef DUMUX_UNIT_HH #define DUMUX_UNIT_HH @@ -46,10 +46,10 @@ public: { return "Unit"; } /*! - * \brief Rough estimate of the density of oil [kg/m^3]. + * \brief Rough estimate of the density of water [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) { @@ -57,10 +57,10 @@ public: } /*! - * \brief Rough estimate of the viscosity of oil kg/(ms). + * \brief Rough estimate of the viscosity of water 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) {