]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Added the links to the pictures in the documentation of GridGenerator::eccentric_hype...
authorMelanie Gerault <mgerault@mit.edu>
Wed, 14 Aug 2019 19:00:40 +0000 (15:00 -0400)
committerMelanie Gerault <mgerault@mit.edu>
Wed, 14 Aug 2019 19:01:16 +0000 (15:01 -0400)
include/deal.II/grid/grid_generator.h

index 6612b08df4dced7ec8a0c001a3b49f0d7345abc7..42fe54b2d55f21df971c7af593cc72b9efc8becb 100644 (file)
@@ -977,8 +977,15 @@ namespace GridGenerator
    * Here, the number <tt>n_cells</tt> of elements has the same meaning as in
    * GridGenerator::hyper_shell.
    *
-   * @note This function is declared to exist for triangulations of all space
-   * dimensions, but throws an error if called in 1d.
+   * The grids with 12 initial cells and 3 levels of global refinement are
+   * plotted below:
+   *
+   * @image html eccentric_hyper_shell_2D.png
+   * @image html eccentric_hyper_shell_2D.png
+   *
+   * @note Because it uses the definition of the hyper shell, this function is
+   * declared to exist for triangulations of all space dimensions, but throws an
+   * error if called in 1d.
    *
    * @note The triangulation passed as argument needs to be empty when calling this function.
    */

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.