]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Augment documentation.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Thu, 30 Jul 2009 18:25:55 +0000 (18:25 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Thu, 30 Jul 2009 18:25:55 +0000 (18:25 +0000)
git-svn-id: https://svn.dealii.org/trunk@19142 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/grid/tria_boundary.h

index d0b5f65eca419568eb839d0fe063bc17f5161668..ef8b5ee517d1fd0522ce21d333a7b561009403e1 100644 (file)
@@ -295,6 +295,14 @@ class Boundary : public Subscriptor
                                      * that were on the boundary
                                      * remain on the boundary.
                                      *
+                                     * If spacedim==1, then the line
+                                     * represented by the line
+                                     * iterator is the entire space
+                                     * (i.e. it is a cell, not a part
+                                     * of the boundary), and the
+                                     * returned point equals the
+                                     * given input point.
+                                     *
                                      * Derived classes do not need to
                                      * implement this function unless
                                      * mesh smoothing algorithms are
@@ -315,6 +323,14 @@ class Boundary : public Subscriptor
                                      * projected onto the area
                                      * characterized by the given
                                      * quad.
+                                     *
+                                     * If spacedim==2, then the line
+                                     * represented by the quad
+                                     * iterator is the entire space
+                                     * (i.e. it is a cell, not a part
+                                     * of the boundary), and the
+                                     * returned point equals the
+                                     * given input point.
                                      */
     virtual
     Point<spacedim>
@@ -447,6 +463,14 @@ class StraightBoundary : public Boundary<dim,spacedim>
                                      * point onto the line through
                                      * the two vertices of the given
                                      * line iterator.
+                                     *
+                                     * If spacedim==1, then the line
+                                     * represented by the line
+                                     * iterator is the entire space
+                                     * (i.e. it is a cell, not a part
+                                     * of the boundary), and the
+                                     * returned point equals the
+                                     * given input point.
                                      */
     virtual
     Point<spacedim>
@@ -466,6 +490,14 @@ class StraightBoundary : public Boundary<dim,spacedim>
                                      * surface spanned by the four
                                      * vertices of the given quad
                                      * iterator.
+                                     *
+                                     * If spacedim==2, then the line
+                                     * represented by the quad
+                                     * iterator is the entire space
+                                     * (i.e. it is a cell, not a part
+                                     * of the boundary), and the
+                                     * returned point equals the
+                                     * given input point.
                                      */
     virtual
     Point<spacedim>

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.