]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Doc update.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 30 Dec 1999 19:36:43 +0000 (19:36 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 30 Dec 1999 19:36:43 +0000 (19:36 +0000)
git-svn-id: https://svn.dealii.org/trunk@2137 0785d39b-7218-0410-832d-ea1e28bc413d

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

index 4f9410e246d67639d3525eb5698af52879754235..8b1f3537efd99acabeb0ca7e80d0142a77e0de58 100644 (file)
@@ -59,6 +59,15 @@ class PreconditionIdentity
  * denoting the relaxation parameter; this example is therefore only meant to
  * illustrate the general idea.)
  *
+ * Note that due to the default template parameters, the above example
+ * could be written shorter as follows:
+ * \begin{verbatim}
+ *    ...
+ *    gmres.solve (matrix, solution, right_hand_side,
+ *                PreconditionUseMatrix<>
+ *                  (matrix,&SparseMatrix<double>::template precondition_Jacobi));
+ * \end{verbatim}
+ *
  * @author Guido Kanschat, Wolfgang Bangerth, 1999
  */
 template<class MATRIX = SparseMatrix<double>,
@@ -132,6 +141,17 @@ class PreconditionUseMatrix
  * for the #PreconditionUseMatrix# class, this time it should work, with
  * relaxation parameter $0.5$.)
  *
+ * Note that due to the default template parameters, the above example
+ * could be written shorter as follows:
+ * \begin{verbatim}
+ *    ...
+ *    gmres.solve (matrix, solution, right_hand_side,
+ *                PreconditionRelaxation<>
+ *                  (matrix,
+ *                    &SparseMatrix<double>::template precondition_Jacobi,
+ *                    0.5));
+ * \end{verbatim}
+ *
  * @author Guido Kanschat, Wolfgang Bangerth, 1999
  */
 template<class MATRIX = SparseMatrix<double>,

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.