]> https://gitweb.dealii.org/ - dealii.git/commitdiff
TriangulationDescription: documentation fixes 18611/head
authorTimo Heister <timo.heister@gmail.com>
Tue, 1 Jul 2025 15:47:47 +0000 (11:47 -0400)
committerTimo Heister <timo.heister@gmail.com>
Tue, 1 Jul 2025 21:17:42 +0000 (17:17 -0400)
include/deal.II/grid/tria_description.h

index 9a07c045fa30a89f5154173485fd0bc6a4f58a3c..da22333aa6cea800a864fc6262c2bae7cdf180f9 100644 (file)
@@ -396,13 +396,14 @@ namespace TriangulationDescription
      * Construct a TriangulationDescription::Description. In contrast
      * to the function above, this function is also responsible for creating
      * a serial triangulation and for its partitioning (by calling the
-     * provided `std::function` objects). Internally only selected processes (
-     * every n-th/each root of a group of size group_size) create a serial
+     * provided `std::function` objects). Internally only selected processes
+     * (every n-th/each root of a group of size `group_size`) create a serial
      * triangulation and the TriangulationDescription::Description for all
-     * processes in its group, which is communicated.
+     * processes in its group, which is then communicated.
      *
      * This function can also be used to read an external mesh only once (by
-     * the root process and a group consisting all processes). The following
+     * the root process), by setting `group_size` to the number of MPI ranks
+     * and therefore creating a single group. The following
      * code snippet shows a modified version of the example provided in the
      * documentation of create_description_from_triangulation().
      * Function calls that only need to be performed by the root process

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.