From e819f928edd5dc8b9a48bf63a498a711c4688e4b Mon Sep 17 00:00:00 2001
From: Christoph Lehmann <christoph.lehmann@ufz.de>
Date: Tue, 23 Aug 2016 09:28:46 +0200
Subject: [PATCH] [NL] changed docu
---
NumLib/ODESolver/ConvergenceCriterion.h | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/NumLib/ODESolver/ConvergenceCriterion.h b/NumLib/ODESolver/ConvergenceCriterion.h
index db0024ed0bf..aaf07e8c15f 100644
--- a/NumLib/ODESolver/ConvergenceCriterion.h
+++ b/NumLib/ODESolver/ConvergenceCriterion.h
@@ -19,10 +19,11 @@ class ConfigTree;
namespace NumLib
{
-/*! Convergence criterion for nonlinear solvers.
+/*! Convergence criterion for iterative algorithms, like nonlinear solvers.
*
* It is able to check the difference of the solution vector between iterations
- * and the residual of the nonlinear equation system.
+ * and the residual of the equation being solved (e.g. the nonlinear equation
+ * system).
*/
class ConvergenceCriterion
{
--
GitLab