diff --git a/Documentation/ProjectFile/process/convergence_criterion/DeltaX/c_DeltaX.md b/Documentation/ProjectFile/process/convergence_criterion/DeltaX/c_DeltaX.md index 576add64edccf5d980a0ff86143dc43a7109a788..c235efb07af9adbe2efd7a1bd62e833f41619ecd 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/DeltaX/c_DeltaX.md +++ b/Documentation/ProjectFile/process/convergence_criterion/DeltaX/c_DeltaX.md @@ -1 +1,9 @@ -\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. diff --git a/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_abstol.md b/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_abstol.md index 576add64edccf5d980a0ff86143dc43a7109a788..6725f9080b054fdeee21d8f3d1d189b40b0f50d2 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_abstol.md +++ b/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_abstol.md @@ -1 +1 @@ -\ogs_missing_documentation +The absolute tolerance being applied to the norm of the whole solution vector. diff --git a/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_norm_type.md b/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_norm_type.md index 576add64edccf5d980a0ff86143dc43a7109a788..963ea35f87460a8ae17273d66fab0b5033d3418f 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_norm_type.md +++ b/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_norm_type.md @@ -1 +1,7 @@ -\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. diff --git a/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_reltol.md b/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_reltol.md index 576add64edccf5d980a0ff86143dc43a7109a788..5204b5978fdb37d68587982b22c3cbd350dab81e 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_reltol.md +++ b/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_reltol.md @@ -1 +1,7 @@ -\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. diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/c_PerComponentDeltaX.md b/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/c_PerComponentDeltaX.md index 576add64edccf5d980a0ff86143dc43a7109a788..8fbeb585ce0d6aadda67b5e5715f7559e6b9d4a4 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/c_PerComponentDeltaX.md +++ b/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/c_PerComponentDeltaX.md @@ -1 +1,10 @@ -\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. diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_abstols.md b/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_abstols.md index 576add64edccf5d980a0ff86143dc43a7109a788..b60f738813846222c2760ad9b9ea4cee1222ab01 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_abstols.md +++ b/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_abstols.md @@ -1 +1,9 @@ -\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. diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_norm_type.md b/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_norm_type.md index 576add64edccf5d980a0ff86143dc43a7109a788..a120c6bd2a753aead12cf4298615a5304efb2c15 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_norm_type.md +++ b/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_norm_type.md @@ -1 +1,3 @@ -\ogs_missing_documentation +The type of norm of the solution vector being computed. + +See \ref ogs_file_param__process__convergence_criterion__DeltaX__norm_type. diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_reltols.md b/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_reltols.md index 576add64edccf5d980a0ff86143dc43a7109a788..e0760301111f87d2d9e16fc10b904a09fcdc67f2 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_reltols.md +++ b/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_reltols.md @@ -1 +1,12 @@ -\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. diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/c_PerComponentResidual.md b/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/c_PerComponentResidual.md index 576add64edccf5d980a0ff86143dc43a7109a788..62512cfd897a9f928740a91e3bd4467bbd91f622 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/c_PerComponentResidual.md +++ b/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/c_PerComponentResidual.md @@ -1 +1,10 @@ -\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. diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_abstols.md b/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_abstols.md index 576add64edccf5d980a0ff86143dc43a7109a788..b60f738813846222c2760ad9b9ea4cee1222ab01 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_abstols.md +++ b/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_abstols.md @@ -1 +1,9 @@ -\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. diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_norm_type.md b/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_norm_type.md index 576add64edccf5d980a0ff86143dc43a7109a788..d547f14900bf4a8a02e93ad9a257b5443ce0ec26 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_norm_type.md +++ b/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_norm_type.md @@ -1 +1,3 @@ -\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. diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_reltols.md b/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_reltols.md index 576add64edccf5d980a0ff86143dc43a7109a788..789cfc38bf0526d0ca661d1c7ca21a1a63b9e541 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_reltols.md +++ b/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_reltols.md @@ -1 +1,12 @@ -\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. diff --git a/Documentation/ProjectFile/process/convergence_criterion/Residual/c_Residual.md b/Documentation/ProjectFile/process/convergence_criterion/Residual/c_Residual.md index 576add64edccf5d980a0ff86143dc43a7109a788..a5d4846796a653dd98b3bfdf6b9779ad4bd2711a 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/Residual/c_Residual.md +++ b/Documentation/ProjectFile/process/convergence_criterion/Residual/c_Residual.md @@ -1 +1,8 @@ -\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. diff --git a/Documentation/ProjectFile/process/convergence_criterion/Residual/t_abstol.md b/Documentation/ProjectFile/process/convergence_criterion/Residual/t_abstol.md index 576add64edccf5d980a0ff86143dc43a7109a788..b3118aaf430eccfcb9198d2c20560811b6ec2536 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/Residual/t_abstol.md +++ b/Documentation/ProjectFile/process/convergence_criterion/Residual/t_abstol.md @@ -1 +1 @@ -\ogs_missing_documentation +The absolute tolerance being applied to the norm of the whole residuum vector. diff --git a/Documentation/ProjectFile/process/convergence_criterion/Residual/t_norm_type.md b/Documentation/ProjectFile/process/convergence_criterion/Residual/t_norm_type.md index 576add64edccf5d980a0ff86143dc43a7109a788..d547f14900bf4a8a02e93ad9a257b5443ce0ec26 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/Residual/t_norm_type.md +++ b/Documentation/ProjectFile/process/convergence_criterion/Residual/t_norm_type.md @@ -1 +1,3 @@ -\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. diff --git a/Documentation/ProjectFile/process/convergence_criterion/Residual/t_reltol.md b/Documentation/ProjectFile/process/convergence_criterion/Residual/t_reltol.md index 576add64edccf5d980a0ff86143dc43a7109a788..2e88c61bffe366f1292ec920a6b7467496f03898 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/Residual/t_reltol.md +++ b/Documentation/ProjectFile/process/convergence_criterion/Residual/t_reltol.md @@ -1 +1,7 @@ -\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. diff --git a/Documentation/ProjectFile/process/convergence_criterion/i_convergence_criterion.md b/Documentation/ProjectFile/process/convergence_criterion/i_convergence_criterion.md index 576add64edccf5d980a0ff86143dc43a7109a788..6f36c4eb60111c852aa665896e471b3b3cf89871 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/i_convergence_criterion.md +++ b/Documentation/ProjectFile/process/convergence_criterion/i_convergence_criterion.md @@ -1 +1,2 @@ -\ogs_missing_documentation +Defines the convergence criterion used by the nonlinear solver solving this +process. diff --git a/Documentation/ProjectFile/process/convergence_criterion/t_type.md b/Documentation/ProjectFile/process/convergence_criterion/t_type.md index 576add64edccf5d980a0ff86143dc43a7109a788..78f7846e65bad162b8c0012c0669f9fad5d0ec1a 100644 --- a/Documentation/ProjectFile/process/convergence_criterion/t_type.md +++ b/Documentation/ProjectFile/process/convergence_criterion/t_type.md @@ -1 +1 @@ -\ogs_missing_documentation +Defines the type of the convergence criterion.