From e6d13c97642ff4821e47c372b24e531386abe607 Mon Sep 17 00:00:00 2001
From: Benjamin Faigle <benjamin.faigle@posteo.de>
Date: Mon, 19 Dec 2011 10:59:01 +0000
Subject: [PATCH] improved documentation
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@7148 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
.../fluidstates/compositionalfluidstate.hh | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/dumux/material/fluidstates/compositionalfluidstate.hh b/dumux/material/fluidstates/compositionalfluidstate.hh
index f47c1d32a3..8a27fadcf9 100644
--- a/dumux/material/fluidstates/compositionalfluidstate.hh
+++ b/dumux/material/fluidstates/compositionalfluidstate.hh
@@ -95,18 +95,19 @@ public:
/*!
* \brief The average molar mass of a fluid phase [kg/mol]
+ *
+ * Todo: Docu needed: what kind of average??
*/
Scalar averageMolarMass(int phaseIdx) const
{ return averageMolarMass_[phaseIdx]; }
/*!
- * \brief The concentration of a component in a phase [mol/m^3]
- *
- * This is usually just called "molar concentration" or just
- * "concentration", but there are many other (though less common)
- * measures for concentration.
+ * \brief The molar concentration of a component in a phase [mol/m^3]
*
- * http://en.wikipedia.org/wiki/Concentration
+ * Due to the ambiguity of the term "concentration", see
+ * e.g. Römpp Chemie Online Lexikon, http://www.roempp.com/prod/
+ * the method returning the molar concentration of a component
+ * in a phase is called "molarity".
*/
Scalar molarity(int phaseIdx, int compIdx) const
{ return molarDensity(phaseIdx)*moleFraction(phaseIdx, compIdx); }
@@ -118,7 +119,7 @@ public:
{ return fugacityCoefficient(phaseIdx, compIdx)*moleFraction(phaseIdx, compIdx)*pressure(phaseIdx); }
/*!
- * \brief The fugacity coefficient of a component in a phase [Pa]
+ * \brief The fugacity coefficient of a component in a phase [-]
*/
Scalar fugacityCoefficient(int phaseIdx, int compIdx) const
{ return fugacityCoefficient_[phaseIdx][compIdx]; }
--
GitLab