From: Wolfgang Bangerth <bangerth@colostate.edu>
Date: Thu, 27 May 2021 13:31:28 +0000 (-0600)
Subject: Minor doc improvement.
X-Git-Tag: v9.4.0-rc1~1319^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F12323%2Fhead;p=dealii.git

Minor doc improvement.
---

diff --git a/include/deal.II/grid/tria_accessor.h b/include/deal.II/grid/tria_accessor.h
index 49ff747a0b..3431a53f67 100644
--- a/include/deal.II/grid/tria_accessor.h
+++ b/include/deal.II/grid/tria_accessor.h
@@ -3514,16 +3514,21 @@ public:
    */
 
   /**
-   * Return globally unique cell index for a non-artificial active cell. The
-   * value is identical to active_cell_index() in the context of a serial
+   * Return a globally unique cell index for the current cell,
+   * assuming it is not artificial. The value is identical to
+   * active_cell_index() if the cell is part of a serial
    * triangulation.
    *
-   * In the context of parallel triangulations, locally-owned cells are
-   * enumerated contiguously within each subdomain of the mesh.
-   *
-   * If a cell-data vector has been set up with
-   * parallel::TriangulationBase::global_active_cell_index_partitioner(), the
-   * returned index can be used to access the correct vector entry.
+   * In the context of parallel triangulations, locally-owned cells
+   * are enumerated contiguously within each subdomain of the
+   * mesh. This ensures that the index returned by this function can
+   * be used as the index into vectors with a total of
+   * Triangulation::n_globally_active_cells() entries, and for which
+   * every process stores a contiguous part.  If such a cell-data
+   * vector has been set up with
+   * parallel::TriangulationBase::global_active_cell_index_partitioner(),
+   * the index returned by this function can then be used to access
+   * the correct vector entry.
    */
   types::global_cell_index
   global_active_cell_index() const;