Multipole#

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

Bases: Magnet

Define a Multipole magnet.

PARAMETERS#

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

Type:: dict

Examples

>>> m1 = Multipole('M1', L=10*_ureg.cm, K1=4*_ureg.m**-2, K2=0.1*_ureg.m**-3)
>>> m1 
    Multipole: {'NAME': 'M1',
                'AT_ENTRY': <Quantity(0, 'meter')>,
                'AT_CENTER': <Quantity(0, 'meter')>,
                'AT_EXIT': <Quantity(0, 'meter')>,
                'APERTYPE': None,
                'APERTURE': [],
                'KINEMATICS': None,
                'L': <Quantity(10, 'centimeter')>,
                'K1': <Quantity(4, '1 / meter ** 2')>,
                'K2': <Quantity(0.1, '1 / meter ** 3')>}

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'

Magnet length.

Type:: Quantity

K1='0.0 / meter ** 2'

Quadrupolar normalized gradient.

Type:: Quantity

K2='0.0 / meter ** 3'

Sextupolar normalized gradient.

Type:: Quantity

Default initializer for all Commands.

Attributes Summary

`PARAMETERS`	Parameters of the element, with their default value and their description .
`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.'), 'K1': (<Quantity(0.0, '1 / meter ** 2')>, 'Quadrupolar normalized gradient.'), 'K2': (<Quantity(0.0, '1 / meter ** 3')>, 'Sextupolar normalized gradient.'), 'KINEMATICS': (None, 'Reference kinematics'), 'L': (<Quantity(0.0, 'meter')>, 'Magnet length.'), 'NAME': ('', 'Primary label for the Manzoni command (default: auto-generated hash).')}#: Parameters of the element, with their default value and their description .

parameters#