AbstractIntegrator

class plasmapy.simulation.particle_integrators.AbstractIntegrator[source]

Bases: ABC

Outlines the necessary methods to define a particle integrator.

Attributes Summary

Property representing whether an integrator incorporates relativistic corrections.

Methods Summary

push(x, v, B, E, q, m, dt)

The method for applying a push to the specified ensemble of particles.

Attributes Documentation

is_relativistic: Property representing whether an integrator incorporates relativistic corrections.

Methods Documentation

abstractmethod static push(x, v, B, E, q, m, dt)[source]

The method for applying a push to the specified ensemble of particles.

The passed parameters should in general not be Quantity objects, but rather their SI values. Specific user implementations may vary.