From e1d720c378623a8026a5e80cfffb9d36910ecab6 Mon Sep 17 00:00:00 2001
From: Norbert Grunwald <Norbert.Grunwald@ufz.de>
Date: Mon, 12 Apr 2021 15:15:34 +0200
Subject: [PATCH] <MPL-Doc> add Documentation for SaturationExponential
---
.../c_SaturationExponential.md | 1 +
.../SaturationExponential/t_exponent.md | 1 +
.../t_reference_capillary_pressure.md | 1 +
.../t_residual_gas_saturation.md | 1 +
.../t_residual_liquid_saturation.md | 1 +
.../SaturationExponential.h | 26 ++++++++++++++-----
6 files changed, 25 insertions(+), 6 deletions(-)
create mode 100644 Documentation/ProjectFile/properties/property/SaturationExponential/c_SaturationExponential.md
create mode 100644 Documentation/ProjectFile/properties/property/SaturationExponential/t_exponent.md
create mode 100644 Documentation/ProjectFile/properties/property/SaturationExponential/t_reference_capillary_pressure.md
create mode 100644 Documentation/ProjectFile/properties/property/SaturationExponential/t_residual_gas_saturation.md
create mode 100644 Documentation/ProjectFile/properties/property/SaturationExponential/t_residual_liquid_saturation.md
diff --git a/Documentation/ProjectFile/properties/property/SaturationExponential/c_SaturationExponential.md b/Documentation/ProjectFile/properties/property/SaturationExponential/c_SaturationExponential.md
new file mode 100644
index 00000000000..83ef8084528
--- /dev/null
+++ b/Documentation/ProjectFile/properties/property/SaturationExponential/c_SaturationExponential.md
@@ -0,0 +1 @@
+\copydoc MaterialPropertyLib::SaturationExponential
diff --git a/Documentation/ProjectFile/properties/property/SaturationExponential/t_exponent.md b/Documentation/ProjectFile/properties/property/SaturationExponential/t_exponent.md
new file mode 100644
index 00000000000..baa7d302274
--- /dev/null
+++ b/Documentation/ProjectFile/properties/property/SaturationExponential/t_exponent.md
@@ -0,0 +1 @@
+\copydoc MaterialPropertyLib::SaturationExponential::exponent_
diff --git a/Documentation/ProjectFile/properties/property/SaturationExponential/t_reference_capillary_pressure.md b/Documentation/ProjectFile/properties/property/SaturationExponential/t_reference_capillary_pressure.md
new file mode 100644
index 00000000000..f35036e41f2
--- /dev/null
+++ b/Documentation/ProjectFile/properties/property/SaturationExponential/t_reference_capillary_pressure.md
@@ -0,0 +1 @@
+\copydoc MaterialPropertyLib::SaturationExponential::p_cap_ref_
diff --git a/Documentation/ProjectFile/properties/property/SaturationExponential/t_residual_gas_saturation.md b/Documentation/ProjectFile/properties/property/SaturationExponential/t_residual_gas_saturation.md
new file mode 100644
index 00000000000..0b56bfad36c
--- /dev/null
+++ b/Documentation/ProjectFile/properties/property/SaturationExponential/t_residual_gas_saturation.md
@@ -0,0 +1 @@
+\copydoc MaterialPropertyLib::SaturationExponential::residual_gas_saturation_
diff --git a/Documentation/ProjectFile/properties/property/SaturationExponential/t_residual_liquid_saturation.md b/Documentation/ProjectFile/properties/property/SaturationExponential/t_residual_liquid_saturation.md
new file mode 100644
index 00000000000..ce79c90316d
--- /dev/null
+++ b/Documentation/ProjectFile/properties/property/SaturationExponential/t_residual_liquid_saturation.md
@@ -0,0 +1 @@
+\copydoc MaterialPropertyLib::SaturationExponential::residual_liquid_saturation_
diff --git a/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationExponential.h b/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationExponential.h
index 3f1063d687f..b67dc8731a7 100644
--- a/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationExponential.h
+++ b/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationExponential.h
@@ -24,14 +24,30 @@ namespace MaterialPropertyLib
* \details This property must be a medium property, it
* computes the saturation of the wetting phase as function
* of capillary pressure.
+ *
+ * Very simple capillary pressure-saturation relationship given by
+ * \f$s_{eff}=1-\left(\frac{p_{c}}{p_{c}^{ref}}\right)^{\lambda}\f$
+ * where
+ * \f$\lambda\f$ is an exponent
+ * \f$p_{c}\f$ is capillary pressure
+ * \f$p_{c}^{ref}\f$ is reference capillary pressure at which \f$s_{eff}=0\f$
+ * This property can mainly be used for testing. If the exponent is set to 1,
+ * the characteristic curve shows a linear dependence.
+ *
+ *
+ * Reference capillary pressure at which \f$s_{eff}=0\f$
+ *
*/
class SaturationExponential final : public Property
{
private:
- const double residual_liquid_saturation_;
- const double residual_gas_saturation_;
- const double p_cap_ref_;
- const double exponent_;
+ const double
+ residual_liquid_saturation_; /// Residual saturation of the gas phase.
+ const double
+ residual_gas_saturation_; /// Residual saturation of the liquid phase.
+ const double p_cap_ref_; /// Reference capillary pressure at which
+ /// effective saturation is zero.
+ const double exponent_; /// Exponent to govern the shape of the curve
public:
SaturationExponential(std::string name,
@@ -49,8 +65,6 @@ public:
}
}
- /// Those methods override the base class implementations and
- /// actually compute and set the property values_ and dValues_.
PropertyDataType value(VariableArray const& variable_array,
ParameterLib::SpatialPosition const& /*pos*/,
double const /*t*/,
--
GitLab