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.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
s_strParamField
Parameters for XAL MODEL LATTICE dtd
|
static java.lang.String |
s_strType
string type identifier for all IdealMagSolenoid objects
|
dblField, enmOrient
ORIENT_HOR, ORIENT_NONE, ORIENT_VER
LightSpeed, Permeability, Permittivity, UnitCharge
Constructor and Description |
---|
IdealMagSolenoid()
JavaBean constructor - creates a new unitialized instance of IdealMagSolenoid
BE CAREFUL
|
IdealMagSolenoid(java.lang.String strId,
double dblFld,
double dblLen)
Creates a new instance of IdealMagSolenoid
|
Modifier and Type | Method and 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(java.io.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.
|
getMagField, getOrientation, initializeFrom, setMagField, setOrientation
getLength, setLength
addCloseElements, applyAlignError, backPropagate, backPropagate, compDriftingTime, compProbeLocation, getAlignX, getAlignY, getAlignZ, getCloseElements, getHardwareNodeId, getId, getPosition, getType, getUID, propagate, propagate, setAlign, setAlignX, setAlignY, setAlignZ, setHardwareNodeId, setId, setPosition, toString
public static final java.lang.String s_strType
public static final java.lang.String s_strParamField
public IdealMagSolenoid(java.lang.String strId, double dblFld, double dblLen)
strId
- identifier for this IdealMagSolenoid objectdblFld
- field gradient strength (in Tesla)dblLen
- length of the solenoidpublic IdealMagSolenoid()
public double elapsedTime(IProbe probe, double dblLen)
elapsedTime
in interface IElement
elapsedTime
in class Element
probe
- propagating probedblLen
- length of subsection to propagate through meterspublic double energyGain(IProbe probe, double dblLen)
energyGain
in interface IElement
energyGain
in class ThickElement
probe
- dummy argumentdblLen
- dummy argumentpublic PhaseMap transferMap(IProbe probe, double length)
dblLen
meters in length.transferMap
in interface IElement
transferMap
in class ThickElement
probe
- supplies the charge, rest and kinetic energy parameterslength
- compute transfer matrix for section of this lengthIElement.transferMap(IProbe,double)