xal.model.elem

Class IdealMagFringeQuadFace

java.lang.Object

xal.model.elem.Element

xal.model.elem.ThinElement

xal.model.elem.ThinElectromagnet

xal.model.elem.IdealMagFringeQuadFace

All Implemented Interfaces:

IElectromagnet, IComponent, IElement

public class IdealMagFringeQuadFace
extends ThinElectromagnet

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.

See Also:

Carey, The Optics of Charged Particle Beams (Harwood, 1987)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	s_strParamField
static java.lang.String	s_strParamLenEff Parameters for XAL MODEL LATTICE dtd
static java.lang.String	s_strParamOrient
static java.lang.String	s_strType the string type identifier for all IdealMagSteeringDipole's

Fields inherited from class xal.model.elem.ThinElectromagnet

dblField, enmOrient

Fields inherited from interface xal.model.elem.IElectromagnet

ORIENT_HOR, ORIENT_NONE, ORIENT_VER

Fields inherited from interface xal.model.IElement

LightSpeed, Permeability, Permittivity, UnitCharge

Constructor Summary

Constructors

Constructor and Description
IdealMagFringeQuadFace() Default constructor - creates a new unitialized instance of IdealMagSectorDipole.
IdealMagFringeQuadFace(java.lang.String strId) Constructor providing the instance identifier for the element.

Method Summary

Modifier and Type	Method and Description
double	elapsedTime(IProbe probe) Returns the time taken for the probe to propagate through element.
double	energyGain(IProbe probe) Return the energy gain for this Element.
double	getBRhoScaling()
boolean	getEntr()
double	getFieldPathFlag() Return the field path flag.
double	getFringeIntegral1() Set the second-order moment integral of the dipole fringe field as described by H.
double	getFringeIntegral2()
double	getK1() K1 (T/m)
double	getNominalKineEnergy()
void	setBRhoScaling(double d)
void	setEntrFlag(boolean entr)
void	setFieldPathFlag(double ba) sako to set field path flag
void	setFringeIntegral1(double dblFringeInt) Set the first-order moment integral of the dipole fringe field as described by H.
void	setFringeIntegral2(double dblFringeInt) Set the first-order moment integral of the dipole fringe field as described by H.
void	setK1(double dbl) K1 (T/m)
void	setNominalKineEnergy(double ba)
protected PhaseMap	transferMap(IProbe probe) Compute and return the transfer map for this dipole magnet pole face element.

Methods inherited from class xal.model.elem.ThinElectromagnet

getMagField, getOrientation, initializeFrom, setMagField, setOrientation

Methods inherited from class xal.model.elem.ThinElement

elapsedTime, energyGain, getLength, transferMap

Methods inherited from class xal.model.elem.Element

addCloseElements, applyAlignError, backPropagate, backPropagate, compDriftingTime, compProbeLocation, getAlignX, getAlignY, getAlignZ, getCloseElements, getHardwareNodeId, getId, getPosition, getType, getUID, print, propagate, propagate, setAlign, setAlignX, setAlignY, setAlignZ, setHardwareNodeId, setId, setPosition, 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

the string type identifier for all IdealMagSteeringDipole's

See Also:

Constant Field Values

s_strParamLenEff

public static final java.lang.String s_strParamLenEff

Parameters for XAL MODEL LATTICE dtd

See Also:

Constant Field Values

s_strParamOrient

public static final java.lang.String s_strParamOrient

See Also:

Constant Field Values

s_strParamField

public static final java.lang.String s_strParamField

See Also:

Constant Field Values

Constructor Detail

IdealMagFringeQuadFace

public IdealMagFringeQuadFace()

Default constructor - creates a new unitialized instance of IdealMagSectorDipole. This is the constructor called in automatic lattice generation. Thus, all element properties are set following construction.

IdealMagFringeQuadFace

public IdealMagFringeQuadFace(java.lang.String strId)

Constructor providing the instance identifier for the element.

Parameters:

strId - string identifier for element

Method Detail

setEntrFlag

public void setEntrFlag(boolean entr)

getBRhoScaling

public double getBRhoScaling()

setBRhoScaling

public void setBRhoScaling(double d)

setNominalKineEnergy

public void setNominalKineEnergy(double ba)

getNominalKineEnergy

public double getNominalKineEnergy()

getK1

public double getK1()

K1 (T/m)

Returns:

setK1

public void setK1(double dbl)

K1 (T/m)

setFringeIntegral1

public void setFringeIntegral1(double dblFringeInt)

Set the first-order moment integral of the dipole fringe field as described by H. Matsuda. The integral determines the amount of defocusing caused by the fringe field. Denoting the integral f1 has the definition f1 := sign(a)sqrt(a) a = -24 [I1sad-I0sad^2/2] where I(n)sad := Integral{[z - z0] k(z)/k0}dz where k0 is normal k0*Len. The integral taken from -infinity to z = infinity.

Parameters:

dblFringeInt - field moment f1 (dimensionless)

setFringeIntegral2

public void setFringeIntegral2(double dblFringeInt)

Set the first-order moment integral of the dipole fringe field as described by H. Matsuda. The integral determines the amount of defocusing caused by the fringe field. Denoting the integral f1 has the definition f2 := [I2sad-I0sad^2/3] where I(n)sad := Integral{[z - z0] k(z)/k0}dz where k0 is normal k0*Len. The integral taken from -infinity to z = infinity.

Parameters:

dblFringeInt - field moment f1 (dimensionless)

setFieldPathFlag

public void setFieldPathFlag(double ba)

sako to set field path flag

Parameters:

ba -

getFringeIntegral1

public double getFringeIntegral1()

Set the second-order moment integral of the dipole fringe field as described by H. Matsuda. The integral determines the amount of defocusing caused by the fringe field.

Returns:

second-order integral of fringe field (dimensionless)

See Also:

IdealMagFringeQuadFace#setFringeIntegral(double)

getFringeIntegral2

public double getFringeIntegral2()

getEntr

public boolean getEntr()

getFieldPathFlag

public double getFieldPathFlag()

Return the field path flag.

Returns:

field path flag = 1 (use design field) or 0 (use bField parameter)

elapsedTime

public double elapsedTime(IProbe probe)

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)

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

Compute and return the transfer map for this dipole magnet pole face element.

Specified by:

transferMap in class ThinElement

Parameters:

probe -

Returns:

Throws:

ModelException

See Also:

xal.sim.slg.sns.xal.model.elem.ThinElement#transferMap(gov.sns.xal.model.IProbe)