Package xal.model.alg

Class EnvelopeTrackerPmqDipole

java.lang.Object

xal.model.alg.Tracker

xal.model.alg.EnvelopeTrackerBase

xal.model.alg.EnvelopeTracker

xal.model.alg.EnvelopeTrackerPmqDipole

All Implemented Interfaces:

Remote, IAlgorithm, IArchive, IContextAware

public class EnvelopeTrackerPmqDipole
extends EnvelopeTracker

This class is a super class of the EnvelopeTracker class meant to handle the special case of IdealPermMagQuad elements. There really is not much extra to do here, just look for the exception element and adjust the number of integration steps accordingly. This algorithm also treats IdealMagSectorDipole2 object in a special fashion.

See the EnvelopeTracker class for a complete description of the functionality

Author:

Christopher K. Allen

See Also:

• EnvelopeTracker

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

Constructor	Description
EnvelopeTrackerPmqDipole()	Creates a new instance of EnvelopeTracker
EnvelopeTrackerPmqDipole(EnvelopeTrackerPmqDipole sourceTracker)	Copy constructor for EnvelopeTrackerPmqDipole

Method Summary

Modifier and Type	Method	Description
EnvelopeTrackerPmqDipole	copy()	Creates a deep copy of EnvelopeTrackerPmqDipole
void	doPropagation(IProbe probe, IElement elem)	Propagates the probe through the element.

Methods inherited from class xal.model.alg.EnvelopeTracker

advanceState

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

EnvelopeTrackerPmqDipole

public EnvelopeTrackerPmqDipole()

Creates a new instance of EnvelopeTracker

EnvelopeTrackerPmqDipole

public EnvelopeTrackerPmqDipole(EnvelopeTrackerPmqDipole sourceTracker)

Copy constructor for EnvelopeTrackerPmqDipole

Parameters:

sourceTracker - Tracker that is being copied

Method Details

copy

public EnvelopeTrackerPmqDipole copy()

Creates a deep copy of EnvelopeTrackerPmqDipole

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)