From e68bbf12fc49f60ea55abf6f1fd494f6881f91e0 Mon Sep 17 00:00:00 2001
From: Dmitri Naumov <github@naumov.de>
Date: Mon, 21 Nov 2016 23:36:28 +0100
Subject: [PATCH] Move parameter documentation.
---
Documentation/ProjectFile/i_ProjectFile.md | 10 +++++-----
.../ProjectFile/parameter/Constant/t_value.md | 3 ---
.../parameters}/parameter/Constant/c_Constant.md | 0
.../prj/parameters/parameter/Constant/t_value.md | 3 +++
.../parameters}/parameter/Constant/t_values.md | 0
.../parameter/CurveScaled/c_CurveScaled.md | 0
.../parameters}/parameter/CurveScaled/t_curve.md | 0
.../parameters}/parameter/CurveScaled/t_parameter.md | 0
.../parameter/Group/index_values/i_index_values.md | 0
.../parameter/Group/index_values/t_index.md | 0
.../parameter/Group/index_values/t_value.md | 0
.../parameter/Group/index_values/t_values.md | 0
.../parameter/MeshElement/c_MeshElement.md | 0
.../parameter/MeshElement/t_field_name.md | 0
.../parameters}/parameter/MeshNode/c_MeshNode.md | 0
.../parameters}/parameter/MeshNode/t_field_name.md | 0
.../parameters/parameter/i_parameter.md} | 0
.../{ => prj/parameters}/parameter/t_name.md | 0
.../{ => prj/parameters}/parameter/t_type.md | 0
.../ProjectFile/prj/parameters/t_parameter.md | 3 ---
.../process_variable/t_initial_condition.md | 2 +-
ProcessLib/Parameter/ConstantParameter.cpp | 6 +++---
ProcessLib/Parameter/CurveScaledParameter.cpp | 6 +++---
ProcessLib/Parameter/GroupBasedParameter.cpp | 12 ++++++------
ProcessLib/Parameter/MeshElementParameter.cpp | 4 ++--
ProcessLib/Parameter/MeshNodeParameter.cpp | 4 ++--
ProcessLib/Parameter/Parameter.cpp | 4 ++--
scripts/doc/append-xml-tags.py | 1 -
scripts/doc/linked-xml-file.py | 1 -
29 files changed, 27 insertions(+), 32 deletions(-)
delete mode 100644 Documentation/ProjectFile/parameter/Constant/t_value.md
rename Documentation/ProjectFile/{ => prj/parameters}/parameter/Constant/c_Constant.md (100%)
create mode 100644 Documentation/ProjectFile/prj/parameters/parameter/Constant/t_value.md
rename Documentation/ProjectFile/{ => prj/parameters}/parameter/Constant/t_values.md (100%)
rename Documentation/ProjectFile/{ => prj/parameters}/parameter/CurveScaled/c_CurveScaled.md (100%)
rename Documentation/ProjectFile/{ => prj/parameters}/parameter/CurveScaled/t_curve.md (100%)
rename Documentation/ProjectFile/{ => prj/parameters}/parameter/CurveScaled/t_parameter.md (100%)
rename Documentation/ProjectFile/{ => prj/parameters}/parameter/Group/index_values/i_index_values.md (100%)
rename Documentation/ProjectFile/{ => prj/parameters}/parameter/Group/index_values/t_index.md (100%)
rename Documentation/ProjectFile/{ => prj/parameters}/parameter/Group/index_values/t_value.md (100%)
rename Documentation/ProjectFile/{ => prj/parameters}/parameter/Group/index_values/t_values.md (100%)
rename Documentation/ProjectFile/{ => prj/parameters}/parameter/MeshElement/c_MeshElement.md (100%)
rename Documentation/ProjectFile/{ => prj/parameters}/parameter/MeshElement/t_field_name.md (100%)
rename Documentation/ProjectFile/{ => prj/parameters}/parameter/MeshNode/c_MeshNode.md (100%)
rename Documentation/ProjectFile/{ => prj/parameters}/parameter/MeshNode/t_field_name.md (100%)
rename Documentation/ProjectFile/{parameter/c_parameter.md => prj/parameters/parameter/i_parameter.md} (100%)
rename Documentation/ProjectFile/{ => prj/parameters}/parameter/t_name.md (100%)
rename Documentation/ProjectFile/{ => prj/parameters}/parameter/t_type.md (100%)
delete mode 100644 Documentation/ProjectFile/prj/parameters/t_parameter.md
diff --git a/Documentation/ProjectFile/i_ProjectFile.md b/Documentation/ProjectFile/i_ProjectFile.md
index 4a6d7e083b5..0e580aef74d 100644
--- a/Documentation/ProjectFile/i_ProjectFile.md
+++ b/Documentation/ProjectFile/i_ProjectFile.md
@@ -15,8 +15,8 @@ different prefixes, namely:
Usually one can choose one of several cases by specifying the associated
<tt><type></tt> tag in the input file.<br>
Example: \ref ogs_file_param__prj__linear_solvers__linear_solver
- and \ref ogs_file_param__parameter__Constant (<tt><type>Constant</type></tt>)
- vs. \ref ogs_file_param__parameter__MeshNode (<tt><type>MeshNode</type></tt>)
+ and \ref ogs_file_param__prj__parameters__parameter__Constant (<tt><type>Constant</type></tt>)
+ vs. \ref ogs_file_param__prj__parameters__parameter__MeshNode (<tt><type>MeshNode</type></tt>)
The input file parameters are documented within a tree structure (cf. the
navigation tree on the left). This structure resembles the XML document tree of
@@ -48,13 +48,13 @@ prefix:
<tt>process_variables.process_variable.boundary_conditions.boundary_condition.geometry</tt>.
2. Cases that distinguish types do not translate to XML tags either.
They enclose a set of configuration settings that can be used at that specific point.<br>
- Example: There is a \ref ogs_file_param__parameter__MeshNode "MeshNode"
+ Example: There is a \ref ogs_file_param__prj__parameters__parameter__MeshNode "MeshNode"
initial condition, which has a \ref
- ogs_file_param__parameter__MeshNode__field_name "field_name" tag. I.e., if you
+ ogs_file_param__prj__parameters__parameter__MeshNode__field_name "field_name" tag. I.e., if you
configure the MeshNode parameter, you can (or must) specify the XML tag with the
path <tt>parameters.parameter.field_name</tt> in the project file.<br> A
MeshNode parameter can be defined by setting the \ref
- ogs_file_param__parameter__type "parameters.parameter.type" tag to
+ ogs_file_param__prj__parameters__parameter__type "parameters.parameter.type" tag to
<tt>MeshNode</tt>.
# Further Information
diff --git a/Documentation/ProjectFile/parameter/Constant/t_value.md b/Documentation/ProjectFile/parameter/Constant/t_value.md
deleted file mode 100644
index 19901f86af7..00000000000
--- a/Documentation/ProjectFile/parameter/Constant/t_value.md
+++ /dev/null
@@ -1,3 +0,0 @@
-Single component constant parameter value.
-
-This is an alternative to the \ref ogs_file_param__parameter__Constant__values
diff --git a/Documentation/ProjectFile/parameter/Constant/c_Constant.md b/Documentation/ProjectFile/prj/parameters/parameter/Constant/c_Constant.md
similarity index 100%
rename from Documentation/ProjectFile/parameter/Constant/c_Constant.md
rename to Documentation/ProjectFile/prj/parameters/parameter/Constant/c_Constant.md
diff --git a/Documentation/ProjectFile/prj/parameters/parameter/Constant/t_value.md b/Documentation/ProjectFile/prj/parameters/parameter/Constant/t_value.md
new file mode 100644
index 00000000000..3179aec89d3
--- /dev/null
+++ b/Documentation/ProjectFile/prj/parameters/parameter/Constant/t_value.md
@@ -0,0 +1,3 @@
+Single component constant parameter value.
+
+This is an alternative to the \ref ogs_file_param__prj__parameters__parameter__Constant__values
diff --git a/Documentation/ProjectFile/parameter/Constant/t_values.md b/Documentation/ProjectFile/prj/parameters/parameter/Constant/t_values.md
similarity index 100%
rename from Documentation/ProjectFile/parameter/Constant/t_values.md
rename to Documentation/ProjectFile/prj/parameters/parameter/Constant/t_values.md
diff --git a/Documentation/ProjectFile/parameter/CurveScaled/c_CurveScaled.md b/Documentation/ProjectFile/prj/parameters/parameter/CurveScaled/c_CurveScaled.md
similarity index 100%
rename from Documentation/ProjectFile/parameter/CurveScaled/c_CurveScaled.md
rename to Documentation/ProjectFile/prj/parameters/parameter/CurveScaled/c_CurveScaled.md
diff --git a/Documentation/ProjectFile/parameter/CurveScaled/t_curve.md b/Documentation/ProjectFile/prj/parameters/parameter/CurveScaled/t_curve.md
similarity index 100%
rename from Documentation/ProjectFile/parameter/CurveScaled/t_curve.md
rename to Documentation/ProjectFile/prj/parameters/parameter/CurveScaled/t_curve.md
diff --git a/Documentation/ProjectFile/parameter/CurveScaled/t_parameter.md b/Documentation/ProjectFile/prj/parameters/parameter/CurveScaled/t_parameter.md
similarity index 100%
rename from Documentation/ProjectFile/parameter/CurveScaled/t_parameter.md
rename to Documentation/ProjectFile/prj/parameters/parameter/CurveScaled/t_parameter.md
diff --git a/Documentation/ProjectFile/parameter/Group/index_values/i_index_values.md b/Documentation/ProjectFile/prj/parameters/parameter/Group/index_values/i_index_values.md
similarity index 100%
rename from Documentation/ProjectFile/parameter/Group/index_values/i_index_values.md
rename to Documentation/ProjectFile/prj/parameters/parameter/Group/index_values/i_index_values.md
diff --git a/Documentation/ProjectFile/parameter/Group/index_values/t_index.md b/Documentation/ProjectFile/prj/parameters/parameter/Group/index_values/t_index.md
similarity index 100%
rename from Documentation/ProjectFile/parameter/Group/index_values/t_index.md
rename to Documentation/ProjectFile/prj/parameters/parameter/Group/index_values/t_index.md
diff --git a/Documentation/ProjectFile/parameter/Group/index_values/t_value.md b/Documentation/ProjectFile/prj/parameters/parameter/Group/index_values/t_value.md
similarity index 100%
rename from Documentation/ProjectFile/parameter/Group/index_values/t_value.md
rename to Documentation/ProjectFile/prj/parameters/parameter/Group/index_values/t_value.md
diff --git a/Documentation/ProjectFile/parameter/Group/index_values/t_values.md b/Documentation/ProjectFile/prj/parameters/parameter/Group/index_values/t_values.md
similarity index 100%
rename from Documentation/ProjectFile/parameter/Group/index_values/t_values.md
rename to Documentation/ProjectFile/prj/parameters/parameter/Group/index_values/t_values.md
diff --git a/Documentation/ProjectFile/parameter/MeshElement/c_MeshElement.md b/Documentation/ProjectFile/prj/parameters/parameter/MeshElement/c_MeshElement.md
similarity index 100%
rename from Documentation/ProjectFile/parameter/MeshElement/c_MeshElement.md
rename to Documentation/ProjectFile/prj/parameters/parameter/MeshElement/c_MeshElement.md
diff --git a/Documentation/ProjectFile/parameter/MeshElement/t_field_name.md b/Documentation/ProjectFile/prj/parameters/parameter/MeshElement/t_field_name.md
similarity index 100%
rename from Documentation/ProjectFile/parameter/MeshElement/t_field_name.md
rename to Documentation/ProjectFile/prj/parameters/parameter/MeshElement/t_field_name.md
diff --git a/Documentation/ProjectFile/parameter/MeshNode/c_MeshNode.md b/Documentation/ProjectFile/prj/parameters/parameter/MeshNode/c_MeshNode.md
similarity index 100%
rename from Documentation/ProjectFile/parameter/MeshNode/c_MeshNode.md
rename to Documentation/ProjectFile/prj/parameters/parameter/MeshNode/c_MeshNode.md
diff --git a/Documentation/ProjectFile/parameter/MeshNode/t_field_name.md b/Documentation/ProjectFile/prj/parameters/parameter/MeshNode/t_field_name.md
similarity index 100%
rename from Documentation/ProjectFile/parameter/MeshNode/t_field_name.md
rename to Documentation/ProjectFile/prj/parameters/parameter/MeshNode/t_field_name.md
diff --git a/Documentation/ProjectFile/parameter/c_parameter.md b/Documentation/ProjectFile/prj/parameters/parameter/i_parameter.md
similarity index 100%
rename from Documentation/ProjectFile/parameter/c_parameter.md
rename to Documentation/ProjectFile/prj/parameters/parameter/i_parameter.md
diff --git a/Documentation/ProjectFile/parameter/t_name.md b/Documentation/ProjectFile/prj/parameters/parameter/t_name.md
similarity index 100%
rename from Documentation/ProjectFile/parameter/t_name.md
rename to Documentation/ProjectFile/prj/parameters/parameter/t_name.md
diff --git a/Documentation/ProjectFile/parameter/t_type.md b/Documentation/ProjectFile/prj/parameters/parameter/t_type.md
similarity index 100%
rename from Documentation/ProjectFile/parameter/t_type.md
rename to Documentation/ProjectFile/prj/parameters/parameter/t_type.md
diff --git a/Documentation/ProjectFile/prj/parameters/t_parameter.md b/Documentation/ProjectFile/prj/parameters/t_parameter.md
deleted file mode 100644
index fa5fb7ffa1f..00000000000
--- a/Documentation/ProjectFile/prj/parameters/t_parameter.md
+++ /dev/null
@@ -1,3 +0,0 @@
-Defines a single parameter.
-
-See \ref ogs_file_param__parameter.
diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/t_initial_condition.md b/Documentation/ProjectFile/prj/process_variables/process_variable/t_initial_condition.md
index 1c7a5f0950d..8ccd0a964f8 100644
--- a/Documentation/ProjectFile/prj/process_variables/process_variable/t_initial_condition.md
+++ b/Documentation/ProjectFile/prj/process_variables/process_variable/t_initial_condition.md
@@ -1,6 +1,6 @@
Initial condition for the process variable.
-This setting references a \ref ogs_file_param__parameter "parameter" by name.
+This setting references a \ref ogs_file_param__prj__parameters__parameter "parameter" by name.
The initial values of the process variable are read from the given initial
condition, i.e., in the very first assembly the values for this process varaible
diff --git a/ProcessLib/Parameter/ConstantParameter.cpp b/ProcessLib/Parameter/ConstantParameter.cpp
index 6c54129088f..b3d8993fc1e 100644
--- a/ProcessLib/Parameter/ConstantParameter.cpp
+++ b/ProcessLib/Parameter/ConstantParameter.cpp
@@ -17,14 +17,14 @@ namespace ProcessLib
std::unique_ptr<ParameterBase> createConstantParameter(
std::string const& name, BaseLib::ConfigTree const& config)
{
- //! \ogs_file_param{parameter__type}
+ //! \ogs_file_param{prj__parameters__parameter__type}
config.checkConfigParameter("type", "Constant");
// Optional case for single-component variables where the value can be used.
// If the 'value' tag is found, use it and return. Otherwise continue with
// then required tag 'values'.
{
- //! \ogs_file_param{parameter__Constant__value}
+ //! \ogs_file_param{prj__parameters__parameter__Constant__value}
auto const value = config.getConfigParameterOptional<double>("value");
if (value)
@@ -37,7 +37,7 @@ std::unique_ptr<ParameterBase> createConstantParameter(
// Value tag not available; continue with required values tag.
std::vector<double> const values =
- //! \ogs_file_param{parameter__Constant__values}
+ //! \ogs_file_param{prj__parameters__parameter__Constant__values}
config.getConfigParameter<std::vector<double>>("values");
if (values.empty())
diff --git a/ProcessLib/Parameter/CurveScaledParameter.cpp b/ProcessLib/Parameter/CurveScaledParameter.cpp
index e90d3e9f116..8b067f6eff9 100644
--- a/ProcessLib/Parameter/CurveScaledParameter.cpp
+++ b/ProcessLib/Parameter/CurveScaledParameter.cpp
@@ -19,10 +19,10 @@ std::unique_ptr<ParameterBase> createCurveScaledParameter(
std::unique_ptr<MathLib::PiecewiseLinearInterpolation>> const&
curves)
{
- //! \ogs_file_param{parameter__type}
+ //! \ogs_file_param{prj__parameters__parameter__type}
config.checkConfigParameter("type", "CurveScaled");
- //! \ogs_file_param{parameter__CurveScaled__curve}
+ //! \ogs_file_param{prj__parameters__parameter__CurveScaled__curve}
auto curve_name = config.getConfigParameter<std::string>("curve");
DBUG("Using curve %s", curve_name.c_str());
@@ -30,7 +30,7 @@ std::unique_ptr<ParameterBase> createCurveScaledParameter(
if (curve_it == curves.end())
OGS_FATAL("Curve `%s' does not exists.", curve_name.c_str());
- //! \ogs_file_param{parameter__CurveScaled__parameter}
+ //! \ogs_file_param{prj__parameters__parameter__CurveScaled__parameter}
auto referenced_parameter_name =
config.getConfigParameter<std::string>("parameter");
DBUG("Using parameter %s", referenced_parameter_name.c_str());
diff --git a/ProcessLib/Parameter/GroupBasedParameter.cpp b/ProcessLib/Parameter/GroupBasedParameter.cpp
index 93ecc84c73f..5cc65f5b7f5 100644
--- a/ProcessLib/Parameter/GroupBasedParameter.cpp
+++ b/ProcessLib/Parameter/GroupBasedParameter.cpp
@@ -19,11 +19,11 @@ std::unique_ptr<ParameterBase> createGroupBasedParameter(
std::string const& name, BaseLib::ConfigTree const& config,
MeshLib::Mesh const& mesh)
{
- //! \ogs_file_param{parameter__type}
+ //! \ogs_file_param{prj__parameters__parameter__type}
config.checkConfigParameter("type", "Group");
// get a property vector of group IDs
- //! \ogs_file_param{parameter__Group__group_id_property}
+ //! \ogs_file_param{prj__parameters__parameter__Group__group_id_property}
std::string const group_id_property_name = config.getConfigParameter<std::string>("group_id_property");
DBUG("Using group_id_property %s", group_id_property_name.c_str());
@@ -37,13 +37,13 @@ std::unique_ptr<ParameterBase> createGroupBasedParameter(
typedef std::vector<double> Values;
typedef std::pair<int, Values> Index_Values;
std::vector<Index_Values> vec_index_values;
- //! \ogs_file_param{parameter__Group__index_values}
+ //! \ogs_file_param{prj__parameters__parameter__Group__index_values}
for (auto p : config.getConfigSubtreeList("index_values"))
{
- //! \ogs_file_param{parameter__Group__index_values__index}
+ //! \ogs_file_param{prj__parameters__parameter__Group__index_values__index}
auto const index = p.getConfigParameter<int>("index");
{
- //! \ogs_file_param{parameter__Group__index_values__value}
+ //! \ogs_file_param{prj__parameters__parameter__Group__index_values__value}
auto const value = p.getConfigParameterOptional<double>("value");
if (value)
@@ -55,7 +55,7 @@ std::unique_ptr<ParameterBase> createGroupBasedParameter(
}
// Value tag not available; continue with required values tag.
- //! \ogs_file_param{parameter__Group__index_values__values}
+ //! \ogs_file_param{prj__parameters__parameter__Group__index_values__values}
Values const values = p.getConfigParameter<Values>("values");
if (values.empty())
diff --git a/ProcessLib/Parameter/MeshElementParameter.cpp b/ProcessLib/Parameter/MeshElementParameter.cpp
index 3bf3a494eee..4b0c496998c 100644
--- a/ProcessLib/Parameter/MeshElementParameter.cpp
+++ b/ProcessLib/Parameter/MeshElementParameter.cpp
@@ -18,9 +18,9 @@ std::unique_ptr<ParameterBase> createMeshElementParameter(
std::string const& name, BaseLib::ConfigTree const& config,
MeshLib::Mesh const& mesh)
{
- //! \ogs_file_param{parameter__type}
+ //! \ogs_file_param{prj__parameters__parameter__type}
config.checkConfigParameter("type", "MeshElement");
- //! \ogs_file_param{parameter__MeshElement__field_name}
+ //! \ogs_file_param{prj__parameters__parameter__MeshElement__field_name}
auto const field_name = config.getConfigParameter<std::string>("field_name");
DBUG("Using field_name %s", field_name.c_str());
diff --git a/ProcessLib/Parameter/MeshNodeParameter.cpp b/ProcessLib/Parameter/MeshNodeParameter.cpp
index 3470d40cb1b..3118fc7c0c7 100644
--- a/ProcessLib/Parameter/MeshNodeParameter.cpp
+++ b/ProcessLib/Parameter/MeshNodeParameter.cpp
@@ -18,9 +18,9 @@ std::unique_ptr<ParameterBase> createMeshNodeParameter(
std::string const& name, BaseLib::ConfigTree const& config,
MeshLib::Mesh const& mesh)
{
- //! \ogs_file_param{parameter__type}
+ //! \ogs_file_param{prj__parameters__parameter__type}
config.checkConfigParameter("type", "MeshNode");
- //! \ogs_file_param{parameter__MeshNode__field_name}
+ //! \ogs_file_param{prj__parameters__parameter__MeshNode__field_name}
auto const field_name = config.getConfigParameter<std::string>("field_name");
DBUG("Using field_name %s", field_name.c_str());
diff --git a/ProcessLib/Parameter/Parameter.cpp b/ProcessLib/Parameter/Parameter.cpp
index 5078403cfd4..0c7d76ffa83 100644
--- a/ProcessLib/Parameter/Parameter.cpp
+++ b/ProcessLib/Parameter/Parameter.cpp
@@ -27,9 +27,9 @@ std::unique_ptr<ParameterBase> createParameter(
curves)
{
- //! \ogs_file_param{parameter__name}
+ //! \ogs_file_param{prj__parameters__parameter__name}
auto const name = config.getConfigParameter<std::string>("name");
- //! \ogs_file_param{parameter__type}
+ //! \ogs_file_param{prj__parameters__parameter__type}
auto const type = config.peekConfigParameter<std::string>("type");
// Create parameter based on the provided type.
diff --git a/scripts/doc/append-xml-tags.py b/scripts/doc/append-xml-tags.py
index 6a3e8afe2d7..98834e36660 100755
--- a/scripts/doc/append-xml-tags.py
+++ b/scripts/doc/append-xml-tags.py
@@ -37,7 +37,6 @@ docdir = os.path.join(docauxdir, "dox", "ProjectFile")
# that are used in the prj file.
tag_path_expansion_table = {
"process": "processes.process",
- "parameter": "parameters.parameter",
"prj": "",
}
diff --git a/scripts/doc/linked-xml-file.py b/scripts/doc/linked-xml-file.py
index cf67be75263..2c37e4f2493 100755
--- a/scripts/doc/linked-xml-file.py
+++ b/scripts/doc/linked-xml-file.py
@@ -35,7 +35,6 @@ outdir = os.path.join(docauxdir, "dox", "CTestProjectFiles")
tag_path_expansion_table = {
"prj__processes__process": "process",
- "prj__parameters__parameter": "parameter"
}
indent = " "*2
--
GitLab