From: Wolfgang Bangerth <bangerth@colostate.edu>
Date: Tue, 30 Aug 2022 03:22:42 +0000 (-0600)
Subject: Clarify a comment for one of the particle generators.
X-Git-Tag: v9.5.0-rc1~1003^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F14229%2Fhead;p=dealii.git

Clarify a comment for one of the particle generators.
---

diff --git a/include/deal.II/particles/generators.h b/include/deal.II/particles/generators.h
index 041c18825d..3429ea7d77 100644
--- a/include/deal.II/particles/generators.h
+++ b/include/deal.II/particles/generators.h
@@ -274,7 +274,10 @@ namespace Particles
      * @param[in] global_bounding_boxes A vector that contains all the bounding
      * boxes for all processors. This vector can be established by first using
      * 'GridTools::compute_mesh_predicate_bounding_box()' and gathering all the
-     * bounding boxes using 'Utilities::MPI::all_gather.
+     * bounding boxes using 'Utilities::MPI::all_gather. Of course, if you are
+     * applying this function on a sequential triangulation, then this argument
+     * is simply an (outer) vector with just one element, and that one element
+     * would be the result of the function mentioned above.
      *
      * @param[in,out] particle_handler The particle handler that will take
      * ownership of the generated particles.