NoParticlesOnGridsTerminationCondition
- class plasmapy.simulation.particle_tracker.NoParticlesOnGridsTerminationCondition[source]
Bases:
AbstractTerminationCondition
Termination condition corresponding to stopping the simulation when all particles have exited the grid.
Attributes Summary
The simulation is finished when no more particles are on any grids.
The progress of the simulation is measured by how many particles are no longer on a grid.
The progress meter is described in terms of the fraction of particles still on the grid.
The no field termination condition does not require a synchronized time step.
The progress of the simulation is measured against the total number of particles in the simulation.
Return the
ParticleTracker
object for this termination condition.The progress meter is described in terms of the fraction of particles still on the grid.
Attributes Documentation
- is_finished
The simulation is finished when no more particles are on any grids.
- progress
The progress of the simulation is measured by how many particles are no longer on a grid.
- progress_description
The progress meter is described in terms of the fraction of particles still on the grid.
- require_synchronized_dt
The no field termination condition does not require a synchronized time step.
- total
The progress of the simulation is measured against the total number of particles in the simulation.
- tracker
Return the
ParticleTracker
object for this termination condition.
- units_string
The progress meter is described in terms of the fraction of particles still on the grid.