beam_calculation package
This package holds modules to compute propagation of beam in the linac.
BeamCalculator is an Abstract Base Class to hold such a solver.
Envelope1D 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 SingleElementCalculatorParameters
to hold the meshing, etc.
Subpackages
- beam_calculation.envelope_1d package
- Submodules
- beam_calculation.envelope_1d.beam_parameters_factory module
- beam_calculation.envelope_1d.element_envelope1d_parameters module
- beam_calculation.envelope_1d.element_envelope1d_parameters_factory module
- beam_calculation.envelope_1d.envelope_1d module
- beam_calculation.envelope_1d.simulation_output_factory module
- beam_calculation.envelope_1d.transfer_matrices_c module
- beam_calculation.envelope_1d.transfer_matrices_p module
- beam_calculation.envelope_1d.transfer_matrix_factory module
- Submodules
- beam_calculation.envelope_3d package
- Submodules
- beam_calculation.envelope_3d.beam_parameters_factory module
- beam_calculation.envelope_3d.element_envelope3d_parameters module
- beam_calculation.envelope_3d.element_envelope3d_parameters_factory module
- beam_calculation.envelope_3d.envelope_3d module
- beam_calculation.envelope_3d.simulation_output_factory module
- beam_calculation.envelope_3d.transfer_matrices_p module
- beam_calculation.envelope_3d.transfer_matrix_factory module
- Submodules
- beam_calculation.integrators package
- beam_calculation.parameters package
- beam_calculation.simulation_output package
- beam_calculation.tracewin package
- Submodules
- beam_calculation.tracewin.beam_parameters_factory module
- beam_calculation.tracewin.element_tracewin_parameters module
- beam_calculation.tracewin.element_tracewin_parameters_factory module
- beam_calculation.tracewin.simulation_output_factory module
- beam_calculation.tracewin.tracewin module
- beam_calculation.tracewin.transfer_matrix_factory module
- Submodules
Submodules
- beam_calculation.beam_calculator module
BeamCalculatorBeamCalculator.__init__()BeamCalculator._abc_implBeamCalculator._generate_simulation_output()BeamCalculator._idsBeamCalculator._set_up_common_factories()BeamCalculator._set_up_specific_factories()BeamCalculator.cavity_settings_factoryBeamCalculator.compute()BeamCalculator.init_solver_parameters()BeamCalculator.is_a_3d_simulationBeamCalculator.is_a_multiparticle_simulationBeamCalculator.post_optimisation_run_with_this()BeamCalculator.reference_phaseBeamCalculator.run()BeamCalculator.run_with_this()
- beam_calculation.factory module