From 062f64723105c1f78ece38a0273332ee69d8c4b0 Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Fri, 3 Sep 2010 09:39:24 +0000 Subject: [PATCH] fix documentation about colorized indicators in hyper_cube() with the exception in 1d. git-svn-id: https://svn.dealii.org/trunk@21852 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/grid/grid_generator.h | 33 +++++++++++-------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/deal.II/deal.II/include/grid/grid_generator.h b/deal.II/deal.II/include/grid/grid_generator.h index 1f6051681d..96ca87547a 100644 --- a/deal.II/deal.II/include/grid/grid_generator.h +++ b/deal.II/deal.II/include/grid/grid_generator.h @@ -56,19 +56,20 @@ class GridGenerator { public: /** - * Initialize the given - * triangulation with a hypercube - * (line in 1D, square in 2D, - * etc) consisting of exactly one - * cell. The hypercube volume is - * the tensor product interval - * [left,right]dim - * in the present number of - * dimensions, where the limits - * are given as arguments. They - * default to zero and unity, - * then producing the unit - * hypercube. + * Initialize the given triangulation + * with a hypercube (line in 1D, square + * in 2D, etc) consisting of exactly one + * cell. The hypercube volume is the + * tensor product interval + * [left,right]dim in + * the present number of dimensions, + * where the limits are given as + * arguments. They default to zero and + * unity, then producing the unit + * hypercube. All boundary indicators are + * set to zero ("not colorized") for 2d + * and 3d. In 1d the indicators are + * colorized, see hyper_rectangle(). * * @image html hyper_cubes.png * @@ -200,6 +201,12 @@ class GridGenerator * instance, the center point * (1,-1,1) yields a material id 5. * + * Note that the @p colorize flag is + * ignored in 1d and is assumed to always + * be true. That means the boundary + * indicator is 0 on the left and 1 on + * the right. See step-15 for details. + * * @note The triangulation needs to be * void upon calling this * function. -- 2.39.5