DoNotSaveSaveRoutine

class plasmapy.simulation.particle_tracker.save_routines.DoNotSaveSaveRoutine

Bases: AbstractSaveRoutine

The default save routine for the ParticleTracker class.

This save routine is a placeholder and will not save the state of the particle tracker.

Attributes Summary

require_synchronized_dt	The do not save save routine does not require a synchronized time step.
results	Return the results of the simulation.
save_now	The do not save save routine will never save by definition.
tracker	Return the ParticleTracker object for this stop condition.

Methods Summary

post_push_hook()	Function called after a push step.
save()	Save the current state of the simulation to memory.

Attributes Documentation

require_synchronized_dt

The do not save save routine does not require a synchronized time step.

results

Return the results of the simulation. The quantities returned depend on those defined in the body of the save routine.

save_now

The do not save save routine will never save by definition.

tracker

Return the ParticleTracker object for this stop condition.

Methods Documentation

post_push_hook() → None

Function called after a push step.

This function is responsible for handling two steps of save routine, namely:

• Deciding to save on the current time step

• How the simulation data is saved (i.e. to disk or memory)

save() → None

Save the current state of the simulation to memory.

If an output directory is specified then the state will also be saved to the disk.