beam_calculation package
Compute propagation of beam in the linac.
BeamCalculator is an Abstract Base Class to hold such a solver.
Envelope1D, Envelope3D and TraceWin are the
implemented solvers inheriting from it. They can be created very easily using
the beam_calculation.factory module.
SimulationOutput is used to uniformly store simulation outputs with
all solvers.
In order to work, solvers rely on ElementBeamCalculatorParameters to
hold the meshing, etc.
Subpackages
- cy_envelope_1d package
- Submodules
- beam_parameters_factory module
- electromagnetic_fields module
- element_parameters module
- element_parameters_factory module
- envelope_1d module
- simulation_output_factory module
- specs module
- transfer_matrices module
- transfer_matrix_factory module
- util module
- Submodules
- envelope_1d package
- Submodules
- beam_parameters_factory module
- element_envelope1d_parameters module
ElementEnvelope1DParametersElementEnvelope1DParameters.__init__()ElementEnvelope1DParameters.set_absolute_meshes()ElementEnvelope1DParameters.re_set_for_broken_cavity()ElementEnvelope1DParameters.transfer_matrix_kw()ElementEnvelope1DParameters.transf_mat_function_wrapper()ElementEnvelope1DParameters._transfer_matrix_results_to_dict()ElementEnvelope1DParameters._proper_transfer_matrix_func()ElementEnvelope1DParameters._abc_impl
DriftEnvelope1DParametersFieldMapEnvelope1DParametersFieldMapEnvelope1DParameters.__init__()FieldMapEnvelope1DParameters.transfer_matrix_kw()FieldMapEnvelope1DParameters._transfer_matrix_results_to_dict()FieldMapEnvelope1DParameters.re_set_for_broken_cavity()FieldMapEnvelope1DParameters._broken_transfer_matrix_results_to_dict()FieldMapEnvelope1DParameters._broken_transfer_matrix_kw()FieldMapEnvelope1DParameters._abc_impl
_get_phi_0_rel()SuperposedFieldMapEnvelope1DParametersBendEnvelope1DParameters_add_cavities_phases()
- element_envelope1d_parameters_factory module
- envelope_1d module
Envelope1DEnvelope1D.flag_cythonEnvelope1D.__init__()Envelope1D._set_up_specific_factories()Envelope1D.alternative_run()Envelope1D.run()Envelope1D.run_with_this()Envelope1D.post_optimisation_run_with_this()Envelope1D.init_solver_parameters()Envelope1D.is_a_multiparticle_simulationEnvelope1D.is_a_3d_simulationEnvelope1D._post_treat_cavity_settings()Envelope1D._abc_impl
_store_entry_phase_in_settings()
- simulation_output_factory module
SimulationOutputFactoryEnvelope1DSimulationOutputFactoryEnvelope1D.out_folderSimulationOutputFactoryEnvelope1D.__post_init__()SimulationOutputFactoryEnvelope1D._transfer_matrix_factory_classSimulationOutputFactoryEnvelope1D._beam_parameters_factory_classSimulationOutputFactoryEnvelope1D.run()SimulationOutputFactoryEnvelope1D.__init__()SimulationOutputFactoryEnvelope1D._abc_impl
- specs module
- transfer_matrices module
- transfer_matrix_factory module
- util module
- Submodules
- envelope_3d package
- Submodules
- beam_parameters_factory module
- element_envelope3d_parameters module
ElementEnvelope3DParametersDriftEnvelope3DParametersQuadEnvelope3DParametersSolenoidEnvelope3DParametersFieldMapEnvelope3DParametersFieldMapEnvelope3DParameters.__init__()FieldMapEnvelope3DParameters.transfer_matrix_kw()FieldMapEnvelope3DParameters._transfer_matrix_results_to_dict()FieldMapEnvelope3DParameters.re_set_for_broken_cavity()FieldMapEnvelope3DParameters._broken_transfer_matrix_results_to_dict()FieldMapEnvelope3DParameters._broken_transfer_matrix_kw()FieldMapEnvelope3DParameters._abc_impl
BendEnvelope3DParameters_add_cavity_phase()
- element_envelope3d_parameters_factory module
- envelope_3d module
Envelope3DEnvelope3D.flag_cythonEnvelope3D.__init__()Envelope3D._set_up_specific_factories()Envelope3D.run()Envelope3D.run_with_this()Envelope3D.post_optimisation_run_with_this()Envelope3D.init_solver_parameters()Envelope3D.is_a_multiparticle_simulationEnvelope3D.is_a_3d_simulationEnvelope3D._compute_cavity_parameters()Envelope3D._abc_impl
_store_entry_phase_in_settings()
- simulation_output_factory module
SimulationOutputFactoryEnvelope3DSimulationOutputFactoryEnvelope3D.out_folderSimulationOutputFactoryEnvelope3D.__post_init__()SimulationOutputFactoryEnvelope3D._transfer_matrix_factory_classSimulationOutputFactoryEnvelope3D._beam_parameters_factory_classSimulationOutputFactoryEnvelope3D.run()SimulationOutputFactoryEnvelope3D.__init__()SimulationOutputFactoryEnvelope3D._abc_impl
- specs module
- transfer_matrices_p module
- transfer_matrix_factory module
- util module
- Submodules
- integrators package
- parameters package
- simulation_output package
- Submodules
- factory module
SimulationOutputFactorySimulationOutputFactory._is_3dSimulationOutputFactory._is_multipartSimulationOutputFactory._solver_idSimulationOutputFactory._beam_kwargsSimulationOutputFactory.__post_init__()SimulationOutputFactory._transfer_matrix_factory_classSimulationOutputFactory._beam_parameters_factory_classSimulationOutputFactory.run()SimulationOutputFactory._generate_element_to_index_func()SimulationOutputFactory.__init__()SimulationOutputFactory._abc_impl
_element_to_index()
- simulation_output module
SimulationOutputSimulationOutput.out_folderSimulationOutput.is_multiparticleSimulationOutput.is_3dSimulationOutput.synch_trajectorySimulationOutput.cav_paramsSimulationOutput.beam_parametersSimulationOutput.element_to_indexSimulationOutput.set_of_cavity_settingsSimulationOutput.transfer_matrixSimulationOutput.z_absSimulationOutput.in_tw_fashionSimulationOutput.r_zz_eltSimulationOutput.__post_init__()SimulationOutput.__str__()SimulationOutput.beam_calculatorSimulationOutput.is_referenceSimulationOutput.linac_idSimulationOutput.has()SimulationOutput.get()SimulationOutput.compute_indirect_quantities()SimulationOutput.pickle()SimulationOutput.from_pickle()SimulationOutput.plot()SimulationOutput.elts()SimulationOutput.__init__()
_to_deg()
- factory module
- Submodules
- tracewin package
- Submodules
- beam_parameters_factory module
- element_tracewin_parameters module
- element_tracewin_parameters_factory module
- machine_config_specs module
- simulation_output_factory module
_0_to_NaN()_remove_invalid_values()_load_results_generic()_set_energy_related_results()_set_phase_related_results()_remove_incomplete_line()_add_dummy_data()_load_parameters_of_cavities()_uniformize_parameters_of_cavities()SimulationOutputFactoryTraceWinSimulationOutputFactoryTraceWin.out_folderSimulationOutputFactoryTraceWin._filenameSimulationOutputFactoryTraceWin.beam_calc_parameters_factorySimulationOutputFactoryTraceWin.__post_init__()SimulationOutputFactoryTraceWin._transfer_matrix_factory_classSimulationOutputFactoryTraceWin._beam_parameters_factory_classSimulationOutputFactoryTraceWin.run()SimulationOutputFactoryTraceWin._create_main_results_dictionary()SimulationOutputFactoryTraceWin._save_tracewin_meshing_in_elements()SimulationOutputFactoryTraceWin._get_parameters_of_cavities()SimulationOutputFactoryTraceWin.__init__()SimulationOutputFactoryTraceWin._abc_impl
- specs module
- tracewin module
TraceWinTraceWin.__init__()TraceWin._set_up_specific_factories()TraceWin._tracewin_base_command()TraceWin._tracewin_full_command()TraceWin.run()TraceWin.run_with_this()TraceWin.post_optimisation_run_with_this()TraceWin.init_solver_parameters()TraceWin.is_a_multiparticle_simulationTraceWin.is_a_3d_simulationTraceWin._post_treat_cavity_setttings()TraceWin._abc_impl
_run_in_bash()
- transfer_matrix_factory module
- Submodules
Submodules
- beam_calculator module
BeamCalculatorBeamCalculator._idsBeamCalculator.__init__()BeamCalculator.reference_phase_policyBeamCalculator._set_up_common_factories()BeamCalculator._set_up_specific_factories()BeamCalculator.run()BeamCalculator.run_with_this()BeamCalculator.post_optimisation_run_with_this()BeamCalculator.init_solver_parameters()BeamCalculator._generate_simulation_output()BeamCalculator.reference_phaseBeamCalculator.is_a_multiparticle_simulationBeamCalculator.is_a_3d_simulationBeamCalculator.compute()BeamCalculator.cavity_settings_factoryBeamCalculator._abc_impl
- beam_calculator_base_specs module
- deprecated_specs module
- factory module
- specs module