]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Clarify documentation.
authorWolfgang Bangerth <bangerth@colostate.edu>
Thu, 12 Sep 2024 23:09:35 +0000 (17:09 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Thu, 12 Sep 2024 23:15:48 +0000 (17:15 -0600)
include/deal.II/base/mpi_compute_index_owner_internal.h

index e95096ca924111e1000aa6be9bde149fbffe5be2..2d64269164d1d3d049dcaab9e68d0997ae40fe42 100644 (file)
@@ -346,8 +346,14 @@ namespace Utilities
            * the consensus algorithm back to the owner in the original
            * IndexSet. This requires some point-to-point communication.
            *
-           * @return Map of processors and associated ranges of indices that
-           *         are requested from the current rank
+           * @return Map of processors and associated sets of indices
+           *         that are requested from the current rank. In
+           *         other words, this function returns for each rank
+           *         that has requested information about indices
+           *         owned by the current which indices it has
+           *         requested about; the values of the map are
+           *         therefore all subsets of the owned set of
+           *         indices.
            */
           std::map<unsigned int, IndexSet>
           get_requesters();

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.