Package xal.model.elem

package xal.model.elem

Modeling Elements Package Library

This package provides classes for modeling hardware aspects of accelerator systems.

Element Descriptions

IdealMagQuad

Focusing magnetic quadrupole element.
- Uni-polar power supply
- Can be oriented as horizontally focusing (IElectromagnet.ORIENT_HOR) or vertically focusing (IElectromagnet.ORIENT_VER).

IdealMagSkewQuad2

Corrective magnetic quadrupole element.
- Bi-polar power supply
- Cannot be oriented (see Javadoc)
- Handles space charge correctly

IdealRolledMagQuad

This is the usual focusing quadrupole, with the additional property that it has been rolled with respect to the beam axis. Presumeabley, this additional property is done intentionally in hardware. It is not a misalignment.


NOTES

I think we need a convention for quadrupoles. Some examples,
- I orient IdealMagSkewQuad2 to focus in quadrants 2 and 4 for positive drive current and to focus in quadrants 1 and 3 for negative drive current.


- I think we need a better design for the IElectromagnet interface, and magnets in general. For example, I don't think getOrientation() makes sense, since this value is not dynamic.
- On the SMF side, Magnet has parameters that do not make sense for all its children (i.e., the hierarchy is questionable). For example, isHorizontal() and isVertical methods do not make sense for a skew quadrupole.


Christopher K. Allen
allenck@ornl.gov
Created: January, 2008
Modified:

  • Class
    Description
    ChargeExchangeFoil
    This class is used as a location marker in the modeling lattice.
    Collimator
    This class is used as a location marker in the modeling lattice.
    ElectromagnetSeq
    This class implements IElectromagnet interface for composed magnets.
    Element
    Convenience abstract base class for constructing XAL modeling elements.
    ElementSeq
    Convenience abstract base class for a composite modeling element.
    IdealDrift
    Represents a drift space in a particle beam transport/accelerator system.
    IdealEDipole
    Represents a thick electric dipole magnet for a beam transport/accelerator system.
    IdealEQuad
    Represents an ideal electrostatic quadrupole for a beam transport/accelerator system.
    IdealHorMagSteeringDipole
    Represents an ideal magnetic steering dipole in the horizontal direction.
    IdealMagDipoleFace
    Deprecated.
    This class has been replaced by IdealMagDipoleFace2
    IdealMagDipoleFace2
    Represents the action of a rotated dipole face as a thin lens effect.
    IdealMagFringeQuad
    Represents a quadrupole magnet with thin face elements which represent fringe field.
    IdealMagFringeQuadFace
    Represents the action of a rotated dipole face as a thin lens effect.
    IdealMagOctupole
    Octupole magnets element Created by Hiroyuki Sako on 11/30/07.
    IdealMagQuad
    Represents an ideal magnetic quadrupole magnet for a beam transport/accelerator system.
    IdealMagSectorDipole
    Deprecated.
    This class has been replaced by IdealMagSectorDipole2
    IdealMagSectorDipole2
    Represents a bending magnetic dipole magnet for a beam in a sector configuration.
    IdealMagSextupole
    Sextupole magnets element
    IdealMagSkewQuad
    Deprecated.
    This class has been replaced by IdealMagSkewQuad3
    IdealMagSkewQuad3
    Represents a "skewed" ideal quadrupole magnet.
    IdealMagSolenoid
    Models an ideal solenoid magnet.
    IdealMagSteeringDipole
    Represents the action of an ideal magnetic dipole.
    IdealMagWedgeDipole
    Deprecated.
    This class has been replaced by IdealMagWedgeDipole2
    IdealMagWedgeDipole2
    Represents a bending dipole magnet with arbitrary pole face angles.
    IdealPermMagQuad
    Represents an ideal permanent magnet quadrupole for a beam transport/accelerator system.
    IdealRfCavity
    This class represents a general RF cavity being an composition of RF gaps and cavity drifts.
    IdealRfCavityDrift
    Represents a drift region between RF cavity accelerating gaps.
    IdealRfGap
    Represents the action of an ideal RF gap.
    IdealRfGapUpgraded
    Represents the action of an ideal RF gap.
    IdealRfGapUpgraded.PHASECALC
    Enumeration specifying the method of phase and energy gain calculation.
    IdealVerMagSteeringDipole
    Represents an ideal magnetic steering dipole in the vertical direction.
    IElectromagnet
    This interface defines the common properties of all electromagnet elements.
    Marker
    This class is used as a location marker in the modeling lattice.
    SpectrumMapRfGap
    Represents the action of an ideal RF gap.
    SpectrumMapRfGap.PHASECALC
    Enumeration specifying the method of phase and energy gain calculation.
    ThickDipole
    Represents a thick magnetic dipole magnet for a beam transport/accelerator system.
    ThickElectromagnet
    This class implements IElectromagnet interface for thick magnets.
    ThickElectrostatic
    This class implements IElectrostatic interface for thick electrostatics.
    ThickElement
    Base class for all modeling elements having a finite length.
    ThickElementBeanInfo
    Provides custom BeanInfo for all ThickElement instances.
    ThickMatrix
    User element representing a general beamline element.
    ThinElectromagnet
    This class implements IElectromagnet interface for thin magnets.
    ThinElement
    Classes derived from ThinElement are modeled as having no length.
    ThinElementBeanInfo
    Provides custom BeanInfo for all ThinElement instances.
    ThinLens
    Represents a thin lens abstract modeling element in a particle beam transport/accelerator system.
    ThinMatrix
    User element represent a general beamline element.