From: bangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Date: Mon, 6 Aug 2007 22:40:04 +0000 (+0000)
Subject: Document the extra argument.
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=da06b50e2a9cb8e1f5c9ce27c66ce5145b04e781;p=dealii-svn.git

Document the extra argument.

git-svn-id: https://svn.dealii.org/trunk@14914 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/deal.II/include/dofs/dof_tools.h b/deal.II/deal.II/include/dofs/dof_tools.h
index 51048a1c09..57f31bde62 100644
--- a/deal.II/deal.II/include/dofs/dof_tools.h
+++ b/deal.II/deal.II/include/dofs/dof_tools.h
@@ -364,16 +364,6 @@ class DoFTools
 				      * resulting sparsity pattern is
 				      * symmetric.
 				      *
-				      * Since this process is purely
-				      * local, the sparsity pattern
-				      * does not provide for entries
-				      * introduced by the elimination
-				      * of hanging nodes.  They have
-				      * to be taken care of by a call
-				      * to
-				      * ConstraintMatrix::condense()
-				      * afterwards.
-				      *
 				      * Remember using
 				      * SparsityPattern::compress()
 				      * after generating the pattern.
@@ -399,6 +389,24 @@ class DoFTools
 				      * content of the object, that is
 				      * previously added entries are
 				      * not deleted.
+				      *
+				      * Since this process is purely local,
+				      * the sparsity pattern does not provide
+				      * for entries introduced by the
+				      * elimination of hanging nodes. They
+				      * have to be taken care of by a call to
+				      * ConstraintMatrix::condense()
+				      * afterwards.
+				      *
+				      * Alternatively, the constraints on
+				      * degrees of freedom can already be
+				      * taken into account at the time of
+				      * creating the sparsity pattern. For
+				      * this, pass the ConstraintMatrix object
+				      * as the last argument to the current
+				      * function. No call to
+				      * ConstraintMatrix::condense() is then
+				      * necessary.
 				      */
     template <class DH, class SparsityPattern>
     static