From e1a01df512fd7c5fa093dbe04843b0b383a4f646 Mon Sep 17 00:00:00 2001 From: maier Date: Tue, 3 Sep 2013 16:51:57 +0000 Subject: [PATCH] Document the bitset in collect_periodic_face_pairse, closes issue 114 git-svn-id: https://svn.dealii.org/trunk@30572 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/include/deal.II/grid/grid_tools.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/deal.II/include/deal.II/grid/grid_tools.h b/deal.II/include/deal.II/grid/grid_tools.h index 146fecf71c..eabd288760 100644 --- a/deal.II/include/deal.II/grid/grid_tools.h +++ b/deal.II/include/deal.II/grid/grid_tools.h @@ -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 -- 2.39.5