Skip to content
Snippets Groups Projects
Commit 7193deaa authored by Christoph Lehmann's avatar Christoph Lehmann Committed by Tom Fischer
Browse files

[Doc] added docu for convergence criteria

parent 2ca61bd2
No related branches found
No related tags found
No related merge requests found
Showing
with 114 additions and 18 deletions
\ogs_missing_documentation Sets up a convergence criterion that checks only the norm of the solution update
from one iteration to another.
A relative and/or absolute tolerance value can be specified, which is applied to
the norm of the whole solution vector, i.e., the entirety of all process
variables.
At least one of the relative or absolute tolerance has to be met in order to
satisfy this convergence criterion.
\ogs_missing_documentation The absolute tolerance being applied to the norm of the whole solution vector.
\ogs_missing_documentation The type of norm of the solution vector being computed.
Possible values:
- <tt>NORM1</tt> for the \f$l_1\f$-norm
- <tt>NORM2</tt> for the \f$l_2\f$-norm
- <tt>INFINITY_N</tt> for the \f$l_\infty\f$-norm.
\ogs_missing_documentation The relative tolerance being applied to the norm of the whole solution vector.
The relative error \f$e\f$ is computed as
\f[e = \frac{||\Delta x||}{||x||+\epsilon},\f]
where \f$\Delta x\f$ and \f$x\f$ are the current solution update and the
new solution from the current iteration, respectively, and \f$\epsilon\f$ is the
machine epsilon guaranteeing that the denominator is always nonzero.
\ogs_missing_documentation Sets up a convergence criterion that checks only the norm of the solution update
from one iteration to another.
Relative and/or absolute tolerance values can be specified, which are applied to
the norm of each component (i.e., each process variable, and, if there is a
vectorial process variable, to each vector component) of the solution vector
individually.
For each component at least one of the relative or absolute tolerance has to be
met in order to satisfy this convergence criterion.
\ogs_missing_documentation Absolute tolerance values being applied.
In this list of values there must be one value for each process variable (and if
there are vectorial process variables, for each vector component of that process
variable). The order of values must match the order of process variables as
defined by the specific process.
If for a certain component no absolute tolerance shall be applied, zero can be
given as the respective tolerance value.
\ogs_missing_documentation The type of norm of the solution vector being computed.
See \ref ogs_file_param__process__convergence_criterion__DeltaX__norm_type.
\ogs_missing_documentation Relative tolerance values being applied.
In this list of values there must be one value for each process variable (and if
there are vectorial process variables, for each vector component of that process
variable). The order of values must match the order of process variables as
defined by the specific process.
If for a certain component no relative tolerance shall be applied, zero can be
given as the respective tolerance value.
For the computation of the relative error for each component, see \ref
ogs_file_param__process__convergence_criterion__DeltaX__reltol.
\ogs_missing_documentation Sets up a convergence criterion that checks only the norm of the residuum
vector.
Relative and/or absolute tolerance values can be specified, which are applied to
the norm of each component (i.e., each process variable, and, if there is a
vectorial process variable, to each vector component) of the residuum vector
individually.
For each component at least one of the relative or absolute tolerance has to be
met in order to satisfy this convergence criterion.
\ogs_missing_documentation Absolute tolerance values being applied.
In this list of values there must be one value for each process variable (and if
there are vectorial process variables, for each vector component of that process
variable). The order of values must match the order of process variables as
defined by the specific process.
If for a certain component no absolute tolerance shall be applied, zero can be
given as the respective tolerance value.
\ogs_missing_documentation The type of norm of the solution vector being computed.
See also \ref ogs_file_param__process__convergence_criterion__DeltaX__norm_type.
\ogs_missing_documentation Relative tolerance values being applied.
In this list of values there must be one value for each process variable (and if
there are vectorial process variables, for each vector component of that process
variable). The order of values must match the order of process variables as
defined by the specific process.
If for a certain component no relative tolerance shall be applied, zero can be
given as the respective tolerance value.
For the computation of the relative error for each component, see \ref
ogs_file_param__process__convergence_criterion__Residual__reltol.
\ogs_missing_documentation Sets up a convergence criterion that checks only the norm of the residuum
vector.
A relative and/or absolute tolerance value can be specified, which is applied to
the norm of the whole residuum vector.
At least one of the relative or absolute tolerance has to be met in order to
satisfy this convergence criterion.
\ogs_missing_documentation The absolute tolerance being applied to the norm of the whole residuum vector.
\ogs_missing_documentation The type of norm of the solution vector being computed.
See also \ref ogs_file_param__process__convergence_criterion__DeltaX__norm_type.
\ogs_missing_documentation The relative tolerance being applied to the norm of the whole residuum vector.
The relative error \f$e\f$ is computed as
\f[e = \frac{||r||}{||r_0||+\epsilon},\f]
where \f$r\f$ and \f$r_0\f$ are the residuum and the residuum from computed in
the first iteration, respectively, and \f$\epsilon\f$ is the machine epsilon
guaranteeing that the denominator is always nonzero.
\ogs_missing_documentation Defines the convergence criterion used by the nonlinear solver solving this
process.
\ogs_missing_documentation Defines the type of the convergence criterion.
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