From fbb697c3d757acce52089d8e39185f184bf64f70 Mon Sep 17 00:00:00 2001 From: Guido Kanschat Date: Thu, 3 Mar 2005 21:59:55 +0000 Subject: [PATCH] documentation update git-svn-id: https://svn.dealii.org/trunk@9989 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/lac/include/lac/block_matrix_array.h | 37 ++++++++++++++------ 1 file changed, 27 insertions(+), 10 deletions(-) diff --git a/deal.II/lac/include/lac/block_matrix_array.h b/deal.II/lac/include/lac/block_matrix_array.h index e2abdd0b6b..a9d5c97e33 100644 --- a/deal.II/lac/include/lac/block_matrix_array.h +++ b/deal.II/lac/include/lac/block_matrix_array.h @@ -85,7 +85,23 @@ class BlockMatrixArray : public Subscriptor const unsigned int n_block_cols); /** - * Add a block matrix entry. + * Add a block matrix entry. The + * matrix is entered + * into a list of blocks for + * multiplication, together with + * its coordinates row + * and col as well as + * optional multiplication factor + * prefix and transpose + * flag transpose. + * + * @note No check for consistency + * of block sizes is + * made. Therefore, entering a + * block of wrong dimension here + * will only lead to a + * ExcDimensionMismatch in one of + * the multiplication functions. */ void enter (const MATRIX &matrix, const unsigned int row, @@ -168,7 +184,7 @@ class BlockMatrixArray : public Subscriptor * Internal data structure. * * For each entry of a - * @p BlockMatrixArray, its + * BlockMatrixArray, its * position, matrix, prefix and * optional transposition must be * stored. This structure @@ -250,18 +266,19 @@ class BlockMatrixArray : public Subscriptor * matrix. Then, forward or backward insertion is performed * block-wise. The diagonal blocks are NOT inverted for this purpose! * - * While block indices may be duplicated (see BlockMatrixArray) - * to add blocks, this is not allowed on the diagonal. A short - * computation reveals why. - * * Like for all preconditioners, the preconditioning operation is - * performed by the @p vmult member function. + * performed by the vmult() member function. + * + * @note While block indices may be duplicated (see BlockMatrixArray) + * to add blocks, this is not allowed for diagonal blocks, since + * summing up the inverse of two blocks does not yield the inverse of + * the sum. * * The implementation may be a little clumsy, but it should be * sufficient as long as the block sizes are much larger than the * number of blocks. * - * @author Guido Kanschat, 2001 + * @author Guido Kanschat, 2001, 2005 */ template class BlockTrianglePrecondition : private BlockMatrixArray @@ -286,7 +303,7 @@ class BlockTrianglePrecondition : private BlockMatrixArray /** * Preconditioning - * adding to @p dst. + * adding to dst. */ template void vmult_add (BlockVector& dst, @@ -301,7 +318,7 @@ class BlockTrianglePrecondition : private BlockMatrixArray /** * Transposed preconditioning - * adding to @p dst. + * adding to dst. */ template void Tvmult_add (BlockVector& dst, -- 2.39.5