From 75fb2f7538e3d243f5f04ccf12a0678c36e5bca0 Mon Sep 17 00:00:00 2001 From: Daniel Arndt Date: Wed, 1 Aug 2018 21:40:52 +0200 Subject: [PATCH] Code example for GridGenerator::merge_triangulations --- include/deal.II/grid/grid_generator.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index a96ad98b0d..dacbccb7ce 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -1166,6 +1166,17 @@ namespace GridGenerator /** * Same as above but allows to merge more than two triangulations at once. + * The following gives an example of how to use this function: + * @code + * Triangulation<2> tria_1, tria_2, tria_3; + * // initialize tria_1, tria_2 and tria_3 + * ... + * Triangulation<2> merged_triangulation; + * GridGenerator::merge_triangulations({&tria_1, &tria_2, &tria_3}, + * merged_triangulation, + * 1.0e-10, + * false); + * @endcode */ template void -- 2.39.5