From f727e2cd1599e1f617134ba81cdf00b0a29e499c Mon Sep 17 00:00:00 2001 From: Bruno Blais Date: Sun, 11 Feb 2024 14:50:16 -0500 Subject: [PATCH] Add documentation --- include/deal.II/grid/grid_generator.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index 97f653827a..2f9e4fb191 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -1493,6 +1493,11 @@ namespace GridGenerator * default), then it is computed adaptively such that the resulting elements * have the least aspect ratio. The same holds for @p n_axial_cells. * + * If @p colorize is set to true, a boundary id of 0 is set for the inner + * cylinder, a boundary id of 1 is set for the outer cylinder, a boundary + * id of 2 is set for the bottom (z-) boundary and a boundary id of 3 + * is set for the top (z+) boundary. + * * @note Although this function is declared as a template, it does not make * sense in 1d and 2d. Also keep in mind that this object is rotated * and positioned differently than the one created by cylinder(). -- 2.39.5