]> https://gitweb.dealii.org/ - dealii.git/commitdiff
fix documentation about colorized indicators in hyper_cube() with the exception in 1d.
authorTimo Heister <timo.heister@gmail.com>
Fri, 3 Sep 2010 09:39:24 +0000 (09:39 +0000)
committerTimo Heister <timo.heister@gmail.com>
Fri, 3 Sep 2010 09:39:24 +0000 (09:39 +0000)
git-svn-id: https://svn.dealii.org/trunk@21852 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/grid/grid_generator.h

index 1f6051681de6d467c642f787f0b12a3971e49cf7..96ca87547a61f8364a79b0987c24ea37ee94689d 100644 (file)
@@ -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
-                                     * <i>[left,right]<sup>dim</sup></i>
-                                     * 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
+                                     * <i>[left,right]<sup>dim</sup></i> 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.

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.