From: Timo Heister Date: Sun, 5 Jan 2020 22:47:48 +0000 (-0500) Subject: doc: minor GridGenerator changes X-Git-Tag: v9.2.0-rc1~737^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F9234%2Fhead;p=dealii.git doc: minor GridGenerator changes --- diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index cbafa8005a..c973b73c58 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -96,13 +96,15 @@ namespace GridGenerator const bool colorize = false); /** - * \brief %Triangulation of a d-simplex with (d+1) vertices and mesh cells. + * \brief Create a d-simplex (a triangle in 2d, a tetrahedron in 3d) with + * (d+1) corners made out of (d+1) cells. * - * The @p vertices argument contains a vector with all d+1 vertices of the - * simplex. They must be given in an order such that the vectors from the - * first vertex to each of the others form a right-handed system. + * 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 + * vectors from the first vertex to each of the others form a right-handed + * system. * - * The meshes generated in two and three dimensions are + * The meshes generated in two and three dimensions are: * * @image html simplex_2d.png * @image html simplex_3d.png @@ -116,7 +118,6 @@ namespace GridGenerator * Triangulation@<3,3@>. * * @author Guido Kanschat - * @date 2015 */ template void @@ -322,7 +323,6 @@ namespace GridGenerator * * @param holes Positive number of holes in each of the dim directions. * @author Guido Kanschat - * @date 2015 */ template void @@ -841,13 +841,12 @@ namespace GridGenerator * zero, and then the legs are numbered starting at one (see * @ref GlossColorization "the glossary entry on colorization"). * - * Examples in two and three dimensions are + * Examples in two and three dimensions are: * * @image html hyper_cross_2d.png * @image html hyper_cross_3d.png * * @author Guido Kanschat - * @date 2015 */ template void