Package xal.extension.jels.model.alg

Class ElsTracker

java.lang.Object

xal.model.alg.Tracker

xal.model.alg.EnvelopeTrackerBase

xal.model.alg.EnvelopeTracker

xal.extension.jels.model.alg.ElsTracker

All Implemented Interfaces:

Remote, IAlgorithm, IArchive, IContextAware

public class ElsTracker
extends EnvelopeTracker

Propagation of probe as implemented in ELS.

Author:

Emanuele Laface, Ivo List <ivo.list@cosylab.com>

Nested Class Summary

Nested classes/interfaces inherited from class xal.model.alg.EnvelopeTrackerBase

EnvelopeTrackerBase.EmitGrowthModel, EnvelopeTrackerBase.PhasePlane

Field Summary

Fields

Modifier and Type	Field	Description
static final Class<EnvelopeProbe>	CLS_PROBE_TYPE	probe type recognized by this algorithm
static final String	TYPE_ID	string type identifier for algorithm
static final int	VERSION	current algorithm version

Fields inherited from class xal.model.alg.EnvelopeTrackerBase

ATTR_EMITGROWTH, ATTR_SCHEFF, ATTR_STEPSIZE, ATTR_USEDCBEAM, ATTR_USESPACECHARGE, LABEL_OPTIONS, TBL_LBL_ENVBASETRACKER

Fields inherited from class xal.model.alg.Tracker

ATTRTAG_DEBUG, ATTRTAG_RFGAP_PHASE, ATTRTAG_TYPE, ATTRTAG_UPDATE, ATTRTAG_VER, NODETAG_ALG, NODETAG_TRACKER, TBL_LBL_ALGORITHM, TBL_PRIM_KEY_NAME, UPDATE_ALWAYS, UPDATE_CUSTOM, UPDATE_ENTRANCE, UPDATE_ENTRANCEANDEXIT, UPDATE_EXIT

Constructor Summary

Constructors

Modifier	Constructor	Description
	ElsTracker()	Creates a new instance of EnvelopeTracker
protected	ElsTracker(String strType, int intVersion, Class<? extends IProbe> clsProbeType)	Creates a new, empty, instance of EnvelopeTracker.
protected	ElsTracker(ElsTracker sourceTracker)	Copy constructor for EnvelopeTracker

Method Summary

Modifier and Type	Method	Description
protected void	advanceState(IProbe ifcProbe, IElement ifcElem, double dblLen)	Advances the probe state through a subsection of the element with the specified length.
ElsTracker	copy()	Creates a deep copy of EnvelopeTracker
void	doPropagation(IProbe probe, IElement elem)	Propagates the probe through the element.

Methods inherited from class xal.model.alg.EnvelopeTrackerBase

compEmitGrowthFunction, compLongFourierTransform, compScheffMatrix, compTransFourierTransform, correctLongSigmaPhaseSpread, correctSigmaPhaseSpread, correctTransFocusingPhaseSpread, correctTransSigmaPhaseSpread, effPhaseSpread, fourierLong1dGaussian, fourierLong1dUniform, fourierLong3dGaussian, fourierLong3dUniform, fourierLongTrace3d, fourierTrans1dGaussian, fourierTrans1dUniform, fourierTrans3dGaussian, fourierTrans3dUniform, fourierTransTrace3d, getEmitGrowthModel, getEmittanceGrowth, getEmittanceGrowthFlag, getSpaceChargeFlag, getStepSize, getUseDCBeam, getUseSpacecharge, load, load, modTransferMatrixForEmitGrowth, phaseSpread, save, setEmitGrowthModel, setEmittanceGrowth, setStepSize, setUseDCBeam, setUseSpacecharge

Methods inherited from class xal.model.alg.Tracker

advanceProbe, getDebugMode, getElemPosition, getProbeType, getProbeUpdatePolicy, getRfGapPhaseCalculation, getStartElementId, getStopElementId, getType, getVersion, initialize, isStopElementIncluded, newFromEditContext, newFromEditContext, newInstance, propagate, registerProbeType, retractProbe, setDebugMode, setElemPosition, setIncludeStopElement, setProbeUpdatePolicy, setRfGapPhaseCalculation, setStartElementId, setStopElementId, unsetStartElementId, unsetStopElementId, validElement, validProbe

Methods inherited from class java.lang.Object

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

Field Details

TYPE_ID

public static final String TYPE_ID

string type identifier for algorithm

VERSION

public static final int VERSION

current algorithm version

See Also:

• Constant Field Values

CLS_PROBE_TYPE

public static final Class<EnvelopeProbe> CLS_PROBE_TYPE

probe type recognized by this algorithm

Constructor Details

ElsTracker

public ElsTracker()

Creates a new instance of EnvelopeTracker

ElsTracker

protected ElsTracker(String strType,
 int intVersion,
 Class<? extends IProbe> clsProbeType)

Creates a new, empty, instance of EnvelopeTracker. This method is a protected constructor meant only for child classes.

Parameters:

strType - string type identifier of algorithm

intVersion - version of algorithm

clsProbeType - class object for probe handled by this algorithm.

ElsTracker

protected ElsTracker(ElsTracker sourceTracker)

Copy constructor for EnvelopeTracker

Parameters:

sourceTracker - Tracker that is being copied

Method Details

copy

public ElsTracker copy()

Creates a deep copy of EnvelopeTracker

Specified by:

copy in interface IAlgorithm

Overrides:

copy in class EnvelopeTracker

doPropagation

public void doPropagation(IProbe probe,
 IElement elem)
                   throws ModelException

Propagates the probe through the element.

Overrides:

doPropagation in class EnvelopeTracker

Parameters:

probe - probe to propagate

elem - element acting on probe

Throws:

ModelException - invalid probe type or error in advancing probe

See Also:

• Tracker.validProbe(IProbe)

advanceState

protected void advanceState(IProbe ifcProbe,
 IElement ifcElem,
 double dblLen)
                     throws ModelException

Advances the probe state through a subsection of the element with the specified length. Applies a space charge kick at the end of the element subsection for any probe having nonzero beam current.

Overrides:

advanceState in class EnvelopeTracker

Parameters:

ifcElem - interface to the beam element

ifcProbe - interface to the probe

dblLen - length of element subsection to advance

Throws:

ModelException - bad element transfer matrix/corrupt probe state