From 60533b45efe60ef4737a5573485e0bb78f97cc1a Mon Sep 17 00:00:00 2001 From: guido Date: Mon, 26 Apr 1999 20:01:13 +0000 Subject: [PATCH] More documentation git-svn-id: https://svn.dealii.org/trunk@1208 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/lac/include/lac/precondition.h | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/deal.II/lac/include/lac/precondition.h b/deal.II/lac/include/lac/precondition.h index afc432ef27..74dc66a1c4 100644 --- a/deal.II/lac/include/lac/precondition.h +++ b/deal.II/lac/include/lac/precondition.h @@ -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 @@ -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 @@ -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 A; + * Vector u; + * PreconditioningRelaxation,Vector > + * precondition_ssor(A, &SparseMatrix::template + * precondition_SSOR, 1.2); + * \end{verbatim} + */ PreconditionRelaxation(const MATRIX & M, function_ptr method, double omega = 1.); -- 2.39.5