]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Document the bitset in collect_periodic_face_pairse, closes issue 114
authorMatthias Maier <tamiko@kyomu.43-1.org>
Tue, 3 Sep 2013 16:50:11 +0000 (16:50 +0000)
committerMatthias Maier <tamiko@kyomu.43-1.org>
Tue, 3 Sep 2013 16:50:11 +0000 (16:50 +0000)
git-svn-id: https://svn.dealii.org/branches/branch_port_the_testsuite@30571 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/include/deal.II/grid/grid_tools.h

index bdbc8ab7929437f1c1a8da4e666d6f0f22433ac1..cbdcbaf7a4b1767ccf4c71407ddb4552b520b616 100644 (file)
@@ -1086,6 +1086,10 @@ namespace GridTools
    * boundary with faces belonging to the second boundary with the help
    * of orthogonal_equality.
    *
+   * The bitset that is returned together with the second face encodes the
+   * _relative_ orientation of the first face with respect to the second
+   * face, see the documentation of orthogonal_equality for further details.
+   *
    * The @p offset is a vector tangential to the faces that is added to the
    * location of vertices of the 'first' boundary when attempting to match
    * them to the corresponding vertices of the 'second' boundary. This can

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.