AllParticlesOffGridTerminationCondition

class plasmapy.simulation.particle_tracker.termination_conditions.AllParticlesOffGridTerminationCondition(fraction_exited_threshold: float = 0.99)[source]

Bases: AbstractTerminationCondition

Termination condition corresponding to stopping the simulation when a specified proportion of particles have entered and exited the grids.

Parameters:: fraction_exited_threshold (float, optional) – The fraction of particles that must leave the grids to terminate the simulation. This does not include particles that have never entered the grids.

Attributes Summary

`is_finished`	Check to see if the proportion of particles that have entered and exited the grid meet thresholds.
`progress`	The progress of the simulation is defined in the context of how many particles are on the grids.
`progress_description`	The termination condition tracks the number of particles remaining in the grids.
`require_synchronized_dt`	The termination condition does not require a synchronized time step.
`total`	The progress of the simulation is compared to the number of particles tracked.
`tracker`	Return the `ParticleTracker` object for this termination condition.
`units_string`	The termination condition tracks particles.

Attributes Documentation

is_finished: Check to see if the proportion of particles that have entered and exited the grid meet thresholds.

progress: The progress of the simulation is defined in the context of how many particles are on the grids.

progress_description: The termination condition tracks the number of particles remaining in the grids.

require_synchronized_dt: The termination condition does not require a synchronized time step.

total: The progress of the simulation is compared to the number of particles tracked.

tracker: Return the ParticleTracker object for this termination condition.

units_string: The termination condition tracks particles.