From 3aae35066af13682ba1dd4a7219e8ab0300a14ba Mon Sep 17 00:00:00 2001
From: Kai Wendel <kaiwendel90@googlemail.com>
Date: Tue, 19 Nov 2019 23:31:36 +0100
Subject: [PATCH] [doc] Correct some typos in comments
---
.../1p/thermalconductivityaverage.hh | 2 +-
.../fluidmatrixinteractions/2p/brookscorey.hh | 16 ++++++------
.../2p/brookscoreyparams.hh | 2 +-
.../fluidmatrixinteractions/2p/efftoabslaw.hh | 23 ++++++++---------
.../fluidmatrixinteractions/2p/heatpipelaw.hh | 4 +--
.../2p/linearmaterial.hh | 14 +++++------
.../2p/regularizedvangenuchten.hh | 4 +--
.../2p/vangenuchten.hh | 25 ++++++++++++-------
.../2pia/efftoabslawia.hh | 4 +--
.../fluidmatrixinteractions/3p/efftoabslaw.hh | 16 ++++++------
.../3p/parkervangen3p.hh | 8 +++---
.../3p/regularizedparkervangen3p.hh | 4 +--
.../3p/thermalconductivitysomerton3p.hh | 11 +++-----
.../fluidmatrixinteractions/mp/mpadapter.hh | 2 +-
.../mp/mplinearmaterial.hh | 2 +-
.../mp/mplinearmaterialparams.hh | 4 +--
.../permeabilitykozenycarman.hh | 2 +-
.../porosityprecipitation.hh | 6 ++---
18 files changed, 76 insertions(+), 73 deletions(-)
diff --git a/dumux/material/fluidmatrixinteractions/1p/thermalconductivityaverage.hh b/dumux/material/fluidmatrixinteractions/1p/thermalconductivityaverage.hh
index d75369138f..c913ffeee0 100644
--- a/dumux/material/fluidmatrixinteractions/1p/thermalconductivityaverage.hh
+++ b/dumux/material/fluidmatrixinteractions/1p/thermalconductivityaverage.hh
@@ -54,7 +54,7 @@ public:
* \brief Relation for a simple effective thermal conductivity \f$\mathrm{[W/(m K)]}\f$
*
* \param volVars volume variables
- * \return effective thermal conductivity \f$\mathrm{[W/(m K)]}\f$
+ * \return Effective thermal conductivity \f$\mathrm{[W/(m K)]}\f$
*/
template<class VolumeVariables>
static Scalar effectiveThermalConductivity(const VolumeVariables& volVars)
diff --git a/dumux/material/fluidmatrixinteractions/2p/brookscorey.hh b/dumux/material/fluidmatrixinteractions/2p/brookscorey.hh
index e58cec18c3..22574dd3f8 100644
--- a/dumux/material/fluidmatrixinteractions/2p/brookscorey.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/brookscorey.hh
@@ -54,7 +54,7 @@ public:
/*!
* \brief The capillary pressure-saturation curve according to Brooks & Corey.
*
- * The Brooks-Corey empirical capillary pressure <-> saturation
+ * The Brooks-Corey empirical capillary pressure <-> saturation
* function is given by
*
* \f$\mathrm{ p_C = p_e\overline{S}_w^{-1/\lambda}
@@ -109,7 +109,7 @@ public:
* \brief The capillary pressure at Swe = 1.0 also called end point capillary pressure
*
* \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
+ * 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.
*/
static Scalar endPointPc(const Params ¶ms)
@@ -126,7 +126,7 @@ public:
*
* \param swe Effective saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$
* \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
+ * 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.
* \return Partial derivative of \f$\mathrm{[p_c]}\f$ w.r.t. effective saturation according to Brooks & Corey.
*
@@ -150,7 +150,7 @@ public:
*
* \param pc Capillary pressure \f$\mathrm{[p_c]}\f$ in \f$\mathrm{[Pa]}\f$.
* \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
+ * 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.
* \return Partial derivative of effective saturation w.r.t. \f$\mathrm{[p_c]}\f$ according to Brooks & Corey.
*
@@ -174,7 +174,7 @@ public:
*
* \param swe The mobile saturation of the wetting phase.
* \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,
+ * 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.
* \return Relative permeability of the wetting phase calculated as implied by Brooks & Corey.
*
@@ -199,7 +199,7 @@ public:
*
* \param swe The mobile saturation of the wetting phase.
* \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,
+ * 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.
* \return Derivative of the relative permeability of the wetting phase w.r.t. effective wetting phase
* saturation calculated as implied by Brooks & Corey.
@@ -225,7 +225,7 @@ public:
*
* \param swe The mobile saturation of the wetting phase.
* \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
+ * 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.
* \return Relative permeability of the non-wetting phase calculated as implied by Brooks & Corey.
*
@@ -253,7 +253,7 @@ public:
*
* \param swe The mobile saturation of the wetting phase.
* \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,
+ * 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.
* \return Derivative of the relative permeability of the non-wetting phase w.r.t. effective wetting phase
* saturation calculated as implied by Brooks & Corey.
diff --git a/dumux/material/fluidmatrixinteractions/2p/brookscoreyparams.hh b/dumux/material/fluidmatrixinteractions/2p/brookscoreyparams.hh
index cb53b2b0b1..f18214fc94 100644
--- a/dumux/material/fluidmatrixinteractions/2p/brookscoreyparams.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/brookscoreyparams.hh
@@ -35,7 +35,7 @@ namespace Dumux {
/*!
* \ingroup Fluidmatrixinteractions
* \brief Specification of the material parameters
- * for the Brooks Corey constitutive relations.
+ * for the Brooks Corey constitutive relations.
* \see BrooksCorey
*/
template <class ScalarT>
diff --git a/dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh b/dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh
index 575d7c900c..3877b38e94 100644
--- a/dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh
@@ -84,7 +84,7 @@ public:
*
* \param pc Capillary pressure \f$\mathrm{[p_c]}\f$ in \f$\mathrm{[Pa]}\f$.
* \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,
+ * 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.
* \return Absolute wetting phase saturation \f$\mathrm{[S_w]}\f$ calculated as inverse of
* (EffLaw e.g. Brooks & Corey, van Genuchten, linear...) constitutive relation.
@@ -98,7 +98,7 @@ public:
* \brief The capillary pressure at Swe = 1.0 also called end point capillary pressure
*
* \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
+ * 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.
*/
static Scalar endPointPc(const Params ¶ms)
@@ -115,7 +115,7 @@ public:
}\f$
* \param sw Absolute saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$.
* \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,
+ * 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.
* \return Partial derivative of \f$\mathrm{[p_c]}\f$ w.r.t. effective saturation according to
EffLaw e.g. Brooks & Corey, van Genuchten, linear... .
@@ -138,7 +138,7 @@ public:
*
* \param pc Capillary pressure \f$\mathrm{[p_c]}\f$ in \f$\mathrm{[Pa]}\f$.
* \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,
+ * 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.
* \return Partial derivative of effective saturation w.r.t. \f$\mathrm{[p_c]}\f$ according to
EffLaw e.g. Brooks & Corey, van Genuchten, linear... .
@@ -154,7 +154,7 @@ 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 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,
+ * 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.
* \return Relative permeability of the wetting phase calculated as implied by
* EffLaw e.g. Brooks & Corey, van Genuchten, linear... .
@@ -183,7 +183,7 @@ 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 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,
+ * 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.
* \return Relative permeability of the non-wetting phase calculated as implied by
* EffLaw e.g. Brooks & Corey, van Genuchten, linear... .
@@ -211,7 +211,7 @@ public:
*
* \param sw Absolute saturation of the wetting phase \f$\mathrm{[{S}_w]}\f$.
* \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,
+ * 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.
* \return Effective saturation of the wetting phase.
*/
@@ -225,7 +225,7 @@ public:
*
* \param sn Absolute saturation of the non-wetting phase \f$\mathrm{[{S}_n]}\f$.
* \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,
+ * 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.
* \return Effective saturation of the non-wetting phase.
*/
@@ -234,13 +234,12 @@ public:
return (sn - params.snr())/(1. - params.swr() - params.snr());
}
-//private:
/*!
* \brief Convert an effective wetting saturation to an absolute one.
*
* \param swe Effective saturation of the non-wetting phase \f$\mathrm{[\overline{S}_n]}\f$.
* \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,
+ * 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.
* \return Absolute saturation of the non-wetting phase.
*/
@@ -253,7 +252,7 @@ public:
* \brief Derivative of the effective saturation w.r.t. the absolute saturation.
*
* \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,
+ * 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.
* \return Derivative of the effective saturation w.r.t. the absolute saturation.
*/
@@ -264,7 +263,7 @@ public:
* \brief Derivative of the absolute saturation w.r.t. the effective saturation.
*
* \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,
+ * 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.
* \return Derivative of the absolute saturation w.r.t. the effective saturation.
*/
diff --git a/dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh b/dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh
index f0d0df71b5..46506d67e0 100644
--- a/dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh
@@ -82,7 +82,7 @@ public:
*
* \return The effective saturaion of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$
* \param params Array of parameters
- * \param pC capillary pressure \f$\mathrm{[p_C]}\f$ in \f$\mathrm{[Pa]}\f$.
+ * \param pC Capillary pressure \f$\mathrm{[p_C]}\f$ in \f$\mathrm{[Pa]}\f$.
*/
static Scalar Sw(const Params ¶ms, Scalar pC)
{
@@ -114,7 +114,7 @@ public:
* \brief Returns the partial derivative of the effective
* saturation to the capillary pressure.
* \param params Array of parameters
- * \param pC capillary pressure \f$\mathrm{[p_C]}\f$ in \f$\mathrm{[Pa]}\f$.
+ * \param pC Capillary pressure \f$\mathrm{[p_C]}\f$ in \f$\mathrm{[Pa]}\f$.
*/
static Scalar dSw_dpC(const Params ¶ms, Scalar pC)
{
diff --git a/dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh b/dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh
index b78a34c660..bb3fd0a91b 100644
--- a/dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh
@@ -60,7 +60,7 @@ public:
*
* \param swe Effective saturation of the wetting phase \f$\overline{S}_w\f$ conversion from absolute saturation happened in EffToAbsLaw.
* \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
+ * 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.
* \return Capillary pressure calculated by linear constitutive relation.
*/
@@ -79,7 +79,7 @@ public:
*
* \param pc Capillary pressure \f$\mathrm{[p_C]}\f$ in \f$\mathrm{[Pa]}\f$.
* \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
+ * 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.
* \return Effective wetting phase saturation calculated as inverse of the linear constitutive relation.
*/
@@ -92,7 +92,7 @@ public:
* \brief The capillary pressure at Swe = 1.0 also called end point capillary pressure
*
* \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
+ * 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.
*/
static Scalar endPointPc(const Params ¶ms)
@@ -109,7 +109,7 @@ public:
}\f$
* \param swe Effective saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$ conversion from absolute saturation happened in EffToAbsLaw.
* \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
+ * 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.
* \return Partial derivative of \f$\mathrm{[p_c]}\f$ w.r.t. effective saturation according to linear material relation.
*/
@@ -124,7 +124,7 @@ public:
*
* \param pc Capillary pressure \f$\mathrm{[p_C]}\f$ in \f$\mathrm{[Pa]}\f$.
* \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
+ * 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.
* \return Partial derivative of effective saturation w.r.t. \f$\mathrm{[p_c]}\f$ according to linear relation.
*/
@@ -137,7 +137,7 @@ public:
* \brief The relative permeability for the wetting phase.
*
* \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
+ * 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.
* \param swe Effective saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$ conversion from absolute saturation happened in EffToAbsLaw.
* \return Relative permeability of the wetting phase calculated as linear relation.
@@ -153,7 +153,7 @@ public:
* \brief The relative permeability for the non-wetting phase.
*
* \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
+ * 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.
* \param swe Effective saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$ conversion from absolute saturation happened in EffToAbsLaw.
* \return Relative permeability of the non-wetting phase calculated as linear relation.
diff --git a/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh b/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh
index aef75f69d2..133d0d629e 100644
--- a/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh
@@ -195,7 +195,7 @@ public:
* \brief The capillary pressure at Swe = 1.0 also called end point capillary pressure
*
* \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
+ * 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.
*/
static Scalar endPointPc(const Params ¶ms)
@@ -449,7 +449,7 @@ private:
* saturations below the minimum saturation.
*
* \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,
+ * 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.
*/
static Scalar mLow_(const Params ¶ms)
diff --git a/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh b/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh
index cac6cebc6c..635803ba54 100644
--- a/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh
@@ -61,7 +61,7 @@ public:
}\f$
* \param swe Effective saturation of the wetting phase \f$\mathrm{\overline{S}_w}\f$
* \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
+ * 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.
* \note Instead of undefined behaviour if swe is not in the valid range, we return a valid number,
* by clamping the input. Note that for pc(swe = 0.0) = inf, have a look at RegularizedVanGenuchten if this is a problem.
@@ -88,7 +88,7 @@ public:
*
* \param pc Capillary pressure \f$\mathrm{p_C}\f$ in \f$\mathrm{[Pa]}\f$
* \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
+ * 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.
* \return The effective saturation of the wetting phase \f$\mathrm{\overline{S}_w}\f$
* \note Instead of undefined behaviour if pc is not in the valid range, we return a valid number,
@@ -109,7 +109,8 @@ public:
* \brief The capillary pressure at Swe = 1.0 also called end point capillary pressure
*
* \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
+ * 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.
*/
static Scalar endPointPc(const Params ¶ms)
@@ -128,7 +129,8 @@ public:
*
* \param swe Effective saturation of the wetting phase \f$\mathrm{\overline{S}_w}\f$
* \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
+ * 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.
*
* \note Instead of undefined behaviour if swe is not in the valid range, we return a valid number,
@@ -153,7 +155,8 @@ public:
*
* \param pc Capillary pressure \f$\mathrm{p_C}\f$ in \f$\mathrm{[Pa]}\f$
* \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
+ * 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.
*
* \note Instead of undefined behaviour if pc is not in the valid range, we return a valid number,
@@ -177,7 +180,8 @@ public:
*
* \param swe The mobile saturation of the wetting phase.
* \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
+ * 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.
*
* \note Instead of undefined behaviour if pc is not in the valid range, we return a valid number,
@@ -203,7 +207,8 @@ public:
*
* \param swe The mobile saturation of the wetting phase.
* \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
+ * 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.
*
* \note Instead of undefined behaviour if pc is not in the valid range, we return a valid number,
@@ -230,7 +235,8 @@ public:
*
* \param swe The mobile saturation of the wetting phase.
* \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
+ * 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.
*
* \note Instead of undefined behaviour if pc is not in the valid range, we return a valid number,
@@ -255,7 +261,8 @@ public:
*
* \param swe The mobile saturation of the wetting phase.
* \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
+ * 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.
*
* \note Instead of undefined behaviour if pc is not in the valid range, we return a valid number,
diff --git a/dumux/material/fluidmatrixinteractions/2pia/efftoabslawia.hh b/dumux/material/fluidmatrixinteractions/2pia/efftoabslawia.hh
index de3f8e3a1c..6d8fc4ffc5 100644
--- a/dumux/material/fluidmatrixinteractions/2pia/efftoabslawia.hh
+++ b/dumux/material/fluidmatrixinteractions/2pia/efftoabslawia.hh
@@ -46,7 +46,7 @@ namespace Dumux {
*
* This approach makes sure that in the "material laws" only effective saturations are considered, which makes sense,
* as these laws only deal with effective saturations. This also allows for changing the calculation of the effective
- * saturations easily, as this is subject of discussion / may be problem specific.
+ * saturations easily, as this is subject of discussion may be problem specific.
*
* Additionally, handing over effective saturations to the "material laws" in stead of them calculating effective
* saturations prevents accidently "converting twice".
@@ -91,7 +91,7 @@ protected:
*
* \param sw Absolute saturation of the wetting phase \f$\mathrm{{S}_w}\f$.
* \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
+ * 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.
* \return Effective saturation of the wetting phase.
*/
diff --git a/dumux/material/fluidmatrixinteractions/3p/efftoabslaw.hh b/dumux/material/fluidmatrixinteractions/3p/efftoabslaw.hh
index 2eaf3fb9d8..d557b36771 100644
--- a/dumux/material/fluidmatrixinteractions/3p/efftoabslaw.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/efftoabslaw.hh
@@ -70,7 +70,7 @@ 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 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,
+ * 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.
* \return Capillary pressure calculated by specific constitutive relation
* (EffLaw e.g. Brooks & Corey, van Genuchten, linear...)
@@ -263,7 +263,7 @@ public:
*
* \param sw Absolute saturation of the wetting phase \f$\mathrm{[{S}_w]}\f$.
* \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,
+ * 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.
* \return Effective saturation of the wetting phase.
*/
@@ -277,7 +277,7 @@ public:
*
* \param sn Absolute saturation of the non-wetting phase \f$\mathrm{[{S}_n]}\f$.
* \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,
+ * 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.
* \return Effective saturation of the non-wetting phase.
*/
@@ -291,7 +291,7 @@ public:
*
* \param st Absolute saturation of the total liquid phase (sw+sn) \f$\mathrm{[{S}_n]}\f$.
* \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,
+ * 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.
* \return Effective saturation of the non-wetting phase.
*/
@@ -305,7 +305,7 @@ public:
*
* \param sg Absolute saturation of the gas phase \f$\mathrm{[{S}_n]}\f$.
* \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,
+ * 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.
* \return Effective saturation of the non-wetting phase.
*/
@@ -320,7 +320,7 @@ public:
*
* \param swe Effective saturation of the non-wetting phase \f$\mathrm{[\overline{S}_n]}\f$.
* \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,
+ * 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.
* \return Absolute saturation of the non-wetting phase.
*/
@@ -342,7 +342,7 @@ public:
* \brief Derivative of the effective saturation w.r.t. the absolute saturation.
*
* \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,
+ * 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.
* \return Derivative of the effective saturation w.r.t. the absolute saturation.
*/
@@ -355,7 +355,7 @@ public:
* \brief Derivative of the absolute saturation w.r.t. the effective saturation.
*
* \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,
+ * 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.
* \return Derivative of the absolute saturation w.r.t. the effective saturation.
*/
diff --git a/dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh b/dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh
index 7dceb25435..a516dea681 100644
--- a/dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh
@@ -245,7 +245,7 @@ public:
krn *= sqrt(resIncluded );
}
else
- krn *= sqrt(sn / (1 - params.swr())); // Hint: (ste - swe) = sn / (1-Srw)
+ krn *= sqrt(sn / (1 - params.swr())); // Hint: (ste - swe) = sn / (1-Swr)
return krn;
}
@@ -278,7 +278,7 @@ public:
*
* \param ste The mobile total liquid saturation.
* \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
+ * 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.
*/
static Scalar dkrg_dste(const Params ¶ms, Scalar ste)
@@ -296,7 +296,7 @@ public:
/*!
* \brief The relative permeability for a phase.
* \param params Array of parameters.
- * \param phaseIdx indicator, The saturation of all phases.
+ * \param phaseIdx Indicator, The saturation of all phases.
* \param swe Effective wetting phase saturation
* \param sn Absolute non-wetting liquid saturation
* \param ste Effective total liquid (wetting + non-wetting) saturation
@@ -331,7 +331,7 @@ private:
* \brief The standard van Genuchten two-phase pc-S relation either with respect to
* the effective wetting phase saturation Swe or the effective total liquid saturation Ste.
* \param params Array of parameters.
- * \param Se Effective wetting phase ortotal liquid saturation
+ * \param Se Effective wetting phase ortotal liquid saturation
*/
const static Scalar pc_(const Params ¶ms, const Scalar se)
{
diff --git a/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh b/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh
index c4904cc08d..c82d4fcb1d 100644
--- a/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh
@@ -71,7 +71,7 @@ public:
* curve.
*
* regularized part:
- * - low saturation: extend the \f$\mathrm{p_c(S_w)}\f$ curve with the slope at the regularization point (i.e. no kink).
+ * - low saturation: extend the \f$\mathrm{p_c(S_w)}\f$ curve with the slope at the regularization point (i.e. no kink).
* - high saturation: connect the high regularization point with \f$\mathrm{\overline{S}_w =1}\f$
* by a straight line (yes, there is a kink :-( ).
*
@@ -395,7 +395,7 @@ public:
/*!
* \brief The relative permeability for a phase.
* \param params Array of parameters.
- * \param phaseIdx indicator, The saturation of all phases.
+ * \param phaseIdx Indicator, The saturation of all phases.
* \param swe Effective wetting phase saturation
* \param sn Absolute non-wetting liquid saturation
* \param ste Effective total liquid (wetting + non-wetting) saturation
diff --git a/dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh b/dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh
index 55e4f0ef9b..bc0b833e55 100644
--- a/dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh
@@ -111,10 +111,10 @@ public:
*
* \param sw The saturation of the wetting phase
* \param sn The saturation of the non-wetting phase
- * \param lambdaW the thermal conductivity of the water phase in \f$\mathrm{[W/(m K)]}\f$
- * \param lambdaN the thermal conductivity of the NAPL phase in \f$\mathrm{[W/(m K)]}\f$
- * \param lambdaG the thermal conductivity of the gas phase in \f$\mathrm{[W/(m K)]}\f$
- * \param lambdaSolid the thermal conductivity of the solid phase in \f$\mathrm{[W/(m K)]}\f$
+ * \param lambdaW The thermal conductivity of the water phase in \f$\mathrm{[W/(m K)]}\f$
+ * \param lambdaN The thermal conductivity of the NAPL phase in \f$\mathrm{[W/(m K)]}\f$
+ * \param lambdaG The thermal conductivity of the gas phase in \f$\mathrm{[W/(m K)]}\f$
+ * \param lambdaSolid The thermal conductivity of the solid phase in \f$\mathrm{[W/(m K)]}\f$
* \param porosity The porosity
*
* \return effective thermal conductivity \f$\mathrm{[W/(m K)]}\f$ after Somerton (1974)
@@ -133,9 +133,6 @@ public:
const Scalar satW = max<Scalar>(0.0, sw);
const Scalar satN = max<Scalar>(0.0, sn);
-// const Scalar lSw = 1.8; //pow(lambdaSolid, (1.0 - porosity)) * pow(lambdaW, porosity);
-// const Scalar lSn = 0.65; //pow(lambdaSolid, (1.0 - porosity)) * pow(lambdaN, porosity);
-// const Scalar lSg = 0.35; //pow(lambdaSolid, (1.0 - porosity)) * pow(lambdaG, porosity);
// porosity weighted geometric mean
const Scalar lSw = pow(lambdaSolid, (1.0 - porosity)) * pow(lambdaW, porosity);
const Scalar lSn = pow(lambdaSolid, (1.0 - porosity)) * pow(lambdaN, porosity);
diff --git a/dumux/material/fluidmatrixinteractions/mp/mpadapter.hh b/dumux/material/fluidmatrixinteractions/mp/mpadapter.hh
index 24699e0ca0..c8bb59cf39 100644
--- a/dumux/material/fluidmatrixinteractions/mp/mpadapter.hh
+++ b/dumux/material/fluidmatrixinteractions/mp/mpadapter.hh
@@ -74,7 +74,7 @@ public:
* \param values Container for the return values
* \param params Array of parameters
* \param state Fluidstate
- * \param wPhaseIdx the phase index of the wetting phase
+ * \param wPhaseIdx The phase index of the wetting phase
*/
template <class ContainerT, class FluidState>
static void relativePermeabilities(ContainerT &values,
diff --git a/dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh b/dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh
index fb6abe9774..2925710ba2 100644
--- a/dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh
+++ b/dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh
@@ -82,7 +82,7 @@ public:
* \param values Container for the return values
* \param params Array of Parameters
* \param state The fluid state
- * \param wPhaseIdx the phase index of the wetting phase
+ * \param wPhaseIdx The phase index of the wetting phase
*/
template <class ContainerT, class FluidState>
static void relativePermeabilities(ContainerT &values,
diff --git a/dumux/material/fluidmatrixinteractions/mp/mplinearmaterialparams.hh b/dumux/material/fluidmatrixinteractions/mp/mplinearmaterialparams.hh
index da7aa99192..6a4477f651 100644
--- a/dumux/material/fluidmatrixinteractions/mp/mplinearmaterialparams.hh
+++ b/dumux/material/fluidmatrixinteractions/mp/mplinearmaterialparams.hh
@@ -67,7 +67,7 @@ public:
/*!
* \brief Set the capillary pressure in \f$\mathrm{[Pa]}\f$ for a phase \f$\mathrm{\alpha}\f$ at \f$\mathrm{S_\alpha=0}\f$.
* \param phaseIdx Index of the phase
- * \param val value of the capillary pressure
+ * \param val Value of the capillary pressure
*/
void setPcMinSat(int phaseIdx, Scalar val)
{ pcMinSat_[phaseIdx] = val; }
@@ -82,7 +82,7 @@ public:
/*!
* \brief Set the capillary pressure in \f$\mathrm{[Pa]}\f$ for a phase \f$\mathrm{\alpha}\f$ at \f$\mathrm{S_\alpha=1}\f$.
* \param phaseIdx Index of the phase
- * \param val value of the capillary pressure
+ * \param val Value of the capillary pressure
*/
void setPcMaxSat(int phaseIdx, Scalar val)
{ pcMaxSat_[phaseIdx] = val; }
diff --git a/dumux/material/fluidmatrixinteractions/permeabilitykozenycarman.hh b/dumux/material/fluidmatrixinteractions/permeabilitykozenycarman.hh
index 4ba65b4b36..f519cef75f 100644
--- a/dumux/material/fluidmatrixinteractions/permeabilitykozenycarman.hh
+++ b/dumux/material/fluidmatrixinteractions/permeabilitykozenycarman.hh
@@ -42,7 +42,7 @@ class PermeabilityKozenyCarman
{
public:
/*!
- * \brief calculates the permeability for a given sub-control volume
+ * \brief Calculates the permeability for a given sub-control volume
* \param refPerm Reference permeability before porosity changes
* \param refPoro The poro corresponding to the reference permeability
* \param poro The porosity for which permeability is to be evaluated
diff --git a/dumux/material/fluidmatrixinteractions/porosityprecipitation.hh b/dumux/material/fluidmatrixinteractions/porosityprecipitation.hh
index bb785c1c7f..fb9423cbcb 100644
--- a/dumux/material/fluidmatrixinteractions/porosityprecipitation.hh
+++ b/dumux/material/fluidmatrixinteractions/porosityprecipitation.hh
@@ -42,9 +42,9 @@ class PorosityPrecipitation
public:
/*!
* \brief Calculates the porosity in a sub-control volume
- * \param element element
- * \param elemSol the element solution
- * \param scv sub control volume
+ * \param element Element
+ * \param elemSol The element solution
+ * \param scv Sub control volume
* \param refPoro The solid matrix porosity without precipitates
* \param minPoro A minimum porosity value
*/
--
GitLab