Package xal.model.elem.sync

Interface IRfCavity

All Known Implementing Classes:
IdealRfCavity
public interface IRfCavity
Common parameters of RF Cavity structures. TODO CKA Add PROPERTY_FREQUENCY property to RfCavitySynchronizer??
Since:
Mar 17, 2004
Version:
Jan 25, 2015
Author:
Craig McChesney, Christopher K. Allen

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    computeSynchronousPhaseAndEnergyGain()
    Compute the synchronous phase and the energy gain for a cavity gap.
    double
    getCavAmp()
    Get the RF cavity field amplitude.
    double
    getCavFrequency()
    Get the operating frequency of the cavity.
    double
    getCavPhase()
    Get the RF cavity field phase.
    double
    getEnergyGain()
    Return the energy gain of a cavity gap previously calculated.
    double
    getSynchronousPhase()
    Return the synchronous phase of a cavity gap, which must be previously calculated using computeSynchronousPhase.
    void
    setCavAmp(double dblAmp)
    Set the RF cavity field amplitude.
    void
    setCavFrequency(double dblFreq)
    Sets the frequency of the RF in the cavity.
    void
    setCavPhase(double dblPhase)
    Set the RF cavity field phase.

  • Method Details

    • getCavAmp

      double getCavAmp()
      Get the RF cavity field amplitude.
      Returns:
      cavity amplitude (in MV/m).

    • getCavFrequency

      double getCavFrequency()
      Get the operating frequency of the cavity.
      Returns:
      frequency of RF cavity (in Hertz)

    • getCavPhase

      double getCavPhase()
      Get the RF cavity field phase.
      Returns:
      cavity phase (in Rad).

    • setCavAmp

      void setCavAmp(double dblAmp)
      Set the RF cavity field amplitude.
      Parameters:
      dblAmp - cavity amplitude (in MV/m).

    • setCavFrequency

      void setCavFrequency(double dblFreq)
      Sets the frequency of the RF in the cavity.
      Parameters:
      dblFreq - RF frequency (in Hz)
      Since:
      Jan 22, 2015 by Christopher K. Allen

    • setCavPhase

      void setCavPhase(double dblPhase)
      Set the RF cavity field phase.
      Parameters:
      dblAmp - cavity phase (in Rad).

    • computeSynchronousPhaseAndEnergyGain

      void computeSynchronousPhaseAndEnergyGain()
      Compute the synchronous phase and the energy gain for a cavity gap.

    • 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: