AbstractTerminationCondition

class plasmapy.simulation.particle_tracker.termination_conditions.AbstractTerminationCondition

Bases: ABC

Abstract base class containing the necessary methods for a ParticleTracker termination condition.

Attributes Summary

is_finished	Return True if the simulation has finished.
progress	Return a number representing the progress of the simulation (compared to total).
progress_description	Return a small string describing the relevant quantity shown on the meter.
require_synchronized_dt	Return if this termination condition requires a synchronized time step.
total	Return a number representing the total number of steps in a simulation.
tracker	Return the ParticleTracker object for this termination condition.
units_string	Return a string representation of the units of total.

Attributes Documentation

is_finished

Return True if the simulation has finished.

progress

Return a number representing the progress of the simulation (compared to total). This number represents the numerator of the completion percentage.

progress_description

Return a small string describing the relevant quantity shown on the meter.

require_synchronized_dt

Return if this termination condition requires a synchronized time step.

total

Return a number representing the total number of steps in a simulation. This number represents the denominator of the completion percentage.

tracker

Return the ParticleTracker object for this termination condition.

units_string

Return a string representation of the units of total.