From 06f6f78840257841cc0e6529331dc31a5a76a04d Mon Sep 17 00:00:00 2001
From: Thomas Fischer <thomas.fischer@ufz.de>
Date: Thu, 1 Aug 2019 13:35:16 +0200
Subject: [PATCH] [docu] Tags for the TimeDependenteterogeneousParameter.
---
.../time_series/i_time_series.md | 2 ++
.../time_series/pair/i_pair.md | 1 +
.../time_series/pair/t_parameter_name.md | 3 +++
.../time_series/pair/t_time.md | 1 +
ParameterLib/TimeDependentHeterogeneousParameter.cpp | 5 ++++-
5 files changed, 11 insertions(+), 1 deletion(-)
create mode 100644 Documentation/ProjectFile/prj/parameters/parameter/TimeDependentHeterogeneousParameter/time_series/i_time_series.md
create mode 100644 Documentation/ProjectFile/prj/parameters/parameter/TimeDependentHeterogeneousParameter/time_series/pair/i_pair.md
create mode 100644 Documentation/ProjectFile/prj/parameters/parameter/TimeDependentHeterogeneousParameter/time_series/pair/t_parameter_name.md
create mode 100644 Documentation/ProjectFile/prj/parameters/parameter/TimeDependentHeterogeneousParameter/time_series/pair/t_time.md
diff --git a/Documentation/ProjectFile/prj/parameters/parameter/TimeDependentHeterogeneousParameter/time_series/i_time_series.md b/Documentation/ProjectFile/prj/parameters/parameter/TimeDependentHeterogeneousParameter/time_series/i_time_series.md
new file mode 100644
index 00000000000..def2e4e1948
--- /dev/null
+++ b/Documentation/ProjectFile/prj/parameters/parameter/TimeDependentHeterogeneousParameter/time_series/i_time_series.md
@@ -0,0 +1,2 @@
+Contains time series information. Each entry consists of a pair of time and
+parameter name. Values of the parameter are piecewise linear interpolated.
diff --git a/Documentation/ProjectFile/prj/parameters/parameter/TimeDependentHeterogeneousParameter/time_series/pair/i_pair.md b/Documentation/ProjectFile/prj/parameters/parameter/TimeDependentHeterogeneousParameter/time_series/pair/i_pair.md
new file mode 100644
index 00000000000..f5cdda5581f
--- /dev/null
+++ b/Documentation/ProjectFile/prj/parameters/parameter/TimeDependentHeterogeneousParameter/time_series/pair/i_pair.md
@@ -0,0 +1 @@
+Contains pair of time and parameter name.
diff --git a/Documentation/ProjectFile/prj/parameters/parameter/TimeDependentHeterogeneousParameter/time_series/pair/t_parameter_name.md b/Documentation/ProjectFile/prj/parameters/parameter/TimeDependentHeterogeneousParameter/time_series/pair/t_parameter_name.md
new file mode 100644
index 00000000000..646f1b237dc
--- /dev/null
+++ b/Documentation/ProjectFile/prj/parameters/parameter/TimeDependentHeterogeneousParameter/time_series/pair/t_parameter_name.md
@@ -0,0 +1,3 @@
+Specification of the parameter name. The specified parameter have to be time
+independent, i.e., it must neither be a CurvedParameter nor a
+TimeDependentHeterogeneousParameter.
diff --git a/Documentation/ProjectFile/prj/parameters/parameter/TimeDependentHeterogeneousParameter/time_series/pair/t_time.md b/Documentation/ProjectFile/prj/parameters/parameter/TimeDependentHeterogeneousParameter/time_series/pair/t_time.md
new file mode 100644
index 00000000000..dec5b818b00
--- /dev/null
+++ b/Documentation/ProjectFile/prj/parameters/parameter/TimeDependentHeterogeneousParameter/time_series/pair/t_time.md
@@ -0,0 +1 @@
+Specification of point in time in the time-parameter-name relation.
diff --git a/ParameterLib/TimeDependentHeterogeneousParameter.cpp b/ParameterLib/TimeDependentHeterogeneousParameter.cpp
index ecae53379e5..9c27cd23aa6 100644
--- a/ParameterLib/TimeDependentHeterogeneousParameter.cpp
+++ b/ParameterLib/TimeDependentHeterogeneousParameter.cpp
@@ -108,15 +108,18 @@ std::unique_ptr<ParameterBase> createTimeDependentHeterogeneousParameter(
//! \ogs_file_param{prj__parameters__parameter__type}
config.checkConfigParameter("type", "TimeDependentHeterogeneousParameter");
auto const time_series_config =
- //! //\ogs_file_param{prj__parameters__parameter__TimeDependentHeterogeneousParameter__time_serie}
+ //! \ogs_file_param{prj__parameters__parameter__TimeDependentHeterogeneousParameter__time_series}
config.getConfigSubtree("time_series");
std::vector<TimeDependentHeterogeneousParameter::PairTimeParameterName>
time_series;
+ //! \ogs_file_param{prj__parameters__parameter__TimeDependentHeterogeneousParameter__time_series__pair}
for (auto const p : time_series_config.getConfigSubtreeList("pair"))
{
+ //! \ogs_file_param{prj__parameters__parameter__TimeDependentHeterogeneousParameter__time_series__pair__time}
auto time = p.getConfigParameter<double>("time");
auto parameter_name =
+ //! \ogs_file_param{prj__parameters__parameter__TimeDependentHeterogeneousParameter__time_series__pair__parameter_name}
p.getConfigParameter<std::string>("parameter_name");
time_series.emplace_back(time, parameter_name);
}
--
GitLab