From: Daniel Arndt <daniel.arndt@iwr.uni-heidelberg.de>
Date: Wed, 1 Aug 2018 19:40:52 +0000 (+0200)
Subject: Code example for GridGenerator::merge_triangulations
X-Git-Tag: v9.1.0-rc1~851^2~1
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=75fb2f7538e3d243f5f04ccf12a0678c36e5bca0;p=dealii.git

Code example for GridGenerator::merge_triangulations
---

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 <int dim, int spacedim>
   void