]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Documentation update
authorguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 10 Feb 2003 09:10:08 +0000 (09:10 +0000)
committerguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 10 Feb 2003 09:10:08 +0000 (09:10 +0000)
git-svn-id: https://svn.dealii.org/trunk@7072 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/solver.h

index bf1b47ead94a2c50db3968b1b0ca2feafd952ae1..9a1782175cae4999c865da4b32615591a2ec596d 100644 (file)
@@ -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 <class Vector = ::Vector<double> >
+template <class VECTOR = Vector<double> >
 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<Vector> &);
+    Solver (SolverControl &, VectorMemory<VECTOR> &);
 
                                     /**
                                      * Access to control object.
@@ -169,24 +171,24 @@ class Solver : public Subscriptor
                                     /**
                                      * Memory for auxilliary vectors.
                                      */
-    VectorMemory<Vector> &memory;
+    VectorMemory<VECTOR> &memory;
 };
 
 
 /*-------------------------------- Inline functions ------------------------*/
 
-template <class Vector>
+template <class VECTOR>
 inline
 SolverControl &
-Solver<Vector>::control() const
+Solver<VECTOR>::control() const
 {
   return cntrl;
 }
 
 
-template<class Vector>
+template<class VECTOR>
 inline
-Solver<Vector>::Solver(SolverControl &cn, VectorMemory<Vector> &mem)
+Solver<VECTOR>::Solver(SolverControl &cn, VectorMemory<VECTOR> &mem)
                : cntrl(cn),
                  memory(mem)
 {}

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.