Package xal.extension.jels.model.elem

Class ThickMagFieldMap

java.lang.Object

xal.model.elem.Element

xal.model.elem.ThickElement

xal.model.elem.ThickElectromagnet

xal.extension.jels.model.elem.ThickMagFieldMap

All Implemented Interfaces:

IElectromagnet, IComponent, IElement

public class ThickMagFieldMap
extends ThickElectromagnet

Thick element version for magnetic field map implementation. This class is supposed to be faster than the ThickMagFieldMap for fieldmaps with many data points, since it removes the overhead of creating an element for every point in the fieldmap. The drawback is that it can't be superposed to other ThickElements.

Author:

Juan F. Esteban Müller <JuanF.EstebanMuller@esss.se>

Field Summary

Fields inherited from class xal.model.elem.ThickElectromagnet

dblField, enmOrient

Fields inherited from class xal.model.elem.Element

dblNodeLen, dblNodePos

Fields inherited from interface xal.model.elem.sync.IElectromagnet

ORIENT_HOR, ORIENT_NONE, ORIENT_VER

Fields inherited from interface xal.model.IElement

LIGHT_SPEED, PERMEABILITY, PERMITTIVITY, UNIT_CHARGE

Constructor Summary

Constructors

Constructor	Description
ThickMagFieldMap()
ThickMagFieldMap(String strId)

Method Summary

Modifier and Type	Method	Description
double	elapsedTime(IProbe probe, double dblLen)	Returns the time taken for the probe probe to propagate through a subsection of the element with length dblLen.
double	energyGain(IProbe probe, double dblLen)	Return the energy gain of the beamline element over a subsection of the specified length.
void	initializeFrom(LatticeElement element)	Conversion method to be provided by the user
PhaseMap	transferMap(IProbe probe, double dblLen)	Method calculates transfer matrix for the field map on the current range (i.e from probe.getPosition, and for dblLength).

Methods inherited from class xal.model.elem.ThickElectromagnet

getMagField, getOrientation, setMagField, setOrientation

Methods inherited from class xal.model.elem.ThickElement

applyErrors, getLength, isFirstSubslice, isLastSubslice, longitudinalPhaseAdvance, setLength

Methods inherited from class xal.model.elem.Element

addCloseElements, backPropagate, backPropagate, compDriftingTime, compProbeLocation, getAlignX, getAlignY, getAlignZ, getCloseElements, getHardwareNodeId, getId, getLatticePosition, getNodeLen, getNodePos, getParent, getPhiX, getPhiY, getPhiZ, getPosition, getType, getUID, print, propagate, propagate, setAlign, setAlignX, setAlignY, setAlignZ, setHardwareNodeId, setId, setParent, setPhiX, setPhiY, setPhiZ, setPosition, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ThickMagFieldMap

public ThickMagFieldMap()

ThickMagFieldMap

public ThickMagFieldMap(String strId)

Method Details

initializeFrom

public void initializeFrom(LatticeElement element)

Description copied from class: ThickElectromagnet

Conversion method to be provided by the user

Specified by:

initializeFrom in interface IComponent

Overrides:

initializeFrom in class ThickElectromagnet

Parameters:

element - the SMF node to convert

transferMap

public PhaseMap transferMap(IProbe probe,
 double dblLen)
                     throws ModelException

Method calculates transfer matrix for the field map on the current range (i.e from probe.getPosition, and for dblLength).

Specified by:

transferMap in interface IElement

Specified by:

transferMap in class ThickElement

Parameters:

probe - probe containing parameters for the sub-sectional transfer matrix

dblLen - length of sub-element

Returns:

Throws:

ModelException

See Also:

• Element.elapsedTime(xal.model.IProbe, double)

energyGain

public double energyGain(IProbe probe,
 double dblLen)

Description copied from class: ThickElement

Return the energy gain of the beamline element over a subsection of the specified length.

Specified by:

energyGain in interface IElement

Specified by:

energyGain in class ThickElement

Parameters:

probe - probe for which energy gain is to be determined

dblLen - subsection length to calculate energyGain for

Returns:

the value #subEnergyGain(probe)*#getCount()

elapsedTime

public double elapsedTime(IProbe probe,
 double dblLen)

Description copied from class: Element

Returns the time taken for the probe probe to propagate through a subsection of the element with length dblLen.

Specified by:

elapsedTime in interface IElement

Specified by:

elapsedTime in class ThickElement

Parameters:

probe - determine energy gain for this probe

dblLen - length of subsection to calculate energy gain for

Returns:

the elapsed time through sectionUnits: seconds