PMQ_Trace3D_Function#

class orbit.py_linac.overlapping_fields.PMQ_Trace3D_Function(length_param, rad_in, rad_out, cutoff_level=0.01)[source]#

Bases: AbstractQuadFieldSourceFunction

The PMQ Function is a represenatation of the field of permanent quad from Trace3D documantation (p 77): https://inis.iaea.org/records/7awtr-mr708

Methods Summary

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 (z_min,z_max) tuple as longitudinal limits of the quad field.

getPMQ_FuncValue(z)

Returns the total PMQ quad field distribution

pmq_func(z)

This is PMQ function defined at p.

Methods Documentation

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 (z_min,z_max) tuple as longitudinal limits of the quad field.

getPMQ_FuncValue(z)[source]#

Returns the total PMQ quad field distribution

pmq_func(z)[source]#

This is PMQ function defined at p. 77 of the Trace3D manual.