From 4f602c842af06ee01e3eca2b620b4a20ecee9faf Mon Sep 17 00:00:00 2001
From: Wenqing Wang <wenqing.wang@ufz.de>
Date: Fri, 5 Mar 2021 15:02:40 +0100
Subject: [PATCH] [Doc] Added class documentation of WaterVapourDensity
---
.../Properties/Density/WaterVapourDensity.h | 34 +++++++++++++++++++
1 file changed, 34 insertions(+)
diff --git a/MaterialLib/MPL/Properties/Density/WaterVapourDensity.h b/MaterialLib/MPL/Properties/Density/WaterVapourDensity.h
index 229bad110a8..8e128e52500 100644
--- a/MaterialLib/MPL/Properties/Density/WaterVapourDensity.h
+++ b/MaterialLib/MPL/Properties/Density/WaterVapourDensity.h
@@ -16,6 +16,40 @@
namespace MaterialPropertyLib
{
class Phase;
+
+/**
+ * \brief A model for water vapour density in the unsaturated porous media.
+ *
+ * The water vapour density is given by
+ * \f[
+ * \rho_v = h\, \rho_{vS},
+ * \f]
+ * where \f$h\f$ is the relative humidity according to
+ * \f[
+ * h=\exp({\frac{p}{\rho_w R T}}),
+ * \f]
+ *
+ * with \f$R\f$ the specific gas constant for water vapour, and
+ * \f$\rho_{vS}\f$, is the saturated vapour density given by
+ * \f[
+ * \rho_{vS}=10^{-3}\, \exp({19.819-4975.9/T}).
+ * \f]
+ * The specific gas constant for water vapour
+ * \f$R=461.6\,\text{J}\,\text{kg}^{-1}\text{K}^{-1}\f$,
+ * the value is calculated by \f$R_g/M_w\f$ with
+ * \f$R_g= 8.3144621\,\text{J}\,\text{mol}^{-1}\text{K}^{-1}\f$,
+ * the ideal gas constant, and
+ * \f$M_w=0.018016\,\text{kg}\,\text{mol}^{-1}\f$,
+ * the molar mass of water.
+ *
+ * The formula of this density model is presented on page 20 of
+ * \cite kimball1976comparison.
+ *
+ * In the application, the vapour density related terms in the mass balance
+ * equation are multiplied with \f$1-S\f$ with \f$ S \f$, the water
+ * saturation. Therefore the application of the water vapour density model is
+ * naturally restricted in the unsaturated zones.
+ */
class WaterVapourDensity final : public Property
{
public:
--
GitLab