xal.model.elem

Class IdealMagWedgeDipole2

java.lang.Object

xal.model.elem.ElementSeq

xal.model.elem.ElectromagnetSeq

xal.model.elem.IdealMagWedgeDipole2

All Implemented Interfaces:

IElectromagnet, IComponent, IComposite

public class IdealMagWedgeDipole2
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
IdealMagWedgeDipole2() Default constructor - creates a new unitialized instance of IdealMagWedgeDipole.
IdealMagWedgeDipole2(java.lang.String strId) Create new IdealMagWedgeDipole object and specify its instance identifier string.

Method Summary

Modifier and Type	Method and Description
double	compProbeCurvature(IProbe probe) Compute the path curvature within the dipole for the given probe.
double	getDesignBendingAngle() Return the bending angle of the magnet's design trajectory.
double	getDesignPathLength() Return the path length of the design trajectory through the magnet.
double	getEntrFringeIntegral() Get the entrance fringe integral (a la D.C.
double	getEntrPoleAngle() Get the entrance pole face angle with respect to the design trajectory
double	getExitFringeIntegral() Get the exit fringe integral (a la D.C.
double	getExitPoleAngle() Get the exit pole face angle with respect to the design trajectory
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.
double	getK0() Returns the magnet strength I think.
double	getMagField() Get the magnetic field strength of the dipole electromagnet
int	getOrientation() Return the orientation enumeration code specifying the bending plane.
double	getPhysicalLength() Return the physical length of the bending dipole.
void	initializeFrom(LatticeElement element) Conversion method to be provided by the user
void	setAlignment(R3 vecAlign) Set the alignment parameters for the magnet.
void	setAlignX(double dx) set align x
void	setAlignY(double dy) set align y
void	setAlignZ(double dz) set align z
void	setDesignBendAngle(double dblBendAng) Set the bending angle of the reference (design) orbit.
void	setDesignPathLength(double dblPathLen) Set the reference (design) orbit path-length through the magnet.
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	setFieldPathFlag(boolean bolFlag) sako use design field if fieldPathFlag = 1, and use bfield if 0
void	setGapSize(double dblGap) Set the gap size between the dipole magnet poles.
void	setHardwareNodeId(java.lang.String strSmfId) Overrides the default setHardwareNodeId(String) method for the ElementSeq base class so we can set the hardware node IDs for the composite elements.
void	setId(java.lang.String strId) Override the default setId(String) method for ElementSeq objects so we can set the identifier strings of each composite element.
void	setK0(double k0) Set the dipole strength of the magnet - I think.
void	setMagField(double dblField) Set the magnetic field strength of the dipole electromagnet.
void	setOrientation(int enmOrient) Set the dipole magnet bending orientation
void	setPhysicalLength(double dblLen) Set the physical length of the bending dipole.
void	setPosition(double dblPos, double dblLen) Set the position of the magnet along the design path within the containing lattice.
void	setQuadComponent(double dblFldInd) for SAD elements, K1 variable (=normal k1*L) in SAD

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, 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

IdealMagWedgeDipole2

public IdealMagWedgeDipole2()

Default constructor - creates a new unitialized instance of IdealMagWedgeDipole.

IdealMagWedgeDipole2

public IdealMagWedgeDipole2(java.lang.String strId)

Create new IdealMagWedgeDipole object and specify its instance identifier string.

Parameters:

strId - instance identifier string

Method Detail

setId

public void setId(java.lang.String strId)

Override the default setId(String) method for ElementSeq objects so we can set the identifier strings of each composite element.

Overrides:

setId in class ElementSeq

Parameters:

strId - identifier string of this composite.

See Also:

ElementSeq.setId(java.lang.String)

setHardwareNodeId

public void setHardwareNodeId(java.lang.String strSmfId)

Overrides the default setHardwareNodeId(String) method for the ElementSeq base class so we can set the hardware node IDs for the composite elements.

Overrides:

setHardwareNodeId in class ElementSeq

Parameters:

strSmfId - identifier for the modeled hardware node (SMF object)

Since:

Sep 5, 2014

See Also:

ElementSeq.setHardwareNodeId(java.lang.String)

setAlignment

public void setAlignment(R3 vecAlign)

Set the alignment parameters for the magnet. I don't know what they are or how they are used.

Parameters:

vecAlign - (dx,dy,dz)

setAlignX

public void setAlignX(double dx)

set align x

Parameters:

dx -

setAlignY

public void setAlignY(double dy)

set align y

Parameters:

dy -

setAlignZ

public void setAlignZ(double dz)

set align z

Parameters:

dz -

setPosition

public void setPosition(double dblPos,
                        double dblLen)

Set the position of the magnet along the design path within the containing lattice.

NOTE:

We have a bit of a logistics problem here because this is a composite element. So when setting the position of this element we want to set the positions of all the internal elements, in particular, the pole faces. Thus, we need the physical length of the magnet to do this. Either we require the length to be provided when invoked this method, or this method must be invoked after setting the physical length. I opted for the former.

The physical length of this element is not set when invoking this method. That must be done separately with a call to setPhysicalLength(double>.

Parameters:

dblPos - lattice position of element center (meters)

dblLen - physical length of this element

See Also:

setPhysicalLength(double)

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)

setQuadComponent

public void setQuadComponent(double dblFldInd)

for SAD elements, K1 variable (=normal k1*L) in SAD

Parameters:

dblFldInd - the field index for the quadrupole

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)

setPhysicalLength

public void setPhysicalLength(double dblLen)

Set the physical length of the bending dipole. The design path length is generally larger than this value because of the curvature.

Parameters:

dblLen - physical length through bend in meters

setDesignPathLength

public void setDesignPathLength(double dblPathLen)

Set the reference (design) orbit path-length through the magnet.

Parameters:

dblPathLen - path length of design trajectory (meters)

setDesignBendAngle

public void setDesignBendAngle(double dblBendAng)

Set the bending angle of the reference (design) orbit.

Parameters:

dblBendAng - design trajectory bending angle (radians)

setFieldPathFlag

public void setFieldPathFlag(boolean bolFlag)

sako use design field if fieldPathFlag = 1, and use bfield if 0

setK0

public void setK0(double k0)

Set the dipole strength of the magnet - I think. I didn't write this method.

Parameters:

k0 - magnet strength ?

Since:

Apr 19, 2011

getK0

public double getK0()

Returns the magnet strength I think. I didn't write this method so I am guessing (I better name or some documentation would have helped).

Returns:

magnet strengh ?

Since:

Apr 19, 2011

getGapHeight

public double getGapHeight()

Return the gap size between the dipole magnet poles.

Returns:

gap size in meters

getEntrPoleAngle

public double getEntrPoleAngle()

Get the entrance pole face angle with respect to the design trajectory

Returns:

pole face angle in radians

getExitPoleAngle

public double getExitPoleAngle()

Get the exit pole face angle with respect to the design trajectory

Returns:

pole face angle in radians

getEntrFringeIntegral

public double getEntrFringeIntegral()

Get the entrance fringe integral (a la D.C. Carey) which accounts for the first-order effects of the fringing field outside the dipole magnet.

Returns:

fringe field integral (unitless)

See Also:

IdealMagDipoleFace2.getFringeIntegral()

getExitFringeIntegral

public double getExitFringeIntegral()

Get the exit fringe integral (a la D.C. Carey) which accounts for the first-order effects of the fringing field outside the dipole magnet.

Returns:

fringe field integral (unitless)

See Also:

IdealMagDipoleFace.getFringeIntegral()

getFieldIndex

public double getFieldIndex()

Return the magnetic field index of the magnet evaluated at the design orbit. The field index is defined as

n ≡ -(R₀/B₀)(dB/dR)

where R₀ is the radius of the design orbit, B₀ is the field at the design orbit (see IdealMagSectorDipole2.getFieldIndex()), and dB/dR is the derivative of the field with respect to the path deflection - evaluated at the design radius R₀.

Returns:

field index of the magnet at the design orbit (unitless)

getPhysicalLength

public double getPhysicalLength()

Return the physical length of the bending dipole. The design path length is generally larger than this value because of the curvature.

Returns:

physical length through bend in meters

getDesignPathLength

public double getDesignPathLength()

Return the path length of the design trajectory through the magnet.

Returns:

design trajectory path length (in meters)

getDesignBendingAngle

public double getDesignBendingAngle()

Return the bending angle of the magnet's design trajectory.

Returns:

design trajectory bending angle (in radians)

compProbeCurvature

public double compProbeCurvature(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