Skip to content

Commit 459a83f

Browse files
committed
[doc] fixed old documentation
1 parent 15d4c45 commit 459a83f

File tree

8 files changed

+16
-6
lines changed

8 files changed

+16
-6
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Assembles the Jacobian using central differences.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Representative magnitudes for the components of the solution vector of the
2+
process being assembled.
3+
4+
E.g., for the HT process there are two components: pressure and temperature,
5+
thus two values are expected in this case.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Specifies the magnitudes of the perturbations used to compute the numerical
2+
Jacobian.
3+
4+
The magnitudes are specified relative to the \c component_magnitudes.
5+
The number of values given must match the one of the \c component_magnitudes.
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
\ogs_missing_documentation
1+
This setting makes it easy to switch between different ways to assemble the
2+
Jacobian, e.g., analytically or numerically using finite differences.

Documentation/ProjectFile/prj/processes/process/jacobian_assembler/t_component_magnitudes.md

-1
This file was deleted.

Documentation/ProjectFile/prj/processes/process/jacobian_assembler/t_relative_epsilons.md

-1
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
\ogs_missing_documentation
1+
The type of the Jacobian assembler to be used.

ProcessLib/CentralDifferencesJacobianAssembler.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -134,10 +134,10 @@ createCentralDifferencesJacobianAssembler(BaseLib::ConfigTree const& config)
134134
config.checkConfigParameter("type", "CentralDifferences");
135135

136136
// TODO make non-optional.
137-
//! \ogs_file_param{prj__processes__process__jacobian_assembler__relative_epsilons}
137+
//! \ogs_file_param{prj__processes__process__jacobian_assembler__CentralDifferences__relative_epsilons}
138138
auto rel_eps = config.getConfigParameterOptional<std::vector<double>>(
139139
"relative_epsilons");
140-
//! \ogs_file_param{prj__processes__process__jacobian_assembler__component_magnitudes}
140+
//! \ogs_file_param{prj__processes__process__jacobian_assembler__CentralDifferences__component_magnitudes}
141141
auto comp_mag = config.getConfigParameterOptional<std::vector<double>>(
142142
"component_magnitudes");
143143

0 commit comments

Comments
 (0)