add documentaiton

MaterialLib/MPL/Properties/CreateHeatConductionSaturation.cpp → MaterialLib/MPL/Properties/CreateSaturationDependentHeatConduction.cpp

@@ -8,15 +8,15 @@
  */
 
 #include "BaseLib/ConfigTree.h"
-#include "HeatConductionSaturation.h"
+#include "SaturationDependentHeatConduction.h"
 
 namespace MaterialPropertyLib
 {
-std::unique_ptr<HeatConductionSaturationDependent>
-createHeatConductionSaturation(BaseLib::ConfigTree const& config)
+std::unique_ptr<SaturationDependentHeatConduction>
+createSaturationDependentHeatConduction(BaseLib::ConfigTree const& config)
 {
     //! \ogs_file_param{properties__property__type}
-    config.checkConfigParameter("type", "HeatConductionSaturationDependent");
+    config.checkConfigParameter("type", "SaturationDependentHeatConduction");
 
     // Second access for storage.
     //! \ogs_file_param{properties__property__name}
@@ -26,15 +26,15 @@ createHeatConductionSaturation(BaseLib::ConfigTree const& config)
          property_name);
 
     auto const K_dry =
-        //! \ogs_file_param{properties__property__HeatConductionSaturationDependent__dry}
+        //! \ogs_file_param{properties__property__SaturationDependentHeatConduction__dry}
         config.getConfigParameter<double>("dry");
 
     auto const K_wet =
-        //! \ogs_file_param{properties__property__HeatConductionSaturationDependent__wet}
+        //! \ogs_file_param{properties__property__SaturationDependentHeatConduction__wet}
         config.getConfigParameter<double>("wet");
 
     return std::make_unique<
-        MaterialPropertyLib::HeatConductionSaturationDependent>(
+        MaterialPropertyLib::SaturationDependentHeatConduction>(
         std::move(property_name), K_dry, K_wet);
 }
 }  // namespace MaterialPropertyLib

MaterialLib/MPL/Properties/CreateHeatConductionSaturation.h → MaterialLib/MPL/Properties/CreateSaturationDependentHeatConduction.h

@@ -18,11 +18,11 @@ class ConfigTree;
 
 namespace MaterialPropertyLib
 {
-class HeatConductionSaturationDependent;
+class SaturationDependentHeatConduction;
 }
 
 namespace MaterialPropertyLib
 {
-std::unique_ptr<HeatConductionSaturationDependent>
-createHeatConductionSaturation(BaseLib::ConfigTree const& config);
+std::unique_ptr<SaturationDependentHeatConduction>
+createSaturationDependentHeatConduction(BaseLib::ConfigTree const& config);
 }  // namespace MaterialPropertyLib

MaterialLib/MPL/Properties/HeatConductionSaturation.cpp → MaterialLib/MPL/Properties/SaturationDependentHeatConduction.cpp

@@ -7,30 +7,30 @@
  *              http://www.opengeosys.org/project/license
  */
 
-#include "HeatConductionSaturation.h"
+#include "SaturationDependentHeatConduction.h"
 
 #include "MaterialLib/MPL/Medium.h"
 
 namespace MaterialPropertyLib
 {
-HeatConductionSaturationDependent::HeatConductionSaturationDependent(
+SaturationDependentHeatConduction::SaturationDependentHeatConduction(
     std::string name, double const K_dry, double const K_wet)
     : K_dry_(K_dry), K_wet_(K_wet)
 {
     name_ = std::move(name);
 }
 
-void HeatConductionSaturationDependent::checkScale() const
+void SaturationDependentHeatConduction::checkScale() const
 {
     if (!std::holds_alternative<Medium*>(scale_))
     {
         OGS_FATAL(
-            "The property 'HeatConductionSaturationDependent' is "
+            "The property 'SaturationDependentHeatConduction' is "
             "implemented on the 'medium' scale only.");
     }
 }
 
-PropertyDataType HeatConductionSaturationDependent::value(
+PropertyDataType SaturationDependentHeatConduction::value(
     VariableArray const& variable_array,
     ParameterLib::SpatialPosition const& /*pos*/, double const /*t*/,
     double const /*dt*/) const
@@ -41,14 +41,14 @@ PropertyDataType HeatConductionSaturationDependent::value(
     return K_dry_ * (1 - S_L) + K_wet_ * S_L;
 }
 
-PropertyDataType HeatConductionSaturationDependent::dValue(
+PropertyDataType SaturationDependentHeatConduction::dValue(
     VariableArray const& /*variable_array*/, Variable const variable,
     ParameterLib::SpatialPosition const& /*pos*/, double const /*t*/,
     double const /*dt*/) const
 {
     (void)variable;
     assert((variable == Variable::liquid_saturation) &&
-           "HeatConductionSaturationDependent::dvalue is implemented for "
+           "SaturationDependentHeatConduction::dvalue is implemented for "
            "derivatives with "
            "respect to liquid saturation only.");
 

MaterialLib/MPL/Properties/HeatConductionSaturation.h → MaterialLib/MPL/Properties/SaturationDependentHeatConduction.h

@@ -16,10 +16,11 @@ namespace MaterialPropertyLib
 /// \details This property must be a medium property, it
 /// computes the effetive heat conductivity based on a wet
 /// and a dry value
-class HeatConductionSaturationDependent final : public Property
+/// \f$ K_{\mathrm{eff}} = S K_{\mathrm{wet}} + (1-S) K_{\mathrm{dry}} \f$
+class SaturationDependentHeatConduction final : public Property
 {
 public:
-    HeatConductionSaturationDependent(std::string name,
+    SaturationDependentHeatConduction(std::string name,
                                       double const K_dry,
                                       double const K_wet);