simulation_output_factory module

Define a class to easily generate the SimulationOutput.

class SimulationOutputFactoryEnvelope3D(_is_3d, _is_multipart, _solver_id, _beam_kwargs, out_folder)

Bases: SimulationOutputFactory

A class for creating simulation outputs for Envelope3D.

Parameters:

• _is_3d (bool)

• _is_multipart (bool)

• _solver_id (str)

• _beam_kwargs (BeamKwargs)

• out_folder (Path)

out_folder: Path

__post_init__()

Create the factories.

The created factories are TransferMatrixFactory and BeamParametersFactory. The sub-class that is used is declared in _transfer_matrix_factory_class() and _beam_parameters_factory_class().

Return type:

None

property _transfer_matrix_factory_class: ABCMeta

Give the class of the transfer matrix factory.

property _beam_parameters_factory_class: ABCMeta

Give the class of the beam parameters factory.

run(elts, single_elts_results, set_of_cavity_settings)

Transform the outputs of BeamCalculator to a SimulationOutput.

Todo

Patch in transfer matrix to get proper input transfer matrix. In future, input beam will not hold transf mat in anymore.

Parameters:

• elts (ListOfElements)

• single_elts_results (list[dict])

• set_of_cavity_settings (SetOfCavitySettings)

Return type:

SimulationOutput

__init__(_is_3d, _is_multipart, _solver_id, _beam_kwargs, out_folder)

Parameters:

• _is_3d (bool)

• _is_multipart (bool)

• _solver_id (str)

• _beam_kwargs (BeamKwargs)

• out_folder (Path)

_abc_impl = <_abc._abc_data object at 0x7feea8480300>