From 4cd82c8d3a6be4bb7b982a53f7730ab0a7d3f95b Mon Sep 17 00:00:00 2001 From: guido Date: Mon, 10 Feb 2003 09:10:08 +0000 Subject: [PATCH] Documentation update git-svn-id: https://svn.dealii.org/trunk@7072 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/lac/include/lac/solver.h | 38 +++++++++++++++++--------------- 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/deal.II/lac/include/lac/solver.h b/deal.II/lac/include/lac/solver.h index bf1b47ead9..9a1782175c 100644 --- a/deal.II/lac/include/lac/solver.h +++ b/deal.II/lac/include/lac/solver.h @@ -49,42 +49,44 @@ class SolverControl; * public: * // Application of matrix to vector src. * // write result into dst - * void vmult (Vector &dst, const Vector &src) const; + * void vmult (VECTOR &dst, const VECTOR &src) const; * * // Application of transpose to a Vector. * // Only used by certain iterative methods. - * void Tvmult (Vector &dst, const Vector &src) const; + * void Tvmult (VECTOR &dst, const VECTOR &src) const; * }; * * - * class Vector + * class VECTOR * { * public: - * // resize and/or clear vector. note + * // resize to have the same structure + * // as the one provided and/or + * // clear vector. note * // that the second argument must have * // a default value equal to false - * void reinit (const unsigned int size, + * void reinit (const VECTOR&, * bool leave_elements_uninitialized = false); * * // scalar product - * double operator * (const Vector &v) const; + * double operator * (const VECTOR &v) const; * * // addition of vectors * // $y = y + x$. - * void add (const Vector &x); + * void add (const VECTOR &x); * * // $y = y + ax$. * void add (const double a, - * const Vector &x); + * const VECTOR &x); * * // $y = ay + bx$. * void sadd (const double a, * const double b, - * const Vector &x); + * const VECTOR &x); * * // $y = ax$. * void equ (const double a, - * const Vector &x); + * const VECTOR &x); * * // scale the elements of the vector * // by a fixed value @@ -96,7 +98,7 @@ class SolverControl; * @end{verbatim} * * In addition, for some solvers there has to be a global function - * @p{swap(vector &a, vector &b)} that exchanges the values of the two vectors. + * @p{swap(VECTOR &a, VECTOR &b)} that exchanges the values of the two vectors. * * The preconditioners used must have the same interface as matrices, * i.e. in particular they have to provide a member function @p{vmult} @@ -135,7 +137,7 @@ class SolverControl; * * @author Wolfgang Bangerth, Guido Kanschat, Ralf Hartmann, 1997-2001 */ -template > +template > class Solver : public Subscriptor { public: @@ -152,7 +154,7 @@ class Solver : public Subscriptor * least as long as that of the solver * object. */ - Solver (SolverControl &, VectorMemory &); + Solver (SolverControl &, VectorMemory &); /** * Access to control object. @@ -169,24 +171,24 @@ class Solver : public Subscriptor /** * Memory for auxilliary vectors. */ - VectorMemory &memory; + VectorMemory &memory; }; /*-------------------------------- Inline functions ------------------------*/ -template +template inline SolverControl & -Solver::control() const +Solver::control() const { return cntrl; } -template +template inline -Solver::Solver(SolverControl &cn, VectorMemory &mem) +Solver::Solver(SolverControl &cn, VectorMemory &mem) : cntrl(cn), memory(mem) {} -- 2.39.5