10.40 GKICKMAP—An ordinary kick map (use UKICKMAP for undualtors).

An ordinary kick map (use UKICKMAP for undualtors).
Parallel capable? : yes
GPU capable? : no
Back-tracking capable? : yes

Parameter NameUnitsType Default


L M double 0.0


TILT RADdouble 0.0

rotation about longitudinal axis

DX M double 0.0


DY M double 0.0


DZ M double 0.0


FACTOR double 1

Factor by which to multiply the kicks.

XY_FACTOR double 1

Factor by which to multiply the x and y values in the input file.

YAW double 0.0

Yaw angle of the device. Meaningful only if N_KICKS is not 1.


Name of SDDS file with undulator kickmap data.

N_KICKS long 1

Number of kicks into which to split the element.

SYNCH_RAD short 0

include classical, single-particle synchrotron radiation?

ISR short 0

include incoherent synchrotron radiation (quantum excitation)?

YAW_END short 0

-1=Entrance, 0=Center, 1=Exit


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 provides simulation a generalized kick map, similar to the UKICKMAP but appropriate for maps that do not pertain to undulators or wigglers.

The input file has the following columns:

The values of x and y must be laid out on a grid of equispaced points. It is assumed that the data is ordered such that x varies fastest. This can be accomplished with the command

% sddssort -column=y,increasing -column=x,increasing input1.sdds input2.sdds

where input1.sdds is the original (unordered) file and input2.sdds is the new file, which would be used with KICKMAP.

This element is included in beam moments computations via the moments_output command.

The YAW and YAW_END parameters can be used in the simulation of canted IDs. Normally, steering magnets are used to create an angle between the devices. The devices are thus oriented in the reference coordinate system, meaning the beam tranverses the IDs at an angle. If it is desirable to align the IDs to the beam, the IDs can be yawed. A positive yaw will tilt the ID so that it is colinear with a beam that has been kicked by a positive horizontal steering angle. The YAW_END parameter defines which end of the ID is held fixed when the yaw is applied.