From: Timo Heister <timo.heister@gmail.com>
Date: Wed, 15 Jan 2014 21:22:52 +0000 (+0000)
Subject: make it more clear the hyper_L works in 2d and 3d.
X-Git-Tag: v8.2.0-rc1~1027
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9c59fc4830409c40723524f41751f7b6dd28a8f6;p=dealii.git

make it more clear the hyper_L works in 2d and 3d.

git-svn-id: https://svn.dealii.org/trunk@32221 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/include/deal.II/grid/grid_generator.h b/deal.II/include/deal.II/grid/grid_generator.h
index 0ad8634481..56194984fe 100644
--- a/deal.II/include/deal.II/grid/grid_generator.h
+++ b/deal.II/include/deal.II/grid/grid_generator.h
@@ -385,10 +385,12 @@ namespace GridGenerator
                   const double        half_length = 1.0);
 
   /**
-   * Initialize the given triangulation with a hyper-L consisting of exactly
+   * Initialize the given triangulation with a hyper-L (in 2d or 3d)
+   *  consisting of exactly
    * <tt>2^dim-1</tt> cells. It produces the hypercube with the interval
    * [<i>left,right</i>] without the hypercube made out of the interval
-   * [<i>(a+b)/2,b</i>].
+   * [<i>(a+b)/2,b</i>]. This will result in the classical L-shape in 2d.
+   * The shape will look like the following in 3d:
    *
    * @image html hyper_l.png
    *
@@ -436,12 +438,12 @@ namespace GridGenerator
    * indicator 1, while the inner boundary has id zero. If the flag is @p
    * false, both have indicator zero.
    *
-   * In 2D, the number <tt>n_cells</tt> of elements for this initial
+   * In 2d, the number <tt>n_cells</tt> of elements for this initial
    * triangulation can be chosen arbitrarily. If the number of initial cells
    * is zero (as is the default), then it is computed adaptively such that the
    * resulting elements have the least aspect ratio.
    *
-   * In 3D, only two different numbers are meaningful, 6 for a surface based
+   * In 3d, only two different numbers are meaningful, 6 for a surface based
    * on a hexahedron (i.e. 6 panels on the inner sphere extruded in radial
    * direction to form 6 cells) and 12 for the rhombic dodecahedron. These
    * give rise to the following meshes upon one refinement:
@@ -614,7 +616,7 @@ namespace GridGenerator
     const bool          colorize = false);
 
   /**
-   * Produce a ring of cells in 3D that is cut open, twisted and glued
+   * Produce a ring of cells in 3d that is cut open, twisted and glued
    * together again. This results in a kind of moebius-loop.
    *
    * @param tria        The triangulation to be worked on.