BaseRF_Gap#

class orbit.py_linac.lattice.BaseRF_Gap(name='baserfgap')[source]#

Bases: orbit.py_linac.lattice.LinacAccNodes.AbstractRF_Gap

The simplest RF gap representation. The only E0*T*L or E0*L and TTFs define all effects of the node. By default the Matrix RF Gap model is used. This model can be replaced later with a more complex RF gap model by using the setCppGapModel(…) method. User should provide the necessary parameters for each type of RF gap model. MatrixRfGap - E0TL, mode BaseRfGap - E0TL, mode RfGapTTF - E0L, T,S,Tp,Sp, beta_min, beta_max The phase of the first gap in the cavity is defined by the parent cavity instance. The relative amplitude is also defined by the parent cavity instance. The ‘mode’ parameter is a shift of the phase between two gaps in PI units.

Methods Summary

`getBetaMinMax`()	Returns beta min and max for TTF model polynomials.
`getGapPhase`()	Returns the rf gap phase.
`getRF_Cavity`()	Returns the parent RF Cavity.
`getTTF_Polynimials`()	Returns the T,S,Tp,Sp, polynomials in the TTF model.
`initialize`()	The BaseRF_Gap class implementation of the AccNode class initialize() method.
`isFirstRFGap`()	Returns True if it is the first gap in RF cavity.
`setAsFirstRFGap`(isFirst)	Sets if it is the first gap in RF cavity.
`setBetaMinMax`(beta_min, beta_max)	Sets beta min and max for TTF model polynomials.
`setCppGapModel`([cppGapModel])	This method will set the fast c++ simple model for the RF Gap.
`setGapPhase`(gap_phase)	Sets the rf gap phase.
`setLinacTracker`([switch])	This method will switch RF gap model to slower one where transformations coefficients are calculated for each particle in the bunch.
`setRF_Cavity`(rf_cav)	Sets the parent RF Cavity.
`setnParts`([n])	Method.
`track`(paramsDict)	The simplest RF gap class implementation of the AccNode class track(probe) method.
`trackDesign`(paramsDict)	The RF First Gap node setups the design time of passage of the bunch through this node.
`ttf_track_bunch__`(bunch, frequency, E0L, phase)	Tracks the bunch through the TTF thin gap model.

Methods Documentation

getBetaMinMax()[source]#: Returns beta min and max for TTF model polynomials.

getGapPhase()[source]#: Returns the rf gap phase.

getRF_Cavity()[source]#: Returns the parent RF Cavity.

getTTF_Polynimials()[source]#: Returns the T,S,Tp,Sp, polynomials in the TTF model.

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

isFirstRFGap()[source]#: Returns True if it is the first gap in RF cavity.

setAsFirstRFGap(isFirst)[source]#: Sets if it is the first gap in RF cavity.

setBetaMinMax(beta_min, beta_max)[source]#: Sets beta min and max for TTF model polynomials.

setCppGapModel(cppGapModel=<MatrixRfGap object>)[source]#: This method will set the fast c++ simple model for the RF Gap. By default it is Matrix RF Gap model which is a linear transport matrix.

setGapPhase(gap_phase)[source]#: Sets the rf gap phase.

setLinacTracker(switch=True)[source]#: This method will switch RF gap model to slower one where transformations coefficients are calculated for each particle in the bunch.

setRF_Cavity(rf_cav)[source]#: Sets the parent RF Cavity.

setnParts(n=1)[source]#: Method. Sets the number of body parts of the node. For the RF gap with zero length it will be only 1.

track(paramsDict)[source]#: The simplest RF gap class implementation of the AccNode class track(probe) method.

trackDesign(paramsDict)[source]#: The RF First Gap node setups the design time of passage of the bunch through this node.

ttf_track_bunch__(bunch, frequency, E0L, phase)[source]#: Tracks the bunch through the TTF thin gap model. This private method was introduced to to check the beta TTF limits in the polynomial representation of T,T’,S,and S’ functions of the relativistic beta.