Package xal.model.elem

Class IdealMagSolenoid

java.lang.Object

xal.model.elem.Element

xal.model.elem.ThickElement

xal.model.elem.ThickElectromagnet

xal.model.elem.IdealMagSolenoid

All Implemented Interfaces:

IElectromagnet, IComponent, IElement

public class IdealMagSolenoid
extends ThickElectromagnet

Models an ideal solenoid magnet. I don't know who implemented this class or when he or she did so. I can't really comment on details yet.

Since:

Apr 19, 2011

Author:

Christopher K. Allen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_FIELD	Parameters for XAL MODEL LATTICE dtd
static final String	TYPE	string type identifier for all IdealMagSolenoid objects

Fields inherited from class xal.model.elem.ThickElectromagnet

dblField, enmOrient

Fields inherited from class xal.model.elem.Element

dblNodeLen, dblNodePos

Fields inherited from interface xal.model.elem.sync.IElectromagnet

ORIENT_HOR, ORIENT_NONE, ORIENT_VER

Fields inherited from interface xal.model.IElement

LIGHT_SPEED, PERMEABILITY, PERMITTIVITY, UNIT_CHARGE

Constructor Summary

Constructors

Constructor	Description
IdealMagSolenoid()	JavaBean constructor - creates a new uninitialized instance of IdealMagSolenoid BE CAREFUL
IdealMagSolenoid(String strId, double dblFld, double dblLen)	Creates a new instance of IdealMagSolenoid

Method Summary

Modifier and Type	Method	Description
double	elapsedTime(IProbe probe, double dblLen)	Returns the time taken for the probe to drift through part of the element.
double	energyGain(IProbe probe, double dblLen)	Return the energy gain imparted to a particular probe.
void	print(PrintWriter os)	Dump current state and content to output stream.
PhaseMap	transferMap(IProbe probe, double length)	Compute the partial transfer map of an ideal solenoid for the particular probe.

Methods inherited from class xal.model.elem.ThickElectromagnet

getMagField, getOrientation, initializeFrom, setMagField, setOrientation

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, 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

TYPE

public static final String TYPE

string type identifier for all IdealMagSolenoid objects

See Also:

• Constant Field Values

PARAM_FIELD

public static final String PARAM_FIELD

Parameters for XAL MODEL LATTICE dtd

See Also:

• Constant Field Values

Constructor Details

IdealMagSolenoid

public IdealMagSolenoid(String strId,
 double dblFld,
 double dblLen)

Creates a new instance of IdealMagSolenoid

Parameters:

strId - identifier for this IdealMagSolenoid object

dblFld - field gradient strength (in Tesla)

dblLen - length of the solenoid

IdealMagSolenoid

public IdealMagSolenoid()

JavaBean constructor - creates a new uninitialized instance of IdealMagSolenoid BE CAREFUL

Method Details

elapsedTime

public double elapsedTime(IProbe probe,
 double dblLen)

Returns the time taken for the probe to drift through part of the element.

Specified by:

elapsedTime in interface IElement

Specified by:

elapsedTime in class ThickElement

Parameters:

probe - propagating probe

dblLen - length of subsection to propagate through meters

Returns:

the elapsed time through sectionUnits: seconds

energyGain

public double energyGain(IProbe probe,
 double dblLen)

Return the energy gain imparted to a particular probe. For an ideal solenoid magnet this value is always zero.

Specified by:

energyGain in interface IElement

Specified by:

energyGain in class ThickElement

Parameters:

probe - dummy argument

dblLen - dummy argument

Returns:

returns a zero value

transferMap

public PhaseMap transferMap(IProbe probe,
 double length)

Compute the partial transfer map of an ideal solenoid for the particular probe. Computes transfer map for a section of solenoid dblLen meters in length.

Specified by:

transferMap in interface IElement

Specified by:

transferMap in class ThickElement

Parameters:

probe - supplies the charge, rest and kinetic energy parameters

length - compute transfer matrix for section of this length

Returns:

transfer map of ideal quadrupole for particular probe

See Also:

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

print

public void print(PrintWriter os)

Dump current state and content to output stream.

Overrides:

print in class Element

Parameters:

os - output stream object