Package xal.model.elem

Class IdealRfCavityDrift

java.lang.Object

xal.model.elem.Element

xal.model.elem.ThickElement

xal.model.elem.IdealDrift

xal.model.elem.IdealRfCavityDrift

All Implemented Interfaces:

IComponent, IElement

public class IdealRfCavityDrift
extends IdealDrift

Represents a drift region between RF cavity accelerating gaps. Extends the IdealDrift class to include a frequency parameter f which is necessary in computing probe phase advance through the drift.

I think we are going to include the structure mode number q in here as well. This way the phase advance due to the higher order modes can be accounted for here.

Since:

Nov 28, 2014

Author:

Christopher K. Allen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STR_TYPEID	string type identifier for all IdealDrift objects

Fields inherited from class xal.model.elem.IdealDrift

TYPE

Fields inherited from class xal.model.elem.Element

dblNodeLen, dblNodePos

Fields inherited from interface xal.model.IElement

LIGHT_SPEED, PERMEABILITY, PERMITTIVITY, UNIT_CHARGE

Constructor Summary

Constructors

Constructor	Description
IdealRfCavityDrift()	Constructor for IdealRfCavityDrift.
IdealRfCavityDrift(String strId, double dblLen)	Constructor for IdealRfCavityDrift.
IdealRfCavityDrift(String strId, double dblLen, double dblFreq, double dblModeConst)	Fully initializing constructor for IdealRfCavityDrift.

Method Summary

Modifier and Type	Method	Description
double	getCavityModeConstant()	Get the operating mode constant λ for the RF cavity design.
double	getFrequency()	Get the frequency of the RF cavity containing this drift space.
double	longitudinalPhaseAdvance(IProbe probe, double dblLen)	Computes and returns the phase advance of the probe while drifting through the given segment of this drift.
void	setCavityModeConstant(double dblModeConst)	Set the operating mode constant λ for the RF cavity design.
void	setFrequency(double dblFreq)	Set the frequency of the RF cavity containing this drift space.
String	toString()

Methods inherited from class xal.model.elem.IdealDrift

elapsedTime, energyGain, getKDrift, prepareFringe, transferMap

Methods inherited from class xal.model.elem.ThickElement

applyErrors, getLength, initializeFrom, isFirstSubslice, isLastSubslice, setLength

Methods inherited from class xal.model.elem.Element

addCloseElements, backPropagate, backPropagate, compDriftingTime, compProbeLocation, getAlignX, getAlignY, getAlignZ, getCloseElements, getHardwareNodeId, getId, getLatticePosition, getNodeLen, getNodePos, getParent, getPhiX, getPhiY, getPhiZ, getPosition, getType, getUID, print, propagate, propagate, setAlign, setAlignX, setAlignY, setAlignZ, setHardwareNodeId, setId, setParent, setPhiX, setPhiY, setPhiZ, setPosition

Methods inherited from class java.lang.Object

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

Field Details

STR_TYPEID

public static final String STR_TYPEID

string type identifier for all IdealDrift objects

See Also:

• Constant Field Values

Constructor Details

IdealRfCavityDrift

public IdealRfCavityDrift(String strId,
 double dblLen,
 double dblFreq,
 double dblModeConst)

Fully initializing constructor for IdealRfCavityDrift. Constructor initializes all defining parameters of this RF cavity drift space.

Parameters:

strId - string identifier of the drift

dblLen - length of the RF cavity drift

dblFreq - RF frequency of the enclosing RF Cavity

dblModeConst - RF structure constant for the cavity operating mode

Since:

Dec 3, 2014

IdealRfCavityDrift

public IdealRfCavityDrift(String strId,
 double dblLen)

Constructor for IdealRfCavityDrift.

Parameters:

strId - the string identifier of the drift space

dblLen - the length of the drift space

Since:

Nov 28, 2014

IdealRfCavityDrift

public IdealRfCavityDrift()

Constructor for IdealRfCavityDrift.

Since:

Nov 28, 2014

Method Details

setFrequency

public void setFrequency(double dblFreq)

Set the frequency of the RF cavity containing this drift space.

Parameters:

dblFreq - fundamental RF frequency of the enclosing RF cavity

setCavityModeConstant

public void setCavityModeConstant(double dblModeConst)

Set the operating mode constant λ for the RF cavity design. The constant is half of the mode number q. Specifically,

λ = 0 (q=0) ⇒ 0 mode cavity structure (e.g. DTL)

λ = 1/2 (q=1) ⇒ π/2 mode structure (bi-periodic structures, e.g., SideCC)

λ = 1 (q=2) ⇒ π-mode cavity (e.g. CCL, super-conducting)

Parameters:

dblModeConst - the new mode constant λ for the cavity drift

getFrequency

public double getFrequency()

Get the frequency of the RF cavity containing this drift space.

Returns:

the fundamental mode frequency f₀ of the enclosing RF cavity

getCavityModeConstant

public double getCavityModeConstant()

Get the operating mode constant λ for the RF cavity design. The constant is half of the mode number q. Specifically,

λ = 0 (q=0) ⇒ 0 mode cavity structure (e.g. DTL)

λ = 1/2 (q=1) ⇒ π/2 mode structure (bi-periodic structures, e.g., SideCC)

λ = 1 (q=2) ⇒ π-mode cavity (e.g. CCL, super-conducting)

Returns:

the operating mode constant λ for the cavity drift

longitudinalPhaseAdvance

public double longitudinalPhaseAdvance(IProbe probe,
 double dblLen)

Computes and returns the phase advance of the probe while drifting through the given segment of this drift.

Specified by:

longitudinalPhaseAdvance in interface IElement

Overrides:

longitudinalPhaseAdvance in class ThickElement

Parameters:

probe - the probe propagating through this element

dblLen - distance the probe propagates through the element

Returns:

longitudinal phase advance of the probe through given distance

Since:

Dec 2, 2014

See Also:

• Element.longitudinalPhaseAdvance(xal.model.IProbe, double)

toString

public String toString()

Overrides:

toString in class Element

Since:

Jan 22, 2015 by Christopher K. Allen

See Also:

• Element.toString()