Framework Elements

SimFrame Elements Module

This module defines classes representing specific accelerator lattice elements, all of which inherit from frameworkElement. Each element has a function for creating strings or python objects representing that element for the codes supported, and is able to convert the generic keywords associated with that class to names that are understood by each code.

Classes:

• dipole: Dipole magnet.

• kicker: Kicker magnet.

• quadrupole: Quadrupole magnet.

• sextupole: Sextupole magnet.

• octupole: Octupole magnet.

• cavity: RF cavity.

• wakefield: Wakefield.

• rf_deflecting_cavity: RF deflecting cavity.

• solenoid: Solenoid magnet.

• aperture: Aperture.

• scatter: Scatter object.

• cleaner: Cleaner object.

• wall_current_monitor: Wall current monitor.

• integrated_current_transformer: Integrated current transformer.

• faraday_cup: Faraday cup.

• screen: Diagnostics screen.

• monitor: Monitor object.

• faraday_cup: Faraday cup.

• watch_point: Watch point.

• beam_position_monitor: Beam position monitor.

• bunch_length_monitor: Bunch length monitor.

• beam_arrival_monitor: Beam arrival monitor.

• collimator: Collimator.

• rcollimator: Rectangular collimator.

• apcontour: Contour.

• center: Center object.

• marker: Marker object.

• drift: Drift.

• shutter: Shutter.

• valve: Vacuum valve.

• bellows: Bellows.

• fel_modulator: FEL modulator.

• wiggler: Wiggler.

• gpt_ccs: GPT coordinate system.

• global_error: Global error object.

• charge: Bunch charge.