From 4c13bff3f355158566384c989bc345c01c7f6ea4 Mon Sep 17 00:00:00 2001
From: Wenqing Wang <wenqing.wang@ufz.de>
Date: Thu, 18 Feb 2021 10:54:38 +0100
Subject: [PATCH] [Doc] Added documentation to class
SoilThermalConductivitySomerton
---
Documentation/bibliography/other.bib | 8 ++++++++
.../SoilThermalConductivitySomerton.h | 15 +++++++++++++++
2 files changed, 23 insertions(+)
diff --git a/Documentation/bibliography/other.bib b/Documentation/bibliography/other.bib
index 93600dc7878..778ac6fe41b 100644
--- a/Documentation/bibliography/other.bib
+++ b/Documentation/bibliography/other.bib
@@ -220,3 +220,11 @@ URL = {https://doi.org/10.1680/geot.2008.58.3.157}
year={1987},
publisher={Wiley Online Library}
}
+
+@inproceedings{somerton1974high,
+ title={High temperature behavior of rocks associated with geothermal type reservoirs},
+ author={Somerton, W.~H. and El-Shaarani, A.~H. and Mobarak, S.~M. and others},
+ booktitle={SPE California Regional Meeting},
+ year={1974},
+ organization={Society of Petroleum Engineers}
+}
diff --git a/MaterialLib/MPL/Properties/ThermalConductivity/SoilThermalConductivitySomerton.h b/MaterialLib/MPL/Properties/ThermalConductivity/SoilThermalConductivitySomerton.h
index bd844340b20..55debdb0239 100644
--- a/MaterialLib/MPL/Properties/ThermalConductivity/SoilThermalConductivitySomerton.h
+++ b/MaterialLib/MPL/Properties/ThermalConductivity/SoilThermalConductivitySomerton.h
@@ -17,6 +17,19 @@
namespace MaterialPropertyLib
{
class Medium;
+/**
+ * \brief A saturation dependent thermal conductivity model for soil.
+ *
+ * This model is proposed by Somerton, W.~H. et al. \cite somerton1974high,
+ * which takes the form of
+ * \f[
+ * \lambda = \lambda_{\text{dry}} +
+ * \sqrt{S}(\lambda_{\text{wet}}-\lambda_{\text{dry}}),
+ * \f]
+ * where \f$\lambda_{\text{dry}}\f$ is the thermal conductivity of soil at the
+ * dry state, \f$\lambda_{\text{wet}}\f$ is the thermal conductivity of soil at
+ * the fully water saturated state, and \f$S\f$ is the water saturation.
+ */
class SoilThermalConductivitySomerton final : public Property
{
public:
@@ -59,7 +72,9 @@ public:
double const dt) const override;
private:
+ /// Thermal conductivity of soil at the dry state.
double const dry_thermal_conductivity_;
+ /// Thermal conductivity of soil at the fully water saturated state.
double const wet_thermal_conductivity_;
};
--
GitLab