From f7a67302523260d968f4ffc0996356128de0344e Mon Sep 17 00:00:00 2001 From: David Wells Date: Sat, 21 Sep 2019 11:24:34 -0400 Subject: [PATCH] Fix a few more things with the last GridGenerator patch. --- doc/news/changes/minor/20190810Workshop | 8 +++--- include/deal.II/grid/grid_generator.h | 34 ++++++++++++------------- 2 files changed, 20 insertions(+), 22 deletions(-) diff --git a/doc/news/changes/minor/20190810Workshop b/doc/news/changes/minor/20190810Workshop index fbaaa36014..666b77ebc6 100644 --- a/doc/news/changes/minor/20190810Workshop +++ b/doc/news/changes/minor/20190810Workshop @@ -2,7 +2,7 @@ Improved: Make a large number of prose, grammar, and various other improvements to the library.
(Ashna Aggarwal, Mario Zepeda Aguilar, Manaswinee Bezbaruah, Bruno Blais, -Kirana Bergstrom, Katherine Cosburn, Luel Emishaw, Rebecca Fildes, Brandon Gleeson, -Bang He, Nicole Hayes, Jiuhua Hu, Lise-Marie Imbert-Gerard, Mannu Jayadharan, -Marie Kajan, Charu Lata, Adriana Morales Miranda, Emily Novak, Rebecca Pereira, -Geneva Porter, Irabiel Romero, Tonatiuh Sanchez-Vizuet, Sara Tro) +Kirana Bergstrom, Katherine Cosburn, Luel Emishaw, Rebecca Fildes, Andres Galindo, +Brandon Gleeson, Bang He, Nicole Hayes, Jiuhua Hu, Lise-Marie Imbert-Gerard, +Mannu Jayadharan, Marie Kajan, Charu Lata, Adriana Morales Miranda, Emily Novak, +Rebecca Pereira, Geneva Porter, Irabiel Romero, Tonatiuh Sanchez-Vizuet, Sara Tro) diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index 334b102fd0..e3033fffc8 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -363,11 +363,10 @@ namespace GridGenerator * boundary faces are assigned such that the lower one in the x-direction is * 0, and the upper one is 1 (see * @ref GlossColorization "the glossary entry on colorization"). - * The - * 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. + * The 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 + * @param tria the triangulation to be created. It needs to be empty upon * calling this function. * * @author Denis Davydov, 2018 @@ -511,21 +510,20 @@ namespace GridGenerator const bool colorize = false); /** - * A parallelogram. The first corner point is the origin. 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. Colorizing is done in the - * same way as in hyper_rectangle(). - * - * @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"). + * A parallelogram. The first corner point is the origin. The next @p dim + * vertices are the ones given in the second argument and the last vertex + * will be the sum of the two vectors connecting the origin to those + * points. Colorizing is done in the same way as in hyper_rectangle(). * - * @note The triangulation passed as argument needs to be empty when calling this function. + * @note This function is implemented in 2d only. + * + * @param tria The triangulation to be created. It needs to be empty upon + * calling this function. + * + * @param corners Second and third vertices of the parallelogram. + * + * @param colorize Assign different boundary ids if true. (see @ref + * GlossColorization "the glossary entry on colorization"). */ template void -- 2.39.5