Skip to content
Snippets Groups Projects
Commit 99a80f8d authored by Christoph Lehmann's avatar Christoph Lehmann
Browse files

[Doc] added linear solver docu

parent 9e96beb2
No related branches found
No related tags found
No related merge requests found
Showing
with 60 additions and 10 deletions
In this group the configuration of linear solvers is described.
Unlike all other options, there can be configurations for linear solvers from
the Eigen, LIS, PETSc, etc. libraries at the same time. Which solver will be
applied in the end is determined by the build configuration of the OGS
executable.
\ogs_missing_documentation
Configuration for solvers from the Eigen library.
For details see also the [documentation of the Eigen library](https://eigen.tuxfamily.org/dox/group__Sparse__Reference.html).
\ogs_missing_documentation
The tolerance of the linear solver.
This setting is only applied if an iterative solver is chosen.
Its default values is \f$10^{-16}\f$.
\ogs_missing_documentation
Defines the maximum number of iterations of the iterative solver.
This setting is ignored if a direct solver is chosen.
Its default value is \f$10^6\f$.
\ogs_missing_documentation
Chooses a specific preconditioner for the iterative linear solver.
This setting is ignored if a direct solver is selected.
Possible values are NONE, DIAGONAL and ILUT.
The default is NONE.
\ogs_missing_documentation
Chooses a specific linear solver.
Possible values are CG, BiCGSTAB, and SparseLU.
The default is SparseLU.
\ogs_missing_documentation
Configures options for linear solvers from the PETSc library.
For further details see also the
[documentation of the PETSc library](http://www.mcs.anl.gov/petsc/documentation/)
\ogs_missing_documentation
Sets PETSc options from the given parameter string.
The default value is <tt>"-ksp_type cg -pc_type bjacobi -ksp_rtol 1e-16 -ksp_max_it 10000"</tt>
\attention
PETSc can also receive options from the commandline arguments. However, the
values from the prj file are applied directly to the linear solver. If
specifying both, make sure that you check which options take precedence.
\ogs_missing_documentation
Sets the options prefix for this PETSc linear solver.
Cf. the PETSc [KSPSetOptionsPrefix documentation](http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/KSP/KSPSetOptionsPrefix.html).
\ogs_missing_documentation
Defines an option string that will be passed to solvers of the LIS library.
The default is <tt>-initx_zeros 0</tt>, i.e., not to overwrite the passed initial
guess with zeroes. All other options are appended to this default value.
\attention
LIS can also receive options from the commandline arguments. However, the values
from the prj file are applied directly to the linear solver. If specifying both,
make sure that you check which options take precedence.
Refer to the [documentation of LIS](http://www.ssisc.org/lis/index.en.html) for further details.
\ogs_missing_documentation
Name of the linear solver.
Used, e.g., to reference it in the nonlinear solver configuation.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment