]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
add documentation to GridGenerator::subdivided_hyper_rectangle
authorheister <heister@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 8 Feb 2013 17:12:00 +0000 (17:12 +0000)
committerheister <heister@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 8 Feb 2013 17:12:00 +0000 (17:12 +0000)
git-svn-id: https://svn.dealii.org/trunk@28281 0785d39b-7218-0410-832d-ea1e28bc413d

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

index 39f53c565bddf62f2ef43e58c42de1c445dd7eb9..69ba622c64dfbb43ac807452239bdca9f293bda8 100644 (file)
@@ -183,7 +183,7 @@ public:
    * surfaces are assigned, such
    * that the lower one in
    * @p x-direction is 0, the
-   * upper one is 1. The indicators
+   * upper one is 1 (the left and the right vertical face). The indicators
    * for the surfaces in
    * @p y-direction are 2 and 3,
    * the ones for @p z are 4 and
@@ -195,7 +195,8 @@ public:
    * direction <i>x<sub>i</sub></i>
    * adds 2<sup>i</sup>. For
    * instance, the center point
-   * (1,-1,1) yields a material id 5.
+   * (1,-1,1) yields a material id 5 (this means that in 2d only material
+   * ids 0,1,2,3 are assigned independent from the number of repetitions).
    *
    * Note that the @p colorize flag is
    * ignored in 1d and is assumed to always

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.