Package xal.model.elem

Class IdealMagWedgeDipole

java.lang.Object
xal.model.elem.ElementSeq
xal.model.elem.ElectromagnetSeq
xal.model.elem.IdealMagWedgeDipole
All Implemented Interfaces:
Iterable<IComponent>, IElectromagnet, IComponent, IComposite
@Deprecated public class IdealMagWedgeDipole extends ElectromagnetSeq
Deprecated.
This class has been replaced by IdealMagWedgeDipole2

Represents a bending dipole magnet with arbitrary pole face angles. This is a composite element constructed from three sub-elements - one IdealMagSectorDipole sandwiched between two IdealDipoleFace elements that provided the thin lens dynamics of the tilted pole faces.

NOTE:

A rectangle dipole can be specified by setting equal exit and entrance pole face angles.

Author:
Christopher K. Allen
See Also:
  • xal.model.elem#IdealMagSectorDipole
  • xal.model.elem#IdealMagDipoleFace

  • Field Details

    • TYPE

      public static final String TYPE
      Deprecated.
      string type identifier for all IdealMagSectorDipole objects
      See Also:

    • SIZE_RESERVE

      public static final int SIZE_RESERVE
      Deprecated.
      storage to reserve for child components
      See Also:

  • Constructor Details

    • IdealMagWedgeDipole

      public IdealMagWedgeDipole()
      Deprecated.
      Default constructor - creates a new uninitialized instance of IdealMagWedgeDipole.

    • IdealMagWedgeDipole

      public IdealMagWedgeDipole(String strId)
      Deprecated.
      Create new IdealMagWedgeDipole object and specify its instance identifier string.
      Parameters:
      strId - instance identifier string

  • Method Details

    • setLength

      public void setLength(double dblLen)
      Deprecated.
      Set the path length of the bending dipole along the design trajectory. Note that off-axis particles will experience a different path length which is accounted for in the dynamics.
      Parameters:
      dblLen - design path length through bend in meters

    • setFieldIndex

      public void setFieldIndex(double dblFldInd)
      Deprecated.
      Set the magnetic field index of the magnet evaluated at the design orbit. The field index is defined as n := -(R0/B0)(dB/dR) where R0 is the radius of the design orbit, B0 is the field at the design orbit (@see IdealMagSectorDipole#getField), and dB/dR is the derivative of the field with respect to the path deflection - evaluated at the design radius R0.
      Parameters:
      dblFldInd - field index of the magnet (unitless)

    • setGapSize

      public void setGapSize(double dblGap)
      Deprecated.
      Set the gap size between the dipole magnet poles.
      Parameters:
      dblGap - gap size in meters

    • setEntrPoleAngle

      public void setEntrPoleAngle(double dblAngPole)
      Deprecated.
      Set the entrance pole face angle with respect to the design trajectory
      Parameters:
      dblAngPole - pole face angle in radians

    • setExitPoleAngle

      public void setExitPoleAngle(double dblAngPole)
      Deprecated.
      Set the exit pole face angle with respect to the design trajectory
      Parameters:
      dblAngPole - pole face angle in radians

    • setEntrFringeIntegral

      public void setEntrFringeIntegral(double dblFldInt)
      Deprecated.
      Set the entrance fringe integral (a la D.C. Carey) which accounts for the first-order effects of the fringing field outside the dipole magnet.
      Parameters:
      dblFldInt - fringe field integral (unitless)
      See Also:

    • setExitFringeIntegral

      public void setExitFringeIntegral(double dblFldInt)
      Deprecated.
      Set the exit fringe integral (a la D.C. Carey) which accounts for the first-order effects of the fringing field outside the dipole magnet.
      Parameters:
      dblFldInt - fringe field integral (unitless)
      See Also:

    • getEntrFace

      public IdealMagDipoleFace getEntrFace()
      Deprecated.
      Return the entrance dipole face object of the wedge dipole.
      Returns:
      entrance pole face

    • getExitFace

      public IdealMagDipoleFace getExitFace()
      Deprecated.
      Return the exit dipole face object of this wedge dipole magnet.
      Returns:
      exit pole face

    • getMagBody

      public IdealMagSectorDipole getMagBody()
      Deprecated.
      Return the dipole magnet body object of this wedge dipole magnet. Note that the body is of type IdealMagSectorDipole which has no end effects.
      Returns:
      magnet body

    • getFieldIndex

      public double getFieldIndex()
      Deprecated.
      Return the magnetic field index of the magnet evaluated at the design orbit. The field index is defined as n := -(R0/B0)(dB/dR) where R0 is the radius of the design orbit, B0 is the field at the design orbit (@see IdealMagSectorDipole#getField), and dB/dR is the derivative of the field with respect to the path deflection - evaluated at the design radius R0.
      Returns:
      field index of the magnet at the design orbit (unitless)

    • getGapHeight

      public double getGapHeight()
      Deprecated.
      Return the gap size between the dipole magnet poles.
      Returns:
      gap size in meters

    • compCurvature

      public double compCurvature(IProbe probe)
      Deprecated.
      Compute the path curvature within the dipole for the given probe. The path curvature is 1/R where R is the bending radius of the dipole (radius of curvature). Note that for zero fields the radius of curvature is infinite while the path curvature is zero.
      Parameters:
      probe - probe object to be deflected
      Returns:
      dipole path curvature for given probe (in 1/meters)

    • getOrientation

      public int getOrientation()
      Deprecated.
      Return the orientation enumeration code specifying the bending plane.
      Returns:
      ORIENT_HOR - dipole has steering action in x (horizontal) plane ORIENT_VER - dipole has steering action in y (vertical) plane ORIENT_NONE - error

    • getMagField

      public double getMagField()
      Deprecated.
      Get the magnetic field strength of the dipole electromagnet
      Returns:
      magnetic field (in Tesla).

    • setOrientation

      public void setOrientation(int enmOrient)
      Deprecated.
      Set the dipole magnet bending orientation
      Parameters:
      enmOrient - magnet orientation enumeration code
      See Also:

    • setMagField

      public void setMagField(double dblField)
      Deprecated.
      Set the magnetic field strength of the dipole electromagnet.
      Parameters:
      dblField - magnetic field (in Tesla).

    • initializeFrom

      public void initializeFrom(LatticeElement element)
      Deprecated.
      Conversion method to be provided by the user
      Specified by:
      initializeFrom in interface IComponent
      Overrides:
      initializeFrom in class ElectromagnetSeq
      Parameters:
      element - the SMF node to convert