From 5769870d4e96c756acf7a76fd88dc7e41bb5497a Mon Sep 17 00:00:00 2001
From: Melanie Lipp <melanie.lipp@iws.uni-stuttgart.de>
Date: Wed, 28 Oct 2020 11:24:47 +0100
Subject: [PATCH] [doc][doxygen] Cleanup for new materiallaw.
---
.../fluidmatrixinteractions/2p/datasplinemateriallaw.hh | 2 +-
dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh | 2 --
.../2p/interfacialarea/exponential.hh | 6 +++---
.../2p/interfacialarea/polynomial2ndorder.hh | 6 +++---
.../fluidmatrixinteractions/2p/splinemateriallaw.hh | 2 +-
dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh | 1 +
dumux/porousmediumflow/2p/boxmaterialinterfaces.hh | 2 +-
dumux/porousmediumflow/2p/saturationreconstruction.hh | 4 ++--
8 files changed, 12 insertions(+), 13 deletions(-)
diff --git a/dumux/material/fluidmatrixinteractions/2p/datasplinemateriallaw.hh b/dumux/material/fluidmatrixinteractions/2p/datasplinemateriallaw.hh
index 794fe36049..990e43fd09 100644
--- a/dumux/material/fluidmatrixinteractions/2p/datasplinemateriallaw.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/datasplinemateriallaw.hh
@@ -36,7 +36,7 @@ namespace Dumux::FluidMatrix {
* \ingroup Fluidmatrixinteractions
* \brief Pc- and Kr-sw curves based on monotone splines through given data points
* \tparam S the type for scalar numbers
- * \tpraram approximatePcSwInverse if this is set true, the
+ * \tparam approximatePcSwInverse if this is set true, the
* spline approximates sw(pc) and evaluating pc(sw) needs spline inversion.
* if this is false, the spline approximates pc(sw) and evaluating
* sw(pc) needs spline inversion. Spline inversion is rather expensive
diff --git a/dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh b/dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh
index 3a5437d690..43a96a6170 100644
--- a/dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh
@@ -273,7 +273,6 @@ public:
/*!
* \brief The capillary pressure-saturation curve.
*
- }\f$
* \param swe Effective saturation of the wetting phase \f$\mathrm{\overline{S}_w}\f$
*/
template<class Scalar>
@@ -305,7 +304,6 @@ public:
/*!
* \brief The partial derivative of the capillary
* pressure w.r.t. the effective saturation.
-
*
* \param swe Effective saturation of the wetting phase \f$\mathrm{\overline{S}_w}\f$
*/
diff --git a/dumux/material/fluidmatrixinteractions/2p/interfacialarea/exponential.hh b/dumux/material/fluidmatrixinteractions/2p/interfacialarea/exponential.hh
index 552922aaf5..4d3b6b2b81 100644
--- a/dumux/material/fluidmatrixinteractions/2p/interfacialarea/exponential.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/interfacialarea/exponential.hh
@@ -92,7 +92,7 @@ public:
* \f$\mathrm{
a_{wn} = a_1 * (S_{wr}-S_w) .* (1-S_w) + a_2 * (S_{wr}-S_w) * (1-S_w) * \exp( a_3 * p_c) ;
}\f$
- * \param sw Effective saturation of the wetting phase
+ * \param swe Effective saturation of the wetting phase
* \param pc Capillary pressure in \f$\mathrm{[Pa]}\f$
* \param params parameter container for the coefficients of the surface
*/
@@ -110,7 +110,7 @@ public:
/*! \brief the derivative of specific interfacial area function w.r.t. capillary pressure
*
* \param params parameter container for the coefficients of the surface
- * \param Sw Effective saturation of the wetting phase
+ * \param swe Effective saturation of the wetting phase
* \param pc Capillary pressure in \f$\mathrm{[Pa]}\f$
*/
template<class Scalar>
@@ -126,7 +126,7 @@ public:
/*! \brief the derivative of specific interfacial area function w.r.t. saturation
*
* \param params parameter container for the coefficients of the surface
- * \param Sw Effective saturation of the wetting phase
+ * \param swe Effective saturation of the wetting phase
* \param pc Capillary pressure in \f$\mathrm{[Pa]}\f$
*/
template<class Scalar>
diff --git a/dumux/material/fluidmatrixinteractions/2p/interfacialarea/polynomial2ndorder.hh b/dumux/material/fluidmatrixinteractions/2p/interfacialarea/polynomial2ndorder.hh
index 1b0f44599c..05f4243a69 100644
--- a/dumux/material/fluidmatrixinteractions/2p/interfacialarea/polynomial2ndorder.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/interfacialarea/polynomial2ndorder.hh
@@ -101,7 +101,7 @@ public:
a_{wn} = a_{00} + a_{10}S_{w} + a_{20}S_{w}^2 + a_{11} S_{w} p_{c} + a_{01} p_{c} + a_{02}p_{c}^2
\f$]
* \param params parameter container for the coefficients of the surface
- * \param Sw Effective saturation of the wetting phase
+ * \param swe Effective saturation of the wetting phase
* \param pc Capillary pressure in \f$\mathrm{[Pa]}\f$
*/
template<class Scalar>
@@ -121,7 +121,7 @@ public:
* \brief the derivative of specific interfacial area function w.r.t. capillary pressure
*
* \param params parameter container for the coefficients of the surface
- * \param Sw Effective saturation of the wetting phase
+ * \param swe Effective saturation of the wetting phase
* \param pc Capillary pressure in \f$\mathrm{[Pa]}\f$
*/
template<class Scalar>
@@ -134,7 +134,7 @@ public:
* \brief the derivative of specific interfacial area function w.r.t. saturation
*
* \param params parameter container for the coefficients of the surface
- * \param Sw Effective saturation of the wetting phase
+ * \param swe Effective saturation of the wetting phase
* \param pc Capillary pressure in \f$\mathrm{[Pa]}\f$
*/
template<class Scalar>
diff --git a/dumux/material/fluidmatrixinteractions/2p/splinemateriallaw.hh b/dumux/material/fluidmatrixinteractions/2p/splinemateriallaw.hh
index 59e54d6f51..78e1967384 100644
--- a/dumux/material/fluidmatrixinteractions/2p/splinemateriallaw.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/splinemateriallaw.hh
@@ -37,7 +37,7 @@ namespace Dumux::FluidMatrix {
* \ingroup Fluidmatrixinteractions
* \brief A spline approximation wrapper for 2p material laws
* \tparam TwoPMaterialLaw the type of material law to be wrapped
- * \tpraram approximatePcSwInverse if this is set true, the
+ * \tparam approximatePcSwInverse if this is set true, the
* spline approximates sw(pc) and evaluating pc(sw) needs spline inversion.
* if this is false, the spline approximates pc(sw) and evaluating
* sw(pc) needs spline inversion. Spline inversion is rather expensive
diff --git a/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh b/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh
index 323aac975d..69aeb71099 100644
--- a/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh
@@ -523,6 +523,7 @@ public:
* parameterization.
*
* \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.
* \note Instead of undefined behaviour if pc is not in the valid range, we return a valid number,
* by clamping the input.
*/
diff --git a/dumux/porousmediumflow/2p/boxmaterialinterfaces.hh b/dumux/porousmediumflow/2p/boxmaterialinterfaces.hh
index 3296cd5444..ab1e84f16d 100644
--- a/dumux/porousmediumflow/2p/boxmaterialinterfaces.hh
+++ b/dumux/porousmediumflow/2p/boxmaterialinterfaces.hh
@@ -19,7 +19,7 @@
/*!
* \file
* \ingroup TwoPModel
- * \copydoc Dumux::BoxMaterialInterfaceParams
+ * \copydoc Dumux::BoxMaterialInterfaces
*/
#ifndef DUMUX_2P_BOX_MATERIAL_INTERFACES_HH
diff --git a/dumux/porousmediumflow/2p/saturationreconstruction.hh b/dumux/porousmediumflow/2p/saturationreconstruction.hh
index 10a49b2644..7a94627486 100644
--- a/dumux/porousmediumflow/2p/saturationreconstruction.hh
+++ b/dumux/porousmediumflow/2p/saturationreconstruction.hh
@@ -53,7 +53,7 @@ public:
* \param element The finite element the scv is embedded in
* \param scv The sub-control volume for which the saturation is computed
* \param elemSol The solution at all dofs inside this element
- * \param Sn The nonwetting phase saturation at the global dof
+ * \param sn The nonwetting phase saturation at the global dof
*/
template<class SpatialParams, class Element, class Scv, class ElemSol>
static typename ElemSol::PrimaryVariables::value_type
@@ -77,7 +77,7 @@ public:
* \param element The finite element the scv is embedded in
* \param scv The sub-control volume for which the saturation is computed
* \param elemSol The solution at all dofs inside this element
- * \param Sn The nonwetting phase saturation at the global dof
+ * \param sn The nonwetting phase saturation at the global dof
*/
template<class SpatialParams, class Element, class Scv, class ElemSol>
static typename ElemSol::PrimaryVariables::value_type
--
GitLab