From c78cf8cd175bf070e1987a7bf570ffb26600176a Mon Sep 17 00:00:00 2001
From: Kilian Weishaupt <kilian.weishaupt@iws.uni-stuttgart.de>
Date: Thu, 3 Mar 2016 07:17:43 +0100
Subject: [PATCH] [fluidsystems] Use uniform doxygen descr. for density
*Use proper citation
---
dumux/material/fluidsystems/h2oair.hh | 11 ++++-------
dumux/material/fluidsystems/h2oairmesitylene.hh | 11 ++++++++---
dumux/material/fluidsystems/h2oairxylene.hh | 13 +++++++++----
dumux/material/fluidsystems/h2on2.hh | 17 ++++++++---------
dumux/material/fluidsystems/h2on2liquidphase.hh | 14 +++++++-------
dumux/material/fluidsystems/h2on2o2.hh | 16 +++++++---------
6 files changed, 43 insertions(+), 39 deletions(-)
diff --git a/dumux/material/fluidsystems/h2oair.hh b/dumux/material/fluidsystems/h2oair.hh
index 4bb492d4e2..59349a6864 100644
--- a/dumux/material/fluidsystems/h2oair.hh
+++ b/dumux/material/fluidsystems/h2oair.hh
@@ -371,12 +371,9 @@ public:
* the partial pressures of all components, return its
* density \f$\mathrm{[kg/m^3]}\f$.
*
- * Formula (2.6)
- * in
- * S.O.Ochs: "Development of a multiphase multicomponent
- * model for PEMFC - Technical report: IRTG-NUPUS",
- * University of Stuttgart, 2008 \cite ochs2008 <BR>
- *
+ * If useComplexRelations == true, we apply Eq. (7)
+ * in Class et al. (2002a) \cite A3:class:2002b <BR>
+ * for the liquid density.
*
* \param phaseIdx index of the phase
* \param temperature phase temperature in \f$\mathrm{[K]}\f$
@@ -406,7 +403,7 @@ public:
return H2O::liquidDensity(T, p);
else
{
- // See: Ochs 2008 (2.6)
+ // See: Eq. (7) in Class et al. (2002a)
const Scalar rholH2O = H2O::liquidDensity(T, p);
const Scalar clH2O = rholH2O/H2O::molarMass();
diff --git a/dumux/material/fluidsystems/h2oairmesitylene.hh b/dumux/material/fluidsystems/h2oairmesitylene.hh
index 9dfd7401df..a029b1508b 100644
--- a/dumux/material/fluidsystems/h2oairmesitylene.hh
+++ b/dumux/material/fluidsystems/h2oairmesitylene.hh
@@ -223,8 +223,14 @@ public:
}
/*!
- * \brief Given all mole fractions in a phase, return the phase
+ * \brief Given a phase's composition, temperature, pressure, and
+ * the partial pressures of all components, return its
* density \f$\mathrm{[kg/m^3]}\f$.
+ *
+ * We apply Eq. (7)
+ * in Class et al. (2002a) \cite A3:class:2002b <BR>
+ * for the water density.
+ *
* \param fluidState The fluid state
* \param phaseIdx The index of the phase
*/
@@ -233,8 +239,7 @@ public:
static Scalar density(const FluidState &fluidState, int phaseIdx)
{
if (phaseIdx == wPhaseIdx) {
- // See: Ochs 2008
- // \todo: proper citation
+ // See: Eq. (7) in Class et al. (2002a)
Scalar rholH2O = H2O::liquidDensity(fluidState.temperature(phaseIdx), fluidState.pressure(phaseIdx));
Scalar clH2O = rholH2O/H2O::molarMass();
diff --git a/dumux/material/fluidsystems/h2oairxylene.hh b/dumux/material/fluidsystems/h2oairxylene.hh
index 3fa78593c5..4f030ff87a 100644
--- a/dumux/material/fluidsystems/h2oairxylene.hh
+++ b/dumux/material/fluidsystems/h2oairxylene.hh
@@ -221,18 +221,23 @@ public:
}
/*!
- * \brief Given all mole fractions in a phase, return the phase
+ * \brief Given a phase's composition, temperature, pressure, and
+ * the partial pressures of all components, return its
* density \f$\mathrm{[kg/m^3]}\f$.
+ *
+ * We apply Eq. (7)
+ * in Class et al. (2002a) \cite A3:class:2002b <BR>
+ * for the water density.
+ *
* \param fluidState The fluid state
- * \param phaseIdx The index of the phase to consider
+ * \param phaseIdx The index of the phase
*/
using Base::density;
template <class FluidState>
static Scalar density(const FluidState &fluidState, int phaseIdx)
{
if (phaseIdx == wPhaseIdx) {
- // See: Ochs 2008
- // \todo: proper citation
+ // See: Eq. (7) in Class et al. (2002a)
Scalar rholH2O = H2O::liquidDensity(fluidState.temperature(phaseIdx), fluidState.pressure(phaseIdx));
Scalar clH2O = rholH2O/H2O::molarMass();
diff --git a/dumux/material/fluidsystems/h2on2.hh b/dumux/material/fluidsystems/h2on2.hh
index 6e809c321e..564868cffc 100644
--- a/dumux/material/fluidsystems/h2on2.hh
+++ b/dumux/material/fluidsystems/h2on2.hh
@@ -337,13 +337,13 @@ public:
}
/*!
- * \brief Calculate the density \f$\mathrm{[kg/m^3]}\f$ of a fluid phase
+ * \brief Given a phase's composition, temperature, pressure, and
+ * the partial pressures of all components, return its
+ * density \f$\mathrm{[kg/m^3]}\f$.
*
- * If useComplexRelations == true, we apply
- * Formula (2.6) from S.O.Ochs:
- * "Development of a multiphase multicomponent
- * model for PEMFC - Technical report: IRTG-NUPUS",
- * University of Stuttgart, 2008
+ * If useComplexRelations == true, we apply Eq. (7)
+ * in Class et al. (2002a) \cite A3:class:2002b <BR>
+ * for the liquid density.
*
* \param fluidState An arbitrary fluid state
* \param phaseIdx The index of the fluid phase to consider
@@ -369,7 +369,7 @@ public:
return H2O::liquidDensity(T, p);
else
{
- // See: Ochs 2008
+ // See: Eq. (7) in Class et al. (2002a)
Scalar rholH2O = H2O::liquidDensity(T, p);
Scalar clH2O = rholH2O/H2O::molarMass();
@@ -392,8 +392,7 @@ public:
* fluidState.averageMolarMass(nPhaseIdx)
/ std::max(1e-5, sumMoleFrac);
- // assume ideal mixture: steam and nitrogen don't "see" each
- // other
+ // assume ideal mixture: steam and nitrogen don't "see" each other
Scalar rho_gH2O = H2O::gasDensity(T, p*fluidState.moleFraction(nPhaseIdx, H2OIdx));
Scalar rho_gN2 = N2::gasDensity(T, p*fluidState.moleFraction(nPhaseIdx, N2Idx));
return (rho_gH2O + rho_gN2) / std::max(1e-5, sumMoleFrac);
diff --git a/dumux/material/fluidsystems/h2on2liquidphase.hh b/dumux/material/fluidsystems/h2on2liquidphase.hh
index 9d07949c5e..ab94473807 100644
--- a/dumux/material/fluidsystems/h2on2liquidphase.hh
+++ b/dumux/material/fluidsystems/h2on2liquidphase.hh
@@ -320,13 +320,13 @@ public:
}
/*!
- * \brief Calculate the density \f$\mathrm{[kg/m^3]}\f$ of a fluid phase.
+ * \brief Given a phase's composition, temperature, pressure, and
+ * the partial pressures of all components, return its
+ * density \f$\mathrm{[kg/m^3]}\f$.
*
- * If useComplexRelations == true, we apply
- * Formula (2.6) from S.O.Ochs:
- * "Development of a multi-phase multicomponent
- * model for PEMFC - Technical report: IRTG-NUPUS",
- * University of Stuttgart, 2008
+ * If useComplexRelations == true, we apply Eq. (7)
+ * in Class et al. (2002a) \cite A3:class:2002b <BR>
+ * for the liquid density.
*
* \param fluidState An arbitrary fluid state
* \param phaseIdx The index of the fluid phase to consider
@@ -352,7 +352,7 @@ public:
return H2O::liquidDensity(T, p);
else
{
- // See: Ochs 2008
+ // See: Eq. (7) in Class et al. (2002a)
Scalar rholH2O = H2O::liquidDensity(T, p);
Scalar clH2O = rholH2O/H2O::molarMass();
diff --git a/dumux/material/fluidsystems/h2on2o2.hh b/dumux/material/fluidsystems/h2on2o2.hh
index 01cc92d7a5..829ec2899f 100644
--- a/dumux/material/fluidsystems/h2on2o2.hh
+++ b/dumux/material/fluidsystems/h2on2o2.hh
@@ -408,16 +408,14 @@ public:
}
}
-
-
/*!
- * \brief Calculate the density \f$\mathrm{[kg/m^3]}\f$ of a fluid phase
+ * \brief Given a phase's composition, temperature, pressure, and
+ * the partial pressures of all components, return its
+ * density \f$\mathrm{[kg/m^3]}\f$.
*
- * If useComplexRelations == true, we apply
- * Formula (2.6) from S.O.Ochs:
- * "Development of a multiphase multicomponent
- * model for PEMFC - Technical report: IRTG-NUPUS",
- * University of Stuttgart, 2008
+ * If useComplexRelations == true, we apply Eq. (7)
+ * in Class et al. (2002a) \cite A3:class:2002b <BR>
+ * for the liquid density.
*
* \param fluidState An abitrary fluid state
* \param phaseIdx The index of the fluid phase to consider
@@ -443,7 +441,7 @@ public:
return H2O::liquidDensity(T, p);
else
{
- // See: Ochs 2008
+ // See: Eq. (7) in Class et al. (2002a)
Scalar rholH2O = H2O::liquidDensity(T,p);
Scalar clH2O = rholH2O/H2O::molarMass();
--
GitLab