xal.model.elem

Class Element

java.lang.Object

xal.model.elem.Element

All Implemented Interfaces:

IComponent, IElement

Direct Known Subclasses:

ThickElement, ThinElement

public abstract class Element
extends java.lang.Object
implements IElement

Convenience abstract base class for constructing XAL modeling elements. This class implements many of the general methods for the IElement interface that are not element specific.

Field Summary

Fields inherited from interface xal.model.IElement

LightSpeed, Permeability, Permittivity, UnitCharge

Constructor Summary

Constructors

Constructor and Description
Element(java.lang.String strType) Creates a new instance of Element
Element(java.lang.String strType, java.lang.String strId) Creates a new instance of Element

Method Summary

Modifier and Type	Method and Description
void	addCloseElements(Element closeElem) Add an element to the list of nearest neighbor elements used when considering the effects of PMQs
protected PhaseMatrix	applyAlignError(PhaseMatrix matPhi) Returns the given transfer matrix adjusted by the misalignment parameters of this element.
void	backPropagate(IProbe probe) Back propagates the Probe object through this element based on the associated algorithm.
void	backPropagate(IProbe probe, double pos) Back propagates the Probe object through this element based on the associated algorithm.
double	compDriftingTime(IProbe probe, double dblLen) Compute the time the probe probe spends drifting a a distance dblLen.
double	compProbeLocation(IProbe probe) This method is intended to return the location of the probe within the current element.
abstract 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.
abstract double	energyGain(IProbe probe, double dblLen) Returns energy gain for subsection of this element of length dblLen for the specified given probe.
double	getAlignX()
double	getAlignY()
double	getAlignZ()
java.util.ArrayList<Element>	getCloseElements() Return the list of nearest adjacent elements to this element.
java.lang.String	getHardwareNodeId() Returns the string identifier of the hardware node which this element models.
java.lang.String	getId() Returns the string identifier for this element.
abstract double	getLength() Return the length of this element.
double	getPosition() Return the center position of the element along the design trajectory.
java.lang.String	getType() Return the element type identifier
int	getUID() Return the internal class unique identifier of this element.
void	initializeFrom(LatticeElement latticeElement) Conversion method to be provided by the user
void	print(java.io.PrintWriter os) Dump current state and content to output stream.
void	propagate(IProbe probe) Override of IComponent.propagate(xal.model.IProbe, double) Propagates the Probe object through this element based on the associated algorithm.
void	propagate(IProbe probe, double pos) Override of IComponent.propagate(xal.model.IProbe, double) Propagates the Probe object through this element based on the associated algorithm.
void	setAlign(R3 vecAlign) Set the alignment parameters all at once.
void	setAlignX(double x)
void	setAlignY(double y)
void	setAlignZ(double z)
void	setHardwareNodeId(java.lang.String strSmfId) Sets the string identifier of the hardware node which this element models.
void	setId(java.lang.String strId) Set the string identifier for the element.
void	setPosition(double dblPos) Set the center position of the element with the containing lattice.
java.lang.String	toString() Writes a general parameters description of this modeling element to the returned string.
abstract 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 java.lang.Object

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

Constructor Detail

Element

public Element(java.lang.String strType)

Creates a new instance of Element

Parameters:

strType - type identifier of the element

Element

public Element(java.lang.String strType,
               java.lang.String strId)

Creates a new instance of Element

Parameters:

strType - type identifier of the element

strId - string identifier of the element

Method Detail

getLength

public abstract double getLength()

Return the length of this element. Derived class must implement this because it is undetermined whether or not this is a thin or thick element.

Specified by:

getLength in interface IComponent

Returns:

length of the element (in meters)

elapsedTime

public abstract 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.

Specified by:

elapsedTime in interface IElement

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 abstract double energyGain(IProbe probe,
                                  double dblLen)

Returns energy gain for subsection of this element of length dblLen for the specified given probe.

Specified by:

energyGain in interface IElement

Parameters:

probe - determine energy gain for this probe

dblLen - length of subsection to calculate energy gain

Returns:

the energy gain provided by this element Units: eV

transferMap

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

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

Parameters:

dblLen - length of sub-element

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

Returns:

transfer map for an element of length dblLen

Throws:

ModelException - unable to compute transfer map

See Also:

IElement.transferMap(IProbe,double)

initializeFrom

public void initializeFrom(LatticeElement latticeElement)

Conversion method to be provided by the user

Specified by:

initializeFrom in interface IComponent

Parameters:

latticeElement - the SMF node to convert

setId

public void setId(java.lang.String strId)

Set the string identifier for the element.

Parameters:

strId - new string identifier for element

setHardwareNodeId

public void setHardwareNodeId(java.lang.String strSmfId)

Sets the string identifier of the hardware node which this element models. Node that this element may only model part of the underlying hardware node or simply some aspect of it. Thus, this is not a unique value amount all modeling elements.

Parameters:

strSmfId - identifier for the modeled hardware node (SMF object)

Since:

Sep 2, 2014

setPosition

public void setPosition(double dblPos)

Set the center position of the element with the containing lattice.

Parameters:

dblPos - center position along the design trajectory (meters)

setAlign

public void setAlign(R3 vecAlign)

Set the alignment parameters all at once.

Parameters:

vecAlign - (dx,dy,dz)

setAlignX

public void setAlignX(double x)

setAlignY

public void setAlignY(double y)

setAlignZ

public void setAlignZ(double z)

getAlignX

public double getAlignX()

getAlignY

public double getAlignY()

getAlignZ

public double getAlignZ()

addCloseElements

public void addCloseElements(Element closeElem)

Add an element to the list of nearest neighbor elements used when considering the effects of PMQs

Parameters:

closeElem - an adjacent element

getUID

public int getUID()

Return the internal class unique identifier of this element.

Returns:

the unique identifier of this object

applyAlignError

protected PhaseMatrix applyAlignError(PhaseMatrix matPhi)

Returns the given transfer matrix adjusted by the misalignment parameters of this element.

Parameters:

matPhi - a transfer matrix

Returns:

the given transfer matrix modified to contain misalignment errors

Since:

Apr 13, 2011

compProbeLocation

public double compProbeLocation(IProbe probe)

This method is intended to return the location of the probe within the current element. Actually, we compute and return the distance of the probe from the element entrance location.

NOTE

This method will always return a value regardless of whether or not the probe is within the element domain. The returned value is the distance fromt the entrance location. Thus, negative values indicate an upstream position and values larger than the element length indicate positions downstream.

Parameters:

probe - probe within element domain

Returns:

the distance within the element entrance

getType

public java.lang.String getType()

Return the element type identifier

Specified by:

getType in interface IComponent

Returns:

element type string

getId

public java.lang.String getId()

Returns the string identifier for this element.

Specified by:

getId in interface IComponent

Returns:

string identifier

getHardwareNodeId

public java.lang.String getHardwareNodeId()

Returns the string identifier of the hardware node which this element models. Note that the element may model only a portion of the hardware object or simply an aspect of it. Thus, this is not a unique values among modeling elements.

Specified by:

getHardwareNodeId in interface IComponent

Returns:

the identifier string of the hardware this element models

Since:

Sep 2, 2014

propagate

public void propagate(IProbe probe,
                      double pos)
               throws ModelException

Override of IComponent.propagate(xal.model.IProbe, double) Propagates the Probe object through this element based on the associated algorithm.

NOTE: CKA
The position of the probe within the element appears to be kept as a field of the algorithm object. I am not exactly sure of any side-effects of this implementation when using the Tracker.propagate(IProbe, IElement) of the Tracker class. Careful when modifying.

Specified by:

propagate in interface IComponent

Parameters:

probe - probe object to propagate

pos - I think it is position of the probe within this element

Throws:

ModelException - error occurred during propagation

See Also:

IComponent.propagate(xal.model.IProbe, double), Tracker.propagate(IProbe, IElement)

propagate

public void propagate(IProbe probe)
               throws ModelException

Override of IComponent.propagate(xal.model.IProbe, double) Propagates the Probe object through this element based on the associated algorithm.

Specified by:

propagate in interface IComponent

Parameters:

probe - probe object to propagate

Throws:

ModelException - error occurred during propagation

See Also:

IComponent.propagate(xal.model.IProbe, double)

backPropagate

public void backPropagate(IProbe probe,
                          double pos)
                   throws ModelException

Back propagates the Probe object through this element based on the associated algorithm.

NOTES: CKA
The position of the probe within the element appears to be kept as a field of the algorithm object. I am not exactly sure of any side-effects of this implementation when using the Tracker.propagate(IProbe, IElement) of the Tracker class. Careful when modifying.
· Support for backward propagation February, 2009.
· You must use the proper algorithm object for this method to work correctly!

Specified by:

backPropagate in interface IComponent

Parameters:

probe - probe object to propagate

pos - I think it is position of the probe within this element

Throws:

ModelException - error occurred during propagation

See Also:

IComponent.propagate(xal.model.IProbe, double), Tracker.propagate(IProbe, IElement)

backPropagate

public void backPropagate(IProbe probe)
                   throws ModelException

Back propagates the Probe object through this element based on the associated algorithm.

NOTES: CKA
· Support for backward propagation February, 2009.
· You must use the proper algorithm object for this method to work correctly!

Specified by:

backPropagate in interface IComponent

Parameters:

probe - probe object to propagate

Throws:

ModelException - error occurred during propagation

See Also:

IComponent.propagate(xal.model.IProbe, double)

getPosition

public double getPosition()

Return the center position of the element along the design trajectory. This is the position with the containing lattice.

Returns:

center position of the element (meters)

getCloseElements

public java.util.ArrayList<Element> getCloseElements()

Return the list of nearest adjacent elements to this element. THis is used primarily in permenant magnet quadrupole considerations.

Returns:

List of adjacent modeling elements

compDriftingTime

public double compDriftingTime(IProbe probe,
                               double dblLen)

Compute the time the probe probe spends drifting a a distance dblLen.

Parameters:

probe - interface to drifting probe

dblLen - length of drift in meters

Returns:

time interval during drift in seconds

toString

public java.lang.String toString()

Writes a general parameters description of this modeling element to the returned string.

Overrides:

toString in class java.lang.Object

Since:

Jan 5, 2015 by Christopher K. Allen

See Also:

Object.toString()

print

public void print(java.io.PrintWriter os)

Dump current state and content to output stream.

Parameters:

os - output stream object