element_envelope3d_parameters_factory module

Create the solver parameters for Envelope3D.

PARAMETERS_3D = {   <class 'lightwin.core.elements.quad.Quad'>: <class 'lightwin.beam_calculation.envelope_3d.element_envelope3d_parameters.QuadEnvelope3DParameters'>,     <class 'lightwin.core.elements.solenoid.Solenoid'>: <class 'lightwin.beam_calculation.envelope_3d.element_envelope3d_parameters.SolenoidEnvelope3DParameters'>,     <class 'lightwin.core.elements.bend.Bend'>: <class 'lightwin.beam_calculation.envelope_3d.element_envelope3d_parameters.BendEnvelope3DParameters'>,     <class 'lightwin.core.elements.diagnostic.Diagnostic'>: <class 'lightwin.beam_calculation.envelope_3d.element_envelope3d_parameters.DriftEnvelope3DParameters'>,     <class 'lightwin.core.elements.drift.Drift'>: <class 'lightwin.beam_calculation.envelope_3d.element_envelope3d_parameters.DriftEnvelope3DParameters'>,     <class 'lightwin.core.elements.field_maps.field_map.FieldMap'>: <class 'lightwin.beam_calculation.envelope_3d.element_envelope3d_parameters.FieldMapEnvelope3DParameters'>}

Implemented elements; a non-implemented element will be replaced by a Drift. A warning will be raised.

class ElementEnvelope3DParametersFactory(method, n_steps_per_cell, solver_id, beam_kwargs, phi_s_definition='historical')[source]

Bases: ElementBeamCalculatorParametersFactory

Define a method to easily create the solver parameters.

Parameters:

  • method (Literal['RK4'])

  • n_steps_per_cell (int)

  • solver_id (str)

  • beam_kwargs (BeamKwargs)

  • phi_s_definition (Literal['historical', 'lagniel'], default: 'historical')

__init__(method, n_steps_per_cell, solver_id, beam_kwargs, phi_s_definition='historical')[source]

Prepare import of proper functions.

Parameters:

  • method (Literal['RK4'])

  • n_steps_per_cell (int)

  • solver_id (str)

  • beam_kwargs (BeamKwargs)

  • phi_s_definition (Literal['historical', 'lagniel'], default: 'historical')

Return type:

None

run(elt)[source]

Create the proper subclass of solver parameters, instantiate it.

Parameters:

elt (Element) – Element under study.

Returns:

Proper instantiated subclass of ElementEnvelope3DParameters.

Return type:

ElementEnvelope3DParameters

_parameters_constructor(elt, default=<class 'lightwin.beam_calculation.envelope_3d.element_envelope3d_parameters.DriftEnvelope3DParameters'>)[source]

Get the proper object constructor.

Examples

>>> self._parameters_constructor(Drift())
DriftEnvelope3DParameters

>>> self._parameters_constructor(Quad())
QuadEnvelope3DParameters

As DiagPosition is not in PARAMETERS_3D, we look for the mother class Diagnostic.

>>> self._parameters_constructor(DiagPosition())
DriftEnvelope3DParameters

To avoid wasting computation time, non-accelerating field maps are treated as drifts.

>>> self._parameters_constructor(FieldMap100(is_accelerating=False))
DriftEnvelope3DParameters
Parameters:

  • elt (Element)

  • default (type, default: <class 'lightwin.beam_calculation.envelope_3d.element_envelope3d_parameters.DriftEnvelope3DParameters'>)

Return type:

type

_abc_impl = <_abc._abc_data object at 0x7318fc805880>