Package xal.model.elem.sync

Interface IRfGap

All Known Implementing Classes:
IdealRfGap, IdealRfGap, IdealRfGapUpgraded, SpectrumMapRfGap, ThickRfFieldMap, ThinRfFieldMap
public interface IRfGap
This interface defines the common properties of all RF Gap structures.
Since:
Nov 4, 2002
Author:
Christopher K. Allen

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    computeSynchronousPhaseAndEnergyGain(IProbe probe)
    Compute the synchronous phase and the energy gain for a cavity gap.
    double
    getE0()
    Get the on accelerating field (V/m)
    double
    getEnergyGain()
    Return the energy gain of a cavity gap previously calculated.
    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 synchronous particle.
    double
    getSynchronousPhase()
    Return the synchronous phase of a cavity gap, which must be previously calculated using computeSynchronousPhase.
    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 Details

    • setETL

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

    • setE0

      void setE0(double e)
      Set the on accelerating field. This method should be called by the RF cavity containing this gap and should use the amplitude factor.
      Parameters:
      e - - the on axis field (V/m)

    • setPhase

      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. This method should be called by the RF cavity containing this gap and should use the phase factor.
      Parameters:
      dblPhase - phase delay of the RF w.r.t. synchronous particle (in radians).

    • setFrequency

      void setFrequency(double dblFreq)
      Set the operating frequency of the RF gap.
      Parameters:
      dblFreq - frequency of RF gap (in Hertz)

    • getETL

      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

      double getPhase()
      Return the RF phase delay of the gap with respect to the synchronous particle.
      Returns:
      phase delay w.r.t. synchronous particle (in radians).

    • getFrequency

      double getFrequency()
      Get the operating frequency of the RF gap.
      Returns:
      frequency of RF gap (in Hertz)

    • getE0

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

    • computeSynchronousPhaseAndEnergyGain

      void computeSynchronousPhaseAndEnergyGain(IProbe probe)
      Compute the synchronous phase and the energy gain for a cavity gap.
      Parameters:
      probe -

    • getSynchronousPhase

      double getSynchronousPhase()
      Return the synchronous phase of a cavity gap, which must be previously calculated using computeSynchronousPhase.
      Returns:
      synchronous phase [rad]

    • getEnergyGain

      double getEnergyGain()
      Return the energy gain of a cavity gap previously calculated.
      Returns: