]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Better document.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Sun, 8 May 2011 23:11:53 +0000 (23:11 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Sun, 8 May 2011 23:11:53 +0000 (23:11 +0000)
git-svn-id: https://svn.dealii.org/trunk@23683 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/include/deal.II/grid/tria_accessor.h

index 8e24dec8c5bc56fce8c0fee78952bee61b0b3927..6a3a6d7a4e6a43b546d6ed49e94bb037b18464bf 100644 (file)
@@ -450,6 +450,24 @@ class TriaAccessorBase
                                      *  Return the index of the
                                      *  element presently pointed to
                                      *  on the present level.
+                                     *
+                                     * Note that these indices are not
+                                     * globally unique for cells (though they
+                                     * may be for faces or edges). Rather, a
+                                     * cell is identified by its refinement
+                                     * level and index within this refinement
+                                     * level, the latter piece of information
+                                     * being what this function
+                                     * returns. Consequently, there may be
+                                     * multiple cells on different refinement
+                                     * levels but with the same index within
+                                     * their level.
+                                     *
+                                     * Similarly, the index returned by this
+                                     * function is not a contiguous set of
+                                     * numbers of each level: going from cell
+                                     * to cell, some of the indices in a
+                                     * level may be unused.
                                      */
     int index () const;
 

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.