Skip to content

Commit

Permalink
[doc] fixed old documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chleh committed Oct 10, 2018
1 parent 15d4c45 commit 459a83f
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 6 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Assembles the Jacobian using central differences.
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
\ogs_missing_documentation
The type of the Jacobian assembler to be used.
4 changes: 2 additions & 2 deletions ProcessLib/CentralDifferencesJacobianAssembler.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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");

Expand Down

0 comments on commit 459a83f

Please sign in to comment.