gtsimulation.pusher#

Particle trajectory pushers.

This subpackage provides numerical methods for advancing particle trajectories in electromagnetic fields.

class gtsimulation.pusher.BunemanBorisSimulator(Particles: Flux, Num: int, Step: float, Bfield: AbsBfield | None = None, Efield: GeneralFieldE | None = None, Medium: GTGeneralMedium | None = None, Region: Regions = Regions.Undefined, BreakCondition: dict | list | None = None, UseDecay: bool = False, InteractNUC: NuclearInteraction | None = None, RadLosses: bool | list = False, Date: datetime = datetime.datetime(2008, 1, 1, 0, 0), Save: int | list = 1, Nfiles: int | list = 1, Output: str | list | None = None, Verbose: int = 1, ForwardTrck=None, TrackParams=False, ParticleOrigin=False, IsFirstRun=True)[source]#

Relativistic Buneman-Boris particle pusher.

Advances the relativistic motion of charged particles in electric and magnetic fields using the Buneman-Boris scheme. The particle proper velocity is advanced through a symmetric splitting of the electric-field acceleration and magnetic-field rotation, followed by conversion to the ordinary velocity.

Notes

The Buneman-Boris pusher is based on the Boris particle-pushing scheme, which employs a time-reversible, leap-frog formulation to advance the particle motion. The time-reversible difference procedures used in the scheme are closely related to those introduced by Buneman [1], who considered, among other examples, the Lorentz equation and relativistic particle orbits. The relativistic formulation of the particle pusher was subsequently presented by Boris [2].

In a purely magnetic field, the magnetic part of the scheme corresponds to a rotation of the particle proper velocity and therefore preserves its magnitude exactly, so that the particle kinetic energy is conserved exactly apart from floating-point round-off.

The implementation used here follows the formulation given by Ripperda et al. [3], where the relativistic Boris pusher is described in a form suitable for numerical implementation.

References

[1]

Buneman, O. “Time-reversible difference procedures.” Journal of Computational Physics 1.4 (1967): 517-535.

[2]

Boris, J. P. “Relativistic plasma simulation — optimization of a hybrid code.” Proceedings of the 4th Conference on Numerical Simulation of Plasmas (1970): 3-67.

[3]

Ripperda, B., et al. “A Comprehensive Comparison of Relativistic Particle Integrators.” The Astrophysical Journal Supplement Series 235.1 (2018): 21.

AlgoStep(T, M, Q, V, X, H, E)[source]#
getFields(X)[source]#
class gtsimulation.pusher.HigueraCarySimulator(Particles: Flux, Num: int, Step: float, Bfield: AbsBfield | None = None, Efield: GeneralFieldE | None = None, Medium: GTGeneralMedium | None = None, Region: Regions = Regions.Undefined, BreakCondition: dict | list | None = None, UseDecay: bool = False, InteractNUC: NuclearInteraction | None = None, RadLosses: bool | list = False, Date: datetime = datetime.datetime(2008, 1, 1, 0, 0), Save: int | list = 1, Nfiles: int | list = 1, Output: str | list | None = None, Verbose: int = 1, ForwardTrck=None, TrackParams=False, ParticleOrigin=False, IsFirstRun=True)[source]#
AlgoStep(T, M, Q, V, X, H, E)[source]#
getFields(X)[source]#
class gtsimulation.pusher.RungeKutta4Simulator(Particles: Flux, Num: int, Step: float, Bfield: AbsBfield | None = None, Efield: GeneralFieldE | None = None, Medium: GTGeneralMedium | None = None, Region: Regions = Regions.Undefined, BreakCondition: dict | list | None = None, UseDecay: bool = False, InteractNUC: NuclearInteraction | None = None, RadLosses: bool | list = False, Date: datetime = datetime.datetime(2008, 1, 1, 0, 0), Save: int | list = 1, Nfiles: int | list = 1, Output: str | list | None = None, Verbose: int = 1, ForwardTrck=None, TrackParams=False, ParticleOrigin=False, IsFirstRun=True)[source]#
AlgoStep(T, M, Q, V, X, H, E)[source]#
getFields(X)[source]#
class gtsimulation.pusher.RungeKutta4SimulatorFast(Particles: Flux, Num: int, Step: float, Bfield: AbsBfield | None = None, Efield: GeneralFieldE | None = None, Medium: GTGeneralMedium | None = None, Region: Regions = Regions.Undefined, BreakCondition: dict | list | None = None, UseDecay: bool = False, InteractNUC: NuclearInteraction | None = None, RadLosses: bool | list = False, Date: datetime = datetime.datetime(2008, 1, 1, 0, 0), Save: int | list = 1, Nfiles: int | list = 1, Output: str | list | None = None, Verbose: int = 1, ForwardTrck=None, TrackParams=False, ParticleOrigin=False, IsFirstRun=True)[source]#
AlgoStep(T, M, Q, V, X, H, E)[source]#
class gtsimulation.pusher.RungeKutta6Simulator(Particles: Flux, Num: int, Step: float, Bfield: AbsBfield | None = None, Efield: GeneralFieldE | None = None, Medium: GTGeneralMedium | None = None, Region: Regions = Regions.Undefined, BreakCondition: dict | list | None = None, UseDecay: bool = False, InteractNUC: NuclearInteraction | None = None, RadLosses: bool | list = False, Date: datetime = datetime.datetime(2008, 1, 1, 0, 0), Save: int | list = 1, Nfiles: int | list = 1, Output: str | list | None = None, Verbose: int = 1, ForwardTrck=None, TrackParams=False, ParticleOrigin=False, IsFirstRun=True)[source]#
AlgoStep(T, M, Q, V, X, H, E)[source]#
getFields(X)[source]#
class gtsimulation.pusher.RungeKutta6SimulatorFast(Particles: Flux, Num: int, Step: float, Bfield: AbsBfield | None = None, Efield: GeneralFieldE | None = None, Medium: GTGeneralMedium | None = None, Region: Regions = Regions.Undefined, BreakCondition: dict | list | None = None, UseDecay: bool = False, InteractNUC: NuclearInteraction | None = None, RadLosses: bool | list = False, Date: datetime = datetime.datetime(2008, 1, 1, 0, 0), Save: int | list = 1, Nfiles: int | list = 1, Output: str | list | None = None, Verbose: int = 1, ForwardTrck=None, TrackParams=False, ParticleOrigin=False, IsFirstRun=True)[source]#
AlgoStep(T, M, Q, V, X, H, E)[source]#
class gtsimulation.pusher.VaySimulator(Particles: Flux, Num: int, Step: float, Bfield: AbsBfield | None = None, Efield: GeneralFieldE | None = None, Medium: GTGeneralMedium | None = None, Region: Regions = Regions.Undefined, BreakCondition: dict | list | None = None, UseDecay: bool = False, InteractNUC: NuclearInteraction | None = None, RadLosses: bool | list = False, Date: datetime = datetime.datetime(2008, 1, 1, 0, 0), Save: int | list = 1, Nfiles: int | list = 1, Output: str | list | None = None, Verbose: int = 1, ForwardTrck=None, TrackParams=False, ParticleOrigin=False, IsFirstRun=True)[source]#
AlgoStep(T, M, Q, V, X, H, E)[source]#
getFields(X)[source]#