PS170

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

Bases: zgoubidoo.commands.magnetique.Magnet

Simulation of a round shape dipole magnet.

TODO

Examples

>>> PS170('PS170', IL=2, XL=2 * _ureg.m, R0 = 1.5 * _ureg.m, B0 = 1 * _ureg.tesla)

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

IL='0'

print field and coordinates along trajectories

Type

int

XL='1 meter'

Length of the element

Type

Quantity

R0='1 meter'

, radius of the circular dipole

Type

Quantity

B0='0 tesla'

field

Type

Quantity

XPAS='1.0 millimeter'

Integration step

Type

Quantity

XCE='0 centimeter'
Type

Quantity

YCE='0 centimeter'
Type

Quantity

ALE='0 degree'
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 = 'PS170'

Keyword of the command used for the Zgoubi input data.

PARAMETERS: dict = {'ALE': (<Quantity(0, 'degree')>, ''), 'B0': (<Quantity(0, 'tesla')>, 'field'), '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': (0,), 'LABEL1': ('', 'Primary label for the Zgoubi command (default: auto-generated hash).'), 'LABEL2': ('', 'Secondary label for the Zgoubi command.'), '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, 'meter')>, ', radius of the circular dipole'), 'REFERENCE_FIELD_COMPONENT': ('BZ', 'Orientation of the reference field (used by field maps)'), 'XCE': (<Quantity(0, 'centimeter')>, ''), 'XL': (<Quantity(1, 'meter')>, 'Length of the element'), 'XPAS': (<Quantity(1.0, 'millimeter')>, 'Integration step'), 'YCE': (<Quantity(0, 'centimeter')>, '')}

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