]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Augment documentation for particles. 10586/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Tue, 23 Jun 2020 21:16:30 +0000 (15:16 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Wed, 24 Jun 2020 02:26:55 +0000 (20:26 -0600)
include/deal.II/particles/particle.h

index 9208c9ef941810a8f5e52ff752aedbfc7eb4671d..7e7e0848eb6a0ad44cc19b0585c900a3d44cbec8 100644 (file)
@@ -268,13 +268,27 @@ namespace Particles
     get_reference_location() const;
 
     /**
-     * Return the ID number of this particle.
+     * Return the ID number of this particle. The ID of a particle is intended
+     * to be a property that is globally unique even in parallel computations
+     * and is transfered along with other properties of a particle if it
+     * moves from a cell owned by the current processor to a cell owned by
+     * a different processor, or if ownership of the cell it is on is
+     * transferred to a different processor.
      */
     types::particle_index
     get_id() const;
 
     /**
-     * Set the ID number of this particle.
+     * Set the ID number of this particle. The ID of a particle is intended
+     * to be a property that is globally unique even in parallel computations
+     * and is transfered along with other properties of a particle if it
+     * moves from a cell owned by the current processor to a cell owned by
+     * a different processor, or if ownership of the cell it is on is
+     * transferred to a different processor. As a consequence, when setting
+     * the ID of a particle, care needs to be taken to ensure that particles
+     * have globally unique IDs. (The ParticleHandler does not itself check
+     * whether particle IDs so set are globally unique in a parallel setting
+     * since this would be a very expensive operation.)
      *
      * @param[in] new_id The new ID number for this particle.
      */

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.