From: bangerth Date: Thu, 6 Aug 2009 13:56:03 +0000 (+0000) Subject: Fix a misunderstanding on my part. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9c2a249895f9339a5539690edb5f5cce917d994f;p=dealii-svn.git Fix a misunderstanding on my part. git-svn-id: https://svn.dealii.org/trunk@19188 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/doc/doxygen/headers/preconditioners.h b/deal.II/doc/doxygen/headers/preconditioners.h index f0e1f7e269..737f1c0e92 100644 --- a/deal.II/doc/doxygen/headers/preconditioners.h +++ b/deal.II/doc/doxygen/headers/preconditioners.h @@ -75,16 +75,17 @@ * 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 one step - * 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