Package xal.smf.impl

Class SCLCavity

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.AcceleratorSeq

xal.smf.impl.RfCavity

xal.smf.impl.SCLCavity

All Implemented Interfaces:

Comparable, ElementType, DataListener

public class SCLCavity
extends RfCavity

SCLCavity class is used to represent an SCL RF cavity.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	identifies this class

Fields inherited from class xal.smf.impl.RfCavity

amplitude, BLANK_BEAM_HANDLE, blankBeam, bucRfCavity, CAV_AMP_AVG_HANDLE, CAV_AMP_SET_HANDLE, CAV_PHASE_AVG_HANDLE, CAV_PHASE_SET_HANDLE, DELTA_TRF_END_HANDLE, DELTA_TRF_START_HANDLE, deltaTRFEnd, deltaTRFStart, gaps, phase, T_DELAY_HANDLE, tDelay

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
SCLCavity(String strID)	Constructor
SCLCavity(String strID, int arrayReserve)	Primary Constructor
SCLCavity(String strId, ChannelFactory channelFactory)	Constructor
SCLCavity(String strId, ChannelFactory channelFactory, int intReserve)	Primary Constructor

Method Summary

Modifier and Type	Method	Description
double	getAvgTTF(double beta)	Deprecated. Read the comments about being a hard coded kluge job.
double	getFieldWithCavityOff(double current, double energy, double resErr, double plsWdth)	Deprecated. This is one of only two methods that uses stuff from outside, and that stuff is the sclcavity sub-package which is completely hard coded for the SNS SCL.
double	getFieldWithCavityOff(double current, double energy, double resErr, double[] plsArry, double sampleRate)	Deprecated. This is one of only two methods that uses stuff from outside, and that stuff is the sclcavity sub-package which is completely hard coded for the SNS SCL.
double	getQLoaded()
double	getStructureTTF()
String	getType()	Get this node's type.
double	toCAFromCavAmpAvg(double value)	Convert the cavity amplitude to channel access.
double	toCavAmpAvgFromCA(double rawValue)	Convert the raw channel access value to get the cavity amplitude in MV/m.

Methods inherited from class xal.smf.impl.RfCavity

addBucket, addNode, getBlankBeam, getCavAmpAvg, getCavAmpSetPoint, getCavFreq, getCavPhaseAvg, getCavPhaseSetPoint, getDfltAvgCavPhase, getDfltAvgCavTTF, getDfltCavAmp, getDfltCavPhase, getGaps, getGapsAsList, getRfField, getRFLength, getSTFFit, getSTFFitEnd, getSTFPrimeFit, getSTFPrimeFitEnd, getStructureMode, getTTFFit, getTTFFitEnd, getTTFPrimeFit, getTTFPrimeFitEnd, setBlankBeam, setCavAmp, setCavPhase, setDfltCavAmp, setDfltCavPhase, setRfField, toAvgCavPhaseFromCavPhase, toCAFromCavPhaseAvg, toCavPhaseAvgFromCA, toCenterAvgCavPhaseFromCavPhase, update, updateDesignAmp, updateDesignPhase

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

TYPE

public static final String TYPE

identifies this class

See Also:

• Constant Field Values

Constructor Details

SCLCavity

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

Primary Constructor

SCLCavity

public SCLCavity(String strId,
 ChannelFactory channelFactory)

Constructor

SCLCavity

public SCLCavity(String strID,
 int arrayReserve)

Primary Constructor

SCLCavity

public SCLCavity(String strID)

Constructor

Method Details

getType

public String getType()

Get this node's type.

Overrides:

getType in class RfCavity

Returns:

the type ID of this node.

getStructureTTF

public double getStructureTTF()

Returns:

constant TTF used in the accelerator LLRF

getQLoaded

public double getQLoaded()

Returns:

Q external

getFieldWithCavityOff

@Deprecated
public double getFieldWithCavityOff(double current,
 double energy,
 double resErr,
 double plsWdth)

Deprecated.

This is one of only two methods that uses stuff from outside, and that stuff is the sclcavity sub-package which is completely hard coded for the SNS SCL. We must get rid of sclcavity.

Parameters:

current - beam current (mA)

energy - beam kinetic energy (MeV)

resErr - cavity resonance error (Hz)

plsWdth - beam pulse width (micro-sec, single number, assume beam is square wave)

Returns:

cavity field induced by beam loading when the cavity is off

getFieldWithCavityOff

@Deprecated
public double getFieldWithCavityOff(double current,
 double energy,
 double resErr,
 double[] plsArry,
 double sampleRate)

Deprecated.

This is one of only two methods that uses stuff from outside, and that stuff is the sclcavity sub-package which is completely hard coded for the SNS SCL. We must get rid of sclcavity.

Parameters:

current - beam current (mA)

energy - beam kinetic energy (MeV)

resErr - cavity resonance error (Hz)

plsArry - beam pulse array

sampleRate - BCM sample rate (micro-sec, single number)

Returns:

cavity field induced by beam loading when the cavity is off

toCavAmpAvgFromCA

public double toCavAmpAvgFromCA(double rawValue)

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

Overrides:

toCavAmpAvgFromCA in class RfCavity

Parameters:

rawValue - the raw channel value

Returns:

the cavity amplitude in MV/m

toCAFromCavAmpAvg

public double toCAFromCavAmpAvg(double value)

Convert the cavity amplitude to channel access.

Overrides:

toCAFromCavAmpAvg in class RfCavity

Parameters:

value - the cavity amplitude

Returns:

the channel access value

getAvgTTF

@Deprecated
public double getAvgTTF(double beta)

Deprecated.

Read the comments about being a hard coded kluge job.

get the average TTF for the cavity as a function of beta this should use parameters form the database, the hardwired fit coefficients should go in the database - this is temp.