]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix a misunderstanding on my part.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Thu, 6 Aug 2009 13:56:03 +0000 (13:56 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Thu, 6 Aug 2009 13:56:03 +0000 (13:56 +0000)
git-svn-id: https://svn.dealii.org/trunk@19188 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/doc/doxygen/headers/preconditioners.h

index f0e1f7e26969023357ed9d5c92645e1a646251d5..737f1c0e929df8b51eb7eb5bfc099e3d21802fda 100644 (file)
  * themselves. For them, an additional interface exists, consisting of
  * the functions
  * @code
- * void  step (VECTOR& dst, const VECTOR& src) const;
- * void  Tstep (VECTOR& dst, const VECTOR& src) const;
+ * void  step (VECTOR& dst, const VECTOR& rhs) const;
+ * void  Tstep (VECTOR& dst, const VECTOR& rhs) const;
  * @endcode
  *
  * Here, $src$ is a residual vector and $dst$ is the iterate that is
  * supposed to be updated. In other words, the operation performed by
  * these functions is
- * $dst = dst - P^{-1} src$ and $dst = dst - P^{-T} src$. The
+ * $dst = dst - P^{-1} (A dst - rhs)$ and $dst = dst - P^{-T} (A dst - rhs)$. The
  * functions are called this way because they perform <i>one step</i>
- * of a fixed point iteration.
+ * of a fixed point (Richardson) iteration. Note that preconditioners
+ * store a reference to the original matrix $A$ during initialization.
  *
  * @ingroup LAC
  * @ingroup Matrices

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.