From 734fef4b2c32fd654c3b6ae2595ce1567279548e Mon Sep 17 00:00:00 2001 From: Guido Kanschat Date: Fri, 11 Mar 2005 15:07:19 +0000 Subject: [PATCH] documentation improved git-svn-id: https://svn.dealii.org/trunk@10097 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/lac/include/lac/matrix_lib.h | 43 ++++++++++++++++------------ 1 file changed, 25 insertions(+), 18 deletions(-) diff --git a/deal.II/lac/include/lac/matrix_lib.h b/deal.II/lac/include/lac/matrix_lib.h index ecf1d7ac0f..f4eb0d26f2 100644 --- a/deal.II/lac/include/lac/matrix_lib.h +++ b/deal.II/lac/include/lac/matrix_lib.h @@ -16,11 +16,13 @@ template class BlockVector; /** - * Poor man's matrix product. Stores two matrices $m_1$ and $m_2$ and - * implements matrix-vector multiplications for the product $m_1 m_2$ - * by performing multiplication with both factors consecutively. + * Poor man's matrix product of two quadratic matrices. Stores two + * quadratic matrices #m1 and #m2 of arbitrary types and implements + * matrix-vector multiplications for the product + * M1M2 by performing multiplication with + * both factors consecutively. * - * @author Guido Kanschat, 2000, 2001, 2002 + * @author Guido Kanschat, 2000, 2001, 2002, 2005 */ template class ProductMatrix : public PointerMatrixBase @@ -43,30 +45,35 @@ class ProductMatrix : public PointerMatrixBase ~ProductMatrix(); /** - * Matrix-vector product. + * Matrix-vector product w = + * m1 * m2 * v. */ - virtual void vmult (VECTOR& dst, - const VECTOR& src) const; + virtual void vmult (VECTOR& w, + const VECTOR& v) const; /** - * Tranposed matrix-vector product. + * Tranposed matrix-vector + * product w = m2T + * * m1T * v. */ - virtual void Tvmult (VECTOR& dst, - const VECTOR& src) const; + virtual void Tvmult (VECTOR& w, + const VECTOR& v) const; /** - * Matrix-vector product, adding to - * @p dst. + * Adding matrix-vector product + * w += m1 * m2 * v */ - virtual void vmult_add (VECTOR& dst, - const VECTOR& src) const; + virtual void vmult_add (VECTOR& w, + const VECTOR& v) const; /** - * Tranposed matrix-vector product, - * adding to @p dst. + * Adding, tranposed + * matrix-vector product w += + * m2T * + * m1T * v. */ - virtual void Tvmult_add (VECTOR& dst, - const VECTOR& src) const; + virtual void Tvmult_add (VECTOR& w, + const VECTOR& v) const; private: /** -- 2.39.5