]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update documentation of CellAccessor::active_cell_index(). 1320/head
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Mon, 10 Aug 2015 20:13:47 +0000 (15:13 -0500)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Mon, 10 Aug 2015 20:13:47 +0000 (15:13 -0500)
include/deal.II/grid/tria_accessor.h

index a3da804d1cd16635d24093edc3b4e1b6de5e3bd4..fcc3f7a2b01f130a503a94f00f3ca48d0ab8b2fe 100644 (file)
@@ -2467,7 +2467,12 @@ public:
    * and
    * @ref GlossArtificialCell).
    * This function counts over all of them, including ghost and artificial
-   * active cells.
+   * active cells. This implies that the index returned by this function
+   * uniquely identifies a cell within the triangulation on a single processor,
+   * but does not uniquely identify the cell among the (parts of the)
+   * triangulation that is shared among processors. If you would like to identify
+   * active cells across processors, you need to consider the CellId of a cell
+   * returned by CellAccessor::id().
    */
   unsigned int active_cell_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.