start moving documentation from the description of the pseudo class to its functions

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

diff --git a/deal.II/deal.II/include/grid/grid_generator.h b/deal.II/deal.II/include/grid/grid_generator.h
index f77f5964a0f66415eda16740d5ec61cfb1e3ad06..83f9133dc5a167f65cf1c49152e344c6e1f191a6 100644 (file)
--- a/deal.II/deal.II/include/grid/grid_generator.h
+++ b/deal.II/deal.II/include/grid/grid_generator.h
@@ -30,32 +30,6 @@ template <typename number> class SparseMatrix;
  * hyperball and the like. Following is a list of domains that can be generated
  * by the functions of this class:
  * <ul>
- *    <li> Hypercube triangulations: a hypercube triangulation is a
- *       domain which is the tensor product of an interval $[a,b]$ in
- *       the given number of spatial dimensions. If you want to create such
- *       a domain, which is a common test case for model problems, call
- *       GridGenerator::hyper_cube(tria, a,b), which produces a
- *       hypercube domain triangulated with exactly one element. You
- *       can get tensor product meshes by successive refinement of
- *       this cell.
- *
- *       If you want the hypercube subdivided a certain number of
- *       times (and if this is not achievable by hierarchic
- *       refinement, for example 3 times), then the
- *       @p subdivided_hyper_cube function may be what you are
- *       looking for.
- *
- *    <li> Rectangular coordinate-parallel domains as a generalization
- *      of hypercubes are generated by
- *      GridGenerator::hyper_rectangle (tria, p1, p2), with two
- *      opposite corner points @p p1 and @p p2.
- *
- *    <li> Rectangular coordinate-parallel domains with different numbers of
- *     cells in each coordinate direction are generated by 
- *      GridGenerator::subdivided_hyper_rectangle
- *     (tria, int[dim] repetitions, p1, p2, colorize), with two
- *      opposite corner points @p p1 and @p p2.
- *
  *    <li> Generalized L-shape domain:
  *      using the GridGenerator::hyper_L (tria, a,b) function produces
  *      the hypercube with the interval $[a,b]$ without the hypercube
@@ -150,16 +124,25 @@ class GridGenerator
                                      * (line in 1D, square in 2D,
                                      * etc) consisting of exactly one
                                      * cell. The hypercube volume is
-                                     * the tensor product of the
-                                     * intervall $[left,right]$ in
-                                     * the present number of
+                                     * 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.
                                      *
-                                     * The triangulation needs to be
+                                     * See also
+                                     * subdivided_hyper_cube() for a
+                                     * coarse mesh consisting of
+                                     * several cells. See
+                                     * hyper_rectangle(), if
+                                     * different lengths in different
+                                     * ordinate directions are
+                                     * required.
+                                     *
+                                     * @note The triangulation needs to be
                                      * void upon calling this
                                      * function.
                                      */
@@ -177,7 +160,11 @@ class GridGenerator
                                      * @p repetitions cells. Thus,
                                      * the number of cells filling
                                      * the given volume is
-                                     * <tt>repetitions^d</tt>.
+                                     * <tt>repetitions<sup>dim</sup></tt>.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     template <int dim>
     static void subdivided_hyper_cube (Triangulation<dim> &tria,
@@ -224,7 +211,7 @@ class GridGenerator
                                      * 
                                      * To get cells with an aspect
                                      * ratio different from that of
-                                     * the recatangle, use different
+                                     * the domain, use different
                                      * numbers of subdivisions in
                                      * different coordinate
                                      * directions. The minimum number
@@ -246,6 +233,10 @@ class GridGenerator
                                      * @p y-direction are 2 and 3,
                                      * the ones for @p z are 4 and
                                      * 5.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     template <int dim>
     static
@@ -270,6 +261,10 @@ class GridGenerator
                                      *
                                      * @note This function is
                                      * implemented in 2d only.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     template <int dim>
     static void
@@ -300,6 +295,10 @@ class GridGenerator
                                      *
                                      * Presently only available in 2d
                                      * and 3d.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void enclosed_hyper_cube (Triangulation<2> &tria,
                                     const double      left = 0.,
@@ -310,6 +309,10 @@ class GridGenerator
                                     /**
                                      * Declaration of same function
                                      * for different space dimension.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void enclosed_hyper_cube (Triangulation<3> &tria,
                                     const double      left = 0.,
@@ -352,6 +355,10 @@ class GridGenerator
                                      * cope with this situation, but
                                      * this has not been implemented
                                      * yet.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */    
     static void hyper_ball (Triangulation<1> &tria,
                            const Point<1>   &center = Point<1>(),
@@ -360,6 +367,10 @@ class GridGenerator
                                     /**
                                      * Declaration of same function
                                      * for different space dimension.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void hyper_ball (Triangulation<2> &tria,
                            const Point<2>   &center = Point<2>(),
@@ -368,6 +379,10 @@ class GridGenerator
                                     /**
                                      * Declaration of same function
                                      * for different space dimension.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void hyper_ball (Triangulation<3> &tria,
                            const Point<3>   &center = Point<3>(),
@@ -388,6 +403,10 @@ class GridGenerator
                                      * cylinder, 1 for the left hand
                                      * face and 2 for the right hand
                                      * face.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void cylinder (Triangulation<3> &tria,
                          const double      radius = 1.,
@@ -400,6 +419,10 @@ class GridGenerator
                                      * Therefore, this is simply a square.
                                      *
                                      * Coloring is like in 3D.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void cylinder (Triangulation<2> &tria,
                          const double      radius = 1.,
@@ -408,6 +431,10 @@ class GridGenerator
                                     /**
                                      * Non-implemented dummy for compilation
                                      * purposes.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void cylinder (Triangulation<1> &tria,
                          const double      radius,
@@ -434,6 +461,10 @@ class GridGenerator
                                      * all space dimensions, but
                                      * throws an error if called in
                                      * 1d.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void hyper_L (Triangulation<1> &tria,
                         const double      left = -1.,
@@ -442,6 +473,10 @@ class GridGenerator
                                     /**
                                      * Declaration of same function
                                      * for different space dimension.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void hyper_L (Triangulation<2> &tria,
                         const double      left = -1.,
@@ -450,6 +485,10 @@ class GridGenerator
                                     /**
                                      * Declaration of same function
                                      * for different space dimension.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void hyper_L (Triangulation<3> &tria,
                         const double      left = -1.,
@@ -480,6 +519,10 @@ class GridGenerator
                                      * throws an error if called in
                                      * 1d. It is also presently not
                                      * implemented in 3d.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void hyper_cube_slit (Triangulation<1> &tria,
                                 const double      left = 0.,
@@ -495,6 +538,10 @@ class GridGenerator
                                      * carry numbers 1 and 2, while
                                      * the outer boundary has number
                                      * 0.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void hyper_cube_slit (Triangulation<2> &tria,
                                 const double      left = 0.,
@@ -507,6 +554,10 @@ class GridGenerator
                                      *
                                      * Colorization is not
                                      * implemented in 3D.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void hyper_cube_slit (Triangulation<3> &tria,
                                 const double      left = 0.,
@@ -539,6 +590,10 @@ class GridGenerator
                                      * throws an error if called in
                                      * 1d. It is also currently not
                                      * implemented in 3d.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void hyper_shell (Triangulation<1>   &tria,
                             const Point<1>     &center,
@@ -549,6 +604,10 @@ class GridGenerator
                                     /**
                                      * Declaration of same function
                                      * for different space dimension.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void hyper_shell (Triangulation<2>   &tria,
                             const Point<2>     &center,
@@ -559,6 +618,10 @@ class GridGenerator
                                     /**
                                      * Declaration of same function
                                      * for different space dimension.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void hyper_shell (Triangulation<3>   &tria,
                             const Point<3>     &center,
@@ -581,6 +644,10 @@ class GridGenerator
                                      *
                                      * The triangulation needs to be void
                                      * upon calling this function.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void cylinder_shell (Triangulation<3>   &tria,
                                 const double        length,
@@ -601,6 +668,10 @@ class GridGenerator
                                      * version is implemented. The appropriate
                                      * boundary class is 
                                      * HalfHyperBallBoundary.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void half_hyper_ball (Triangulation<2> &tria,
                                 const Point<2>   &center = Point<2>(),
@@ -643,6 +714,10 @@ class GridGenerator
                                      *
                                      * At present, this function only
                                      * exists in 2d.
+                                     *
+                                     * @note The triangulation needs to be
+                                     * void upon calling this
+                                     * function.
                                      */
     static void half_hyper_shell (Triangulation<2>   &tria,
                                  const Point<2>     &center,