10.5 BMXYZ—A map of (Bx, By, Bz) vs (x, y, z), for straight elements only

A map of (Bx, By, Bz) vs (x, y, z), for straight elements only
Parallel capable? : yes
GPU capable? : no
Back-tracking capable? : no






Parameter Name Units Type Default

Description






L M double 0.0

insertion length






DX M double 0.0

misalignment






DY M double 0.0

misalignment






DZ M double 0.0

misalignment






TILT RAD double 0.0

rotation about longitudinal axis






LFIELD M double -1

expected length of the field map. If negative, determined from field data.






STRENGTH NULLdouble 1

factor by which to multiply field






FSE NULLdouble 0.0

Fractional Strength Error.






ACCURACY NULLdouble 0.0

integration accuracy






METHOD NULLSTRINGNULL

integration method (runge-kutta, bulirsch-stoer, modified-midpoint, two-pass modified-midpoint, leap-frog, non-adaptive runge-kutta






FILENAME NULLSTRINGNULL

name of file containing columns (x, y, z) and either (Bx, By, Bz) or (Fx, Fy, Fz)






SYNCH_RAD short 0

include classical, single-particle synchrotron radiation?






CHECK_FIELDS short 0

check fields by computing divB and curlB errors?






INJECT_AT_Z0 short 0

By default, particles are placed at the entrance to the field map regardless of the z coordinate values. If nonzero, particles start at z=0.






DRIFT_MATRIX short 0

If non-zero, instead of tracking to determine the matrix, just assume a drift-space matrix.






BMXYZ continued

A map of (Bx, By, Bz) vs (x, y, z), for straight elements only






Parameter Name Units Type Default

Description






XY_INTERPOLATION_ORDER short 1

Order of interpolation in x and y.






XY_GRID_EXCESS short 0

Number of rows or columns to add in each dimension to the minimum.






SINGLE_PRECISION short 0

If nonzero, store field data in single precision to reduce memory requirements.






PARTICLE_OUTPUT_FILE NULLSTRINGNULL

name of file for phase-space output inside element. Use for debugging only in serial version.






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 transport through a 3D magnetic field specified as a field map. It does this by simply integrating the Lorentz force equation in cartesian coordinates. It does not incorporate changes in the design trajectory resulting from the fields. I.e., if you input a dipole field, it is interpreted as a steering element.

The field map file is an SDDS file with the following columns:

The field map file must contain a rectangular grid of points, equispaced (separately) in x, y, and z. There should be no missing values in the grid (this is not checked by elegant). In addition, the x values must vary fastest as the values are accessed in row order, then the y values. To ensure that this is the case, use the following command on the field file:

sddssort fieldFile -column=z,incr -column=y,incr -column=x,incr

This element is an alternative to FTABLE using a more conventional integration method.

BOFFAXE