From 939d0e5a167147f7ff499e6cc888531089a565a6 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Fri, 27 Apr 2001 09:31:06 +0000 Subject: [PATCH] Small clean-ups. git-svn-id: https://svn.dealii.org/trunk@4494 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/lac/include/lac/sparse_matrix.h | 29 +++++++++++++++---------- 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/deal.II/lac/include/lac/sparse_matrix.h b/deal.II/lac/include/lac/sparse_matrix.h index c94aafe27c..2d718610df 100644 --- a/deal.II/lac/include/lac/sparse_matrix.h +++ b/deal.II/lac/include/lac/sparse_matrix.h @@ -14,7 +14,7 @@ #define __deal2__sparse_matrix_h -/*---------------------------- sparsematrix.h ---------------------------*/ +/*---------------------------- sparse_matrix.h ---------------------------*/ #include @@ -206,7 +206,6 @@ class SparseMatrix : public Subscriptor * matrix is of dimension * $m \times n$. */ - unsigned int n () const; /** @@ -443,7 +442,8 @@ class SparseMatrix : public Subscriptor * being this matrix. */ template - void vmult (Vector& dst, const Vector& src) const; + void vmult (Vector &dst, + const Vector &src) const; /** * Matrix-vector multiplication: @@ -454,7 +454,8 @@ class SparseMatrix : public Subscriptor * transposed matrix. */ template - void Tvmult (Vector& dst, const Vector& src) const; + void Tvmult (Vector &dst, + const Vector &src) const; /** * Adding Matrix-vector @@ -463,7 +464,8 @@ class SparseMatrix : public Subscriptor * matrix. */ template - void vmult_add (Vector& dst, const Vector& src) const; + void vmult_add (Vector &dst, + const Vector &src) const; /** * Adding Matrix-vector @@ -474,7 +476,8 @@ class SparseMatrix : public Subscriptor * the transposed matrix. */ template - void Tvmult_add (Vector& dst, const Vector& src) const; + void Tvmult_add (Vector &dst, + const Vector &src) const; /** * Return the square of the norm @@ -534,13 +537,15 @@ class SparseMatrix : public Subscriptor /** * Compute the residual of an - * equation @p{Ax=b}, where the + * equation @p{Mx=b}, where the * residual is defined to be - * @p{r=b-Ax} with @p{x} typically + * @p{r=b-Mx} with @p{x} typically * being an approximate of the * true solution of the * equation. Write the residual - * into @p{dst}. + * into @p{dst}. The l2 norm of + * the residual vector is + * returned. */ template somenumber residual (Vector &dst, @@ -563,7 +568,7 @@ class SparseMatrix : public Subscriptor const number omega = 1.) const; /** - * Apply SOR preconditioning to + * Apply SSOR preconditioning to * @p{src}. */ template @@ -1042,9 +1047,9 @@ number & SparseMatrix::global_entry (const unsigned int j) }; -/*---------------------------- sparsematrix.h ---------------------------*/ +/*---------------------------- sparse_matrix.h ---------------------------*/ #endif -/*---------------------------- sparsematrix.h ---------------------------*/ +/*---------------------------- sparse_matrix.h ---------------------------*/ -- 2.39.5