]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Improve documentation 5831/head
authorDaniel Arndt <daniel.arndt@iwr.uni-heidelberg.de>
Tue, 30 Jan 2018 22:12:28 +0000 (23:12 +0100)
committerDaniel Arndt <daniel.arndt@iwr.uni-heidelberg.de>
Tue, 30 Jan 2018 22:12:28 +0000 (23:12 +0100)
include/deal.II/dofs/dof_tools.h

index 0aa4c225d64b012e0422fa3fe7f496f45f2d4170..292b8bc8e0c35892555475efee634a46e4421b01 100644 (file)
@@ -831,7 +831,11 @@ namespace DoFTools
    * order to allow adding constraints from different sources to the same
    * object. You therefore need to make sure it contains only constraints you
    * still want; otherwise call the ConstraintMatrix::clear() function.
-   * Likewise, this function does not close the object since you may want to
+   * Since this function does not check if it would add cycles in
+   * @p constraints, it is recommended to call this function prior to other
+   * functions that constrain DoFs with respect to others such as
+   * make_periodicity_constraints().
+   * This function does not close the object since you may want to
    * enter other constraints later on yourself.
    *
    * In the hp-case, i.e. when the argument is of type hp::DoFHandler, we
@@ -1106,6 +1110,9 @@ namespace DoFTools
    * first_vector_components is empty the matrix is interpreted as an
    * interpolation matrix with size no_face_dofs $\times$ no_face_dofs.
    *
+   * This function makes sure that identity constraints don't create cycles
+   * in @p constraint_matrix.
+   *
    * Detailed information can be found in the see
    * @ref GlossPeriodicConstraints "Glossary entry on periodic boundary conditions".
    *

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.