From 99e22f7fb9bd579d90e5b5ea7aa2d93c22fde7f6 Mon Sep 17 00:00:00 2001
From: Kilian Weishaupt <kilian.weishaupt@iws.uni-stuttgart.de>
Date: Mon, 18 Jan 2016 16:52:34 +0100
Subject: [PATCH] [fix] Fix missing or wrong parameter descriptions
doxyerr.log showed more than 100 issues. Some of them
have been resolved here.
---
.../material/eos/pengrobinsonparamsmixture.hh | 2 +-
.../fluidmatrixinteractions/3p/efftoabslaw.hh | 8 ++++-
.../3p/parkervangen3p.hh | 36 +++++++++----------
.../3p/parkervangen3pparams.hh | 2 +-
.../3p/regularizedparkervangen3p.hh | 29 +++++++--------
5 files changed, 37 insertions(+), 40 deletions(-)
diff --git a/dumux/material/eos/pengrobinsonparamsmixture.hh b/dumux/material/eos/pengrobinsonparamsmixture.hh
index e8371b2e7a..77efb50fa7 100644
--- a/dumux/material/eos/pengrobinsonparamsmixture.hh
+++ b/dumux/material/eos/pengrobinsonparamsmixture.hh
@@ -51,7 +51,7 @@ namespace Dumux
*
* See:
*
- * R. Reid, et al. (1987, pp. 43-44) \cite reis1987 <BR>
+ * R. Reid, et al. (1987, pp. 43-44) \cite reid1987 <BR>
*
* and
*
diff --git a/dumux/material/fluidmatrixinteractions/3p/efftoabslaw.hh b/dumux/material/fluidmatrixinteractions/3p/efftoabslaw.hh
index cb05fec866..1827df4b08 100644
--- a/dumux/material/fluidmatrixinteractions/3p/efftoabslaw.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/efftoabslaw.hh
@@ -108,7 +108,7 @@ public:
/*!
* \brief The capillary pressure-saturation curve for the gas and non-wetting phase
* \param params Array of parameters
- * \param St sum of wetting (liquid) phase saturations
+ * \param st sum of wetting (liquid) phase saturations
*/
static Scalar pcgn(const Params ¶ms, const Scalar st)
{
@@ -191,6 +191,8 @@ public:
*
* \param sw Absolute saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$. It is converted to effective saturation
* and then handed over to the material law actually used for calculation.
+ * \param sn Absolute saturation of the non-wetting phase \f$\mathrm{[{S}_n]}\f$. It is converted to effective saturation
+ * and then handed over to the material law actually used for calculation.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
@@ -208,6 +210,8 @@ public:
*
* \param sw Absolute saturation of the wetting phase \f$\mathrm{[{S}_w]}\f$. It is converted to effective saturation
* and then handed over to the material law actually used for calculation.
+ * \param sn Absolute saturation of the non-wetting phase \f$\mathrm{[{S}_n]}\f$. It is converted to effective saturation
+ * and then handed over to the material law actually used for calculation.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
@@ -225,6 +229,8 @@ public:
*
* \param sw Absolute saturation of the wetting phase \f$\mathrm{[{S}_w]}\f$. It is converted to effective saturation
* and then handed over to the material law actually used for calculation.
+ * \param sn Absolute saturation of the non-wetting phase \f$\mathrm{[{S}_n]}\f$. It is converted to effective saturation
+ * and then handed over to the material law actually used for calculation.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
diff --git a/dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh b/dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh
index 096ed35bb4..25358b258a 100644
--- a/dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh
@@ -73,7 +73,7 @@ public:
/*!
* \brief The capillary pressure-saturation curve for the gas and wetting phase
* \param params Array of parameters
- * \param sw wetting phase saturation or sum of wetting phase saturations
+ * \param swe Effective wetting phase saturation
*
*/
static Scalar pcgw(const Params ¶ms, const Scalar swe)
@@ -84,7 +84,7 @@ public:
/*!
* \brief The capillary pressure-saturation curve for the non-wettigng and wetting phase
* \param params Array of parameters
- * \param sw wetting phase saturation or sum of wetting phase saturations
+ * \param swe Effective wetting phase saturation
*/
static Scalar pcnw(const Params ¶ms, const Scalar swe)
{
@@ -94,7 +94,7 @@ public:
/*!
* \brief The capillary pressure-saturation curve for the gas and non-wetting phase
* \param params Array of parameters
- * \param St sum of wetting (liquid) phase saturations
+ * \param ste Effective total liquid (wetting + non-wetting) saturation
*/
static Scalar pcgn(const Params ¶ms, const Scalar ste)
{
@@ -152,7 +152,7 @@ public:
* \brief Returns the partial derivative of the capillary
* pressure to the effective saturation.
* \param params Array of parameters
- * \param sw Wetting liquid saturation
+ * \param seRegu Effective wetting phase saturation for regularization
*/
static Scalar dpcgw_dsw(const Params ¶ms, const Scalar seRegu)
{
@@ -165,7 +165,7 @@ public:
* \brief Returns the partial derivative of the capillary
* pressure to the effective saturation.
* \param params Array of parameters
- * \param sw Wetting liquid saturation
+ * \param seRegu Effective wetting phase saturation for regularization
*/
static Scalar dpcnw_dsw(const Params ¶ms, const Scalar seRegu)
{
@@ -174,11 +174,11 @@ public:
* powSeRegu/seRegu/params.vgm()/params.betaNw();
}
- /*!
+ /*!
* \brief Returns the partial derivative of the capillary
* pressure to the effective saturation.
* \param params Array of parameters
- * \param sw Wetting liquid saturation
+ * \param seRegu Effective wetting phase saturation for regularization
*/
static Scalar dpcgn_dst(const Params ¶ms, const Scalar seRegu)
{
@@ -208,10 +208,8 @@ public:
* (see p61. in "Comparison of the Three-Phase Oil Relative Permeability Models"
* MOJDEH DELSHAD and GARY A. POPE, Transport in Porous Media 4 (1989), 59-83.) \cite delshad1989 <BR>
*
- * \param sn Non-wetting liquid saturation
- * \param sg Gas saturation
- * \param saturation wetting liquid saturation
* \param params Array of parameters.
+ * \param swe Effective wetting phase saturation
*/
static Scalar krw(const Params ¶ms, const Scalar swe)
{
@@ -228,13 +226,13 @@ public:
* or more comprehensive in
* "Estimation of primary drainage three-phase relative permeability for organic
* liquid transport in the vadose zone", Leonardo I. Oliveira, Avery H. Demond,
- * Journal of Contaminant Hydrology 66 (2003), 261-285 \cite oloiveira2003 <BR>
+ * Journal of Contaminant Hydrology 66 (2003), 261-285 \cite oliveira2003 <BR>
*
*
- * \param sw Wetting liquid saturation
- * \param sg Gas saturation
- * \param saturation Non-wetting liquid saturation
* \param params Array of parameters.
+ * \param swe Effective wetting phase saturation
+ * \param sne Effective non-wetting liquid saturation
+ * \param ste Effective total liquid (wetting + non-wetting) saturation
*/
static Scalar krn(const Params ¶ms, const Scalar swe, const Scalar sne, const Scalar ste)
{
@@ -266,10 +264,8 @@ public:
* (see p61. in "Comparison of the Three-Phase Oil Relative Permeability Models"
* MOJDEH DELSHAD and GARY A. POPE, Transport in Porous Media 4 (1989), 59-83.) \cite delshad1989 <BR>
*
- * \param sw Wetting liquid saturation
- * \param sn Non-wetting liquid saturation
- * \param saturation Gas saturation
* \param params Array of parameters.
+ * \param ste Effective total liquid (wetting + non-wetting) saturation
*/
static Scalar krg(const Params ¶ms, const Scalar ste)
{
@@ -278,11 +274,11 @@ public:
/*!
* \brief The relative permeability for a phase.
- * \param sw Wetting liquid saturation
- * \param sg Gas saturation
- * \param sn Non-wetting liquid saturation
* \param params Array of parameters.
* \param phaseIdx indicator, The saturation of all phases.
+ * \param swe Effective wetting phase saturation
+ * \param sne Effective non-wetting liquid saturation
+ * \param ste Effective total liquid (wetting + non-wetting) saturation
*/
static Scalar kr(const Params ¶ms, const int phaseIdx, const Scalar swe, const Scalar sne, const Scalar ste)
{
diff --git a/dumux/material/fluidmatrixinteractions/3p/parkervangen3pparams.hh b/dumux/material/fluidmatrixinteractions/3p/parkervangen3pparams.hh
index 8a5bd1f3f5..5359525dc6 100644
--- a/dumux/material/fluidmatrixinteractions/3p/parkervangen3pparams.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/parkervangen3pparams.hh
@@ -175,7 +175,7 @@ public:
/*!
* \brief Set the residual gas saturation.
- * \param v Set the resiudal gas saturation
+ * \param input Set the resiudal gas saturation
*/
void setSgr(Scalar input)
{
diff --git a/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh b/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh
index ee652be9a8..1fd9eded88 100644
--- a/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh
@@ -89,7 +89,7 @@ public:
/*!
* \brief The capillary pressure-saturation curve for the gas and wetting phase
* \param params Array of parameters
- * \param sw wetting phase saturation or sum of wetting phase saturations
+ * \param swe Effective wetting phase saturation
*
*/
static Scalar pcgw(const Params ¶ms, Scalar swe)
@@ -120,7 +120,7 @@ public:
/*!
* \brief The capillary pressure-saturation curve for the non-wettigng and wetting phase
* \param params Array of parameters
- * \param sw wetting phase saturation or sum of wetting phase saturations
+ * \param swe Effective wetting phase saturation
*/
static Scalar pcnw(const Params ¶ms, Scalar swe)
{
@@ -149,7 +149,7 @@ public:
/*!
* \brief The capillary pressure-saturation curve for the gas and non-wetting phase
* \param params Array of parameters
- * \param St sum of wetting (liquid) phase saturations
+ * \param ste Effective total liquid (wetting + non-wetting) saturation
*/
static Scalar pcgn(const Params ¶ms, Scalar ste)
{
@@ -180,7 +180,7 @@ public:
/*!
* \brief This function ensures a continous transition from 2 to 3 phases and vice versa
* \param params Array of parameters
- * \param sne Non-wetting liquid saturation
+ * \param sne Effective non-wetting liquid saturation
*/
static Scalar pcAlpha(const Params ¶ms, Scalar sne)
{
@@ -229,10 +229,8 @@ public:
* (see p61. in "Comparison of the Three-Phase Oil Relative Permeability Models"
* MOJDEH DELSHAD and GARY A. POPE, Transport in Porous Media 4 (1989), 59-83.)
*
- * \param sn Non-wetting liquid saturation
- * \param sg Gas saturation
- * \param saturation wetting liquid saturation
* \param params Array of parameters.
+ * \param swe Effective wetting phase saturation
*/
static Scalar krw(const Params ¶ms, const Scalar swe)
{
@@ -255,11 +253,10 @@ public:
* liquid transport in the vadose zone", Leonardo I. Oliveira, Avery H. Demond,
* Journal of Contaminant Hydrology 66 (2003), 261-285
*
- *
- * \param sw Wetting liquid saturation
- * \param sg Gas saturation
- * \param saturation Non-wetting liquid saturation
* \param params Array of parameters.
+ * \param swe Effective wetting phase saturation
+ * \param sne Effective non-wetting liquid saturation
+ * \param ste Effective total liquid (wetting + non-wetting) saturation
*/
static Scalar krn(const Params ¶ms, Scalar swe, Scalar sne, Scalar ste)
{
@@ -285,10 +282,8 @@ public:
* (see p61. in "Comparison of the Three-Phase Oil Relative Permeability Models"
* MOJDEH DELSHAD and GARY A. POPE, Transport in Porous Media 4 (1989), 59-83.)
*
- * \param sw Wetting liquid saturation
- * \param sn Non-wetting liquid saturation
- * \param saturation Gas saturation
* \param params Array of parameters.
+ * \param ste Effective total liquid (wetting + non-wetting) saturation
*/
static Scalar krg(const Params ¶ms, const Scalar ste)
{
@@ -302,11 +297,11 @@ public:
/*!
* \brief The relative permeability for a phase.
- * \param sw Wetting liquid saturation
- * \param sg Gas saturation
- * \param sn Non-wetting liquid saturation
* \param params Array of parameters.
* \param phaseIdx indicator, The saturation of all phases.
+ * \param swe Effective wetting phase saturation
+ * \param sne Effective non-wetting liquid saturation
+ * \param ste Effective total liquid (wetting + non-wetting) saturation
*/
static Scalar kr(const Params ¶ms, const int phaseIdx, const Scalar swe, const Scalar sne, const Scalar ste)
{
--
GitLab