EngeFunction#

class orbit.py_linac.overlapping_fields.EngeFunction(length_param, acceptance_diameter_param, cutoff_level=0.01)[source]#

Bases: AbstractQuadFieldSourceFunction

The Enge function with parameters from Berz’s paper [1].

References

Methods Summary

`getCuttOffZ`()	Returns the cutoff distance from the center of quad's field
`getFuncDerivative`(z)	Returns the derivative of the getFuncValue(z)
`getFuncValue`(z)	Returns the quad's field at the distance z from the center
`getLimitsZ`()	Returns the tuple with min and max Z value for this field
`getNumberOfPoints`()	Returns the number of points in the field function
`setAcceptanceDiameter`(acceptance_diameter)	Sets the acceptance diameter of the quad
`setCutOffLevel`(cutoff_level)	Sets the cutoff level for quad's field
`setCutOffZ`(cutoff_z)	Sets the cutoff distance from the center of quad's field
`setEngeCoefficients`(a_arr)	Sets new values for Enge function's coeffients.
`setLength`(length)	Sets the length of quad's field
`setNumberOfPoints`(n_func_points)	Sets the number of points in the field function

Methods Documentation

getCuttOffZ()[source]#: Returns the cutoff distance from the center of quad’s field

getFuncDerivative(z)[source]#: Returns the derivative of the getFuncValue(z)

getFuncValue(z)[source]#: Returns the quad’s field at the distance z from the center

getLimitsZ()[source]#: Returns the tuple with min and max Z value for this field

getNumberOfPoints()[source]#: Returns the number of points in the field function

setAcceptanceDiameter(acceptance_diameter)[source]#: Sets the acceptance diameter of the quad

setCutOffLevel(cutoff_level)[source]#: Sets the cutoff level for quad’s field

setCutOffZ(cutoff_z)[source]#: Sets the cutoff distance from the center of quad’s field

setEngeCoefficients(a_arr)[source]#: Sets new values for Enge function’s coeffients.

setLength(length)[source]#: Sets the length of quad’s field

setNumberOfPoints(n_func_points)[source]#: Sets the number of points in the field function