]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update GridGenerator::half_hyper_shell documentation for correctness
authorGraham Harper <grahambenharper@gmail.com>
Thu, 30 Jan 2020 03:25:43 +0000 (20:25 -0700)
committerGraham Harper <grahambenharper@gmail.com>
Thu, 30 Jan 2020 04:32:17 +0000 (21:32 -0700)
include/deal.II/grid/grid_generator.h

index 21b0cd408719292f4d79984ed571a0f91fce609d..e1501fa74a0e6f802095a8ef48992ffbc0431c99 100644 (file)
@@ -1126,7 +1126,9 @@ namespace GridGenerator
    *
    * If colorize is set to <code>true</code>, the inner, outer, and the part
    * of the boundary where $x=0$, get indicator 0, 1, and 2,
-   * respectively. Otherwise all indicators are set to 0 (see
+   * respectively. Additionally, in 2d, the boundary indicator 3 is given to
+   * the vertical edge below the x-axis. Otherwise, if colorize is set to
+   * <code>false</code> all indicators are set to 0 (see
    * @ref GlossColorization "the glossary entry on colorization").
    *
    * All manifold ids are set to zero, and a SphericalManifold is attached

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.