xal.model.elem

Class IdealMagWedgeDipole

java.lang.Object

xal.model.elem.ElementSeq

xal.model.elem.ElectromagnetSeq

xal.model.elem.IdealMagWedgeDipole

All Implemented Interfaces:

IElectromagnet, IComponent, IComposite

public class IdealMagWedgeDipole
extends ElectromagnetSeq

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.

See Also:

xal.model.elem, xal.model.elem

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	s_strType string type identifier for all IdealMagSectorDipole objects
static int	s_szReserve storage to reserve for child components

Fields inherited from class xal.model.elem.ElementSeq

s_szDefReserve

Fields inherited from interface xal.model.elem.IElectromagnet

ORIENT_HOR, ORIENT_NONE, ORIENT_VER

Constructor Summary

Constructors

Constructor and Description
IdealMagWedgeDipole() Default constructor - creates a new unitialized instance of IdealMagWedgeDipole.
IdealMagWedgeDipole(java.lang.String strId) Create new IdealMagWedgeDipole object and specify its instance identifier string.

Method Summary

Modifier and Type	Method and Description
double	compCurvature(IProbe probe) Compute the path curvature within the dipole for the given probe.
IdealMagDipoleFace	getEntrFace() Return the entrance dipole face object of the wedge dipole.
IdealMagDipoleFace	getExitFace() Return the exit dipole face object of this wedge dipole magnet.
double	getFieldIndex() Return the magnetic field index of the magnet evaluated at the design orbit.
double	getGapHeight() Return the gap size between the dipole magnet poles.
IdealMagSectorDipole	getMagBody() Return the dipole magnet body object of this wedge dipole magnet.
double	getMagField() Get the magnetic field strength of the dipole electromagnet
int	getOrientation() Return the orientation enumeration code specifying the bending plane.
void	initializeFrom(LatticeElement element) Conversion method to be provided by the user
void	setEntrFringeIntegral(double dblFldInt) Set the entrance fringe integral (a la D.C.
void	setEntrPoleAngle(double dblAngPole) Set the entrance pole face angle with respect to the design trajectory
void	setExitFringeIntegral(double dblFldInt) Set the exit fringe integral (a la D.C.
void	setExitPoleAngle(double dblAngPole) Set the exit pole face angle with respect to the design trajectory
void	setFieldIndex(double dblFldInd) Set the magnetic field index of the magnet evaluated at the design orbit.
void	setGapSize(double dblGap) Set the gap size between the dipole magnet poles.
void	setLength(double dblLen) Set the path length of the bending dipole along the design trajectory.
void	setMagField(double dblField) Set the magnetic field strength of the dipole electromagnet.
void	setOrientation(int enmOrient) Set the dipole magnet bending orientation

Methods inherited from class xal.model.elem.ElementSeq

addChild, backPropagate, backPropagate, childIterator, concatenateEquals, getAllElements, getChild, getChildCount, getComments, getCompList, getElementList, getHardwareNodeId, getId, getLeafCount, getLength, getReverseCompList, getType, globalBackIterator, globalIterator, localBackIterator, localIterator, print, propagate, propagate, remove, setComments, setCompList, setHardwareNodeId, setId, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

s_strType

public static final java.lang.String s_strType

string type identifier for all IdealMagSectorDipole objects

See Also:

Constant Field Values

s_szReserve

public static final int s_szReserve

storage to reserve for child components

See Also:

Constant Field Values

Constructor Detail

IdealMagWedgeDipole

public IdealMagWedgeDipole()

Default constructor - creates a new unitialized instance of IdealMagWedgeDipole.

IdealMagWedgeDipole

public IdealMagWedgeDipole(java.lang.String strId)

Create new IdealMagWedgeDipole object and specify its instance identifier string.

Parameters:

strId - instance identifier string

Method Detail

setLength

public void setLength(double dblLen)

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)

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)

Set the gap size between the dipole magnet poles.

Parameters:

dblGap - gap size in meters

setEntrPoleAngle

public void setEntrPoleAngle(double dblAngPole)

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)

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)

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:

IdealMagDipoleFace.setFringeIntegral(double)

setExitFringeIntegral

public void setExitFringeIntegral(double dblFldInt)

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:

IdealMagDipoleFace.setFringeIntegral(double)

getEntrFace

public IdealMagDipoleFace getEntrFace()

Return the entrance dipole face object of the wedge dipole.

Returns:

entrance pole face

getExitFace

public IdealMagDipoleFace getExitFace()

Return the exit dipole face object of this wedge dipole magnet.

Returns:

exit pole face

getMagBody

public IdealMagSectorDipole getMagBody()

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

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

Return the gap size between the dipole magnet poles.

Returns:

gap size in meters

compCurvature

public double compCurvature(IProbe probe)

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

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

Get the magnetic field strength of the dipole electromagnet

Returns:

magnetic field (in Tesla).

setOrientation

public void setOrientation(int enmOrient)

Set the dipole magnet bending orientation

Parameters:

enmOrient - magnet orientation enumeration code

See Also:

getOrientation()

setMagField

public void setMagField(double dblField)

Set the magnetic field strength of the dipole electromagnet.

Parameters:

dblField - magnetic field (in Tesla).

initializeFrom

public void initializeFrom(LatticeElement element)

Conversion method to be provided by the user

Specified by:

initializeFrom in interface IComponent

Overrides:

initializeFrom in class ElectromagnetSeq

Parameters:

latticeElement - the SMF node to convert