Elements

The elements submodule contains the physical implementation of the different beamline elements, namely:

• Drifts

• Dipoles

• Quadrupoles

• Sextupoles

• Multipoles (magnets with a combined dipolar, quadrupolar and sextupolar function),

• Collimators (rectangular, circular and elliptical);

• Scatterers

  thin materials that interact with the particles and only modify the transverse angle along the two transverse axes

• Degraders

  thick materials which combine particle interaction with a simple drift type propagation along the material

Classes

BeamStop(name, integrator, *params, **kwargs)	Define a BeamStop.
Bend(name, integrator, *params, **kwargs)	Define a Bend magnet.
CircularCollimator(name, integrator, ...)	Define a CircularCollimator.
Collimator(name, integrator, *params, **kwargs)	Define a Collimator.
Degrader(name, integrator, *params, **kwargs)	Define a Degrader.
DipEdge(name, integrator, *params, **kwargs)	Define a DipEdge element.
Drift(name, integrator, *params, **kwargs)	Definition of a Drift.
Dump(name, integrator, *params, **kwargs)	Define a Dump.
EllipticalCollimator(name, integrator, ...)	Define an EllipticalCollimator.
Fringein(name, integrator, *params, **kwargs)	Define a Fringe field at the entrance of a bending magnet.
Fringeout(name, integrator, *params, **kwargs)	Define a Fringe field at the exit of a bending magnet.
Gap(name, integrator, *params, **kwargs)	Define a gap where no physical geometry is placed
HKicker(name, integrator, *params, **kwargs)	Define a HKicker element.
Kicker(name, integrator, *params, **kwargs)	Define a Kicker element.
ManzoniElement([name, integrator])	param name:
Marker(name, integrator, *params, **kwargs)	Define a Marker
Matrix(name, integrator, *params, **kwargs)	Define a Matrix element.
Multipole(name, integrator, *params, **kwargs)	Define a Multipole magnet.
Quadrupole(name, integrator, *params, **kwargs)	Define a Quadrupole magnet.
RBend(name, integrator, *params, **kwargs)	Definition of a RBend
RectangularCollimator(name, integrator, ...)	Define a RectangularCollimator.
SBend(name, integrator, *params, **kwargs)	Definition of a SBend
SRotation(name, integrator, *params, **kwargs)	Definition of a SRotation.
Scatterer(name, integrator, *params, **kwargs)	Define a Scatterer.
Sextupole(name, integrator, *params, **kwargs)	Define a Sextupole magnet.
TKicker(name, integrator, *params, **kwargs)	Default initializer for all Commands.
VKicker(name, integrator, *params, **kwargs)	Define a VKicker element.

Class Inheritance Diagram