Package xal.model.elem

Class IdealMagDipoleFace

java.lang.Object
xal.model.elem.Element
xal.model.elem.ThinElement
xal.model.elem.ThinElectromagnet
xal.model.elem.IdealMagDipoleFace
All Implemented Interfaces:
IElectromagnet, IComponent, IElement
@Deprecated public class IdealMagDipoleFace extends ThinElectromagnet
Deprecated.
This class has been replaced by IdealMagDipoleFace2
Represents the action of a rotated dipole face as a thin lens effect. Note that there is always an associated dipole magnet for any IdealMagDipoleFace. The two objects should provide the same values for the IElectromagnet interface. Note that a dipole face rotation has the same effect both on beam entering the dipole or exiting the dipole. The model for the pole face effect is taken from D.C. Carey's book.
Author:
Christopher K. Allen
See Also:
  • "D.C. Carey, The Optics of Charged Particle Beams (Harwood, 1987)"

  • Field Details

  • Constructor Details

    • IdealMagDipoleFace

      public IdealMagDipoleFace()
      Deprecated.
      Default constructor - creates a new uninitialized instance of IdealMagSectorDipole. This is the constructor called in automatic lattice generation. Thus, all element properties are set following construction.

    • IdealMagDipoleFace

      public IdealMagDipoleFace(String strId)
      Deprecated.
      Constructor providing the instance identifier for the element.
      Parameters:
      strId - string identifier for element

  • Method Details

    • setPoleFaceAngle

      public void setPoleFaceAngle(double dblAngPole)
      Deprecated.
      Set the angle between the pole face normal vector and the design trajectory. This can be either at the magnet entrance or exit, the effect is the same.
      Parameters:
      dblAngPole - pole face angle in radians

    • setGapHeight

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

    • setFringeIntegral

      public void setFringeIntegral(double dblFrngMmt)
      Deprecated.
      Set the second-order moment integral of the dipole fringe field as described by D.C. Carey. The integral determines the amount of defocusing caused by the fringe field. Denoting the integral I2 it has the definition I2 := Integral{ B(z)[B0 - B(z)]/(g B0^2) }dz where g is the gap height, B0 is the hard edge value for the magnetic field, and B(z) is the true magnetic field along the design trajectory with path length parameter z. The integral taken from a location z0 within the magnet where B(z0)=B0 out to z = infinity. Some examples values are the following: I2 = 0.1666 linear drop off I2 = 0.4 clamped Rogowski coil I2 = 0.7 unclamped Rogoski coil
      Parameters:
      dblFrngMmt - field moment I2 (dimensionless)

    • setPathLength

      public void setPathLength(double pl)
      Deprecated.

    • setBendAngle

      public void setBendAngle(double ba)
      Deprecated.

    • setFieldPathFlag

      public void setFieldPathFlag(double ba)
      Deprecated.

    • getPathLength

      public double getPathLength()
      Deprecated.

    • getBendAngle

      public double getBendAngle()
      Deprecated.

    • getFieldPathFlag

      public double getFieldPathFlag()
      Deprecated.

    • getGapHeight

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

    • getPoleFaceAngle

      public double getPoleFaceAngle()
      Deprecated.
      Return the angle between the pole face normal vector and the design trajectory. This can be either at the magnet entrance or exit, the effect is the same.
      Returns:
      pole face angle in radians

    • getFringeIntegral

      public double getFringeIntegral()
      Deprecated.
      Set the second-order moment integral of the dipole fringe field as described by D.C. Carey. The integral determines the amount of defocusing caused by the fringe field.
      Returns:
      second-order integral of fringe field (dimensionless)
      See Also:

    • elapsedTime

      public double elapsedTime(IProbe probe)
      Deprecated.
      Returns the time taken for the probe to propagate through element.
      Specified by:
      elapsedTime in class ThinElement
      Parameters:
      probe - propagating probe
      Returns:
      value of zero

    • energyGain

      public double energyGain(IProbe probe)
      Deprecated.
      Return the energy gain for this Element.
      Specified by:
      energyGain in class ThinElement
      Parameters:
      probe - propagating probe
      Returns:
      value of zero

    • transferMap

      protected PhaseMap transferMap(IProbe probe) throws ModelException
      Deprecated.
      Description copied from class: ThinElement
      Compute the transfer matrix of this element.
      Specified by:
      transferMap in class ThinElement
      Parameters:
      probe -
      Returns:
      Throws:
      ModelException
      See Also: