10.6 BOFFAXE—A straight magnetic field element using off-axis expansion from an on-axis derivative.

A straight magnetic field element using off-axis expansion from an on-axis derivative.
Parallel capable? : yes
GPU capable? : no
Back-tracking capable? : no

Parameter Name Units Type Default


L M double 0.0

insertion length

LFIELD M double -1

expected length of the field map for verification purposes only.


name of file containing derivative data


name of longitunidal coordinate column in the data file


name of derivative column in the data file

ORDER short 1

order of transverse derivative


order of expansion in x and y. If zero, determined by data in file.


factor by which to multiply field

TILT RAD double 0.0

rotation about longitudinal axis

DX M double 0.0


DY M double 0.0


DZ M double 0.0


BX T double 0.0

add BX*STRENGTH to Bx field

BY T double 0.0

add BY*STRENGTH to By field

Z_INTERVAL short 1

input z data is sampled at this interval


Number of subdivisions of z interval to use in integration

SYNCH_RAD short 0

if nonzero, include classical, single-particle synchrotron radiation

ISR short 0

if nonzero, include incoherent synchrotron radiation (quantum excitation)


name of file for phase-space and field output. Use for debugging only!

BOFFAXE continued

A straight magnetic field element using off-axis expansion from an on-axis derivative.

Parameter NameUnitsType Default



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 experimental element simulates transport through a 3D magnetic field constructed from an off-axis expansion. At present, it is restricted to non-bending elements and in fact to quadrupoles and sextupoles.

This method of expanding the fields is prone to corruption by noise, to a much greater degree than the generalized gradient expansion used by BGGEXP. However, it uses data that can very readily be obtained from magnetic measurements with a Hall probe. Users are cautioned to take care in deciding how far to trust the expansion.

For quadrupoles, we use the on-axis gradient g(z) and its z derivatives g(n)(z) The scalar potential can be written

    x5y5g (8)(z ) g (6)(z )(x5y3 + x3y5)  1        (         )   1              1 (         )
Φ = ------------------------------- +----g(4)(z) x5y + xy5 + ---x3y3g(4)(z)- --- x3y + xy3 g′′(z)+xyg (z)
       86400            4320         720                    108            12

From which we find

                        (             )
     x4y5g-(8)(z)  g(6)(z)-5x4y3 +-3x2y5-- -1--(4)   (  4     5)  1--2 3 (4)    1--(  2    3)  ′′
Bx =    17280   -         4320         + 720g  (z) 5x y + y  + 36x y g  (z)- 12  3x y + y  g (z)+yg (z)

                        (             )
     x5y4g (8)(z) g (6)(z) 3x5y2 + 5x3y4    1  (4)   ( 5      4)  1  3 2 (4)     1 ( 3      2) ′′
By = ---17280-------------4320---------+ 720g  (z) x  + 5xy  + 36x y g  (z)- 12- x + 3xy   g (z)+xg(z)


       5 5 (9)     (7)   ( 5 3   3 5)            (         )                          (        )
Bz = x-y-g---(z-)- g--(z-)-x-y-+-x-y-- +-1--g(5)(z) x5y + xy5 + -1-x3y3g(5)(z)- -1g(3)(z)  x3y + xy3 +xyg ′(z)
        86400            4320         720                    108            12

These equations satisfy Maxwell’s curl equation exactly while satisfying the divergence equation to 10th order. A similar expansion is available in the code for sextupoles.

For quadrupoles, at minimum the z-dependent gradient B1(z) must be given, while for sextupoles B2(z) is required. Bn(z) is specified in the column named by the FIELD_COLUMN parameter. The names for the columns containing z derivatives of Bn(z) are constructed from the name of the primary column. Assume for concreteness that FIELD_COLUMN="Gradient". elegant looks for Bn(1)(z) in column GradientDeriv and Bn(m)(z) for m > 1 in columns GradientDeriv2, GradientDeriv3, etc. Even if the expansion is limited by the ORDER parameter, all gradients will be used for interpolation with respect to z if the Z_SUBDIVISIONS parameter is larger than 1. The expansion is truncated if the needed columns do not exist in the input file.

The needed derivatives can be obtained using the program sddsderiv, e.g.,

sddsderiv gradient.sdds gradient1.sdds -differ=Gradient -versus=z -savitzky=7,7,7,1  
sddsderiv gradient.sdds gradient2.sdds -differ=Gradient -versus=z -savitzky=7,7,7,2  
sddsderiv gradient.sdds gradient3.sdds -differ=Gradient -versus=z -savitzky=7,7,7,3  
sddsxref gradient.sdds gradient[123].sdds gradients.sdds -take=*Deriv*

(In this example, we use a Savitzky-Golay filter to compute the first three z derivatives of g(z) using a 7th order fit with 7 points ahead of and behind the evaluation location.) The file gradients.sdds would then be given as the value of FILENAME.

High-order numerical derivative are of course prone to corruption by measurement noise. Examining the derivatives is strongly recommended to ensure this is not an issue.