TimeElapsedTerminationCondition

class plasmapy.simulation.particle_tracker.TimeElapsedTerminationCondition(termination_time: Quantity)[source]

Termination condition corresponding to the elapsed time of a ParticleTracker.

Attributes Summary

`is_finished`	Conclude the simulation if all particles have been tracked over the specified termination time.
`progress`	Return the current time step of the simulation.
`progress_description`	The time elapsed termination condition depends on elapsed time, therefore the relevant quantity is time remaining.
`require_synchronized_dt`	The elapsed time termination condition requires a synchronized step to stop all particles at the same time.
`total`	Return the total amount of time over which the particles are tracked.
`tracker`	Return the `ParticleTracker` object for this termination condition.
`units_string`	The units for the time elapsed condition have the units of seconds.

Attributes Documentation

is_finished: Conclude the simulation if all particles have been tracked over the specified termination time.

progress_description: The time elapsed termination condition depends on elapsed time, therefore the relevant quantity is time remaining.

require_synchronized_dt: The elapsed time termination condition requires a synchronized step to stop all particles at the same time.

total: Return the total amount of time over which the particles are tracked.

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

units_string: The units for the time elapsed condition have the units of seconds.