]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Augment the documentation of GridGenerator::simplex(). 9236/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Mon, 6 Jan 2020 20:07:31 +0000 (13:07 -0700)
committerWolfgang Bangerth <bangerth@colostate.edu>
Mon, 6 Jan 2020 20:07:31 +0000 (13:07 -0700)
include/deal.II/grid/grid_generator.h

index c973b73c586b6e3b08856de861ddeba8c0dd858e..4c8e04ab733c435a6d24aac08258fe423a70a9b4 100644 (file)
@@ -96,8 +96,13 @@ namespace GridGenerator
              const bool                    colorize = false);
 
   /**
-   * \brief Create a d-simplex (a triangle in 2d, a tetrahedron in 3d) with
-   * (d+1) corners made out of (d+1) cells.
+   * Create a $d$-<a href="https://en.wikipedia.org/wiki/Simplex">simplex</a>
+   * (i.e., a triangle in 2d, or a tetrahedron in 3d) with
+   * $d+1$ corners. Since deal.II does not support triangular and
+   * tetrahedral cells, the simplex described by the input arguments
+   * is subdivided into quadrilaterals and hexahedra by adding edge,
+   * face, and simplex midpoints, resulting in a mesh that consists of
+   * $d+1$ quadrilateral or hexahedral cells.
    *
    * The @p vertices argument contains a vector with all d+1 vertices defining
    * the corners of the simplex. They must be given in an order such that the

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.