beam_calculation.envelope_1d.element_envelope1d_parameters_factory module

Create the solver parameters for Envelope1D.

class ElementEnvelope1DParametersFactory(method: Literal['leapfrog', 'RK4'], n_steps_per_cell: int, solver_id: str, flag_cython: bool = False, phi_s_definition: Literal['historical'] = 'historical')

Bases: ElementBeamCalculatorParametersFactory

Define a method to easily create the solver parameters.

__init__(method: Literal['leapfrog', 'RK4'], n_steps_per_cell: int, solver_id: str, flag_cython: bool = False, phi_s_definition: Literal['historical'] = 'historical') → None: Prepare import of proper functions.

_abc_impl = <_abc._abc_data object>

_parameters_constructor(elt: ~core.elements.element.Element, default: type = <class 'beam_calculation.envelope_1d.element_envelope1d_parameters.DriftEnvelope1DParameters'>) → type

Get the proper object constructor.

Examples

>>> self._parameters_constructor(Drift())
DriftEnvelope1DParameters

In 1D, a quadrupole is basically a drift.

>>> self._parameters_constructor(Quad())
DriftEnvelope1DParameters

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

>>> self._parameters_constructor(DiagPosition())
DriftEnvelope1DParameters

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

>>> self._parameters_constructor(FieldMap100(is_accelerating=False))
DriftEnvelope1DParameters

run(elt: Element) → ElementEnvelope1DParameters

Create the proper subclass of solver parameters, instantiate it.

Note

If an Element type is not found in PARAMETERS_1D, we take its mother type.

Parameters:: elt (Element) – Element under study.
Returns:: Proper instantiated subclass of ElementEnvelope1DParameters.
Return type:: ElementEnvelope1DParameters