The Particle class

The Particle class is top-level class in KENV. It contains all the particle data.

class kenv.beam.Particle(*, x: float = 0.0, y: float = 0.0, xp: float = 0.0, yp: float = 0.0, energy: float = 0.0, larmor_angle: float = 0.0)[source]

Initialization of a particle.

Parameters
  • x (float) – Position of the x-axis, [m]

  • y (float) – Position of the y-axis, [m]

  • xp (float) – Angle of the x-axis, [rad]

  • yp (float) – Angle of the y-axis, [rad]

  • energy (float) – Energy, [MeV]

  • larmor_angle (float) – Larmor angle, [rad]