]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Clarify a comment for one of the particle generators. 14229/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Tue, 30 Aug 2022 03:22:42 +0000 (21:22 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Tue, 30 Aug 2022 03:22:42 +0000 (21:22 -0600)
include/deal.II/particles/generators.h

index 041c18825d2b72eabc36aa977ad700902e3cd398..3429ea7d771615005e36558b8c61b6fd8b918207 100644 (file)
@@ -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.

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.