]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
More documentation
authorguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 26 Apr 1999 20:01:13 +0000 (20:01 +0000)
committerguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 26 Apr 1999 20:01:13 +0000 (20:01 +0000)
git-svn-id: https://svn.dealii.org/trunk@1208 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/precondition.h

index afc432ef2731f8e69d3b1a874c598a282c8f739f..74dc66a1c4ef2923a6b6433bdd933b81844e0802 100644 (file)
@@ -7,6 +7,10 @@
 
 /**
  * No preconditioning.
+ * This class halps you, if you want to use a linear solver without
+ * preconditioning. Since this is a strange idea, the documentation
+ * here stays quite short.
+ *
  * @author Guido Kanschat, 1999
  */
 template<class VECTOR>
@@ -74,7 +78,11 @@ class PreconditionUseMatrix
 
 /**
  * Preconditioner for builtin relaxation methods.
- * Uses methods of #SparseMatrix#.
+ * Application of this preconditioner involves
+ * use of the #precondition_...# methods of #SparseMatrix#.
+ *
+ * Construction of objects of this class is quite strange, so read the
+ * documentation of the constructor for an example.
  * @author Guido Kanschat, 1999
  */
 template<class MATRIX, class VECTOR>
@@ -95,8 +103,16 @@ class PreconditionRelaxation
                                      * for later use and selects a
                                      * preconditioning method, which
                                      * must be a member function of
-                                     * that matrix.
-                                     */
+                                     * that matrix. An example of a
+                                     * typical usage is this:
+       * \begin{verbatim}
+       * SparseMatrix<float> A;
+       * Vector<double> u;
+       * PreconditioningRelaxation<SparseMatrix<float>,Vector<double> >
+       *    precondition_ssor(A, &SparseMatrix<float>::template
+       *       precondition_SSOR<double>, 1.2);
+       * \end{verbatim}
+       */
     PreconditionRelaxation(const MATRIX & M, function_ptr method,
                           double omega = 1.);
     

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.