From b2fc7d5d80e30f042850e70e197c6fdaea662cd0 Mon Sep 17 00:00:00 2001
From: Wenqing Wang <wenqing.wang@ufz.de>
Date: Fri, 20 Mar 2020 17:24:43 +0100
Subject: [PATCH] [SaturationVanGenuchten] Documentation and moving private
section to bottom
---
.../SaturationVanGenuchten.h | 49 ++++++++++++++-----
1 file changed, 37 insertions(+), 12 deletions(-)
diff --git a/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationVanGenuchten.h b/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationVanGenuchten.h
index cbaff22c6ab..69f7e7fde15 100644
--- a/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationVanGenuchten.h
+++ b/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationVanGenuchten.h
@@ -15,20 +15,38 @@ namespace MaterialPropertyLib
class Medium;
class Phase;
class Component;
-
-/// The van Genuchten soil characteristics function.
-///
-/// This property must be a medium property, it computes the saturation of the
-/// wetting phase as function of capillary pressure.
+/**
+ * \brief The van Genuchten capillary pressure model.
+ *
+ * \f[p_c(S)=p_b (S_e^{-1/m}-1)^{1-m}\f]
+ * with
+ * \f[S_e=\frac{S-S_r}{S_{\mbox{max}}-S_r}\f]
+ * where
+ * \f{eqnarray*}{
+ * &p_b& \mbox{ entry pressure,}\\
+ * &S_r& \mbox{ residual saturation,}\\
+ * &S_{\mbox{max}}& \mbox{ maximum saturation,}\\
+ * &m(<=1) & \mbox{ exponent.}\\
+ * \f}
+ *
+ * Note:
+ * \f[m=1/(1-n)\f].
+ *
+ * If \f$\alpha\f$ instead of \f$p_b\f$ is available, \f$p_b\f$ can
+ * be calculated
+ * as
+ * \f[p_b=\rho g/\alpha\f]
+ *
+ * If the capillary pressure is known, the saturation can be
+ * obtained by this model with
+ * \f[S(p_c)=
+ * \left( \left(\dfrac{p_c}{p_b}\right)^{\frac{1}{m}} +1\right)^{-m}
+ * (S_{\mbox{max}}-S_r) +S_r \f]
+ * class SaturationVanGenuchten handles the computations associated
+ * with \f$S(p_c)\f$.
+ */
class SaturationVanGenuchten final : public Property
{
-private:
- Medium* _medium = nullptr;
- double const _S_L_res;
- double const _S_L_max;
- double const _m;
- double const _p_b;
-
public:
SaturationVanGenuchten(double const residual_liquid_saturation,
double const residual_gas_saturation,
@@ -63,5 +81,12 @@ public:
ParameterLib::SpatialPosition const& /*pos*/,
double const /*t*/,
double const /*dt*/) const override;
+
+private:
+ Medium* _medium = nullptr;
+ double const _S_L_res;
+ double const _S_L_max;
+ double const _m;
+ double const _p_b;
};
} // namespace MaterialPropertyLib
--
GitLab