From: Wolfgang Bangerth Date: Sun, 8 May 2011 23:11:53 +0000 (+0000) Subject: Better document. X-Git-Tag: v8.0.0~4082 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=41d7b26169bcf948128845275cf6334db3dd8446;p=dealii.git Better document. git-svn-id: https://svn.dealii.org/trunk@23683 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/include/deal.II/grid/tria_accessor.h b/deal.II/include/deal.II/grid/tria_accessor.h index 8e24dec8c5..6a3a6d7a4e 100644 --- a/deal.II/include/deal.II/grid/tria_accessor.h +++ b/deal.II/include/deal.II/grid/tria_accessor.h @@ -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;