RF_Cavity#

class orbit.py_linac.lattice.RF_Cavity(name='none')[source]#

Bases: orbit.utils.NamedObject.NamedObject, orbit.utils.ParamsDictObject.ParamsDictObject

This is the class to keep refernces to the RF Gaps which are BaseLinacNode subclasses. This class does not belong to the AccNodes.

Methods Summary

`addRF_GapNode`(rfGap)	Adds the rf gap to the cavity.
`getAmp`()	Returns the Amp for RF cavity.
`getAvgGapPhase`()	Returns average phase for all RF gaps in the cavity
`getAvgGapPhaseDeg`()	Returns average phase in degrees for all RF gaps in the cavity
`getDesignAmp`()	Returns the design Amp for the RF cavity.
`getDesignArrivalTime`()	Returns the design arrival time for the first RF gap.
`getDesignPhase`()	Returns the design phase for the first RF gap.
`getFirstGapEntranceDesignPhase`()	Returns the design phase at the first gap entrance if Length_of_gap > 0.
`getFirstGapEntrancePhase`()	Returns the phase at the first gap entrance if Length_of_gap > 0.
`getFrequency`()	Returns the frequency in Hz.
`getPhase`()	Returns the phase for the first RF gap.
`getPosition`()	Returns the position of the RF cavity in the sequence.
`getRF_GapNodes`()	Returns the array with rf gaps.
`getUsePhaseAtEntrance`()	Returns the usePhaseAtEntrance parameter of the cavity
`isDesignSetUp`()	Returns the design set up information (True,False).
`removeAllGapNodes`()	Remove all rf gaps from this cavity.
`reverseOrder`()	Reverse order of RF gaps in the cavity.
`setAmp`(Amp)	Sets the Amp for RF cavity.
`setDesignArrivalTime`(time)	Sets the design arrival time for the first RF gap.
`setDesignSetUp`(designOnOf)	Sets the design set up information (True,False).
`setFirstGapEntranceDesignPhase`(phase)	Sets the design phase at the first gap entrance if Length_of_gap > 0.
`setFirstGapEntrancePhase`(phase)	Sets the phase at the first gap entrance if Length_of_gap > 0.
`setFrequency`(freq)	Sets the frequency in Hz.
`setPhase`(phase)	Sets the phase for the first RF gap.
`setPosition`(pos)	Sets the position of the RF cavity in the sequence.
`setUsePhaseAtEntrance`(usePhaseAtEntrance)	This parameter is only for RF gap types with the continuous RF fields on the axis of the cavity.

Methods Documentation

addRF_GapNode(rfGap)[source]#: Adds the rf gap to the cavity.

getAmp()[source]#: Returns the Amp for RF cavity.

getAvgGapPhase()[source]#: Returns average phase for all RF gaps in the cavity

getAvgGapPhaseDeg()[source]#: Returns average phase in degrees for all RF gaps in the cavity

getDesignAmp()[source]#: Returns the design Amp for the RF cavity.

getDesignArrivalTime()[source]#: Returns the design arrival time for the first RF gap.

getDesignPhase()[source]#: Returns the design phase for the first RF gap.

getFirstGapEntranceDesignPhase()[source]#: Returns the design phase at the first gap entrance if Length_of_gap > 0.

getFirstGapEntrancePhase()[source]#: Returns the phase at the first gap entrance if Length_of_gap > 0.

getFrequency()[source]#: Returns the frequency in Hz.

getPhase()[source]#: Returns the phase for the first RF gap.

getPosition()[source]#: Returns the position of the RF cavity in the sequence.

getRF_GapNodes()[source]#: Returns the array with rf gaps.

getUsePhaseAtEntrance()[source]#: Returns the usePhaseAtEntrance parameter of the cavity

isDesignSetUp()[source]#: Returns the design set up information (True,False).

removeAllGapNodes()[source]#: Remove all rf gaps from this cavity.

reverseOrder()[source]#: Reverse order of RF gaps in the cavity. The first gap should become the last and vice versa.

setAmp(Amp)[source]#: Sets the Amp for RF cavity.

setDesignArrivalTime(time)[source]#: Sets the design arrival time for the first RF gap.

setDesignSetUp(designOnOf)[source]#: Sets the design set up information (True,False).

setFirstGapEntranceDesignPhase(phase)[source]#: Sets the design phase at the first gap entrance if Length_of_gap > 0.

setFirstGapEntrancePhase(phase)[source]#: Sets the phase at the first gap entrance if Length_of_gap > 0.

setFrequency(freq)[source]#: Sets the frequency in Hz.

setPhase(phase)[source]#: Sets the phase for the first RF gap.

setPosition(pos)[source]#: Sets the position of the RF cavity in the sequence.

setUsePhaseAtEntrance(usePhaseAtEntrance)[source]#: This parameter is only for RF gap types with the continuous RF fields on the axis of the cavity. If usePhaseAtEntrance = False we will use the phase at the center of 1 st RF gap as for a standard cavity representations as a set of zero-length RF gaps. If usePhaseAtEntrance = False we use the phase at the entrance of the cavity. By default it is False. Switching to True will change cavity phase and all longitudinal dynamics calculations. You should calculate and set of the cavity phase before the bunch tracking. And, of course, you should start with the trackDesignBunch(…) lattice method.