OverlappingQuadsNode#

class orbit.py_linac.lattice.OverlappingQuadsNode(name='OverlappingQuads')[source]#

Bases: orbit.py_linac.lattice.LinacAccNodes.BaseLinacNode

The class represent the set of quads with the overlapping fields.

Methods Summary

`addQuad`(quad, fieldFunc, z_center_of_field)	Adds the quad with the field function and the position.
`getCentersOfField`()	Returns the array of centers of the quads in this node.
`getQuads`()	Returns the list of quads in this node.
`getTotalField`(z_from_center)	Returns the combined field of all overlapping quads.
`getTotalFieldDerivative`(z_from_center)	Returns the combined derivative of the field of all overlapping quads.
`getUseLongitudinalFieldOfQuad`()	If we going to use the longitudinal magnetic field component of quad
`getZ_Min_Max`()	Returns the tuple (z_min,z_max) with the limits of z coordinate from the center.
`getZ_Step`()	Returns the longitudinal step for the tracking along the node.
`initialize`()	The OverlappingQuadsNode class implementation of the AccNode class initialize() method.
`isNodeInReversedLattice`()	Returns True if this node in the reversed lattice or False if it otherwise.
`reverseOrderNodeSpecific`()	This method is used for a lattice reversal and a bunch backtracking This is a node type specific method.
`setUseLongitudinalFieldOfQuad`(use)	If we going to use the longitudinal magnetic field component of quad
`setZ_Step`(z_step)	Sets the longitudinal step for the tracking along the node.
`track`(paramsDict)	The OverlappingQuadsNode class implementation of the AccNode class track(paramDict) method.

Methods Documentation

addQuad(quad, fieldFunc, z_center_of_field)[source]#: Adds the quad with the field function and the position. The position of the quad is relative to the beginning of this OverlappingQuadsNode.

getCentersOfField()[source]#: Returns the array of centers of the quads in this node.

getQuads()[source]#: Returns the list of quads in this node.

getTotalField(z_from_center)[source]#: Returns the combined field of all overlapping quads. z_from_center - is a distance from the center of the node. z - is a distance from the beginning of the node.

getTotalFieldDerivative(z_from_center)[source]#: Returns the combined derivative of the field of all overlapping quads. z_from_center - is a distance from the center of the node. z - is a distance from the beginning of the node.

getUseLongitudinalFieldOfQuad()[source]#: If we going to use the longitudinal magnetic field component of quad

getZ_Min_Max()[source]#: Returns the tuple (z_min,z_max) with the limits of z coordinate from the center. These parameters define the length of the node. The center of the node is at 0.

getZ_Step()[source]#: Returns the longitudinal step for the tracking along the node.

initialize()[source]#: The OverlappingQuadsNode class implementation of the AccNode class initialize() method.

isNodeInReversedLattice()[source]#: Returns True if this node in the reversed lattice or False if it otherwise.

reverseOrderNodeSpecific()[source]#: This method is used for a lattice reversal and a bunch backtracking This is a node type specific method. The implementation of the abstract method of AccNode class from the top level lattice package.

setUseLongitudinalFieldOfQuad(use)[source]#: If we going to use the longitudinal magnetic field component of quad

setZ_Step(z_step)[source]#: Sets the longitudinal step for the tracking along the node.

track(paramsDict)[source]#: The OverlappingQuadsNode class implementation of the AccNode class track(paramDict) method.