element_envelope1d_parameters_factory module

Create the solver parameters for Envelope1D.

class ElementEnvelope1DParametersFactory(method: Literal['RK4', 'leapfrog'], n_steps_per_cell: int, solver_id: str, beam_kwargs: dict[str, Any], phi_s_definition: Literal['historical', 'lagniel'] = 'historical')

Bases: ElementBeamCalculatorParametersFactory

Define a method to easily create the solver parameters.

parameters = {   <class 'lightwin.core.elements.field_maps.field_map.FieldMap'>: <class 'lightwin.beam_calculation.envelope_1d.element_envelope1d_parameters.FieldMapEnvelope1DParameters'>,     <class 'lightwin.core.elements.field_maps.superposed_field_map.SuperposedFieldMap'>: <class 'lightwin.beam_calculation.envelope_1d.element_envelope1d_parameters.SuperposedFieldMapEnvelope1DParameters'>,     <class 'lightwin.core.elements.aperture.Aperture'>: <class 'lightwin.beam_calculation.envelope_1d.element_envelope1d_parameters.DriftEnvelope1DParameters'>,     <class 'lightwin.core.elements.bend.Bend'>: <class 'lightwin.beam_calculation.envelope_1d.element_envelope1d_parameters.BendEnvelope1DParameters'>,     <class 'lightwin.core.elements.diagnostic.Diagnostic'>: <class 'lightwin.beam_calculation.envelope_1d.element_envelope1d_parameters.DriftEnvelope1DParameters'>,     <class 'lightwin.core.elements.drift.Drift'>: <class 'lightwin.beam_calculation.envelope_1d.element_envelope1d_parameters.DriftEnvelope1DParameters'>,     <class 'lightwin.core.elements.edge.Edge'>: <class 'lightwin.beam_calculation.envelope_1d.element_envelope1d_parameters.DriftEnvelope1DParameters'>,     <class 'lightwin.core.elements.quad.Quad'>: <class 'lightwin.beam_calculation.envelope_1d.element_envelope1d_parameters.DriftEnvelope1DParameters'>,     <class 'lightwin.core.elements.solenoid.Solenoid'>: <class 'lightwin.beam_calculation.envelope_1d.element_envelope1d_parameters.DriftEnvelope1DParameters'>}

__init__(method: Literal['RK4', 'leapfrog'], n_steps_per_cell: int, solver_id: str, beam_kwargs: dict[str, Any], phi_s_definition: Literal['historical', 'lagniel'] = 'historical') → None

Prepare import of proper functions.

run(elt: Element) → ElementEnvelope1DParameters

Create the proper subclass of solver parameters, instantiate it.

Note

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

Parameters:

elt (Element) – Element under study.

Returns:

Proper instantiated subclass of ElementEnvelope1DParameters.

Return type:

ElementEnvelope1DParameters

See also

_parameters_constructor

_parameters_constructor(elt: Element) → 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, 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

_abc_impl = <_abc._abc_data object at 0x7f36f93c3180>