Package xal.smf.impl

Class RfCavity

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.AcceleratorSeq

xal.smf.impl.RfCavity

All Implemented Interfaces:

Comparable, ElementType, DataListener

Direct Known Subclasses:

CCL, DTLTank, ESSRfCavity, ReBuncher, SCLCavity

public class RfCavity
extends AcceleratorSeq

The implementation of the RF Cavity element. The Rf Cavity is the device that is directly connected to a klystron. There are internal RF gap(s) within this cavity, which are controlled by the cavity. The RfGaps are a separate class of type AcceleratorNode. The beam dynamics are done in the RfGap class. Note: the "knob" connections are to the klystron. The

Author:

Nikolay Malitsky, Christopher K. Allen

Field Summary

Fields

Modifier and Type	Field	Description
final AccessibleProperty	amplitude
static final String	BLANK_BEAM_HANDLE
final AccessibleProperty	blankBeam
protected RfCavityBucket	bucRfCavity	RF Cavity parameters
static final String	CAV_AMP_AVG_HANDLE
static final String	CAV_AMP_SET_HANDLE
static final String	CAV_PHASE_AVG_HANDLE
static final String	CAV_PHASE_SET_HANDLE
static final String	DELTA_TRF_END_HANDLE
static final String	DELTA_TRF_START_HANDLE
final AccessibleProperty	deltaTRFEnd
final AccessibleProperty	deltaTRFStart
protected List<RfGap>	gaps	container of the enclosed RfGap(s) in this cavity sorted by position
final AccessibleProperty	phase
static final String	T_DELAY_HANDLE
final AccessibleProperty	tDelay
static final String	TYPE	accelerator node type

Fields inherited from class xal.smf.AcceleratorSeq

arrNodes, bucSequence, nodeTable, sequences

Fields inherited from class xal.smf.AcceleratorNode

bolIsSoft, bolStatus, bolValid, bucAlign, bucAper, bucTwiss, channelSuite, dblLen, dblPos, dblS, mapAttrs, objAccel, seqParent, strEId, strId, strPId

Constructor Summary

Constructors

Constructor	Description
RfCavity(String strId)	Constructor
RfCavity(String strId, int intReserve)	Constructor
RfCavity(String strId, ChannelFactory channelFactory)	Constructor
RfCavity(String strId, ChannelFactory channelFactory, int intReserve)	Primary Constructor

Method Summary

Modifier and Type	Method	Description
void	addBucket(AttributeBucket buc)	Override AcceleratorNode implementation to check for a RfCavityStruct Bucket
boolean	addNode(AcceleratorNode newNode)	Method to move a node from one sequence to this sequence warning be careful - need to check node position when moving it about!!
boolean	getBlankBeam()	Determine whether the beam is blanked
double	getCavAmpAvg()	get the cavity amplitude (MV) and publish this to all the gaps connected to this cavity note the cavity amp [MV] = klystron amplitude * ampFactor where ampFactor is a calibration factor determined experimentally
double	getCavAmpSetPoint()	return the present live set point for the amplitude
double	getCavFreq()	Get RF cavity frequency.
double	getCavPhaseAvg()	Get the cavity phase relative to the beam (deg) and publish it to all the rf gaps associated with this cavity note the cavity phase = klystron phase + phaseOffset where phaseOffset is a calibration factor determined experimentally
double	getCavPhaseSetPoint()	return the present live set point for the phase
double	getDfltAvgCavPhase()
double	getDfltAvgCavTTF()	CKA - Never used
double	getDfltCavAmp()
double	getDfltCavPhase()
Collection<RfGap>	getGaps()	method to return the gaps associated with this cavity
List<RfGap>	getGapsAsList()	method to return the gaps associated with this cavity as a List
RfCavityBucket	getRfField()	returns the bucket for the RfField of this cavity
double	getRFLength()	get the length of the active RF accelerating structure in this cavity (m)
RealUnivariatePolynomial	getSTFFit()	return a polynomial fit of the "S" transit time factor as a function of beta
RealUnivariatePolynomial	getSTFFitEnd()	return a polynomial fit of the "S" transit time factor for end cells as a function of beta
RealUnivariatePolynomial	getSTFPrimeFit()	return a polynomial fit of the "S" transit time factor prime as a function of beta
RealUnivariatePolynomial	getSTFPrimeFitEnd()	return a polynomial fit of the "S" transit time factor prime for end cells as a function of beta
double	getStructureMode()	returns 0 if the gap is part of a 0 mode cavity structure (e.g.
RealUnivariatePolynomial	getTTFFit()	return a polynomial fit of the transit time factor as a function of beta
RealUnivariatePolynomial	getTTFFitEnd()	return a polynomial fit of the transit time factor for end cells as a function of beta
RealUnivariatePolynomial	getTTFPrimeFit()	return a polynomial fit of the transit time factor prime as a function of beta
RealUnivariatePolynomial	getTTFPrimeFitEnd()	return a polynomial fit of the transit time factor prime for end cells as a function of beta
String	getType()	Override to provide type signature
void	setBlankBeam(boolean mode)	Blank the beam
void	setCavAmp(double newAmp)	Set the cavity amplitude [MV] note the cavity amp [MV] = klystron amp * ampFactor where ampFactor is a calibration factor determined experimentally
void	setCavPhase(double newPhase)	Set the cavity phase relative to the beam (deg) note the cavity phase = klystron phase + phaseOffset where phaseOffset is a calibration factor determined experimentally
void	setDfltCavAmp(double value)
void	setDfltCavPhase(double value)
void	setRfField(RfCavityBucket buc)	sets the bucket for the RfField of this cavity
double	toAvgCavPhaseFromCavPhase(double cavityPhase)	Convert the cavity phase (phase at entrance to cavity) to average cavity phase by averaging the phase over the gaps.
double	toCAFromCavAmpAvg(double value)	Convert the cavity amplitude to channel access.
double	toCAFromCavPhaseAvg(double value)	Convert the cavity phase to channel access.
double	toCavAmpAvgFromCA(double rawValue)	Convert the raw channel access value to get the cavity amplitude in MV.
double	toCavPhaseAvgFromCA(double rawValue)	Convert the raw channel access value to get the cavity phase in degrees.
double	toCenterAvgCavPhaseFromCavPhase(double cavityPhase)	Calculate the average phase of the gaps at the center of the cavity from the phase at the entrance to the cavity.
void	update(DataAdaptor adaptor)	Collect all of the enclosed rf gaps for convenience
void	updateDesignAmp(double amp)	method to set the design amplitude
void	updateDesignPhase(double phase)	Set the design phase

Methods inherited from class xal.smf.AcceleratorSeq

addNodeAt, addSequenceChain, addSoft, appendNodesOfClassWithQualifier, appendNodesWithQualifier, canPrecede, contains, dataLabel, filterNodesByClass, filterNodesByStatus, formsRing, getAllInclusiveNodes, getAllInclusiveNodes, getAllInclusiveNodesWithQualifier, getAllNodes, getAllNodes, getAllNodesOfType, getAllNodesWithQualifier, getAllSeqs, getAperProfile, getAperProfile, getDistanceBetween, getEntranceID, getIndexOfNode, getLeaves, getLength, getNodeAt, getNodeCount, getNodes, getNodes, getNodesOfClassWithQualifier, getNodesOfClassWithQualifier, getNodesOfClassWithStatus, getNodesOfType, getNodesOfType, getNodesWithQualifier, getNodesWithQualifier, getNodeWithId, getPosition, getPredecessors, getPrimaryAncestor, getRelativePosition, getRelativePosition, getSequence, getSequenceBuc, getSequences, getSequences, getShortestRelativePosition, indexToAddNode, isLinear, orderSequences, recurNodeSearch, recurSeqSearch, removeAllNodes, removeNode, setSequence, sortNodes, sortNodesByProximity, sortNodesByRelativePosition, write, writeAttributes, writeDeeply, writeStatus

Methods inherited from class xal.smf.AcceleratorNode

batchConnectAllHandles, batchConnectAllHandlesAndWait, channelSuite, clear, compareTo, findChannel, getAccelerator, getAccessibleProperties, getAccessibleProperties, getAlign, getAllChannels, getAndConnectChannel, getAndConnectChannelSetAndReadback, getAper, getBucket, getBuckets, getChannel, getDefaultHandles, getDesignPropertyValue, getEId, getHandles, getId, getLivePropertyChannels, getLivePropertyValue, getParent, getPId, getPitchAngle, getPosition, getProperties, getReadbackHandles, getRollAngle, getSDisplay, getSetHandle, getSoftType, getStatus, getTwiss, getValid, getXOffset, getYawAngle, getYOffset, getZOffset, hasBucket, hasParent, isChannelSettable, isKindOf, isMagnet, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setDesignPropertyValue, setLength, setLivePropertyValue, setParent, setPitchAngle, setPosition, setRollAngle, setSDisplay, setStatus, setTwiss, setValid, setValueAndVerify, setXOffset, setYawAngle, setYOffset, setZOffset, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

CAV_AMP_SET_HANDLE

public static final String CAV_AMP_SET_HANDLE

See Also:

• Constant Field Values

CAV_PHASE_SET_HANDLE

public static final String CAV_PHASE_SET_HANDLE

See Also:

• Constant Field Values

CAV_AMP_AVG_HANDLE

public static final String CAV_AMP_AVG_HANDLE

See Also:

• Constant Field Values

CAV_PHASE_AVG_HANDLE

public static final String CAV_PHASE_AVG_HANDLE

See Also:

• Constant Field Values

DELTA_TRF_START_HANDLE

public static final String DELTA_TRF_START_HANDLE

See Also:

• Constant Field Values

DELTA_TRF_END_HANDLE

public static final String DELTA_TRF_END_HANDLE

See Also:

• Constant Field Values

T_DELAY_HANDLE

public static final String T_DELAY_HANDLE

See Also:

• Constant Field Values

BLANK_BEAM_HANDLE

public static final String BLANK_BEAM_HANDLE

See Also:

• Constant Field Values

amplitude

public final AccessibleProperty amplitude

phase

public final AccessibleProperty phase

deltaTRFStart

public final AccessibleProperty deltaTRFStart

deltaTRFEnd

public final AccessibleProperty deltaTRFEnd

tDelay

public final AccessibleProperty tDelay

blankBeam

public final AccessibleProperty blankBeam

TYPE

public static final String TYPE

accelerator node type

See Also:

• Constant Field Values

bucRfCavity

protected RfCavityBucket bucRfCavity

RF Cavity parameters

gaps

protected List<RfGap> gaps

container of the enclosed RfGap(s) in this cavity sorted by position

NOTE:

An RfCavityStruct is an AcceleratorSeq which is already an ordered list of AcceleratorNodes. This attribute and any reliance on it seems dangerously redundant.

NOTE:

This appears to be used to process the gaps and only the gaps within this cavity structure.

Constructor Details

RfCavity

public RfCavity(String strId,
 ChannelFactory channelFactory,
 int intReserve)

Primary Constructor

RfCavity

public RfCavity(String strId,
 ChannelFactory channelFactory)

Constructor

RfCavity

public RfCavity(String strId)

Constructor

RfCavity

public RfCavity(String strId,
 int intReserve)

Constructor

Method Details

getType

public String getType()

Override to provide type signature

Overrides:

getType in class AcceleratorSeq

addNode

public boolean addNode(AcceleratorNode newNode)

Method to move a node from one sequence to this sequence warning be careful - need to check node position when moving it about!!

Overrides:

addNode in class AcceleratorSeq

update

public void update(DataAdaptor adaptor)

Collect all of the enclosed rf gaps for convenience

Specified by:

update in interface DataListener

Overrides:

update in class AcceleratorSeq

Parameters:

adaptor - The adaptor from which to update the data

getRfField

public RfCavityBucket getRfField()

returns the bucket for the RfField of this cavity

setRfField

public void setRfField(RfCavityBucket buc)

sets the bucket for the RfField of this cavity

addBucket

public void addBucket(AttributeBucket buc)

Override AcceleratorNode implementation to check for a RfCavityStruct Bucket

Overrides:

addBucket in class AcceleratorSeq

getCavAmpAvg

public double getCavAmpAvg()
                    throws GetException

get the cavity amplitude (MV) and publish this to all the gaps connected to this cavity note the cavity amp [MV] = klystron amplitude * ampFactor where ampFactor is a calibration factor determined experimentally

Throws:

GetException

toCavAmpAvgFromCA

public double toCavAmpAvgFromCA(double rawValue)

Convert the raw channel access value to get the cavity amplitude in MV.

Parameters:

rawValue - the raw channel value

Returns:

the cavity amplitude in MV

toCAFromCavAmpAvg

public double toCAFromCavAmpAvg(double value)

Convert the cavity amplitude to channel access.

Parameters:

value - the cavity amplitude

Returns:

the channel access value

getCavPhaseAvg

public double getCavPhaseAvg()
                      throws GetException

Get the cavity phase relative to the beam (deg) and publish it to all the rf gaps associated with this cavity note the cavity phase = klystron phase + phaseOffset where phaseOffset is a calibration factor determined experimentally

Throws:

GetException

toCavPhaseAvgFromCA

public double toCavPhaseAvgFromCA(double rawValue)

Convert the raw channel access value to get the cavity phase in degrees.

Parameters:

rawValue - the raw channel value

Returns:

the cavity phase in degrees

toCAFromCavPhaseAvg

public double toCAFromCavPhaseAvg(double value)

Convert the cavity phase to channel access.

Parameters:

value - the cavity phase

Returns:

the channel access value

getDfltCavAmp

public double getDfltCavAmp()

Returns:

default (design) cavity amplitude (MV)

getDfltCavPhase

public double getDfltCavPhase()

Returns:

default (design) cavity phase (deg)

setDfltCavAmp

public void setDfltCavAmp(double value)

setDfltCavPhase

public void setDfltCavPhase(double value)

getDfltAvgCavPhase

public double getDfltAvgCavPhase()

Returns:

default (design) average cavity phase (averaged over all RF gaps in the cavity)

getDfltAvgCavTTF

public double getDfltAvgCavTTF()

CKA - Never used

Returns:

default (design) average cavity TTF (averaged over all RF gaps in the cavity)

getRFLength

public double getRFLength()

get the length of the active RF accelerating structure in this cavity (m)

toAvgCavPhaseFromCavPhase

public double toAvgCavPhaseFromCavPhase(double cavityPhase)

Convert the cavity phase (phase at entrance to cavity) to average cavity phase by averaging the phase over the gaps.

Parameters:

cavityPhase - the phase at the start of the cavity.

Returns:

the average phase of the cavity

toCenterAvgCavPhaseFromCavPhase

public double toCenterAvgCavPhaseFromCavPhase(double cavityPhase)

Calculate the average phase of the gaps at the center of the cavity from the phase at the entrance to the cavity.

Parameters:

cavityPhase - the phase at the start of the cavity.

Returns:

the average phase of the cavity

setCavAmp

public void setCavAmp(double newAmp)
               throws PutException

Set the cavity amplitude [MV] note the cavity amp [MV] = klystron amp * ampFactor where ampFactor is a calibration factor determined experimentally

Throws:

PutException

setCavPhase

public void setCavPhase(double newPhase)
                 throws PutException

Set the cavity phase relative to the beam (deg) note the cavity phase = klystron phase + phaseOffset where phaseOffset is a calibration factor determined experimentally

Throws:

PutException

getCavAmpSetPoint

public double getCavAmpSetPoint()
                         throws GetException

return the present live set point for the amplitude

Throws:

GetException

getCavPhaseSetPoint

public double getCavPhaseSetPoint()
                           throws GetException

return the present live set point for the phase

Throws:

GetException

getBlankBeam

public boolean getBlankBeam()
                     throws GetException

Determine whether the beam is blanked

Returns:

true if the beam is blanked and false if not

Throws:

GetException

setBlankBeam

public void setBlankBeam(boolean mode)
                  throws PutException

Blank the beam

Parameters:

mode - true to blank the beam and false for continuous on

Throws:

PutException

getGaps

public Collection<RfGap> getGaps()

method to return the gaps associated with this cavity

getGapsAsList

public List<RfGap> getGapsAsList()

method to return the gaps associated with this cavity as a List

updateDesignPhase

public void updateDesignPhase(double phase)

Set the design phase

Parameters:

phase - new design phase (deg)

updateDesignAmp

public void updateDesignAmp(double amp)

method to set the design amplitude

Parameters:

amp - new design amplitude (MV)

getTTFFit

public RealUnivariatePolynomial getTTFFit()

return a polynomial fit of the transit time factor as a function of beta

getTTFPrimeFit

public RealUnivariatePolynomial getTTFPrimeFit()

return a polynomial fit of the transit time factor prime as a function of beta

getSTFFit

public RealUnivariatePolynomial getSTFFit()

return a polynomial fit of the "S" transit time factor as a function of beta

getSTFPrimeFit

public RealUnivariatePolynomial getSTFPrimeFit()

return a polynomial fit of the "S" transit time factor prime as a function of beta

getTTFFitEnd

public RealUnivariatePolynomial getTTFFitEnd()

return a polynomial fit of the transit time factor for end cells as a function of beta

getTTFPrimeFitEnd

public RealUnivariatePolynomial getTTFPrimeFitEnd()

return a polynomial fit of the transit time factor prime for end cells as a function of beta

getSTFFitEnd

public RealUnivariatePolynomial getSTFFitEnd()

return a polynomial fit of the "S" transit time factor for end cells as a function of beta

getSTFPrimeFitEnd

public RealUnivariatePolynomial getSTFPrimeFitEnd()

return a polynomial fit of the "S" transit time factor prime for end cells as a function of beta

getStructureMode

public double getStructureMode()

returns 0 if the gap is part of a 0 mode cavity structure (e.g. DTL) returns 1 if the gap is part of a pi mode cavity (e.g. CCL, Superconducting)

getCavFreq

public double getCavFreq()

Get RF cavity frequency.

Returns:

RF cavity frequency (MHz)