Reference documentation for deal.II version GIT relicensing-1125-gadd8e16ae6 2024-07-19 10:00:01+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
No Matches
Public Attributes | List of all members
Particles::ParticleHandler< dim, spacedim >::Signals Struct Reference

#include <deal.II/particles/particle_handler.h>

Public Attributes

boost::signals2::signal< void(const typename Particles::ParticleIterator< dim, spacedim > &particle, const typename Triangulation< dim, spacedim >::active_cell_iterator &cell)> particle_lost

Detailed Description

template<int dim, int spacedim = dim>
struct Particles::ParticleHandler< dim, spacedim >::Signals

A structure that has boost::signal objects for a number of actions that a particle handler can do to itself. How signals can be used in applications is explained in the "Getting notice when a triangulation changes" section in the Triangulation class with more information and examples. In short these signals allow the particle handler to notify applications about certain events inside the particle handler, e.g. when a particle is lost.

For documentation on signals, see .

Definition at line 841 of file particle_handler.h.

Member Data Documentation

◆ particle_lost

template<int dim, int spacedim = dim>
boost::signals2::signal<void( const typename Particles::ParticleIterator<dim, spacedim> &particle, const typename Triangulation<dim, spacedim>::active_cell_iterator &cell)> Particles::ParticleHandler< dim, spacedim >::Signals::particle_lost

This signal is triggered whenever the ParticleHandler::sort_particles_into_subdomains_and_cells() function encounters a particle that can not be associated with a cell. This can happen if the particle leaves the domain of the triangulation, or if it leaves the locally known domain in a parallel triangulation (including the ghost cells for a parallel::distributed::triangulation).

The connected function receives an iterator to the particle in question, and its last known cell association.

This signal is used in step-19.

Definition at line 860 of file particle_handler.h.

The documentation for this struct was generated from the following file: