From f855e2933fc36395262c2928d406ced0bf99078c Mon Sep 17 00:00:00 2001
From: Christoph Lehmann <christoph.lehmann@ufz.de>
Date: Wed, 10 Oct 2018 15:12:06 +0200
Subject: [PATCH] [doc] fixed old documentation
---
.../CentralDifferences/c_CentralDifferences.md | 1 +
.../CentralDifferences/t_component_magnitudes.md | 5 +++++
.../CentralDifferences/t_relative_epsilons.md | 5 +++++
.../process/jacobian_assembler/i_jacobian_assembler.md | 3 ++-
.../process/jacobian_assembler/t_component_magnitudes.md | 1 -
.../process/jacobian_assembler/t_relative_epsilons.md | 1 -
.../prj/processes/process/jacobian_assembler/t_type.md | 2 +-
ProcessLib/CentralDifferencesJacobianAssembler.cpp | 4 ++--
8 files changed, 16 insertions(+), 6 deletions(-)
create mode 100644 Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CentralDifferences/c_CentralDifferences.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CentralDifferences/t_component_magnitudes.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CentralDifferences/t_relative_epsilons.md
delete mode 100644 Documentation/ProjectFile/prj/processes/process/jacobian_assembler/t_component_magnitudes.md
delete mode 100644 Documentation/ProjectFile/prj/processes/process/jacobian_assembler/t_relative_epsilons.md
diff --git a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CentralDifferences/c_CentralDifferences.md b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CentralDifferences/c_CentralDifferences.md
new file mode 100644
index 00000000000..e82c136f483
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CentralDifferences/c_CentralDifferences.md
@@ -0,0 +1 @@
+Assembles the Jacobian using central differences.
diff --git a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CentralDifferences/t_component_magnitudes.md b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CentralDifferences/t_component_magnitudes.md
new file mode 100644
index 00000000000..9779446fed8
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CentralDifferences/t_component_magnitudes.md
@@ -0,0 +1,5 @@
+Representative magnitudes for the components of the solution vector of the
+process being assembled.
+
+E.g., for the HT process there are two components: pressure and temperature,
+thus two values are expected in this case.
diff --git a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CentralDifferences/t_relative_epsilons.md b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CentralDifferences/t_relative_epsilons.md
new file mode 100644
index 00000000000..fe283cc4dde
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/CentralDifferences/t_relative_epsilons.md
@@ -0,0 +1,5 @@
+Specifies the magnitudes of the perturbations used to compute the numerical
+Jacobian.
+
+The magnitudes are specified relative to the \c component_magnitudes.
+The number of values given must match the one of the \c component_magnitudes.
diff --git a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/i_jacobian_assembler.md b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/i_jacobian_assembler.md
index 576add64edc..6755f45fee2 100644
--- a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/i_jacobian_assembler.md
+++ b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/i_jacobian_assembler.md
@@ -1 +1,2 @@
-\ogs_missing_documentation
+This setting makes it easy to switch between different ways to assemble the
+Jacobian, e.g., analytically or numerically using finite differences.
diff --git a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/t_component_magnitudes.md b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/t_component_magnitudes.md
deleted file mode 100644
index 576add64edc..00000000000
--- a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/t_component_magnitudes.md
+++ /dev/null
@@ -1 +0,0 @@
-\ogs_missing_documentation
diff --git a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/t_relative_epsilons.md b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/t_relative_epsilons.md
deleted file mode 100644
index 576add64edc..00000000000
--- a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/t_relative_epsilons.md
+++ /dev/null
@@ -1 +0,0 @@
-\ogs_missing_documentation
diff --git a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/t_type.md b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/t_type.md
index 576add64edc..093cf9207f3 100644
--- a/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/t_type.md
+++ b/Documentation/ProjectFile/prj/processes/process/jacobian_assembler/t_type.md
@@ -1 +1 @@
-\ogs_missing_documentation
+The type of the Jacobian assembler to be used.
diff --git a/ProcessLib/CentralDifferencesJacobianAssembler.cpp b/ProcessLib/CentralDifferencesJacobianAssembler.cpp
index 569bb85e5a9..bb26babba5a 100644
--- a/ProcessLib/CentralDifferencesJacobianAssembler.cpp
+++ b/ProcessLib/CentralDifferencesJacobianAssembler.cpp
@@ -134,10 +134,10 @@ createCentralDifferencesJacobianAssembler(BaseLib::ConfigTree const& config)
config.checkConfigParameter("type", "CentralDifferences");
// TODO make non-optional.
- //! \ogs_file_param{prj__processes__process__jacobian_assembler__relative_epsilons}
+ //! \ogs_file_param{prj__processes__process__jacobian_assembler__CentralDifferences__relative_epsilons}
auto rel_eps = config.getConfigParameterOptional<std::vector<double>>(
"relative_epsilons");
- //! \ogs_file_param{prj__processes__process__jacobian_assembler__component_magnitudes}
+ //! \ogs_file_param{prj__processes__process__jacobian_assembler__CentralDifferences__component_magnitudes}
auto comp_mag = config.getConfigParameterOptional<std::vector<double>>(
"component_magnitudes");
--
GitLab