From: Manu Jayadharan Date: Wed, 7 Aug 2019 11:38:56 +0000 (-0400) Subject: improved documentation for grid generator X-Git-Tag: v9.2.0-rc1~1264^2~1 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cadb8340daeb73654fec7494d1be9bde8181d174;p=dealii.git improved documentation for grid generator --- diff --git a/doc/news/changes/minor/20190807MJayadharan b/doc/news/changes/minor/20190807MJayadharan new file mode 100644 index 0000000000..eaa50d612e --- /dev/null +++ b/doc/news/changes/minor/20190807MJayadharan @@ -0,0 +1,3 @@ +Changed: Improved the documentation about GridGenerator::subdivided_hyper_cube(). +
+(Manu Jayadharan, 2019/08/07) diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index f1b0434d1b..32f1de5aa3 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -135,6 +135,17 @@ namespace GridGenerator * Triangulation@<2,3@> will be a square in the xy plane with z=0. * * @note The triangulation passed as argument needs to be empty when calling this function. + * + * @param tria The Triangulation to create. It needs to be empty upon + * calling this function. + * + * @param repetitions A vector of @p dim positive values denoting the number + * of cells to generate in that direction. For example, first component of the vector specifies the number of cells + * in the x-direction, second component specifies that for the y-direction for dim=2. + * + * @param left Lower bound for the interval used to create the hyper cube. + * + * @param right Upper bound for the interval used to create the hyper cube. */ template void