Package xal.extension.jels.model.elem

Class RfqDummyModel

java.lang.Object

xal.model.elem.Element

xal.model.elem.ThickElement

xal.extension.jels.model.elem.RfqDummyModel

All Implemented Interfaces:

IComponent, IElement

public class RfqDummyModel
extends ThickElement

Author:

Juan F. Esteban Müller <JuanF.EstebanMuller@ess.eu>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STR_TYPEID

Fields inherited from class xal.model.elem.Element

dblNodeLen, dblNodePos

Fields inherited from interface xal.model.IElement

LIGHT_SPEED, PERMEABILITY, PERMITTIVITY, UNIT_CHARGE

Constructor Summary

Constructors

Constructor	Description
RfqDummyModel()
RfqDummyModel(String strType)

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 latticeElement)	Conversion method to be provided by the user
PhaseMap	transferMap(IProbe probe, double dblLen)	Compute the transfer matrix for subsection of this element of length dblLen for the specified given probe.

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

Field Details

STR_TYPEID

public static final String STR_TYPEID

See Also:

• Constant Field Values

Constructor Details

RfqDummyModel

public RfqDummyModel()

RfqDummyModel

public RfqDummyModel(String strType)

Method Details

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

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()

initializeFrom

public void initializeFrom(LatticeElement latticeElement)

Description copied from class: ThickElement

Conversion method to be provided by the user

Specified by:

initializeFrom in interface IComponent

Overrides:

initializeFrom in class ThickElement

Parameters:

latticeElement - the SMF node to convert

transferMap

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

Description copied from class: Element

Compute the transfer matrix for subsection of this element of length dblLen for the specified given probe. That is, this method should return the incremental transfer matrix.

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:

transfer map for an element of length dblLen

Throws:

ModelException - unable to compute transfer map

See Also:

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