From d13b698fc57250404b1a5e5928ca70aab024e478 Mon Sep 17 00:00:00 2001 From: Andres Galindo Date: Wed, 7 Aug 2019 13:58:45 -0400 Subject: [PATCH] improved documentation in GridGenerator --- include/deal.II/grid/grid_generator.h | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index c8ffbbbad4..334b102fd0 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -107,7 +107,7 @@ namespace GridGenerator * @image html simplex_2d.png * @image html simplex_3d.png * - * @param tria The Triangulation to create. It needs to be empty upon + * @param tria The triangulation to be created. It needs to be empty upon * calling this function. * * @param vertices The dim+1 corners of the simplex. @@ -232,7 +232,7 @@ namespace GridGenerator * @note For an example of the use of this function see the step-28 tutorial * program. * - * @param tria The Triangulation to create. It needs to be empty upon + * @param tria The triangulation to be created. It needs to be empty upon * calling this function. * * @param repetitions A vector of @p dim positive values denoting the number @@ -314,7 +314,7 @@ namespace GridGenerator * the first @p dim coordinate directions embedded into the @p spacedim * dimensional space with the remaining entries set to zero. * - * @param tria The Triangulation to create. It needs to be empty upon + * @param tria The triangulation to be created. It needs to be empty upon * calling this function. * * @param holes Positive number of holes in each of the dim directions. @@ -367,6 +367,9 @@ namespace GridGenerator * indicators for the surfaces in the y-direction are 2 and 3, and the ones * for the z-direction are 5 and 6. The hole boundary has indicator 4. * + *@param tria the triangulation to be created. It needs to be empty upon + * calling this function. + * * @author Denis Davydov, 2018 */ template @@ -433,7 +436,7 @@ namespace GridGenerator * * @image html channel_with_cylinder_2d_manifolds.png * - * @param tria Triangulation to create. Must be empty upon calling this + * @param tria Triangulation to be created. Must be empty upon calling this * function. * * @param shell_region_width Width of the layer of shells around the cylinder. @@ -513,7 +516,14 @@ namespace GridGenerator * point will be the sum of these two vectors. Colorizing is done in the * same way as in hyper_rectangle(). * - * @note This function is implemented in 2d only. + * @note This function is implemented in 2d only. + * + * @param tria Triangulation to be created. + * @param corners Adjacent points. The @p dim + * adjacent points are the ones given in the second argument and the fourth + * point will be the sum of these two vectors. + * @param colorize Assign different boundary ids if set to true. (see + * @ref GlossColorization "the glossary entry on colorization"). * * @note The triangulation passed as argument needs to be empty when calling this function. */ @@ -581,7 +591,7 @@ namespace GridGenerator /** * A subdivided parallelepiped. * - * @param tria The Triangulation to create. It needs to be empty upon + * @param tria The triangulation to be created. It needs to be empty upon * calling this function. * * @param origin First corner of the parallelepiped. -- 2.39.5