Merge branch 'opt-inline-params-satwtd_TC' into 'master'

Dmitri Naumov · Dmitri Naumov · commit 9d582e436361 · 2025-08-26T14:16:30.000+02:00
Enable optional inline parameters for MPL property SaturationWeightedThermalConductivity

See merge request ogs/ogs!5392
diff --git a/BaseLib/ConfigTree-impl.h b/BaseLib/ConfigTree-impl.h
@@ -14,6 +14,7 @@
 #include <utility>
 
 #include "ConfigTree.h"
+#include "StringTools.h"
 
 namespace BaseLib
 {
@@ -87,24 +88,20 @@ std::optional<std::vector<T>> ConfigTree::getConfigParameterOptionalImpl(
 {
     if (auto p = getConfigSubtreeOptional(param))
     {
-        std::istringstream sstr{p->getValue<std::string>()};
-        std::vector<T> result;
-        T value;
-        while (sstr >> value)
-        {
-            result.push_back(value);
-        }
-        if (!sstr.eof())  // The stream is not read until the end, must be an
-                          // error. result contains number of read values.
+        std::string const raw = p->getValue<std::string>();
+
+        std::size_t bad_idx = 0;
+        if (auto parsed = BaseLib::tryParseVector<T>(raw, &bad_idx))
         {
-            error("Value for key <" + param + "> `" + shortString(sstr.str()) +
-                  "' not convertible to a vector of the desired type."
-                  " Could not convert token no. " +
-                  std::to_string(result.size() + 1) + ".");
-            return std::nullopt;
+            return parsed;  // OK
         }
 
-        return std::make_optional(result);
+        // preserve original error wording & token index
+        error("Value for key <" + param + "> `" + shortString(raw) +
+              "' not convertible to a vector of the desired type."
+              " Could not convert token no. " +
+              std::to_string(bad_idx) + ".");
+        return std::nullopt;  // not reached
     }
 
     return std::nullopt;
diff --git a/BaseLib/StringTools.h b/BaseLib/StringTools.h
@@ -16,8 +16,11 @@
 
 #include <cstddef>
 #include <list>
+#include <range/v3/range/conversion.hpp>
+#include <range/v3/view/istream.hpp>
 #include <sstream>
 #include <string>
+#include <string_view>
 #include <vector>
 
 namespace BaseLib
@@ -83,4 +86,31 @@ std::string randomString(std::size_t length);
 //! Append '-' and a number such that the name is unique.
 std::string getUniqueName(std::vector<std::string> const& existing_names,
                           std::string const& input_name);
+
+/**
+ *   Tries to parse a whitespace-separated list of values from a string.
+ *   Returns std::nullopt if parsing fails and sets the bad token index.
+ */
+template <typename T>
+std::optional<std::vector<T>> tryParseVector(std::string const& raw,
+                                             std::size_t* bad_token_idx)
+{
+    std::istringstream iss{raw};
+
+    // Create a range that reads T values from the stream
+    auto values = ranges::istream_view<T>(iss);
+    std::vector<T> out = ranges::to<std::vector>(values);
+
+    // Check if we consumed the entire input
+    if (!iss.eof())
+    {
+        if (bad_token_idx)
+        {
+            *bad_token_idx = out.size() + 1;
+        }
+        return std::nullopt;
+    }
+    return out;
+}
+
 }  // end namespace BaseLib
diff --git a/Documentation/ProjectFile/properties/property/SaturationWeightedThermalConductivity/t_dry_thermal_conductivity.md b/Documentation/ProjectFile/properties/property/SaturationWeightedThermalConductivity/t_dry_thermal_conductivity.md
@@ -1,2 +1,4 @@
 \copydoc MaterialPropertyLib::SaturationWeightedThermalConductivity::dry_thermal_conductivity_
-The values must be given as Parameter type.
+The values can be given either as a reference to a predefined `<parameter>`
+or directly as inline constant values, e.g.,
+`<dry_thermal_conductivity>0.5 0.3 0.2</dry_thermal_conductivity>`.
diff --git a/Documentation/ProjectFile/properties/property/SaturationWeightedThermalConductivity/t_wet_thermal_conductivity.md b/Documentation/ProjectFile/properties/property/SaturationWeightedThermalConductivity/t_wet_thermal_conductivity.md
@@ -1,2 +1,4 @@
 \copydoc MaterialPropertyLib::SaturationWeightedThermalConductivity::wet_thermal_conductivity_
-The values must be given as Parameter type.
+The values can be given either as a reference to a predefined `<parameter>`
+or directly as inline constant values, e.g.,
+`<wet_thermal_conductivity>0.9 0.6 0.7</wet_thermal_conductivity>`.
diff --git a/MaterialLib/MPL/CreateComponent.cpp b/MaterialLib/MPL/CreateComponent.cpp
@@ -24,7 +24,7 @@ namespace
 std::unique_ptr<MaterialPropertyLib::Component> createComponent(
     int const geometry_dimension,
     BaseLib::ConfigTree const& config,
-    std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const& parameters,
+    std::vector<std::unique_ptr<ParameterLib::ParameterBase>>& parameters,
     ParameterLib::CoordinateSystem const* const local_coordinate_system,
     std::map<std::string,
              std::unique_ptr<MathLib::PiecewiseLinearInterpolation>> const&
@@ -75,7 +75,7 @@ namespace MaterialPropertyLib
 std::vector<std::unique_ptr<Component>> createComponents(
     int const geometry_dimension,
     std::optional<BaseLib::ConfigTree> const& config,
-    std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const& parameters,
+    std::vector<std::unique_ptr<ParameterLib::ParameterBase>>& parameters,
     ParameterLib::CoordinateSystem const* const local_coordinate_system,
     std::map<std::string,
              std::unique_ptr<MathLib::PiecewiseLinearInterpolation>> const&
diff --git a/MaterialLib/MPL/CreateComponent.h b/MaterialLib/MPL/CreateComponent.h
@@ -46,7 +46,7 @@ namespace MaterialPropertyLib
 std::vector<std::unique_ptr<Component>> createComponents(
     int const geometry_dimension,
     std::optional<BaseLib::ConfigTree> const& config,
-    std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const& parameters,
+    std::vector<std::unique_ptr<ParameterLib::ParameterBase>>& parameters,
     ParameterLib::CoordinateSystem const* const local_coordinate_system,
     std::map<std::string,
              std::unique_ptr<MathLib::PiecewiseLinearInterpolation>> const&
diff --git a/MaterialLib/MPL/CreateMedium.cpp b/MaterialLib/MPL/CreateMedium.cpp
@@ -25,7 +25,7 @@ std::unique_ptr<Medium> createMedium(
     int const material_id,
     int const geometry_dimension,
     BaseLib::ConfigTree const& config,
-    std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const& parameters,
+    std::vector<std::unique_ptr<ParameterLib::ParameterBase>>& parameters,
     ParameterLib::CoordinateSystem const* const local_coordinate_system,
     std::map<std::string,
              std::unique_ptr<MathLib::PiecewiseLinearInterpolation>> const&
diff --git a/MaterialLib/MPL/CreateMedium.h b/MaterialLib/MPL/CreateMedium.h
@@ -45,7 +45,7 @@ std::unique_ptr<Medium> createMedium(
     int const material_id,
     int const geometry_dimension,
     BaseLib::ConfigTree const& config,
-    std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const& parameters,
+    std::vector<std::unique_ptr<ParameterLib::ParameterBase>>& parameters,
     ParameterLib::CoordinateSystem const* const local_coordinate_system,
     std::map<std::string,
              std::unique_ptr<MathLib::PiecewiseLinearInterpolation>> const&
diff --git a/MaterialLib/MPL/CreatePhase.cpp b/MaterialLib/MPL/CreatePhase.cpp
@@ -27,7 +27,7 @@ namespace
 std::unique_ptr<MaterialPropertyLib::Phase> createPhase(
     int const geometry_dimension,
     BaseLib::ConfigTree const& config,
-    std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const& parameters,
+    std::vector<std::unique_ptr<ParameterLib::ParameterBase>>& parameters,
     ParameterLib::CoordinateSystem const* const local_coordinate_system,
     std::map<std::string,
              std::unique_ptr<MathLib::PiecewiseLinearInterpolation>> const&
@@ -91,7 +91,7 @@ namespace MaterialPropertyLib
 std::vector<std::unique_ptr<Phase>> createPhases(
     int const geometry_dimension,
     std::optional<BaseLib::ConfigTree> const& config,
-    std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const& parameters,
+    std::vector<std::unique_ptr<ParameterLib::ParameterBase>>& parameters,
     ParameterLib::CoordinateSystem const* const local_coordinate_system,
     std::map<std::string,
              std::unique_ptr<MathLib::PiecewiseLinearInterpolation>> const&
diff --git a/MaterialLib/MPL/CreatePhase.h b/MaterialLib/MPL/CreatePhase.h
@@ -51,7 +51,7 @@ namespace MaterialPropertyLib
 std::vector<std::unique_ptr<Phase>> createPhases(
     int const geometry_dimension,
     std::optional<BaseLib::ConfigTree> const& config,
-    std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const& parameters,
+    std::vector<std::unique_ptr<ParameterLib::ParameterBase>>& parameters,
     ParameterLib::CoordinateSystem const* const local_coordinate_system,
     std::map<std::string,
              std::unique_ptr<MathLib::PiecewiseLinearInterpolation>> const&
diff --git a/MaterialLib/MPL/CreateProperty.cpp b/MaterialLib/MPL/CreateProperty.cpp
@@ -28,7 +28,7 @@ namespace
 std::unique_ptr<MaterialPropertyLib::Property> createProperty(
     int const geometry_dimension,
     BaseLib::ConfigTree const& config,
-    std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const& parameters,
+    std::vector<std::unique_ptr<ParameterLib::ParameterBase>>& parameters,
     ParameterLib::CoordinateSystem const* const local_coordinate_system,
     std::map<std::string,
              std::unique_ptr<MathLib::PiecewiseLinearInterpolation>> const&
@@ -395,7 +395,7 @@ namespace MaterialPropertyLib
 std::unique_ptr<PropertyArray> createProperties(
     int const geometry_dimension,
     std::optional<BaseLib::ConfigTree> const& config,
-    std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const& parameters,
+    std::vector<std::unique_ptr<ParameterLib::ParameterBase>>& parameters,
     ParameterLib::CoordinateSystem const* const local_coordinate_system,
     std::map<std::string,
              std::unique_ptr<MathLib::PiecewiseLinearInterpolation>> const&
diff --git a/MaterialLib/MPL/CreateProperty.h b/MaterialLib/MPL/CreateProperty.h
@@ -51,7 +51,7 @@ using PropertyArray =
 std::unique_ptr<PropertyArray> createProperties(
     int const geometry_dimension,
     std::optional<BaseLib::ConfigTree> const& config,
-    std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const& parameters,
+    std::vector<std::unique_ptr<ParameterLib::ParameterBase>>& parameters,
     ParameterLib::CoordinateSystem const* const local_coordinate_system,
     std::map<std::string,
              std::unique_ptr<MathLib::PiecewiseLinearInterpolation>> const&
diff --git a/MaterialLib/MPL/Properties/ThermalConductivity/CreateSaturationWeightedThermalConductivity.cpp b/MaterialLib/MPL/Properties/ThermalConductivity/CreateSaturationWeightedThermalConductivity.cpp
@@ -42,7 +42,7 @@ namespace MaterialPropertyLib
 std::unique_ptr<Property> createSaturationWeightedThermalConductivity(
     int const geometry_dimension,
     BaseLib::ConfigTree const& config,
-    std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const& parameters)
+    std::vector<std::unique_ptr<ParameterLib::ParameterBase>>& parameters)
 {
     //! \ogs_file_param{properties__property__type}
     config.checkConfigParameter("type",
@@ -53,17 +53,17 @@ std::unique_ptr<Property> createSaturationWeightedThermalConductivity(
 
     DBUG("Create SaturationWeightedThermalConductivity medium property");
 
-    std::string const& dry_thermal_conductivity_parameter_name =
-        //! \ogs_file_param{properties__property__SaturationWeightedThermalConductivity__dry_thermal_conductivity}
-        config.getConfigParameter<std::string>("dry_thermal_conductivity");
-    auto const& dry_thermal_conductivity = ParameterLib::findParameter<double>(
-        dry_thermal_conductivity_parameter_name, parameters, 0, nullptr);
-
-    std::string const& wet_thermal_conductivity_parameter_name =
-        //! \ogs_file_param{properties__property__SaturationWeightedThermalConductivity__wet_thermal_conductivity}
-        config.getConfigParameter<std::string>("wet_thermal_conductivity");
-    auto const& wet_thermal_conductivity = ParameterLib::findParameter<double>(
-        wet_thermal_conductivity_parameter_name, parameters, 0, nullptr);
+    auto& dry_thermal_conductivity =
+        ParameterLib::getNamedOrCreateInlineParameter(
+            //! \ogs_file_param_special{properties__property__SaturationWeightedThermalConductivity__dry_thermal_conductivity}
+            config, parameters, property_name, "dry_thermal_conductivity",
+            "dry_inline");
+
+    auto& wet_thermal_conductivity =
+        ParameterLib::getNamedOrCreateInlineParameter(
+            //! \ogs_file_param_special{properties__property__SaturationWeightedThermalConductivity__wet_thermal_conductivity}
+            config, parameters, property_name, "wet_thermal_conductivity",
+            "wet_inline");
 
     std::string const& mean_type_str =
         //! \ogs_file_param{properties__property__SaturationWeightedThermalConductivity__mean_type}
diff --git a/MaterialLib/MPL/Properties/ThermalConductivity/CreateSaturationWeightedThermalConductivity.h b/MaterialLib/MPL/Properties/ThermalConductivity/CreateSaturationWeightedThermalConductivity.h
@@ -31,6 +31,5 @@ class Property;
 std::unique_ptr<Property> createSaturationWeightedThermalConductivity(
     int const geometry_dimension,
     BaseLib::ConfigTree const& config,
-    std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const&
-        parameters);
+    std::vector<std::unique_ptr<ParameterLib::ParameterBase>>& parameters);
 }  // namespace MaterialPropertyLib
diff --git a/ParameterLib/Parameter.cpp b/ParameterLib/Parameter.cpp
@@ -120,4 +120,47 @@ std::optional<std::string> isDefinedOnSameMesh(ParameterBase const& parameter,
            "parameter's domain of definition mesh differs from the boundary "
            "condition or source term domain of definition mesh.";
 }
+
+Parameter<double>& getNamedOrCreateInlineParameter(
+    BaseLib::ConfigTree const& config,
+    std::vector<std::unique_ptr<ParameterBase>>& parameters,
+    std::string const& property_name,
+    std::string const& tag_name,
+    std::string const& inline_suffix)
+{
+    std::string const raw = config.getConfigParameter<std::string>(tag_name);
+
+    // try to parse number(s) (if empty - no inline-values)
+    std::size_t bad_idx = 0;
+    if (auto values = BaseLib::tryParseVector<double>(raw, &bad_idx); values)
+    {
+        if (values->empty())
+        {
+            OGS_FATAL(
+                "Empty inline value list in <{:s}> for property '{:s}'. "
+                "Provide at least one numeric value (e.g., \"1.23 4.56\") or "
+                "specify the name of an existing parameter. "
+                "Raw input was: \"{:s}\".",
+                tag_name, property_name, raw);
+        }
+
+        // collect all existing parameter names for checks against uniqueness
+        std::vector<std::string> existing_names;
+        existing_names.reserve(parameters.size());
+        std::transform(parameters.begin(), parameters.end(),
+                       std::back_inserter(existing_names),
+                       [](auto const& p) { return p->name; });
+
+        // assign inline values as constant parameter
+        std::string pname = BaseLib::getUniqueName(
+            existing_names, property_name + "_" + inline_suffix);
+        using P = ConstantParameter<double>;
+        parameters.push_back(std::make_unique<P>(pname, std::move(*values)));
+        return static_cast<Parameter<double>&>(*parameters.back());
+    }
+
+    // No inline values -> 'raw' is just a parameter name, now find that
+    // parameter.
+    return findParameter<double>(raw, parameters, 0, nullptr);
+}
 }  // namespace ParameterLib
diff --git a/ParameterLib/Parameter.h b/ParameterLib/Parameter.h
@@ -208,4 +208,28 @@ std::unique_ptr<ParameterBase> createParameter(
 std::optional<std::string> isDefinedOnSameMesh(ParameterBase const& parameter,
                                                MeshLib::Mesh const& mesh);
 
+/**
+ * Returns a Parameter<double>& based on the value of the given config tag.
+ *
+ * If the config entry `<tag_name>` is a double, creates a ConstantParameter
+ * with that value, adds it to `parameters`, and returns it.
+ *
+ * If the entry is a string, interprets it as the name of an existing parameter
+ * and returns a reference to that parameter.
+ *
+ * @param config           The configuration tree to read from.
+ * @param parameters       The parameter storage vector (will be modified if
+ *                         an inline constant is created).
+ * @param property_name    Name of the property (used for auto-generated
+ *                         parameter names in the inline case).
+ * @param tag_name         XML/ConfigTree tag name to read.
+ * @param inline_suffix    Suffix for auto-generated parameter names.
+ */
+Parameter<double>& getNamedOrCreateInlineParameter(
+    BaseLib::ConfigTree const& config,
+    std::vector<std::unique_ptr<ParameterBase>>& parameters,
+    std::string const& property_name,
+    std::string const& tag_name,
+    std::string const& inline_suffix);
+
 }  // namespace ParameterLib
diff --git a/Tests/BaseLib/TestStringTools.cpp b/Tests/BaseLib/TestStringTools.cpp
@@ -43,3 +43,73 @@ TEST(BaseLibStringTools, SplitString)
     // ... and behave like this if they are on their own:
     EXPECT_THAT(BaseLib::splitString(",", ','), ContainerEq(list<string>{""}));
 }
+
+TEST(BaseLibStringTools, TryParseVector_ParsesSimpleDoubles)
+{
+    std::size_t bad = 999;
+    auto v = BaseLib::tryParseVector<double>("1 2 3", &bad);
+    ASSERT_TRUE(v.has_value());
+    EXPECT_THAT(*v, testing::ElementsAre(1.0, 2.0, 3.0));
+    EXPECT_EQ(bad, 999u);  // unchanged
+}
+
+TEST(BaseLibStringTools, TryParseVector_WhitespaceSignsAndScientific)
+{
+    std::size_t bad = 0;
+    auto v = BaseLib::tryParseVector<double>("  -1\t 2.5\n 3.0e-1  ", &bad);
+    ASSERT_TRUE(v.has_value());
+    ASSERT_EQ(v->size(), 3u);
+    EXPECT_NEAR((*v)[0], -1.0, 1e-15);
+    EXPECT_NEAR((*v)[1], 2.5, 1e-15);
+    EXPECT_NEAR((*v)[2], 0.3, 1e-15);
+}
+
+TEST(BaseLibStringTools, TryParseVector_EmptyStringYieldsEmptyVector)
+{
+    std::size_t bad = 999;
+    auto v = BaseLib::tryParseVector<double>("", &bad);
+    ASSERT_TRUE(v.has_value());
+    EXPECT_TRUE(v->empty());
+    EXPECT_EQ(bad, 999u);  // unchanged
+}
+
+TEST(BaseLibStringTools, TryParseVector_OnlyWhitespaceYieldsEmptyVector)
+{
+    std::size_t bad = 7;
+    auto v = BaseLib::tryParseVector<double>(" \t\n ", &bad);
+    ASSERT_TRUE(v.has_value());
+    EXPECT_TRUE(v->empty());
+    EXPECT_EQ(bad, 7u);
+}
+
+TEST(BaseLibStringTools, TryParseVector_TrailingGarbageFailsAndReportsIndex)
+{
+    std::size_t bad = 0;
+    auto v = BaseLib::tryParseVector<double>("1 2 3 xyz", &bad);
+    EXPECT_FALSE(v.has_value());
+    EXPECT_EQ(bad, 4u);  // error at token 4
+}
+
+TEST(BaseLibStringTools, TryParseVector_LeadingGarbageFailsAtToken1)
+{
+    std::size_t bad = 0;
+    auto v = BaseLib::tryParseVector<double>("foo 1 2", &bad);
+    EXPECT_FALSE(v.has_value());
+    EXPECT_EQ(bad, 1u);  // error at token 1
+}
+
+TEST(BaseLibStringTools, TryParseVector_MixedNumberThenGarbageFailsAt2)
+{
+    std::size_t bad = 0;
+    auto v = BaseLib::tryParseVector<double>("1 foo 3", &bad);
+    EXPECT_FALSE(v.has_value());
+    EXPECT_EQ(bad, 2u);  // error at token 2
+}
+
+TEST(BaseLibStringTools, TryParseVector_CommaSeparatedFailsAt2)
+{
+    std::size_t bad = 0;
+    auto v = BaseLib::tryParseVector<double>("1,2 3", &bad);
+    EXPECT_FALSE(v.has_value());
+    EXPECT_EQ(bad, 2u);  // error at token 2
+}
diff --git a/Tests/MaterialLib/TestMPLSaturationWeightedThermalConductivity.cpp b/Tests/MaterialLib/TestMPLSaturationWeightedThermalConductivity.cpp
diff --git a/Tests/ParameterLib/Parameter.cpp b/Tests/ParameterLib/Parameter.cpp
