From 75508d014b8d40d4715a64c5a43fa4c2124193ee Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Mon, 29 Aug 2022 21:22:42 -0600 Subject: [PATCH] Clarify a comment for one of the particle generators. --- include/deal.II/particles/generators.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) 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. -- 2.39.5