Package xal.model

Class RingModel

java.lang.Object
xal.model.elem.ElementSeq
xal.model.RingModel
All Implemented Interfaces:
Iterable<IComponent>, IComponent, IComposite
@Deprecated public class RingModel extends ElementSeq
Deprecated.
This class is never used
Author:
Christopher K. Allen

  • Field Details

    • SIZE_DEF_RESERVE

      public static final int SIZE_DEF_RESERVE
      Deprecated.
      default number of element positions to reserve in list array
      See Also:

    • TYPE

      public static final String TYPE
      Deprecated.
      the string type identifier for all Lattice objects
      See Also:

  • Constructor Details

    • RingModel

      public RingModel()
      Deprecated.
      Creates a new, empty instance of RingModel.

    • RingModel

      public RingModel(String strId)
      Deprecated.
      Creates a new instance of RingModel with specified string identifier.
      Parameters:
      strId - identifier of the lattice

    • RingModel

      public RingModel(String strId, int szReserve)
      Deprecated.
      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 Details

    • setVersion

      public void setVersion(String strVersion)
      Deprecated.
      Sets the version tag
      Parameters:
      strVersion - revision number of lattice

    • setAuthor

      public void setAuthor(String strAuthor)
      Deprecated.
      Sets the author tag
      Parameters:
      strAuthor - author of lattice description

    • setDate

      public void setDate(String strDate)
      Deprecated.
      Sets the date tag
      Parameters:
      strDate - date string of lattice description

    • propagate

      public void propagate(IProbe probe) throws ModelException
      Deprecated.
      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:

    • backPropagate

      public void backPropagate(IProbe probe) throws ModelException
      Deprecated.

      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:

    • getVersion

      public String getVersion()
      Deprecated.
      Get the version of the lattice
      Returns:
      lattice revision number

    • getAuthor

      public String getAuthor()
      Deprecated.
      Get the author of the lattice definition
      Returns:
      lattice author

    • getDate

      public String getDate()
      Deprecated.
      Get the date of lattice description
      Returns:
      lattice model date

    • compOneTurnMatrix

      public PhaseMap compOneTurnMatrix(TransferMapProbe probe) throws ModelException
      Deprecated.
      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)
      Deprecated.

      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