From e037dbe4e33e6297ef508df2409bfaa227e2e3ac Mon Sep 17 00:00:00 2001
From: wenqing <wenqing.wang@ufz.de>
Date: Wed, 19 Dec 2018 17:52:42 +0100
Subject: [PATCH] [Parameter Doc] Fixed some errors (#2301)

Fixed the documentation for an used parameter
---
 ..._PhaseFieldIrreversibleDamageOracleBoundaryCondition.md} | 0
 .../constitutive_relation/i_constitutive_relation.md        | 1 -
 .../THERMO_MECHANICS/constitutive_relation/t_type.md        | 3 ---
 .../process/THERMO_MECHANICS/t_constitutive_relation.md     | 1 +
 .../ProjectFile/prj/time_loop/processes/process/t_output.md | 6 +++---
 ProcessLib/BoundaryCondition/CreateBoundaryCondition.cpp    | 1 +
 ProcessLib/ThermoMechanics/CreateThermoMechanicsProcess.cpp | 2 ++
 7 files changed, 7 insertions(+), 7 deletions(-)
 rename Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/{PhaseFieldIrreversibleDamageOracleBoundaryCondition/c_PhaseFieldIrreversibleDamageOracleBoundaryCondition.md => t_PhaseFieldIrreversibleDamageOracleBoundaryCondition.md} (100%)
 delete mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_MECHANICS/constitutive_relation/i_constitutive_relation.md
 delete mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_MECHANICS/constitutive_relation/t_type.md
 create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_MECHANICS/t_constitutive_relation.md

diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/PhaseFieldIrreversibleDamageOracleBoundaryCondition/c_PhaseFieldIrreversibleDamageOracleBoundaryCondition.md b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/t_PhaseFieldIrreversibleDamageOracleBoundaryCondition.md
similarity index 100%
rename from Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/PhaseFieldIrreversibleDamageOracleBoundaryCondition/c_PhaseFieldIrreversibleDamageOracleBoundaryCondition.md
rename to Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/t_PhaseFieldIrreversibleDamageOracleBoundaryCondition.md
diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_MECHANICS/constitutive_relation/i_constitutive_relation.md b/Documentation/ProjectFile/prj/processes/process/THERMO_MECHANICS/constitutive_relation/i_constitutive_relation.md
deleted file mode 100644
index 74e106945a6..00000000000
--- a/Documentation/ProjectFile/prj/processes/process/THERMO_MECHANICS/constitutive_relation/i_constitutive_relation.md
+++ /dev/null
@@ -1 +0,0 @@
-The constitutive relation for the mechanical part. It works for all material models.
\ No newline at end of file
diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_MECHANICS/constitutive_relation/t_type.md b/Documentation/ProjectFile/prj/processes/process/THERMO_MECHANICS/constitutive_relation/t_type.md
deleted file mode 100644
index c5e8e713a68..00000000000
--- a/Documentation/ProjectFile/prj/processes/process/THERMO_MECHANICS/constitutive_relation/t_type.md
+++ /dev/null
@@ -1,3 +0,0 @@
-The type of constitutive relation. See
-ProcessLib::ThermoMechanics::createThermoMechanicsProcess()
-for available implementations.
diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_MECHANICS/t_constitutive_relation.md b/Documentation/ProjectFile/prj/processes/process/THERMO_MECHANICS/t_constitutive_relation.md
new file mode 100644
index 00000000000..7befde51212
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/THERMO_MECHANICS/t_constitutive_relation.md
@@ -0,0 +1 @@
+\copydoc ogs_file_param__material__solid__constitutive_relation
diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/t_output.md b/Documentation/ProjectFile/prj/time_loop/processes/process/t_output.md
index 5836184f816..7e065dd8114 100644
--- a/Documentation/ProjectFile/prj/time_loop/processes/process/t_output.md
+++ b/Documentation/ProjectFile/prj/time_loop/processes/process/t_output.md
@@ -1,3 +1,3 @@
-Deprecated config tag. Don't use the tag. Please configure your output within
-the global output section, i. e., within the xpath
-'//OpenGeoSysProject/time_loop/output'.
+Don't use the tag. It is a deprecated config tag.  Please configure your output
+ within the global output section, i. e., within the xpath
+'//OpenGeoSysProject/time_loop/output'.
\ No newline at end of file
diff --git a/ProcessLib/BoundaryCondition/CreateBoundaryCondition.cpp b/ProcessLib/BoundaryCondition/CreateBoundaryCondition.cpp
index fa3342bdf56..e57630900d2 100644
--- a/ProcessLib/BoundaryCondition/CreateBoundaryCondition.cpp
+++ b/ProcessLib/BoundaryCondition/CreateBoundaryCondition.cpp
@@ -134,6 +134,7 @@ std::unique_ptr<BoundaryCondition> createBoundaryCondition(
     {
         return ProcessLib::
             createPhaseFieldIrreversibleDamageOracleBoundaryCondition(
+                //! \ogs_file_param_special{prj__process_variables__process_variable__boundary_conditions__boundary_condition__PhaseFieldIrreversibleDamageOracleBoundaryCondition}
                 config.config, dof_table, bulk_mesh, variable_id,
                 *config.component_id);
     }
diff --git a/ProcessLib/ThermoMechanics/CreateThermoMechanicsProcess.cpp b/ProcessLib/ThermoMechanics/CreateThermoMechanicsProcess.cpp
index db77bc7d96f..c7e3435c907 100644
--- a/ProcessLib/ThermoMechanics/CreateThermoMechanicsProcess.cpp
+++ b/ProcessLib/ThermoMechanics/CreateThermoMechanicsProcess.cpp
@@ -100,6 +100,8 @@ std::unique_ptr<Process> createThermoMechanicsProcess(
             variable_T->getNumberOfComponents());
     }
 
+    //! \ogs_file_param{prj__processes__process__THERMO_MECHANICS__constitutive_relation}
+    config.peekConfigParameter<std::string>("constitutive_relation");
     auto solid_constitutive_relations =
         MaterialLib::Solids::createConstitutiveRelations<DisplacementDim>(
             parameters, config);
-- 
GitLab