|RS||double||0.0||shunt impedance (Ra=2*Rs)|
|CHARGE||double||0.0||beam charge (or use CHARGE element)|
|BETA||double||0.0||normalized load impedance|
|BIN_SIZE||double||0.0||bin size for current histogram (use 0 for autosize)|
|N_BINS||long||20||number of bins for current histogram|
|PLANE||STRING||both||x, y, or both|
|SAMPLE_INTERVAL||long||1||passes between output to RECORD file|
||If non-zero, then in BINLESS mode, provides per-particle output of RECORD data.|
|RECORD||STRING||NULL||output file for cavity data|
||if nonzero, don't accumulate field from pass to pass|
||don't affect the beam until this pass|
|XFACTOR||double||1||factor by which to multiply shunt impedances|
|YFACTOR||double||1||factor by which to multiply shunt impedances|
||Number of passes over which to linearly ramp up the impedance to full strength.|
||If nonzero, use algorithm that doesn't requiring binning. Best for few particles, widely spaced.|
|RESET_FOR_EACH_STEP||long||1||If nonzero, voltage and phase are reset for each simulation step.|
A simulation of a beam-driven TM dipole mode of an RF cavity.
||If nonzero, induced voltage from present turn does not affect bunch. Short range wake should be included via TRWAKE or ZTRANSVERSE element.|
|GROUP||string||NULL||Optionally used to assign an element to a group, with a user-defined name. Group names will appear in the parameter output file in the column ElementGroup|
This element simulates a beam-driven dipole mode cavity using the fundamental theorem of beam loading and phasor rotation.
Normally, the field dumped in the cavity by one particle affects trailing particles in the same turn.
However, if one is also using a
ZTRANSVSE element to simulate the short-range wake of the cavity, this would be double-counting.
In that case, one can use
LONG_RANGE_ONLY=1 to suppress the same-turn effects of the