From: Wolfgang Bangerth <bangerth@math.tamu.edu>
Date: Mon, 24 Apr 2006 20:18:33 +0000 (+0000)
Subject: Add documentation.
X-Git-Tag: v8.0.0~11889
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d881263aaeca542e613d6fb5d263408dd0d6c06e;p=dealii.git

Add documentation.


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

diff --git a/deal.II/lac/include/lac/precondition.h b/deal.II/lac/include/lac/precondition.h
index 9513a4b8d4..832446b4b0 100644
--- a/deal.II/lac/include/lac/precondition.h
+++ b/deal.II/lac/include/lac/precondition.h
@@ -31,7 +31,20 @@ template <typename number> class SparseMatrix;
  * No preconditioning.  This class helps you, if you want to use a
  * linear solver without preconditioning. All solvers in LAC require a
  * preconditioner. Therefore, you must use the identity provided here
- * to avoid preconditioning.
+ * to avoid preconditioning. It can be used in the following way:
+ *
+ @verbatim
+  SolverControl           solver_control (1000, 1e-12);
+  SolverCG<>              cg (solver_control);
+  cg.solve (system_matrix, solution, system_rhs,
+	    PreconditionIdentity());
+ @endverbatim
+ *
+ * See the @ref step_3 "step-3" tutorial program for an example and
+ * additional explanations.
+ *
+ * Alternatively, the IdentityMatrix class can be used to precondition
+ * in this way.
  *
  * @author Guido Kanschat, 1999
  */