From: Wolfgang Bangerth Date: Mon, 6 Jan 2020 20:07:31 +0000 (-0700) Subject: Augment the documentation of GridGenerator::simplex(). X-Git-Tag: v9.2.0-rc1~736^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7a0122e4a5ab8002778fc30c562f72f18c853056;p=dealii.git Augment the documentation of GridGenerator::simplex(). --- diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index c973b73c58..4c8e04ab73 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -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$-simplex + * (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