Solenoid

class zgoubidoo.commands.magnetique.Solenoid(label1: str = '', label2: str = '', *params, **kwargs)

Bases: zgoubidoo.commands.magnetique.CartesianMagnet

Solenoid.

Zgoubi manual description

The solenoidal m􏰛agnet has an effective length XL, a mean radius R0 and an asymptotic field B0 = μ0 NI/XL, wherein BX is the longitudinal field component, and NI the number of Ampere-Turns.

The distance of ray-tracing beyond the effective length XL, is XE at the entrance, and XS at the exit.

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='black'

Magnet color for plotting.

Type

str

LENGTH_IS_ARC_LENGTH='False'

Type

bool

IL='0'

Print field and coordinates along trajectories

Type

int

XL='0 centimeter'

Magnet length

Type

Quantity

R0='1.0 centimeter'

Radius

Type

Quantity

B0='0 kilogauss'

Asymptotic field

Type

Quantity

XE='0 centimeter'

Entrance face integration zone for the fringe field

Type

Quantity

XS='0 centimeter'

Exit face integration zone for the fringe field

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

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 = 'SOLENOID'

Keyword of the command used for the Zgoubi input data.

PARAMETERS: dict = {'ALE': (<Quantity(0, 'radian')>,), '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).'), 'B0': (<Quantity(0, 'kilogauss')>, 'Asymptotic field'), 'COLOR': ('black', 'Magnet color for plotting.'), 'HEIGHT': (<Quantity(20, 'centimeter')>, 'Height of the magnet (distance between poles), used by plotting functions.'), 'IL': (0, 'Print field and coordinates along trajectories'), 'KINEMATICS': (None, 'A kinematics object.'), 'KPOS': (1, 'Misalignment type'), 'LABEL1': ('', 'Primary label for the Zgoubi command (default: auto-generated hash).'), 'LABEL2': ('', 'Secondary label for the Zgoubi command.'), 'LENGTH_IS_ARC_LENGTH': (False, ''), '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(1.0, 'centimeter')>, 'Radius'), 'REFERENCE_FIELD_COMPONENT': ('BZ', 'Orientation of the reference field (used by field maps)'), 'XCE': (<Quantity(0, 'centimeter')>, 'x offset'), 'XE': (<Quantity(0, 'centimeter')>, 'Entrance face integration zone for the fringe field'), 'XL': (<Quantity(0, 'centimeter')>, 'Magnet length'), 'XPAS': (<Quantity(0.1, 'centimeter')>, 'Integration step'), 'XS': (<Quantity(0, 'centimeter')>, 'Exit face integration zone for the fringe field'), 'YCE': (<Quantity(0, 'centimeter')>, 'y offset')}

Parameters of the command, with their default value, their description and optinally an index used by other commands (e.g. fit).