]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Added an image in the documentation of the grid_generator
authorblaisb <blais.bruno@gmail.com>
Tue, 6 Aug 2019 20:48:55 +0000 (16:48 -0400)
committerblaisb <blais.bruno@gmail.com>
Tue, 6 Aug 2019 20:48:55 +0000 (16:48 -0400)
as well as a small description of said image to exemply what
type of output can be gotten from this generator

doc/doxygen/images/cylinder_shell.png [new file with mode: 0644]
include/deal.II/grid/grid_generator.h

diff --git a/doc/doxygen/images/cylinder_shell.png b/doc/doxygen/images/cylinder_shell.png
new file mode 100644 (file)
index 0000000..588f22d
Binary files /dev/null and b/doc/doxygen/images/cylinder_shell.png differ
index f1b0434d1ba6d8cefc6237db042bcf8d120ceaa2..87427881b3d979e8ff216dd17fb0064d0b456408 100644 (file)
@@ -1031,6 +1031,13 @@ namespace GridGenerator
    * to the triangulation.
    *
    * @note The triangulation passed as argument needs to be empty when calling this function.
+   * 
+   * @image html cylinder_shell.png
+   *
+   * In this picture, a cylinder shell of length 2, inner radius 0.5, outer radius 1. is 
+   * shown. The default argument for n_radial_cells and n_axial_cells are used and a single 
+   * global refinement is carried out.
+   *
    */
   template <int dim>
   void

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.