]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Clarify documentation. 14852/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Tue, 7 Mar 2023 21:46:50 +0000 (14:46 -0700)
committerWolfgang Bangerth <bangerth@colostate.edu>
Tue, 7 Mar 2023 21:46:50 +0000 (14:46 -0700)
include/deal.II/grid/grid_generator.h

index 4768bcaab2d540f7311f3330927092acf2ba29ba..9bd1481502fcff312b59b0dbebaae8b4222d5402 100644 (file)
@@ -468,13 +468,15 @@ namespace GridGenerator
    * to the cylinder: see the mathematical definition given in
    * GridGenerator::concentric_hyper_shells.
    *
-   * @param colorize Assign different boundary ids if set to true. For more
+   * @param colorize If `true`, then assign different boundary ids to
+   * different parts of the boundary. For more
    * information on boundary indicators see
    * @ref GlossBoundaryIndicator "this glossary entry".
    * The left boundary (at $x = 0$) is assigned an id of $0$, the right
-   * boundary (at $x = 2.2$) is assigned an id of $1$, the cylinder boundary
-   * is assigned an id of $2$, and the channel walls are assigned an id of
-   * $3$.
+   * boundary (at $x = 2.2$) is assigned an id of $1$; the boundary of
+   * the obstacle in the middle (i.e., the circle in 2d or the cylinder
+   * walls in 3d) is assigned an id of $2$, and the channel walls are
+   * assigned an id of $3$.
    *
    * See the original paper for more information:
    * @code{.bib}

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.