SynchrotronRadiationLosses¶
-
class
zgoubidoo.commands.radiation.SynchrotronRadiationLosses(label1: str = '', label2: str = '', *params, **kwargs)[source]¶ Bases:
zgoubidoo.commands.actions.ActionSynchrotron radiation loss.
Zgoubi manual description
The keyword SRLOSS allows activating or stopping (option KSR = 1, 0 respectively) stepwise tracking of energy loss by stochastic emission of photons in magnetic fields, following the method described in section 3.1.
It can be chosen to allow radiation in the sole dipole fields, or in all types of fields regardless of their multipole composition. It can also be chosen to allow for the radiation induced transverse kick.
SRLOSS must be preceded by PARTICUL for defining mass and charge values as they enter in the definition of SR parameters.
Statistics on SR parameters are computed and updated while tracking, the results of which can be obtained by means of the keyword SRPRNT.
Command attributes
-
LABEL1='' Primary label for the Zgoubi command (default: auto-generated hash).
- Type
str
-
LABEL2='' Secondary label for the Zgoubi command.
- Type
str
-
KSR='1' Switch (0: SR switched off, 1: SR switched on).
- Type
int
-
I='1' Output SRLOSS information to file.
- Type
int
-
KEYWORDS='ALL' - Type
str
-
SCALING='' If “scale” then scale magnetic field based on energy loss from synchrotron radiation.
- Type
str
-
OPTION='2' 1: effect on DP only, 2 : effect on dp and kick angle.
- Type
int
-
SEED='123456' Random seed.
- Type
int
Default initializer for all Commands.
Attributes Summary
Keyword of the command used for the Zgoubi input data.
Parameters of the command, with their default value, their description and optionally an index used by other commands (e.g.
Methods Summary
off()Switches off the synchrotron radiation losses.
on()Switches on the synchrotron radiation losses.
switch([value])Switches on or off the synchrotron radiation losses.
Attributes Documentation
-
KEYWORD: str = 'SRLOSS'¶ Keyword of the command used for the Zgoubi input data.
-
PARAMETERS: dict = {'I': (1, 'Output SRLOSS information to file.'), 'KEYWORDS': ('ALL', ''), 'KSR': (1, 'Switch (0: SR switched off, 1: SR switched on).'), 'LABEL1': ('', 'Primary label for the Zgoubi command (default: auto-generated hash).'), 'LABEL2': ('', 'Secondary label for the Zgoubi command.'), 'OPTION': (2, '1: effect on DP only, 2 : effect on dp and kick angle.'), 'SCALING': ('', 'If "scale" then scale magnetic field based on energy loss from synchrotron radiation.'), 'SEED': (123456, 'Random seed.')}¶ Parameters of the command, with their default value, their description and optionally an index used by other commands (e.g. fit).
Methods Documentation
-