7.33 insert_sceffects

• type: setup command.
• function: set up for transverse space charge calculation.
• sequence: must precede run_setup.
• NB: this command is intended only for simulation of space-charge kicks in rings. Please read the manual page for SCMULT for details on the algorithm.
• Command syntax, including use of equations and subcommands, is discussed in 7.2.

• name — Possibily wild-card containing string specifying the name of the elements after which to insert the space charge kick element.
• type — Possibily wild-card containing string specifying the type of the elements after which to insert the space charge kick element.
• exclude — Possibily wild-card containing string specifying the name of elements to be excluded from the insertion of the space charge kick element.
• disable — If nonzero, the command is ignored.
• clear — If nonzero, all prior space charge insertions are deleted.
• element_prefix — Name under which the space charge kick will appear in the beamline.
• skip — If nonzero, the given number of insertion locations are skipped. If zero, only one space charge kick is inserted at the end of beamline.
• vertical, horizontal, nonlinear — If non-zero, then space charge is included in the plane in question.
• uniform_distribution — Used for bi-Gaussian distributed beam (coasting beam), i.e., beam that is uniform in z but gaussian in x and y.
• verbosity — Larger non-zero values request greater amounts of detail in printouts.
• averaging_factor — For nonlinear space charge mode only, this parameter allows applying an infinite-impulse-response (IIR) filter to the turn-by-turn beam size data in order to reduce the effects of noise. A value of 1 means that only data from the present turn is used, while values approaching 0 will tend to use the initial beam sizes only. In more detail, the effective rms beam size used in the calculation of the kicks for the i^th turn is

  (6)

  where σ_i is the actual rms beam size. N.B.: strictly speaking, simulations performed with f≠1 are invalid, as the effect of strong space charge could be understated. However, judicious use of this parameter may allow valid simulations with fewer particles. The user should vary the parameter to ensure that results are insenstive to the value.

Important notes:

• By default skip=0, which results in only one SCMULT element at the end of the beamline, regardless of whether values are given for the name or type fields.
• This element is not designed for space charge calculations in guns or linacs. It is only intended for simulating space charge in rings.
• This command can not work with concatenation-based matrix tracking.
• Some users use matched_to_cell in the bunched_beam command. This will erase SCMULT assignments along the beamline. In this case, issue another twiss_output command just before tracking.