]> https://gitweb.dealii.org/ - dealii.git/commitdiff
improve DynamicSparsityPattern usage documentation 11499/head
authorTimo Heister <timo.heister@gmail.com>
Sat, 9 Jan 2021 19:34:58 +0000 (14:34 -0500)
committerTimo Heister <timo.heister@gmail.com>
Sat, 9 Jan 2021 19:34:58 +0000 (14:34 -0500)
include/deal.II/lac/dynamic_sparsity_pattern.h

index 3d35694e3ddd6487d70e8c8f92ddd9de8cf77e49..254dfd0e97a7e231a1a845f2666a9de2319148e5 100644 (file)
@@ -304,13 +304,13 @@ namespace DynamicSparsityPatternIterators
  *
  * <h3>Usage</h3>
  *
- * Use this class as follows:
+ * Usage of this class is explained in step-2 (without constraints) and step-6
+ * (with AffineConstraints) and typically looks as follows:
  * @code
  * DynamicSparsityPattern dynamic_pattern (dof_handler.n_dofs());
  * DoFTools::make_sparsity_pattern (dof_handler,
- *                                  dynamic_pattern);
- * constraints.condense (dynamic_pattern);
- *
+ *                                  dynamic_pattern,
+ *                                  constraints);
  * SparsityPattern sp;
  * sp.copy_from (dynamic_pattern);
  * @endcode

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.