xal.model

Class RingModel

java.lang.Object

xal.model.elem.ElementSeq

xal.model.RingModel

All Implemented Interfaces:

IComponent, IComposite

public class RingModel
extends ElementSeq

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	s_strType the string type identifier for all Lattice objects
static int	s_szDefReserve default number of element positions to reserve in list array

Constructor Summary

Constructors

Constructor and Description
RingModel() Creates a new, empty instance of RingModel.
RingModel(java.lang.String strId) Creates a new instance of RingModel with specified string identifier.
RingModel(java.lang.String strId, int szReserve) Creates a new instance of RingModel and reserves space for a szReserve length lattice.

Method Summary

Modifier and Type	Method and Description
void	backPropagate(IProbe probe) Back propagation of a probe through the lattice.
CovarianceMatrix	compClosedOrbit(SynchronousProbe probe) Nothing is done here.
PhaseMap	compOneTurnMatrix(TransferMapProbe probe) Compute the one-turn map of the ring for a particular TransferMapProbe describing the beam at injection.
java.lang.String	getAuthor() Get the author of the lattice definition
java.lang.String	getDate() Get the date of lattice description
java.lang.String	getVersion() Get the version of the lattice
void	propagate(IProbe probe) Propagate a probe through the lattice.
void	setAuthor(java.lang.String strAuthor) Sets the author tag
void	setDate(java.lang.String strDate) Sets the date tag
void	setVersion(java.lang.String strVersion) Sets the version tag

Methods inherited from class xal.model.elem.ElementSeq

addChild, backPropagate, childIterator, concatenateEquals, getAllElements, getChild, getChildCount, getComments, getCompList, getElementList, getHardwareNodeId, getId, getLeafCount, getLength, getReverseCompList, getType, globalBackIterator, globalIterator, initializeFrom, localBackIterator, localIterator, print, propagate, remove, setComments, setCompList, setHardwareNodeId, setId, toString

Methods inherited from class java.lang.Object

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

Field Detail

s_szDefReserve

public static final int s_szDefReserve

default number of element positions to reserve in list array

See Also:

Constant Field Values

s_strType

public static final java.lang.String s_strType

the string type identifier for all Lattice objects

See Also:

Constant Field Values

Constructor Detail

RingModel

public RingModel()

Creates a new, empty instance of RingModel.

RingModel

public RingModel(java.lang.String strId)

Creates a new instance of RingModel with specified string identifier.

Parameters:

strId - identifier of the lattice

RingModel

public RingModel(java.lang.String strId,
                 int szReserve)

Creates a new instance of RingModel and reserves space for a szReserve length lattice.

Parameters:

strId - identifier of the lattice

szReserve - number of Element spaces to reserve

Method Detail

setVersion

public void setVersion(java.lang.String strVersion)

Sets the version tag

Parameters:

strVersion - revision number of lattice

setAuthor

public void setAuthor(java.lang.String strAuthor)

Sets the author tag

Parameters:

strAuthor - author of lattice description

setDate

public void setDate(java.lang.String strDate)

Sets the date tag

Parameters:

strDate - date string of lattice description

propagate

public void propagate(IProbe probe)
               throws ModelException

Propagate a probe through the lattice. The probe is first initialized by calling the initialize() method of the probe then updated by calling the update() method in order to save the initial state of the probe into its trajectory.

Specified by:

propagate in interface IComponent

Specified by:

propagate in interface IComposite

Overrides:

propagate in class ElementSeq

Parameters:

probe - the state of the probe will be advance using the elements dynamics

Throws:

ModelException - an error occurred while advancing the probe state

See Also:

IComponent.propagate(IProbe)

backPropagate

public void backPropagate(IProbe probe)
                   throws ModelException

Back propagation of a probe through the lattice. The probe is first initialized by calling the initialize() method of the probe then updated by calling the update() method in order to save the initial state of the probe into its trajectory.

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

Overrides:

backPropagate in class ElementSeq

Parameters:

probe - the state of the probe will be advance using the elements dynamics

Throws:

ModelException - an error occurred while advancing the probe state

Since:

Feb 27, 2009

See Also:

ElementSeq.backPropagate(IProbe)

getVersion

public java.lang.String getVersion()

Get the version of the lattice

Returns:

lattice revision number

getAuthor

public java.lang.String getAuthor()

Get the author of the lattice definition

Returns:

lattice author

getDate

public java.lang.String getDate()

Get the date of lattice description

Returns:

lattice model date

compOneTurnMatrix

public PhaseMap compOneTurnMatrix(TransferMapProbe probe)
                           throws ModelException

Compute the one-turn map of the ring for a particular TransferMapProbe describing the beam at injection.

Parameters:

probe - probe with injection properties of the beam

Returns:

one-turn map of ring for particular probe

Throws:

ModelException - error in ring propagation of the probe

compClosedOrbit

public CovarianceMatrix compClosedOrbit(SynchronousProbe probe)

Nothing is done here.

Compute the closed-orbit correlation matrix of the ring for a particular injection probe (of type TransferMapProbe).

Parameters:

probe -

Returns:

This method simply returns the zero matrix