Particle tracking simulations

Attention

This functionality is under development. Backward incompatible changes might occur in future releases.

Introduction

This module contains the ParticleTracker class, which is a simple particle stepper implementing the Boris algorithm.

This module is highly unstable and is expected to change a lot in the future.

API

Module containing the definition for the general particle tracker.

Classes

AbstractSaveRoutine([output_directory])

Abstract base class containing the necessary methods for a ParticleTracker save routine.

AbstractTerminationCondition()

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

DoNotSaveSaveRoutine()

The default save routine for the ParticleTracker class.

IntervalSaveRoutine(interval, **kwargs)

Abstract class describing a save routine that saves every given interval.

NoParticlesOnGridsTerminationCondition()

Termination condition corresponding to stopping the simulation when all particles have exited the grid.

ParticleTracker(grids[, ...])

A particle tracker for particles in electric and magnetic fields without inter-particle interactions.

TimeElapsedTerminationCondition(termination_time)

Termination condition corresponding to the elapsed time of a ParticleTracker.

Inheritance diagram of plasmapy.simulation.particle_tracker.AbstractSaveRoutine, plasmapy.simulation.particle_tracker.AbstractTerminationCondition, plasmapy.simulation.particle_tracker.DoNotSaveSaveRoutine, plasmapy.simulation.particle_tracker.IntervalSaveRoutine, plasmapy.simulation.particle_tracker.NoParticlesOnGridsTerminationCondition, plasmapy.simulation.particle_tracker.ParticleTracker, plasmapy.simulation.particle_tracker.TimeElapsedTerminationCondition