]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add documentation
authorBruno Blais <blais.bruno@gmail.com>
Sun, 11 Feb 2024 19:50:16 +0000 (14:50 -0500)
committerBruno Blais <blais.bruno@gmail.com>
Sun, 11 Feb 2024 19:50:16 +0000 (14:50 -0500)
include/deal.II/grid/grid_generator.h

index 97f653827a6e76fde05d8304e589f694022cd1ff..2f9e4fb191fe70e06746a0f96da01190a20ce07c 100644 (file)
@@ -1493,6 +1493,11 @@ namespace GridGenerator
    * default), then it is computed adaptively such that the resulting elements
    * have the least aspect ratio. The same holds for @p n_axial_cells.
    *
+   * If @p colorize is set to true, a boundary id of 0 is set for the inner
+   * cylinder, a boundary id of 1 is set for the outer cylinder, a boundary
+   * id of 2 is set for the bottom (z-) boundary and a boundary id of 3
+   * is set for the top (z+) boundary.
+   *
    * @note Although this function is declared as a template, it does not make
    * sense in 1d and 2d. Also keep in mind that this object is rotated
    * and positioned differently than the one created by cylinder().

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.