AGSQuadrupole¶

class zgoubidoo.commands.magnetique.AGSQuadrupole(label1: str = '', label2: str = '', *params, **kwargs)[source]¶

Bases: zgoubidoo.commands.magnetique.CartesianMagnet

AGS quadrupole.

Zgoubi manual description

The AGS quadrupoles are regular quadrupoles. The simulation of AGSQUAD uses the same field modelling as MULTIPOL, section 1.3.7, page 25. However amperes are provided as input to AGSQUAD rather than fields, the reason being that some of the AGS quadrupoles have two superimposed coil circuits, with separate power supplies. It has been dealt with this particularity by allowing for an additional set of multi- pole data in AGSQUAD, compared to MULTIPOL. The field in AGSQUAD is computed using transfer functions from the ampere-turns in the coils to magnetic field that account for the non-linearity of the magnetic permeability [33].

Command attributes

LABEL1=''

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

Type: str

LABEL2=''

Secondary label for the Zgoubi command.

Type: str

HEIGHT='20 centimeter'

Height of the magnet (distance between poles), used by plotting functions.

Type: Quantity

POLE_WIDTH='30 centimeter'

Pole width (used for plotting only).

Type: Quantity

PIPE_THICKNESS='2 centimeter'

Thickness of the pipe, used by plotting functions.

Type: Quantity

PIPE_COLOR='grey'

Color of the pipe, used by plotting functions.

Type: str

REFERENCE_FIELD_COMPONENT='BZ'

Orientation of the reference field (used by field maps)

Type: str

KINEMATICS='None'

A kinematics object.

Type: NoneType

APERTURE_LEFT='10 centimeter'

Aperture size of the magnet, left side (used for plotting only).

Type: Quantity

APERTURE_RIGHT='10 centimeter'

Aperture size of the magnet, right side (used for plotting only).

Type: Quantity

APERTURE_TOP='10 centimeter'

Aperture size of the magnet, top side (used for plotting only).

Type: Quantity

APERTURE_BOTTOM='10 centimeter'

Aperture size of the magnet, bottom side (used for plotting only).

Type: Quantity

COLOR='#FF0000'

Magnet color for plotting.

Type: str

LENGTH_IS_ARC_LENGTH='False'

Type: bool

IL='2'

Print field and coordinates along trajectories

Type: int

XL='10.0 centimeter'

Magnet length (straight reference frame)

Type: Quantity

R0='10.0 centimeter'

Radius of the pole tips

Type: Quantity

IW1='0 ampere'

Current in windings

Type: Quantity

IW2='0 ampere'

Current in windings

Type: Quantity

IW3='0 ampere'

Current in windings

Type: Quantity

dIW1='0'

Relative error on current

Type: int

dIW2='0'

Relative error on current

Type: int

dIW3='0'

Relative error on current

Type: int

X_E='0 centimeter'

Entrance face integration zone for the fringe field

Type: Quantity

LAM_E='0 centimeter'

Entrance face fringe field extent

Type: Quantity

NCE='0'

UNUSED

Type: int

C0_E='0'

Fringe field coefficient C0

Type: int

C1_E='1'

Fringe field coefficient C1

Type: int

C2_E='0'

Fringe field coefficient C2

Type: int

C3_E='0'

Fringe field coefficient C3

Type: int

C4_E='0'

Fringe field coefficient C4

Type: int

C5_E='0'

Fringe field coefficient C5

Type: int

X_S='0 centimeter'

Exit face integration zone for the fringe field

Type: Quantity

LAM_S='0 centimeter'

Exit face fringe field extent

Type: Quantity

NCS='0'

UNUSED

Type: int

C0_S='0'

Fringe field coefficient C0

Type: int

C1_S='1'

Fringe field coefficient C1

Type: int

C2_S='0'

Fringe field coefficient C2

Type: int

C3_S='0'

Fringe field coefficient C3

Type: int

C4_S='0'

Fringe field coefficient C4

Type: int

C5_S='0'

Fringe field coefficient C5

Type: int

R1='0 radian'

Roll angle

Type: Quantity

XPAS='0.1 centimeter'

Integration step

Type: Quantity

KPOS='1'

Misalignment type

Type: int

XCE='0 centimeter'

x offset

Type: Quantity

YCE='0 centimeter'

y offset

Type: Quantity

ALE='0 radian'

misalignment rotation

Type: Quantity

Default initializer for all Commands.

Attributes Summary

`KEYWORD`	Keyword of the command used for the Zgoubi input data.
`PARAMETERS`	Parameters of the command, with their default value, their description and optinally an index used by other commands (e.g.

Attributes Documentation

KEYWORD: str = 'AGSQUAD'¶: Keyword of the command used for the Zgoubi input data.

PARAMETERS: dict = {'ALE': (<Quantity(0, 'radian')>, 'misalignment rotation', 83), 'APERTURE_BOTTOM': (<Quantity(10, 'centimeter')>, 'Aperture size of the magnet, bottom side (used for plotting only).'), 'APERTURE_LEFT': (<Quantity(10, 'centimeter')>, 'Aperture size of the magnet, left side (used for plotting only).'), 'APERTURE_RIGHT': (<Quantity(10, 'centimeter')>, 'Aperture size of the magnet, right side (used for plotting only).'), 'APERTURE_TOP': (<Quantity(10, 'centimeter')>, 'Aperture size of the magnet, top side (used for plotting only).'), 'C0_E': (0, 'Fringe field coefficient C0', 31), 'C0_S': (0, 'Fringe field coefficient C0', 51), 'C1_E': (1, 'Fringe field coefficient C1', 32), 'C1_S': (1, 'Fringe field coefficient C1', 52), 'C2_E': (0, 'Fringe field coefficient C2', 33), 'C2_S': (0, 'Fringe field coefficient C2', 53), 'C3_E': (0, 'Fringe field coefficient C3', 34), 'C3_S': (0, 'Fringe field coefficient C3', 54), 'C4_E': (0, 'Fringe field coefficient C4', 35), 'C4_S': (0, 'Fringe field coefficient C4', 55), 'C5_E': (0, 'Fringe field coefficient C5', 36), 'C5_S': (0, 'Fringe field coefficient C5', 56), 'COLOR': ('#FF0000', 'Magnet color for plotting.'), 'HEIGHT': (<Quantity(20, 'centimeter')>, 'Height of the magnet (distance between poles), used by plotting functions.'), 'IL': (2, 'Print field and coordinates along trajectories', 1), 'IW1': (<Quantity(0, 'ampere')>, 'Current in windings', 12), 'IW2': (<Quantity(0, 'ampere')>, 'Current in windings', 13), 'IW3': (<Quantity(0, 'ampere')>, 'Current in windings', 14), 'KINEMATICS': (None, 'A kinematics object.'), 'KPOS': (1, 'Misalignment type', 80), 'LABEL1': ('', 'Primary label for the Zgoubi command (default: auto-generated hash).'), 'LABEL2': ('', 'Secondary label for the Zgoubi command.'), 'LAM_E': (<Quantity(0, 'centimeter')>, 'Entrance face fringe field extent', 21), 'LAM_S': (<Quantity(0, 'centimeter')>, 'Exit face fringe field extent', 41), 'LENGTH_IS_ARC_LENGTH': (False, ''), 'NCE': (0, 'UNUSED', 30), 'NCS': (0, 'UNUSED', 50), 'PIPE_COLOR': ('grey', 'Color of the pipe, used by plotting functions.'), 'PIPE_THICKNESS': (<Quantity(2, 'centimeter')>, 'Thickness of the pipe, used by plotting functions.'), 'POLE_WIDTH': (<Quantity(30, 'centimeter')>, 'Pole width (used for plotting only).'), 'R0': (<Quantity(10.0, 'centimeter')>, 'Radius of the pole tips', 11), 'R1': (<Quantity(0, 'radian')>, 'Roll angle', 60), 'REFERENCE_FIELD_COMPONENT': ('BZ', 'Orientation of the reference field (used by field maps)'), 'XCE': (<Quantity(0, 'centimeter')>, 'x offset', 81), 'XL': (<Quantity(10.0, 'centimeter')>, 'Magnet length (straight reference frame)', 10), 'XPAS': (<Quantity(0.1, 'centimeter')>, 'Integration step', 70), 'X_E': (<Quantity(0, 'centimeter')>, 'Entrance face integration zone for the fringe field', 20), 'X_S': (<Quantity(0, 'centimeter')>, 'Exit face integration zone for the fringe field', 40), 'YCE': (<Quantity(0, 'centimeter')>, 'y offset', 82), 'dIW1': (0, 'Relative error on current', 15), 'dIW2': (0, 'Relative error on current', 16), 'dIW3': (0, 'Relative error on current', 17)}¶: Parameters of the command, with their default value, their description and optinally an index used by other commands (e.g. fit).