Kicker#

class georges.manzoni.elements.Kicker(name: str = '', integrator: ~georges.manzoni.integrators.IntegratorType = <class 'georges.manzoni.integrators.MadXIntegrator'>, *params, **kwargs)[source]#

Bases: Magnet

Define a Kicker element.

PARAMETERS#

Dictionary containing the parameters of the Kicker with their default values.

Type:: dict

Examples

>>> k1 = Kicker('K1', L=10*_ureg.cm, HKICK=0.1, VKICK=-0.2)
>>> k1 
    Kicker: {'NAME': 'K1',
             'AT_ENTRY': <Quantity(0, 'meter')>,
             'AT_CENTER': <Quantity(0, 'meter')>,
             'AT_EXIT': <Quantity(0, 'meter')>,
             'APERTYPE': None, 'APERTURE': [],
             'KINEMATICS': None,
             'L': <Quantity(10, 'centimeter')>,
             'HKICK': 0.1,
             'VKICK': -0.2,
             'TILT': <Quantity(0.0, 'radian')>}

Command attributes

NAME=''

Primary label for the Manzoni command (default: auto-generated hash).

Type:: str

AT_ENTRY='0 meter'

Entrance position of the element.

Type:: Quantity

AT_CENTER='0 meter'

Entrance position of the element.

Type:: Quantity

AT_EXIT='0 meter'

Exit position of the element.

Type:: Quantity

APERTYPE='None'

Aperture type (CIRCULAR, ELLIPTICAL, RECTANGULAR or PHASE_SPACE)

Type:: NoneType

APERTURE='[]'

Type:: list

KINEMATICS='None'

Reference kinematics

Type:: NoneType

L='0.0 meter'

Kicker length.

Type:: Quantity

HKICK='0.0'

The momentum change in the horizontal plane.

Type:: float

VKICK='0.0'

The momentum change in the vertical plane.

Type:: float

TILT='0.0 radian'

The roll angle about the longitudinal axis. A positive angle represents a clockwise rotation of the kicker

Type:: Quantity

Default initializer for all Commands.

Attributes Summary

`PARAMETERS`	Parameters of the element, with their default value and their descriptions.
`parameters`

Attributes Documentation

PARAMETERS: dict = {'APERTURE': ([], ''), 'APERTYPE': (None, 'Aperture type (CIRCULAR, ELLIPTICAL, RECTANGULAR or PHASE_SPACE)'), 'AT_CENTER': (<Quantity(0, 'meter')>, 'Entrance position of the element.'), 'AT_ENTRY': (<Quantity(0, 'meter')>, 'Entrance position of the element.'), 'AT_EXIT': (<Quantity(0, 'meter')>, 'Exit position of the element.'), 'HKICK': (0.0, 'The momentum change in the horizontal plane.'), 'KINEMATICS': (None, 'Reference kinematics'), 'L': (<Quantity(0.0, 'meter')>, 'Kicker length.'), 'NAME': ('', 'Primary label for the Manzoni command (default: auto-generated hash).'), 'TILT': (<Quantity(0.0, 'radian')>, 'The roll angle about the longitudinal axis. A positive angle represents a clockwise rotation of the kicker'), 'VKICK': (0.0, 'The momentum change in the vertical plane.')}#: Parameters of the element, with their default value and their descriptions.

parameters#