xal.smf.impl

Class RfCavity

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.AcceleratorSeq

xal.smf.impl.RfCavity

All Implemented Interfaces:

ElementType, DataListener

Direct Known Subclasses:

CCL, DTLTank, 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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RfCavity.Property accessible properties

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<RfGap>	_gaps container of the enclosed RfGap(s) in this cavity sorted by position
static java.lang.String	BLANK_BEAM_HANDLE
static java.lang.String	CAV_AMP_AVG_HANDLE
static java.lang.String	CAV_AMP_SET_HANDLE
static java.lang.String	CAV_PHASE_AVG_HANDLE
static java.lang.String	CAV_PHASE_SET_HANDLE
static java.lang.String	DELTA_TRF_END_HANDLE
static java.lang.String	DELTA_TRF_START_HANDLE
protected RfCavityBucket	m_bucRfCavity RF Cavity parameters
static java.lang.String	s_strType accelerator node type
static java.lang.String	T_DELAY_HANDLE

Fields inherited from class xal.smf.AcceleratorSeq

_sequences, m_arrNodes, m_bucSequence, nodeTable

Fields inherited from class xal.smf.AcceleratorNode

channelSuite, m_bolIsSoft, m_bolStatus, m_bolValid, m_bucAlign, m_bucAper, m_bucTwiss, m_dblLen, m_dblPos, m_dblS, m_mapAttrs, m_objAccel, m_seqParent, m_strEId, m_strId, m_strPId

Constructor Summary

Constructors

Constructor and Description
RfCavity(java.lang.String strId) Constructor
RfCavity(java.lang.String strId, int intReserve) Constructor

Method Summary

Modifier and Type	Method and Description
void	addBucket(AttributeBucket buc) Override AcceleratorNode implementation to check for a RfCavityStruct Bucket
boolean	getBlankBeam() Determine whether the beam is blanked
double	getCavAmpAvg() get the cavity amplitude (kV) and publish this to all the gaps connected to this cavity note the cavity amp [kV] = 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	getDesignPropertyValue(java.lang.String propertyName) Get the design value for the specified property
double	getDfltAvgCavPhase()
double	getDfltAvgCavTTF()
double	getDfltCavAmp()
double	getDfltCavPhase()
java.util.Collection<RfGap>	getGaps() method to return the gaps associated with this cavity
java.util.List<RfGap>	getGapsAsList() method to return the gaps associated with this cavity as a List
Channel[]	getLivePropertyChannels(java.lang.String propertyName) Get the array of channels for the specified property
double	getLivePropertyValue(java.lang.String propertyName, double[] channelValues) Get the live property value for the corresponding array of channel values in the order given by getLivePropertyChannels()
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)
UnivariateRealPolynomial	getSTFFit() return a polynomial fit of the "S" transit time factor as a function of beta
UnivariateRealPolynomial	getSTFFitEnd() return a polynomial fit of the "S" transit time factor for end cells as a function of beta
UnivariateRealPolynomial	getSTFPrimeFit() return a polynomial fit of the "S" transit time factor prime as a function of beta
UnivariateRealPolynomial	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.
UnivariateRealPolynomial	getTTFFit() return a polynomial fit of the transit time factor as a function of beta
UnivariateRealPolynomial	getTTFFitEnd() return a polynomial fit of the transit time factor for end cells as a function of beta
UnivariateRealPolynomial	getTTFPrimeFit() return a polynomial fit of the transit time factor prime as a function of beta
UnivariateRealPolynomial	getTTFPrimeFitEnd() return a polynomial fit of the transit time factor prime for end cells as a function of beta
java.lang.String	getType() Override to provide type signature
protected void	publishAmplitude(double newCavAmp)
void	publishPhase(double newCavPhase)
void	setBlankBeam(boolean mode) Blank the beam
void	setCavAmp(double newAmp) Set the cavity amplitude [kV] note the cavity amp [kV] = 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 kV.
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

addNode, addNodeAt, addSequenceChain, addSoft, appendNodesOfClassWithQualifier, appendNodesWithQualifier, canPrecede, contains, dataLabel, filterNodesByClass, filterNodesByStatus, formsRing, getAllInclusiveNodes, getAllInclusiveNodes, getAllInclusiveNodesWithQualifier, getAllNodes, getAllNodes, getAllNodesOfType, getAllNodesWithQualifier, getAllSeqs, 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, writeDeeply

Methods inherited from class xal.smf.AcceleratorNode

channelSuite, clear, findChannel, getAccelerator, getAlign, getAndConnectChannel, getAper, getBucket, getBuckets, getChannel, getEId, getHandles, getId, getParent, getPId, getPitchAngle, getPosition, getRollAngle, getSDisplay, getSoftType, getStatus, getTwiss, getValid, getXOffset, getYawAngle, getYOffset, getZOffset, hasBucket, hasParent, isKindOf, isMagnet, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setLength, setParent, setPitchAngle, setPosition, setRollAngle, setSDisplay, setStatus, setTwiss, setValid, setXOffset, setYawAngle, setYOffset, setZOffset, toString

Methods inherited from class java.lang.Object

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

Field Detail

CAV_AMP_SET_HANDLE

public static final java.lang.String CAV_AMP_SET_HANDLE

See Also:

Constant Field Values

CAV_PHASE_SET_HANDLE

public static final java.lang.String CAV_PHASE_SET_HANDLE

See Also:

Constant Field Values

CAV_AMP_AVG_HANDLE

public static final java.lang.String CAV_AMP_AVG_HANDLE

See Also:

Constant Field Values

CAV_PHASE_AVG_HANDLE

public static final java.lang.String CAV_PHASE_AVG_HANDLE

See Also:

Constant Field Values

DELTA_TRF_START_HANDLE

public static final java.lang.String DELTA_TRF_START_HANDLE

See Also:

Constant Field Values

DELTA_TRF_END_HANDLE

public static final java.lang.String DELTA_TRF_END_HANDLE

See Also:

Constant Field Values

T_DELAY_HANDLE

public static final java.lang.String T_DELAY_HANDLE

See Also:

Constant Field Values

BLANK_BEAM_HANDLE

public static final java.lang.String BLANK_BEAM_HANDLE

See Also:

Constant Field Values

s_strType

public static final java.lang.String s_strType

accelerator node type

See Also:

Constant Field Values

m_bucRfCavity

protected RfCavityBucket m_bucRfCavity

RF Cavity parameters

_gaps

protected java.util.List<RfGap> _gaps

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

NOTE:

I don't understand the point of this, an RfCavityStruct is an AcceleratorSeq which is already an ordered list of AcceleratorNodes. This attribute and any reliance on it seems dangerously redundant.

Constructor Detail

RfCavity

public RfCavity(java.lang.String strId)

Constructor

RfCavity

public RfCavity(java.lang.String strId,
                int intReserve)

Constructor

Method Detail

getType

public java.lang.String getType()

Override to provide type signature

Overrides:

getType 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

getDesignPropertyValue

public double getDesignPropertyValue(java.lang.String propertyName)

Get the design value for the specified property

Overrides:

getDesignPropertyValue in class AcceleratorNode

getLivePropertyValue

public double getLivePropertyValue(java.lang.String propertyName,
                                   double[] channelValues)

Get the live property value for the corresponding array of channel values in the order given by getLivePropertyChannels()

Overrides:

getLivePropertyValue in class AcceleratorNode

getLivePropertyChannels

public Channel[] getLivePropertyChannels(java.lang.String propertyName)

Get the array of channels for the specified property

Overrides:

getLivePropertyChannels in class AcceleratorNode

getCavAmpAvg

public double getCavAmpAvg()
                    throws ConnectionException,
                           GetException

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

Throws:

ConnectionException

GetException

toCavAmpAvgFromCA

public double toCavAmpAvgFromCA(double rawValue)

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

Parameters:

rawValue - the raw channel value

Returns:

the cavity amplitude in kV

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 ConnectionException,
                             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:

ConnectionException

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

getDfltCavPhase

public double getDfltCavPhase()

Returns:

default (design) cavity phase

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()

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 ConnectionException,
                      PutException

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

Throws:

ConnectionException

PutException

setCavPhase

public void setCavPhase(double newPhase)
                 throws ConnectionException,
                        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:

ConnectionException

PutException

getCavAmpSetPoint

public double getCavAmpSetPoint()
                         throws ConnectionException,
                                GetException

return the present live set point for the amplitude

Throws:

ConnectionException

GetException

getCavPhaseSetPoint

public double getCavPhaseSetPoint()
                           throws ConnectionException,
                                  GetException

return the present live set point for the phase

Throws:

ConnectionException

GetException

publishAmplitude

protected void publishAmplitude(double newCavAmp)

publishPhase

public void publishPhase(double newCavPhase)

getBlankBeam

public boolean getBlankBeam()
                     throws ConnectionException,
                            GetException

Determine whether the beam is blanked

Returns:

true if the beam is blanked and false if not

Throws:

ConnectionException

GetException

setBlankBeam

public void setBlankBeam(boolean mode)
                  throws ConnectionException,
                         PutException

Blank the beam

Parameters:

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

Throws:

ConnectionException

PutException

getGaps

public java.util.Collection<RfGap> getGaps()

method to return the gaps associated with this cavity

getGapsAsList

public java.util.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 (kV)

getTTFFit

public UnivariateRealPolynomial getTTFFit()

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

getTTFPrimeFit

public UnivariateRealPolynomial getTTFPrimeFit()

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

getSTFFit

public UnivariateRealPolynomial getSTFFit()

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

getSTFPrimeFit

public UnivariateRealPolynomial getSTFPrimeFit()

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

getTTFFitEnd

public UnivariateRealPolynomial getTTFFitEnd()

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

getTTFPrimeFitEnd

public UnivariateRealPolynomial getTTFPrimeFitEnd()

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

getSTFFitEnd

public UnivariateRealPolynomial getSTFFitEnd()

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

getSTFPrimeFitEnd

public UnivariateRealPolynomial 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