gov.sns.xal.model.elem
Interface IRfGap

All Known Implementing Classes:
IdealRfGap

public interface IRfGap

This interface defines the common properties of all RF Gap structures.


Method Summary
 double getE0()
          Get the on accelerating field (V/m)
 double getETL()
          Return the ETL product of the gap, where E is the longitudinal electric field, T is the transit time factor, and L is the gap length.
 double getFrequency()
          Get the operating frequency of the RF gap.
 double getPhase()
          Return the RF phase delay of the gap with respect to the synchonous particle.
 void setE0(double E)
          Set the on accelerating field
 void setETL(double dblETL)
          Set the ETL product of the RF gap where E is the longitudinal electric field of the gap, T is the transit time factor of the gap, L is the length of the gap.
 void setFrequency(double dblFreq)
          Set the operating frequency of the RF gap.
 void setPhase(double dblPhase)
          Set the phase delay of the RF in gap with respect to the synchronous particle.
 

Method Detail

setETL

public void setETL(double dblETL)
Set the ETL product of the RF gap where E is the longitudinal electric field of the gap, T is the transit time factor of the gap, L is the length of the gap. The maximum energy gain from the gap is given by qETL where q is the charge (in coulombs) of the species particle.

Parameters:
dblETL - ETL product of gap (in volts).

setPhase

public void setPhase(double dblPhase)
Set the phase delay of the RF in gap with respect to the synchronous particle. The actual energy gain from the gap is given by qETLcos(dblPhi) where dbkPhi is the phase delay.

Parameters:
dblPhase - phase delay of the RF w.r.t. synchonouse particle (in radians).

setFrequency

public void setFrequency(double dblFreq)
Set the operating frequency of the RF gap.

Parameters:
dblFreq - frequency of RF gap (in Hertz)

getETL

public double getETL()
Return the ETL product of the gap, where E is the longitudinal electric field, T is the transit time factor, and L is the gap length.

Returns:
the ETL product of the gap (in volts).

getPhase

public double getPhase()
Return the RF phase delay of the gap with respect to the synchonous particle.

Returns:
phase delay w.r.t. synchonous particle (in radians).

getFrequency

public double getFrequency()
Get the operating frequency of the RF gap.

Returns:
frequency of RF gap (in Hertz)

setE0

public void setE0(double E)
Set the on accelerating field


getE0

public double getE0()
Get the on accelerating field (V/m)