accelerator module

Define Accelerator, the highest-level class of LightWin.

It holds, well… an accelerator. This accelerator has a ListOfElements. For each BeamCalculator defined, it has a SimulationOutput stored in Accelerator.simulation_outputs. Additionally, it has a ParticleInitialState, which describes energy, phase, etc of the beam at the entry of its ListOfElements.

class Accelerator(name, status, dat_file, accelerator_path, list_of_elements_factory, e_mev, sigma, pickle_path=None, index=0, **kwargs)[source]

Bases: object

Class holding a ListOfElements.

Parameters:

name (str)
status (Literal['reference', 'broken', 'fix'])
dat_file (Path)
accelerator_path (Path)
list_of_elements_factory (ListOfElementsFactory)
e_mev (float)
sigma (ndarray[tuple[Any, ...], dtype[double]])
pickle_path (Path | None, default: None)
index (int, default: 0)

__init__(name, status, dat_file, accelerator_path, list_of_elements_factory, e_mev, sigma, pickle_path=None, index=0, **kwargs)[source]

Create object.

Parameters:

name (str) – Name of the accelerator, used in plots.
status (Literal['reference', 'broken', 'fix']) – Current status design.
dat_file (Path) – Absolute path to the linac DAT file.
accelerator_path (Path) – Absolute path where results for each BeamCalculator will be stored.
list_of_elements_factory (ListOfElementsFactory) – A factory to create the list of elements.
e_mev (float) – Initial beam energy in \(\mathrm{MeV}\).
sigma (ndarray[tuple[Any, ...], dtype[double]]) – Initial beam \(\sigma\) matrix in \(\mathrm{m}\) and \(\mathrm{rad}\).
pickle_path (Path | None, default: None) – Where to pickle object. Used in keep().
index (int, default: 0) – Corresponding FaultScenario index. A null index is reserved for reference accelerator.

Return type:

None

name: Name for the object. The default will be "Reference" or "Solution". If object is unpickled, the name will be taken from the TOML configuration dictionary.

index: Corresponding FaultScenario index. A null index is reserved for reference accelerator.

simulation_outputs: dict[str, SimulationOutput]: Every SimulationOutput instance, associated with the name of the BeamCalculator that created it. This dictionary is filled by keep().

accelerator_path: Absolute path where results for each BeamCalculator will be stored. Typically, this is a 000001/-like folder.

elts: ListOfElements: The list of elements contained in the accelerator.

_is_unpickled: bool: Internal variable telling if this instance was create by unpickling a PKL file.

_pickle_path: Path | None: If set, keep() will also pickle current instance

__str__()[source]

Return str(self).

Return type:: str

property id: str

Produce a unique identifier for current object.

It is the concatenation of index and name:

000000_Reference        # Default for reference
000001_Solution         # Default for broken/fixed of first failure
000001_AnotherSolution  # Can be created by unpickling

property l_cav: Shortcut to easily get list of cavities.

property is_unpickled: bool

Tell if current object was created by unpickling a PKL file.

If this flag is True, the main consequence is that the BeamCalculator instances will not re-create new SimulationOutput, and instead return the ones that should already be in simulation_outputs.