]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Comment update.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 26 Sep 2003 15:04:08 +0000 (15:04 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 26 Sep 2003 15:04:08 +0000 (15:04 +0000)
git-svn-id: https://svn.dealii.org/trunk@8040 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/grid/tria_hex.h

index 5b4db61a72ac3bfeac2c6f35230513dc00c191f2..5dcd50ccfc0d21461b26f64a910a747f196098d8 100644 (file)
 #include <base/exceptions.h>
 
 /**
- *   @p{Hexahedron}s denote the fundamental entities of triangulations in three
- *   dimensions. They are
- *   characterized by the (global) indices of the six bounding quadrilaterals.
+ *   @p{Hexahedron}s denote the fundamental entities of triangulations
+ *   in three dimensions. They are characterized by the (global)
+ *   indices of the six bounding quadrilaterals.
  *
- *   A heaxhedron itself has one index, as far as the topological part handled in
- *   the triangulation is concerned: the index in the level
- *   it belongs to. The level index is implicitly given by the position
- *   in the @p{hexes.hexes} list attached to the information of each level
- *   of the triangulation.
+ *   A heaxhedron itself has one index, as far as the topological part
+ *   handled in the triangulation is concerned: the index in the level
+ *   it belongs to. The level index is implicitly given by the
+ *   position in the @p{hexes.hexes} list attached to the information
+ *   of each level of the triangulation.
  *
- *   For conventions on the numbering of faces, lines and vertices within a
- *   hexahedron, refer to the documentation of the @ref{Triangulation} class.
+ *   For conventions on the numbering of faces, lines and vertices
+ *   within a hexahedron, refer to the documentation of the
+ *   @ref{Triangulation} class.
  *
  *   @author Wolfgang Bangerth, 1998
  */
@@ -39,12 +40,13 @@ class Hexahedron
 
                                     /**
                                      *  Construct a Hex with quad
-                                     *  indices @p{i0} through @p{i5}. By default,
-                                     *  indices are set to -1, i.e. an
+                                     *  indices @p{i0} through
+                                     *  @p{i5}. By default, indices
+                                     *  are set to -1, i.e. an
                                      *  invalid value.
                                      *
-                                     *  No convention is set as of now on the
-                                     *  order of quads
+                                     *  No convention is set as of
+                                     *  now on the order of quads
                                      */
     Hexahedron (const int i0 = -1,
                const int i1 = -1,
@@ -54,14 +56,15 @@ class Hexahedron
                const int i5 = -1);
     
                                     /**
-                                     *  Return the index of quad @p{i}=0
-                                     *  through 5.
+                                     *  Return the index of quad
+                                     *  @p{i}=0 through 5.
                                      */
     int quad (const int i) const;
     
                                     /**
-                                     *  Set the index of the @p{i}th quad to
-                                     *  @p{index}. @p{i}=0 through 5.
+                                     *  Set the index of the @p{i}th
+                                     *  quad to @p{index}. @p{i}=0
+                                     *  through 5.
                                      */
     void set_quad (const int i, const int index);
     
@@ -80,6 +83,14 @@ class Hexahedron
                    << "Indices for the quad number must be 0 through 5, "
                    << "but you gave " << arg1); 
   protected:
+                                     /**
+                                      * Indices of the six quads that
+                                      * bound this hexahedron. The
+                                      * level index is implicitly
+                                      * given by the level of this
+                                      * hexahedron, so this is only
+                                      * the index within this level.
+                                      */
     int quads[6];
 };
 

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.