]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
add example to documentation
authorguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 14 Jun 2006 14:12:07 +0000 (14:12 +0000)
committerguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 14 Jun 2006 14:12:07 +0000 (14:12 +0000)
git-svn-id: https://svn.dealii.org/trunk@13246 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/block_sparsity_pattern.h

index a537e9ebe53d0d3bf03ceb9081a3112f62dc67ac..2c1dc8e913a78c963d84cba7dc5d58310ed928b9 100644 (file)
@@ -505,7 +505,34 @@ class BlockSparsityPattern : public BlockSparsityPatternBase<SparsityPattern>
  * templated name of the base class. For information on the interface
  * of this class refer to the base class.
  *
- * @author Wolfgang Bangerth, 2000, 2001
+ * <h3>Example</h3>
+ * 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 <tt>dof</tt> and the ConstraintMatrix
+ * <tt>constraints</tt> 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<CompressedSparsityPattern>
 {

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.