From: guido Date: Wed, 14 Jun 2006 14:12:07 +0000 (+0000) Subject: add example to documentation X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c79a6d3f529f85e10d230b3c7dc88d03a8df8465;p=dealii-svn.git add example to documentation git-svn-id: https://svn.dealii.org/trunk@13246 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/lac/include/lac/block_sparsity_pattern.h b/deal.II/lac/include/lac/block_sparsity_pattern.h index a537e9ebe5..2c1dc8e913 100644 --- a/deal.II/lac/include/lac/block_sparsity_pattern.h +++ b/deal.II/lac/include/lac/block_sparsity_pattern.h @@ -505,7 +505,34 @@ class BlockSparsityPattern : public BlockSparsityPatternBase * templated name of the base class. For information on the interface * of this class refer to the base class. * - * @author Wolfgang Bangerth, 2000, 2001 + *

Example

+ * Usage of this class is very similar to CompressedSparsityPattern, + * but since the use of block indices causes some additional + * complications, we give a short example. + * + * @dontinclude compressed_block_sparsity_pattern.cc + * + * After the the DoFHandler dof and the ConstraintMatrix + * constraints have been set up with a system element, we + * must count the degrees of freedom in each matrix block: + * + * @skipline dofs_per_block + * @until count + * + * Now, we are ready to set up the CompressedBlockSparsityPattern. + * + * @until collect + * + * It is filled as if it were a normal pattern + * + * @until condense + * + * In the end, it is copied to a normal BlockSparsityPattern for later + * use. + * + * @until copy + * + * @author Wolfgang Bangerth, 2000, 2001, example by Guido Kanschat, 2006 */ class CompressedBlockSparsityPattern : public BlockSparsityPatternBase {