Gap#

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

Bases: ManzoniElement

Define a gap where no physical geometry is placed

PARAMETERS#

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

Type:

dict

Examples

>>> g1 = Gap('G1', L=1*_ureg.m)
>>> g1 
    Gap: {'NAME': 'G1',
    'AT_ENTRY': <Quantity(0, 'meter')>,
    'AT_CENTER': <Quantity(0, 'meter')>,
    'AT_EXIT': <Quantity(0, 'meter')>,
    'L': <Quantity(1, 'meter')>,
    'APERTYPE': None,
    'APERTURE': []}

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

L='0.0 meter'

Drift length.

Type:

Quantity

APERTYPE='None'

Aperture type (CIRCULAR, ELLIPTICAL, RECTANGULAR or PHASE_SPACE)

Type:

NoneType

APERTURE='[]'
Type:

list

Default initializer for all Commands.

Attributes Summary

PARAMETERS

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

parameters

Methods Summary

propagate(beam_in[, beam_out, global_parameters])

param beam:

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.'), 'L': (<Quantity(0.0, 'meter')>, 'Drift length.'), 'NAME': ('', 'Primary label for the Manzoni command (default: auto-generated hash).')}#

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

parameters#

Methods Documentation

propagate(beam_in: ndarray, beam_out: ndarray | None = None, global_parameters: list | None = None) Tuple[ndarray, ndarray][source]#
Parameters:
  • beam

  • out

  • global_parameters

Returns: