From: zamni <zamni@0785d39b-7218-0410-832d-ea1e28bc413d>
Date: Tue, 25 Jan 2000 18:30:12 +0000 (+0000)
Subject: Doc update.
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=bd8f9e4d3c0e9d4f7293ef3ccadc5f622804b8d1;p=dealii-svn.git

Doc update.


git-svn-id: https://svn.dealii.org/trunk@2259 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/lac/include/lac/solver_control.h b/deal.II/lac/include/lac/solver_control.h
index 7ddecac706..4e24bcd645 100644
--- a/deal.II/lac/include/lac/solver_control.h
+++ b/deal.II/lac/include/lac/solver_control.h
@@ -45,9 +45,11 @@ class SolverControl : public Subscriptor
   public:
 
 				     /**
-				      * #Enum# denoting the different states
-				      * a solver can be in. See the general
-				      * documentation for more information.
+				      * #Enum# denoting the different
+				      * states a solver can be in. See
+				      * the general documentation of
+				      * this class for more
+				      * information.
 				      */
     enum State {
       iterate = 0, success, failure
@@ -164,11 +166,17 @@ class SolverControl : public Subscriptor
 
 
 /**
- * Specialization  of #SolverControl# which returns #success# if either
- * the specified tolerance is achieved or if the
- * initial residual (or whatever criterion was chosen by the solver
- * class) is reduced by a given factor. This is useful in cases where
- * you don't want to solve exactly, but rather want to gain two digits.
+ * Specialization of #SolverControl# which returns #success# if either
+ * the specified tolerance is achieved or if the initial residual (or
+ * whatever criterion was chosen by the solver class) is reduced by a
+ * given factor. This is useful in cases where you don't want to solve
+ * exactly, but rather want to gain two digits or if the maximal
+ * number of iterations is achived.  For exemple: The maximal number
+ * of iterations is 20, the reduction factor is 1% und the tolerance
+ * is 0.1%. The initial residual is 2.5. The process will break if 20
+ * iteration are comleted or the new residual is less then 2.5*1% or
+ * if it is less then 0.1%.
+ 
  */
 class ReductionControl : public SolverControl
 {