xal.smf.impl

Class RfGap

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.RfGap

All Implemented Interfaces:

ElementType, DataListener

public class RfGap
extends AcceleratorNode

The implementation of the RF gap element. The RfGap class is meant to be used in connection with a set of related RF gaps, such as the gaps in a DTL Tank, which are all part of a single resonant cavity controlled by a single klystron. Each gap may have a fixed scale factor for both the field and phase, relative to a nominal field and phase.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected RfGapBucket	m_bucRfGap The rf gap bucket containing the length, ampFactor, phaseFactor and TTF
static java.lang.String	s_strType

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
RfGap(java.lang.String strId)

Method Summary

Modifier and Type	Method and Description
void	addBucket(AttributeBucket buc) Override AcceleratorNode implementation to check for a RfGapBucket
double	getDesignEnergyGain() Computes and returns the design value of the energy gain for this gap.
double	getDesignPropertyValue(java.lang.String propertyName) Get the design value for the specified property
double	getGapAmpAvg() return the RF amplitude in the gap (kV/m).
double	getGapDfltAmp() return the RF amplitude in the gap (kV/m)
double	getGapDfltE0TL() This is the product of the field * gap length * TTF
double	getGapDfltFrequency() return the RF fundamental frequency
double	getGapDfltPhase() return the RF phase in the gap (deg)
double	getGapE0TL() This is the product of the field * gap length * TTF
double	getGapLength() return Rf Gap Length
double	getGapOffset() these may be different, for example, for a DTL cavity
double	getGapPhaseAvg() This includes the calibration offset factor if it has been set
double	getGapTTF() return TTF
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()
RfGapBucket	getRfGap()
UnivariateRealPolynomial	getSFit() return a polynomial fit of the S factor as a function of beta
UnivariateRealPolynomial	getSPrimeFit() return a polynomial fit of the S-prime factor 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	getTTFPrimeFit() return a polynomial fit of the TTF-prime factor as a function of beta
java.lang.String	getType() Override to provide type signature
boolean	isEndCell() returns whether this is the first gap of a cavity string
boolean	isFirstGap() returns whether this is the first gap of a cavity string
void	setFirstGap(boolean tf) sets the flag indicating whether this is the first gap in a cavity
void	setGapAmp(double cavAmp) Set the RF amplitude in the (kV/m) should be done by the parent cavity (e.g.
void	setGapPhase(double cavPhase) Set the RF phase in the gap (deg) should be done by the parent cavity (e.g.
void	setRfGap(RfGapBucket buc)
double	toE0TLFromGapField(double field) Convert RF gap field, E0, to E0TL.
double	toGapAmpFromCavityAmp(double cavityAmp) Convert RF cavity amplitude to get the RF gap's amplitude.
double	toGapPhaseFromCavityPhase(double cavityPhase) Convert RF cavity phase to get the RF gap's phase.

Methods inherited from class xal.smf.AcceleratorNode

channelSuite, clear, dataLabel, findChannel, getAccelerator, getAlign, getAndConnectChannel, getAper, getBucket, getBuckets, getChannel, getEId, getHandles, getId, getLength, getParent, getPId, getPitchAngle, getPosition, getPrimaryAncestor, 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, update, write

Methods inherited from class java.lang.Object

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

Field Detail

s_strType

public static final java.lang.String s_strType

See Also:

Constant Field Values

m_bucRfGap

protected RfGapBucket m_bucRfGap

The rf gap bucket containing the length, ampFactor, phaseFactor and TTF

Constructor Detail

RfGap

public RfGap(java.lang.String strId)

Method Detail

getType

public java.lang.String getType()

Override to provide type signature

Specified by:

getType in class AcceleratorNode

getRfGap

public RfGapBucket getRfGap()

setRfGap

public void setRfGap(RfGapBucket buc)

addBucket

public void addBucket(AttributeBucket buc)

Override AcceleratorNode implementation to check for a RfGapBucket

Overrides:

addBucket in class AcceleratorNode

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

getGapAmpAvg

public double getGapAmpAvg()
                    throws ConnectionException,
                           GetException

return the RF amplitude in the gap (kV/m). Note, this method should probably be modified

Throws:

ConnectionException

GetException

getGapDfltAmp

public double getGapDfltAmp()

return the RF amplitude in the gap (kV/m)

getGapPhaseAvg

public double getGapPhaseAvg()
                      throws ConnectionException,
                             GetException

This includes the calibration offset factor if it has been set

Returns:

the RF phase in the gap (deg).

Throws:

ConnectionException

GetException

getGapE0TL

public double getGapE0TL()
                  throws ConnectionException,
                         GetException

This is the product of the field * gap length * TTF

Returns:

the E0TL product (kV)

Throws:

ConnectionException

GetException

getGapDfltE0TL

public double getGapDfltE0TL()

This is the product of the field * gap length * TTF

Returns:

the E0TL product (kV)

getGapDfltPhase

public double getGapDfltPhase()

return the RF phase in the gap (deg)

getGapDfltFrequency

public double getGapDfltFrequency()

return the RF fundamental frequency

toGapAmpFromCavityAmp

public double toGapAmpFromCavityAmp(double cavityAmp)

Convert RF cavity amplitude to get the RF gap's amplitude.

Parameters:

cavityAmp - the RF cavity's amplitude

Returns:

this RF gap's amplitude

toGapPhaseFromCavityPhase

public double toGapPhaseFromCavityPhase(double cavityPhase)

Convert RF cavity phase to get the RF gap's phase.

Parameters:

cavityPhase - the RF cavity's phase

Returns:

this RF gap's phase

toE0TLFromGapField

public double toE0TLFromGapField(double field)

Convert RF gap field, E0, to E0TL. This is the product of the field * gap length * TTF.

Parameters:

field - the RF field in KV/m

Returns:

the E0TL product (kV)

getGapLength

public double getGapLength()

return Rf Gap Length

getGapTTF

public double getGapTTF()

return TTF

setGapAmp

public void setGapAmp(double cavAmp)

Set the RF amplitude in the (kV/m) should be done by the parent cavity (e.g. DTL tank)

Currently this method does nothing!

Parameters:

cavAmp - The amplitude of the first gap (kV/m)

setGapPhase

public void setGapPhase(double cavPhase)

Set the RF phase in the gap (deg) should be done by the parent cavity (e.g. DTL tank)

Parameters:

cavPhase - The phase of the first gap (deg)

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 TTF-prime factor as a function of beta

getSFit

public UnivariateRealPolynomial getSFit()

return a polynomial fit of the S factor as a function of beta

getSPrimeFit

public UnivariateRealPolynomial getSPrimeFit()

return a polynomial fit of the S-prime factor 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)

getGapOffset

public double getGapOffset()

these may be different, for example, for a DTL cavity

Returns:

the offset of the gap center from the cell center (m)

setFirstGap

public void setFirstGap(boolean tf)

sets the flag indicating whether this is the first gap in a cavity

isFirstGap

public boolean isFirstGap()

returns whether this is the first gap of a cavity string

isEndCell

public boolean isEndCell()

returns whether this is the first gap of a cavity string

getDesignEnergyGain

public double getDesignEnergyGain()

Computes and returns the design value of the energy gain for this gap. The energy gain is given by the Panofsky equation dW=q E0 T L cos(phi).

Returns:

design energy gain (eV) Added 10/17/02 CKA