From 33fabf9a9ea47c913d8c81aa4e10fe201d738721 Mon Sep 17 00:00:00 2001
From: Thomas Fischer <thomas.fischer@ufz.de>
Date: Mon, 23 Mar 2020 10:33:52 +0100
Subject: [PATCH] [PL] Rename GroundwaterFlow to SteadyStateDiffusion VI.
- Rename documentation files and add docu.
---
.../processes/process/GROUNDWATER_FLOW/c_GROUNDWATER_FLOW.md | 0
.../GROUNDWATER_FLOW/process_variables/i_process_variables.md | 1 -
.../GROUNDWATER_FLOW/process_variables/t_process_variable.md | 1 -
.../STEADY_STATE_DIFFUSION/c_STEADY_STATE_DIFFUSION.md | 1 +
.../process_variables/i_process_variables.md | 1 +
.../process_variables/t_process_variable.md | 2 ++
.../SteadyStateDiffusion/CreateSteadyStateDiffusion.cpp | 4 ++--
.../create-boundary-conditions-along-a-polyline/index.pandoc | 2 +-
8 files changed, 7 insertions(+), 5 deletions(-)
delete mode 100644 Documentation/ProjectFile/prj/processes/process/GROUNDWATER_FLOW/c_GROUNDWATER_FLOW.md
delete mode 100644 Documentation/ProjectFile/prj/processes/process/GROUNDWATER_FLOW/process_variables/i_process_variables.md
delete mode 100644 Documentation/ProjectFile/prj/processes/process/GROUNDWATER_FLOW/process_variables/t_process_variable.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/STEADY_STATE_DIFFUSION/c_STEADY_STATE_DIFFUSION.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/STEADY_STATE_DIFFUSION/process_variables/i_process_variables.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/STEADY_STATE_DIFFUSION/process_variables/t_process_variable.md
diff --git a/Documentation/ProjectFile/prj/processes/process/GROUNDWATER_FLOW/c_GROUNDWATER_FLOW.md b/Documentation/ProjectFile/prj/processes/process/GROUNDWATER_FLOW/c_GROUNDWATER_FLOW.md
deleted file mode 100644
index e69de29bb2d..00000000000
diff --git a/Documentation/ProjectFile/prj/processes/process/GROUNDWATER_FLOW/process_variables/i_process_variables.md b/Documentation/ProjectFile/prj/processes/process/GROUNDWATER_FLOW/process_variables/i_process_variables.md
deleted file mode 100644
index 576add64edc..00000000000
--- a/Documentation/ProjectFile/prj/processes/process/GROUNDWATER_FLOW/process_variables/i_process_variables.md
+++ /dev/null
@@ -1 +0,0 @@
-\ogs_missing_documentation
diff --git a/Documentation/ProjectFile/prj/processes/process/GROUNDWATER_FLOW/process_variables/t_process_variable.md b/Documentation/ProjectFile/prj/processes/process/GROUNDWATER_FLOW/process_variables/t_process_variable.md
deleted file mode 100644
index 576add64edc..00000000000
--- a/Documentation/ProjectFile/prj/processes/process/GROUNDWATER_FLOW/process_variables/t_process_variable.md
+++ /dev/null
@@ -1 +0,0 @@
-\ogs_missing_documentation
diff --git a/Documentation/ProjectFile/prj/processes/process/STEADY_STATE_DIFFUSION/c_STEADY_STATE_DIFFUSION.md b/Documentation/ProjectFile/prj/processes/process/STEADY_STATE_DIFFUSION/c_STEADY_STATE_DIFFUSION.md
new file mode 100644
index 00000000000..3ba704b0d1e
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/STEADY_STATE_DIFFUSION/c_STEADY_STATE_DIFFUSION.md
@@ -0,0 +1 @@
+Steady state diffusion process described by a scalar, elliptic partial differential equation.
diff --git a/Documentation/ProjectFile/prj/processes/process/STEADY_STATE_DIFFUSION/process_variables/i_process_variables.md b/Documentation/ProjectFile/prj/processes/process/STEADY_STATE_DIFFUSION/process_variables/i_process_variables.md
new file mode 100644
index 00000000000..f2f28265edd
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/STEADY_STATE_DIFFUSION/process_variables/i_process_variables.md
@@ -0,0 +1 @@
+The process variable for the steady state diffusion process.
diff --git a/Documentation/ProjectFile/prj/processes/process/STEADY_STATE_DIFFUSION/process_variables/t_process_variable.md b/Documentation/ProjectFile/prj/processes/process/STEADY_STATE_DIFFUSION/process_variables/t_process_variable.md
new file mode 100644
index 00000000000..641b29811bd
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/STEADY_STATE_DIFFUSION/process_variables/t_process_variable.md
@@ -0,0 +1,2 @@
+The scalar process variable for the steady state diffusion process, for instance
+temperature or pressure.
diff --git a/ProcessLib/SteadyStateDiffusion/CreateSteadyStateDiffusion.cpp b/ProcessLib/SteadyStateDiffusion/CreateSteadyStateDiffusion.cpp
index 70419884656..9b05c30e371 100644
--- a/ProcessLib/SteadyStateDiffusion/CreateSteadyStateDiffusion.cpp
+++ b/ProcessLib/SteadyStateDiffusion/CreateSteadyStateDiffusion.cpp
@@ -57,14 +57,14 @@ std::unique_ptr<Process> createSteadyStateDiffusion(
// Process variable.
- //! \ogs_file_param{prj__processes__process__GROUNDWATER_FLOW__process_variables}
+ //! \ogs_file_param{prj__processes__process__STEADY_STATE_DIFFUSION__process_variables}
auto const pv_config = config.getConfigSubtree("process_variables");
std::vector<std::vector<std::reference_wrapper<ProcessVariable>>>
process_variables;
auto per_process_variables = findProcessVariables(
variables, pv_config,
- {//! \ogs_file_param_special{prj__processes__process__GROUNDWATER_FLOW__process_variables__process_variable}
+ {//! \ogs_file_param_special{prj__processes__process__STEADY_STATE_DIFFUSION__process_variables__process_variable}
"process_variable"});
process_variables.push_back(std::move(per_process_variables));
diff --git a/web/content/docs/tools/model-preparation/create-boundary-conditions-along-a-polyline/index.pandoc b/web/content/docs/tools/model-preparation/create-boundary-conditions-along-a-polyline/index.pandoc
index de12240699f..5c10eac7ad8 100644
--- a/web/content/docs/tools/model-preparation/create-boundary-conditions-along-a-polyline/index.pandoc
+++ b/web/content/docs/tools/model-preparation/create-boundary-conditions-along-a-polyline/index.pandoc
@@ -12,7 +12,7 @@ author = "Thomas Fischer"
The tool `CreateBoundaryConditionsAlongPolylines` searches for mesh nodes that are near to polylines and generates for each found node an OGS-5 boundary condition at a point.
-The user has to provide the input mesh `mesh` and the geometry `geometry` that must contain at least one polyline. Possible input formats for the mesh are the legacy OGS-5 mesh format or the vtu format. The geometry can be provided in the legacy OGS-5 gli format as well as in the gml format. The user can specify an environment via a search radius around the polyline. For all nodes within this environment boundary conditions are generated. Furthermore the type of the process the boundary condition is belonging to should be given. At the moment there are boundary condition output for LIQUID_FLOW (primary variable PRESSURE1) and GROUNDWATER_FLOW (primary variable HEAD) process avaible.
+The user has to provide the input mesh `mesh` and the geometry `geometry` that must contain at least one polyline. Possible input formats for the mesh are the legacy OGS-5 mesh format or the vtu format. The geometry can be provided in the legacy OGS-5 gli format as well as in the gml format. The user can specify an environment via a search radius around the polyline. For all nodes within this environment boundary conditions are generated. Furthermore the type of the process the boundary condition is belonging to should be given. At the moment there are boundary condition output for LIQUID_FLOW (primary variable PRESSURE1) and STEADY_STATE_DIFFUSION (primary variable HEAD) process avaible.
The tool will output a OGS-5 boundary condition file (.bc) and a geometry file (.gli) containing the points the boundary conditions refer to. The original geometry will not be altered. Additional, it is possible to write the geometry in the gml format by setting the switch `gml` to 1.
--
GitLab