From 0c4f98531a5a3cad2e888e97c56ff21d72c08051 Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Sun, 8 Dec 2013 15:49:12 +0000 Subject: [PATCH] add documentation git-svn-id: https://svn.dealii.org/trunk@31940 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/include/deal.II/grid/grid_tools.h | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/deal.II/include/deal.II/grid/grid_tools.h b/deal.II/include/deal.II/grid/grid_tools.h index aca9b0b885..b65081d4a5 100644 --- a/deal.II/include/deal.II/grid/grid_tools.h +++ b/deal.II/include/deal.II/grid/grid_tools.h @@ -1066,7 +1066,9 @@ namespace GridTools /** * This function will collect periodic face pairs on the - * coarsest mesh level of the given @p container (a Triangulation or DoFHandler). + * coarsest mesh level of the given @p container (a Triangulation or + * DoFHandler) and add them to the vector @p matched_pairs leaving the + * original contents intact. * * Define a 'first' boundary as all boundary faces having boundary_id * @p b_id1 and a 'second' boundary consisting of all faces belonging @@ -1093,6 +1095,11 @@ namespace GridTools * parallel::distributed::Triangulation::add_periodicity to enforce * periodicity algebraically. * + * @note Because elements will be added to @p matched_pairs (and existing + * entries will be preserved), it is possible to call this function several + * times with different boundary ids to generate a vector with all periodic + * pairs. + * * @author Daniel Arndt, Matthias Maier, 2013 */ template @@ -1117,7 +1124,8 @@ namespace GridTools * face with local face index 2*dimension+1 and boundary * indicator @p b_id. * - * This function will collect periodic face pairs on the coarsest mesh level. + * This function will collect periodic face pairs on the coarsest mesh level + * and add them to @p matched_pairs leaving the original contents intact. * * @note This version of collect_periodic_face_pairs will not work on * meshes with cells not in @ref GlossFaceOrientation -- 2.39.5