Merge branch 'saturation_dependent_thermal_conductivity' into 'master'

[MPL] rename HeatConduction -> ThermalConductivity

See merge request ogs/ogs!3651

Documentation/ProjectFile/properties/property/SaturationDependentHeatConduction/c_SaturationDependentHeatConduction.md

-\copydoc MaterialPropertyLib::SaturationDependentHeatConduction

Documentation/ProjectFile/properties/property/SaturationDependentHeatConduction/t_dry.md

-\copydoc MaterialPropertyLib::SaturationDependentHeatConduction::K_dry_

Documentation/ProjectFile/properties/property/SaturationDependentHeatConduction/t_wet.md

-\copydoc MaterialPropertyLib::SaturationDependentHeatConduction::K_wet_

Documentation/ProjectFile/properties/property/SaturationDependentThermalConductivity/c_SaturationDependentThermalConductivity.md

+\copydoc MaterialPropertyLib::SaturationDependentThermalConductivity

Documentation/ProjectFile/properties/property/SaturationDependentThermalConductivity/t_dry.md

+\copydoc MaterialPropertyLib::SaturationDependentThermalConductivity::K_dry_

Documentation/ProjectFile/properties/property/SaturationDependentThermalConductivity/t_wet.md

+\copydoc MaterialPropertyLib::SaturationDependentThermalConductivity::K_wet_

MaterialLib/MPL/CreateProperty.cpp

@@ -210,9 +210,9 @@ std::unique_ptr<MaterialPropertyLib::Property> createProperty(
         return createRelPermUdellNonwettingPhase(config);
     }
 
-    if (boost::iequals(property_type, "SaturationDependentHeatConduction"))
+    if (boost::iequals(property_type, "SaturationDependentThermalConductivity"))
     {
-        return createSaturationDependentHeatConduction(config);
+        return createSaturationDependentThermalConductivity(config);
     }
 
     if (boost::iequals(property_type, "SaturationDependentSwelling"))

MaterialLib/MPL/Properties/CreateProperties.h

@@ -37,7 +37,7 @@
 #include "CreateOrthotropicEmbeddedFracturePermeability.h"
 #include "CreatePermeabilityOrthotropicPowerLaw.h"
 #include "CreatePorosityFromMassBalance.h"
-#include "CreateSaturationDependentHeatConduction.h"
+#include "CreateSaturationDependentThermalConductivity.h"
 #include "CreateSaturationDependentSwelling.h"
 #include "CreateStrainDependentPermeability.h"
 #include "CreateTransportPorosityFromMassBalance.h"

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

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

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

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

MaterialLib/MPL/Properties/Properties.h

@@ -42,7 +42,7 @@
 #include "RelativePermeability/RelPermUdell.h"
 #include "RelativePermeability/RelPermUdellNonwettingPhase.h"
 #include "RelativePermeability/RelPermVanGenuchten.h"
-#include "SaturationDependentHeatConduction.h"
+#include "SaturationDependentThermalConductivity.h"
 #include "SaturationDependentSwelling.h"
 #include "ThermalConductivity/SoilThermalConductivitySomerton.h"
 #include "TransportPorosityFromMassBalance.h"

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

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

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

@@ -13,14 +13,14 @@
 namespace MaterialPropertyLib
 {
 /// Saturation dependent model for effective heat conduction
-/// \details This model is for the porous media with isotropic heat conductivity. This property must be a medium property, it
-/// computes the effetive heat conductivity based on a wet
+/// \details This model is for the porous media with isotropic thermal conductivity. This property must be a medium property, it
+/// computes the effective thermal conductivity based on a wet
 /// and a dry value
 /// \f$ K_{\mathrm{eff}} = S K_{\mathrm{wet}} + (1-S) K_{\mathrm{dry}} \f$
-class SaturationDependentHeatConduction final : public Property
+class SaturationDependentThermalConductivity final : public Property
 {
 public:
-    SaturationDependentHeatConduction(std::string name,
+    SaturationDependentThermalConductivity(std::string name,
                                       double const K_dry,
                                       double const K_wet);
 

Tests/MaterialLib/TestSaturationDependentHeatConduction.cpp → Tests/MaterialLib/TestSaturationDependentThermalConductivity.cpp

@@ -15,19 +15,19 @@
 #include <boost/math/constants/constants.hpp>
 
 #include "MaterialLib/MPL/Medium.h"
-#include "MaterialLib/MPL/Properties/CreateSaturationDependentHeatConduction.h"
-#include "MaterialLib/MPL/Properties/SaturationDependentHeatConduction.h"
+#include "MaterialLib/MPL/Properties/CreateSaturationDependentThermalConductivity.h"
+#include "MaterialLib/MPL/Properties/SaturationDependentThermalConductivity.h"
 #include "MaterialLib/MPL/Utils/FormEigenTensor.h"
 #include "ParameterLib/ConstantParameter.h"
 #include "TestMPL.h"
 #include "Tests/TestTools.h"
 
-TEST(MaterialPropertyLib, SaturationDependentHeatConduction)
+TEST(MaterialPropertyLib, SaturationDependentThermalConductivity)
 {
     double const k_dry = 0.2;
     double const k_wet = 1.5;
 
-    auto const k_model_eff = MPL::SaturationDependentHeatConduction(
+    auto const k_model_eff = MPL::SaturationDependentThermalConductivity(
         "thermal_conductivity", k_dry, k_wet);
 
     ParameterLib::SpatialPosition const pos;