envelope_3d package

Define modules for the Envelope3D beam calculator.

It is a 3d envelope calculator, only implemented in Python for now.

Submodules

• beam_parameters_factory module
  • BeamParametersFactoryEnvelope3D
    • BeamParametersFactoryEnvelope3D.factory_method()
    • BeamParametersFactoryEnvelope3D._abc_impl
• element_envelope3d_parameters module
  • ElementEnvelope3DParameters
    • ElementEnvelope3DParameters.__init__()
    • ElementEnvelope3DParameters.transfer_matrix_arguments()
    • ElementEnvelope3DParameters._transfer_matrix_results_to_dict()
    • ElementEnvelope3DParameters._transfer_matrix_results_to_dict_broken_field_map()
    • ElementEnvelope3DParameters.re_set_for_broken_cavity()
    • ElementEnvelope3DParameters._abc_impl
  • DriftEnvelope3DParameters
    • DriftEnvelope3DParameters.__init__()
    • DriftEnvelope3DParameters.transfer_matrix_arguments()
    • DriftEnvelope3DParameters._abc_impl
  • QuadEnvelope3DParameters
    • QuadEnvelope3DParameters.__init__()
    • QuadEnvelope3DParameters.transfer_matrix_arguments()
    • QuadEnvelope3DParameters._abc_impl
  • SolenoidEnvelope3DParameters
    • SolenoidEnvelope3DParameters.__init__()
    • SolenoidEnvelope3DParameters._abc_impl
  • FieldMapEnvelope3DParameters
    • FieldMapEnvelope3DParameters.__init__()
    • FieldMapEnvelope3DParameters.transfer_matrix_arguments()
    • FieldMapEnvelope3DParameters._transfer_matrix_results_to_dict()
    • FieldMapEnvelope3DParameters.re_set_for_broken_cavity()
    • FieldMapEnvelope3DParameters._abc_impl
  • BendEnvelope3DParameters
    • BendEnvelope3DParameters.__init__()
    • BendEnvelope3DParameters._abc_impl
• element_envelope3d_parameters_factory module
  • PARAMETERS_3D
  • ElementEnvelope3DParametersFactory
    • ElementEnvelope3DParametersFactory.__init__()
    • ElementEnvelope3DParametersFactory.run()
    • ElementEnvelope3DParametersFactory._abc_impl
    • ElementEnvelope3DParametersFactory._parameters_constructor()
• envelope_3d module
  • Envelope3D
    • Envelope3D.__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_simulation
    • Envelope3D.is_a_3d_simulation
    • Envelope3D._adapt_cavity_settings()
    • Envelope3D._compute_cavity_parameters()
    • Envelope3D._abc_impl
• simulation_output_factory module
  • SimulationOutputFactoryEnvelope3D
    • SimulationOutputFactoryEnvelope3D.out_folder
    • SimulationOutputFactoryEnvelope3D.__post_init__()
    • SimulationOutputFactoryEnvelope3D._transfer_matrix_factory_class
    • SimulationOutputFactoryEnvelope3D._beam_parameters_factory_class
    • SimulationOutputFactoryEnvelope3D.run()
    • SimulationOutputFactoryEnvelope3D.__init__()
    • SimulationOutputFactoryEnvelope3D._abc_impl
• transfer_matrices_p module
  • e_func()
  • drift()
  • quad()
  • _horizontal_focusing_quadrupole()
  • _horizontal_defocusing_quadrupole()
  • field_map_rk4()
  • thin_lense()
  • _magnetic_rigidity()
  • _focusing_strength()
  • _quadrupole_trigo_hyperbolic()
• transfer_matrix_factory module
  • TransferMatrixFactoryEnvelope3D
    • TransferMatrixFactoryEnvelope3D._preprocess()
    • TransferMatrixFactoryEnvelope3D.run()
    • TransferMatrixFactoryEnvelope3D._abc_impl