envelope_1d package

Define the modules for the Envelope1D beam calculator.

It is a 1d envelope calculator, with two implementations. The first one is in pure Python. The second one, CyEnvelope1D, is in Cython. It is faster, but require a compilation. Check out setup.py.

Submodules

• beam_parameters_factory module
  • BeamParametersFactoryEnvelope1D
    • BeamParametersFactoryEnvelope1D.factory_method()
    • BeamParametersFactoryEnvelope1D._abc_impl
• element_envelope1d_parameters module
  • ElementEnvelope1DParameters
    • ElementEnvelope1DParameters.__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
  • DriftEnvelope1DParameters
    • DriftEnvelope1DParameters.__init__()
    • DriftEnvelope1DParameters._abc_impl
  • FieldMapEnvelope1DParameters
    • FieldMapEnvelope1DParameters.__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()
  • SuperposedFieldMapEnvelope1DParameters
    • SuperposedFieldMapEnvelope1DParameters.__init__()
    • SuperposedFieldMapEnvelope1DParameters.transfer_matrix_kw()
    • SuperposedFieldMapEnvelope1DParameters._transfer_matrix_results_to_dict()
    • SuperposedFieldMapEnvelope1DParameters.re_set_for_broken_cavity()
    • SuperposedFieldMapEnvelope1DParameters._abc_impl
  • BendEnvelope1DParameters
    • BendEnvelope1DParameters.__init__()
    • BendEnvelope1DParameters._pre_compute_factors_for_transfer_matrix()
    • BendEnvelope1DParameters.transfer_matrix_kw()
    • BendEnvelope1DParameters._abc_impl
  • _add_cavities_phases()
• element_envelope1d_parameters_factory module
  • PARAMETERS_1D
  • ElementEnvelope1DParametersFactory
    • ElementEnvelope1DParametersFactory._parameters
    • ElementEnvelope1DParametersFactory.__init__()
    • ElementEnvelope1DParametersFactory.run()
    • ElementEnvelope1DParametersFactory._parameters_constructor()
    • ElementEnvelope1DParametersFactory._abc_impl
• envelope_1d module
  • Envelope1D
    • Envelope1D.flag_cython
    • Envelope1D.__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_simulation
    • Envelope1D.is_a_3d_simulation
    • Envelope1D._post_treat_cavity_settings()
    • Envelope1D._abc_impl
  • _store_entry_phase_in_settings()
• simulation_output_factory module
  • SimulationOutputFactoryEnvelope1D
    • SimulationOutputFactoryEnvelope1D.out_folder
    • SimulationOutputFactoryEnvelope1D.__post_init__()
    • SimulationOutputFactoryEnvelope1D._transfer_matrix_factory_class
    • SimulationOutputFactoryEnvelope1D._beam_parameters_factory_class
    • SimulationOutputFactoryEnvelope1D.run()
    • SimulationOutputFactoryEnvelope1D.__init__()
    • SimulationOutputFactoryEnvelope1D._abc_impl
• specs module
  • envelope_1d_pre_treat()
• transfer_matrices module
  • e_func()
  • e_func_complex()
  • e_funcs_scaled()
  • e_funcs_scaled_complex()
  • z_drift()
  • z_field_map_rk4()
  • z_superposed_field_maps_rk4()
  • z_field_map_leapfrog()
  • z_thin_lense_new()
  • z_thin_lense()
  • z_thin_lense_superposed()
  • z_bend()
• transfer_matrix_factory module
  • TransferMatrixFactoryEnvelope1D
    • TransferMatrixFactoryEnvelope1D._preprocess()
    • TransferMatrixFactoryEnvelope1D.run()
    • TransferMatrixFactoryEnvelope1D._abc_impl
• util module
  • ENVELOPE1D_METHODS