From: Peter Munch <peterrmuench@gmail.com>
Date: Sun, 26 Jun 2022 07:56:01 +0000 (+0200)
Subject: Add cross-references for global indices
X-Git-Tag: v9.5.0-rc1~1121^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3d831f64635a962b9d2f8340ea9fb683c6d65fa8;p=dealii.git

Add cross-references for global indices
---

diff --git a/include/deal.II/distributed/tria_base.h b/include/deal.II/distributed/tria_base.h
index 166453c530..c9c40be302 100644
--- a/include/deal.II/distributed/tria_base.h
+++ b/include/deal.II/distributed/tria_base.h
@@ -204,14 +204,16 @@ namespace parallel
 
     /**
      * Return partitioner for the global indices of the cells on the active
-     * level of the triangulation.
+     * level of the triangulation, which is returned by the function
+     * CellAccessor::global_active_cell_index().
      */
     const std::weak_ptr<const Utilities::MPI::Partitioner>
     global_active_cell_index_partitioner() const;
 
     /**
      * Return partitioner for the global indices of the cells on the given @p
-     * level of the triangulation.
+     * level of the triangulation, which is returned by the function
+     * CellAccessor::global_level_cell_index().
      */
     const std::weak_ptr<const Utilities::MPI::Partitioner>
     global_level_cell_index_partitioner(const unsigned int level) const;
diff --git a/include/deal.II/grid/tria_accessor.h b/include/deal.II/grid/tria_accessor.h
index 2d191f5dcd..6d8b32f152 100644
--- a/include/deal.II/grid/tria_accessor.h
+++ b/include/deal.II/grid/tria_accessor.h
@@ -3781,7 +3781,9 @@ public:
   /**
    * Return a globally unique index for a non-artificial level cell.
    *
-   * @note Similar to global_active_cell_index().
+   * @note Similar to global_active_cell_index(), with the difference
+   * that the cell-data vector has been set up with
+   * parallel::TriangulationBase::global_level_cell_index_partitioner().
    */
   types::global_cell_index
   global_level_cell_index() const;