Document in classes derived from Solver that they use the signal/slot mechanism.

diff --git a/include/deal.II/lac/solver_bicgstab.h b/include/deal.II/lac/solver_bicgstab.h
index bde7fc7353d5d044fda81414a38d0c5e32250f3f..8e0c03e4927f171d3b9cc67fd23b4cd68a19b6f9 100644 (file)
--- a/include/deal.II/lac/solver_bicgstab.h
+++ b/include/deal.II/lac/solver_bicgstab.h
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------
 //
-// Copyright (C) 1998 - 2013 by the deal.II authors
+// Copyright (C) 1998 - 2014 by the deal.II authors
 //
 // This file is part of the deal.II library.
 //
@@ -61,6 +61,14 @@ DEAL_II_NAMESPACE_OPEN
  * The second parameter is the size of a breakdown criterion. It is
  * difficult to find a general good criterion, so if things do not
  * work for you, try to change this value.
+ *
+ *
+ * <h3>Observing the progress of linear solver iterations</h3>
+ *
+ * The solve() function of this class uses the mechanism described
+ * in the Solver base class to determine convergence. This mechanism
+ * can also be used to observe the progress of the iteration.
+ *
  */
 template <class VECTOR = Vector<double> >
 class SolverBicgstab : public Solver<VECTOR>

diff --git a/include/deal.II/lac/solver_cg.h b/include/deal.II/lac/solver_cg.h
index 515af42a24691dae4f157e7aebb5b8f3ba76e373..aff541ab58dae40ee758f09f071b08ac246cf7bd 100644 (file)
--- a/include/deal.II/lac/solver_cg.h
+++ b/include/deal.II/lac/solver_cg.h
@@ -55,6 +55,7 @@ class PreconditionIdentity;
  * Elements". It requires a symmetric preconditioner (i.e., for example, SOR
  * is not a possible choice).
  *
+ *
  * <h3>Eigenvalue computation</h3>
  *
  * The cg-method performs an orthogonal projection of the original
@@ -75,9 +76,17 @@ class PreconditionIdentity;
  * <tt>sqrt(beta_0)/alpha_0</tt>, ..., <tt>sqrt(beta_{m-2</tt>)/alpha_{m-2}}.
  * The eigenvalues of this matrix can be computed by postprocessing.
  *
- * See Y. Saad: "Iterative methods for Sparse Linear Systems", section
+ * @see Y. Saad: "Iterative methods for Sparse Linear Systems", section
  * 6.7.3 for details.
  *
+ *
+ * <h3>Observing the progress of linear solver iterations</h3>
+ *
+ * The solve() function of this class uses the mechanism described
+ * in the Solver base class to determine convergence. This mechanism
+ * can also be used to observe the progress of the iteration.
+ *
+ *
  * @author W. Bangerth, G. Kanschat, R. Becker and F.-T. Suttmeier
  */
 template <class VECTOR = Vector<double> >

diff --git a/include/deal.II/lac/solver_gmres.h b/include/deal.II/lac/solver_gmres.h
index d01eeb84efdbc590747a54aa111fb1b6dfd0e378..ee750f1ecb9564441e93d1e524ce9bc70a89c00f 100644 (file)
--- a/include/deal.II/lac/solver_gmres.h
+++ b/include/deal.II/lac/solver_gmres.h
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------
 //
-// Copyright (C) 1998 - 2013 by the deal.II authors
+// Copyright (C) 1998 - 2014 by the deal.II authors
 //
 // This file is part of the deal.II library.
 //
@@ -112,7 +112,8 @@ namespace internal
  * preconditioning. The default is left preconditioning. Finally it
  * includes a flag indicating whether or not the default residual is
  * used as stopping criterion.
-
+ *
+ *
  * <h3>Left versus right preconditioning</h3>
  *
  * @p AdditionalData allows you to choose between left and right
@@ -132,6 +133,7 @@ namespace internal
  * residuals have to be computed in this case, impeding the overall
  * performance of the solver.
  *
+ *
  * <h3>The size of the Arnoldi basis</h3>
  *
  * The maximal basis size is controlled by
@@ -150,6 +152,14 @@ namespace internal
  * For the requirements on matrices and vectors in order to work with
  * this class, see the documentation of the Solver base class.
  *
+ *
+ * <h3>Observing the progress of linear solver iterations</h3>
+ *
+ * The solve() function of this class uses the mechanism described
+ * in the Solver base class to determine convergence. This mechanism
+ * can also be used to observe the progress of the iteration.
+ *
+ *
  * @author Wolfgang Bangerth, Guido Kanschat, Ralf Hartmann.
  */
 template <class VECTOR = Vector<double> >

diff --git a/include/deal.II/lac/solver_minres.h b/include/deal.II/lac/solver_minres.h
index 66bbf5ae5d152723a06d9c35e9e2e6d2834e0a21..f919bf3cfe737be9ba663d4be5320cfb6e733fc0 100644 (file)
--- a/include/deal.II/lac/solver_minres.h
+++ b/include/deal.II/lac/solver_minres.h
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------
 //
-// Copyright (C) 2000 - 2013 by the deal.II authors
+// Copyright (C) 2000 - 2014 by the deal.II authors
 //
 // This file is part of the deal.II library.
 //
@@ -51,10 +51,17 @@ DEAL_II_NAMESPACE_OPEN
  *
  * The preconditioner has to be positive definite and symmetric
  *
- * The algorithm is taken from the Master thesis of Astrid Batterman
- * with some changes.
- * The full text can be found at
- * <tt>http://scholar.lib.vt.edu/theses/public/etd-12164379662151/etd-title.html</tt>
+ * The algorithm is taken from the Master thesis of Astrid Battermann
+ * with some changes. The full text can be found at
+ * http://scholar.lib.vt.edu/theses/public/etd-12164379662151/etd-title.html
+ *
+ *
+ * <h3>Observing the progress of linear solver iterations</h3>
+ *
+ * The solve() function of this class uses the mechanism described
+ * in the Solver base class to determine convergence. This mechanism
+ * can also be used to observe the progress of the iteration.
+ *
  *
  * @author Thomas Richter, 2000, Luca Heltai, 2006
  */

diff --git a/include/deal.II/lac/solver_qmrs.h b/include/deal.II/lac/solver_qmrs.h
index cbd3234c1c541cb5562dcead59fc16e4c85098a2..743e665dc4d6a455264a53979e2458ee36ed8f17 100644 (file)
--- a/include/deal.II/lac/solver_qmrs.h
+++ b/include/deal.II/lac/solver_qmrs.h
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------
 //
-// Copyright (C) 1999 - 2013 by the deal.II authors
+// Copyright (C) 1999 - 2014 by the deal.II authors
 //
 // This file is part of the deal.II library.
 //
@@ -60,6 +60,14 @@ DEAL_II_NAMESPACE_OPEN
  * has a default argument, so you may call it without the additional
  * parameter.
  *
+ *
+ * <h3>Observing the progress of linear solver iterations</h3>
+ *
+ * The solve() function of this class uses the mechanism described
+ * in the Solver base class to determine convergence. This mechanism
+ * can also be used to observe the progress of the iteration.
+ *
+ *
  * @author Guido Kanschat, 1999
  */
 template <class VECTOR = Vector<double> >

diff --git a/include/deal.II/lac/solver_relaxation.h b/include/deal.II/lac/solver_relaxation.h
index 22e40e8e2af4ce2f194e59c98b6eeabcb05557ae..2f38c8c8e9e30700a990527a8a1d839eed8dbc70 100644 (file)
--- a/include/deal.II/lac/solver_relaxation.h
+++ b/include/deal.II/lac/solver_relaxation.h
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------
 //
-// Copyright (C) 2010 - 2013 by the deal.II authors
+// Copyright (C) 2010 - 2014 by the deal.II authors
 //
 // This file is part of the deal.II library.
 //
@@ -42,6 +42,14 @@ DEAL_II_NAMESPACE_OPEN
  * solver changes. AdditionalData of this class currently does not
  * contain any data.
  *
+ *
+ * <h3>Observing the progress of linear solver iterations</h3>
+ *
+ * The solve() function of this class uses the mechanism described
+ * in the Solver base class to determine convergence. This mechanism
+ * can also be used to observe the progress of the iteration.
+ *
+ *
  * @ingroup Solvers
  * @author Guido Kanschat
  * @date 2010

diff --git a/include/deal.II/lac/solver_richardson.h b/include/deal.II/lac/solver_richardson.h
index 9e2938227a287ac4239cb3fecea823bf4b6fe070..8e389ef04cf6fd1ab85500085c82d5c051f804f3 100644 (file)
--- a/include/deal.II/lac/solver_richardson.h
+++ b/include/deal.II/lac/solver_richardson.h
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------
 //
-// Copyright (C) 1999 - 2013 by the deal.II authors
+// Copyright (C) 1999 - 2014 by the deal.II authors
 //
 // This file is part of the deal.II library.
 //
@@ -48,6 +48,14 @@ DEAL_II_NAMESPACE_OPEN
  * which is the only content of the @p AdditionalData structure. By default,
  * the constructor of the structure sets it to one.
  *
+ *
+ * <h3>Observing the progress of linear solver iterations</h3>
+ *
+ * The solve() function of this class uses the mechanism described
+ * in the Solver base class to determine convergence. This mechanism
+ * can also be used to observe the progress of the iteration.
+ *
+ *
  * @author Ralf Hartmann
  */
 template <class VECTOR = Vector<double> >