From e904715ae0cf0465cef120403dab7b5ebd10d0b8 Mon Sep 17 00:00:00 2001 From: Luca Heltai Date: Wed, 10 Jun 2020 13:27:53 +0200 Subject: [PATCH] Document particle_lost in particle handler. --- include/deal.II/particles/particle_handler.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/include/deal.II/particles/particle_handler.h b/include/deal.II/particles/particle_handler.h index 136ec3a5d8..d4f2f447cc 100644 --- a/include/deal.II/particles/particle_handler.h +++ b/include/deal.II/particles/particle_handler.h @@ -557,6 +557,12 @@ namespace Particles * After this function call every particle is either on its current * process and in its current cell, or deleted (if it could not find * its new process or cell). + * + * The user may attach a function to the signal + * Particles::ParticleHandler::Signals::particle_lost(). The signal is + * triggered whenever a particle is deleted, and the connected functions + * are called passing an iterator to the particle in question, and its last + * known cell association. */ void sort_particles_into_subdomains_and_cells(); -- 2.39.5