From 06ad643464e111155804da348e9019a30422111a Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Tue, 23 Jun 2020 15:16:30 -0600 Subject: [PATCH] Augment documentation for particles. --- include/deal.II/particles/particle.h | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/include/deal.II/particles/particle.h b/include/deal.II/particles/particle.h index 9208c9ef94..7e7e0848eb 100644 --- a/include/deal.II/particles/particle.h +++ b/include/deal.II/particles/particle.h @@ -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. */ -- 2.39.5