xal.model.elem

Class IdealEQuad

java.lang.Object

xal.model.elem.Element

xal.model.elem.ThickElement

xal.model.elem.ThickElectrostatic

xal.model.elem.IdealEQuad

All Implemented Interfaces:

IElectrostatic, IComponent, IElement

public class IdealEQuad
extends ThickElectrostatic

Represents an ideal electrostatic quadrupole for a beam transport/accelerator system.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	s_strParamAperture Parameter for XAL MODEL LATTICE dtd
static java.lang.String	s_strParamOrient Parameter for XAL MODEL LATTICE dtd
static java.lang.String	s_strParamVoltage Parameter for XAL MODEL LATTICE dtd
static java.lang.String	s_strType string type identifier for all IdealEQuad objects

Fields inherited from class xal.model.elem.ThickElectrostatic

dblField, enmOrient

Fields inherited from interface xal.model.elem.IElectrostatic

ORIENT_HOR, ORIENT_NONE, ORIENT_VER

Fields inherited from interface xal.model.IElement

LightSpeed, Permeability, Permittivity, UnitCharge

Constructor Summary

Constructors

Constructor and Description
IdealEQuad() JavaBean constructor - creates a new uninitialized instance of IdealEQuad BE CAREFUL
IdealEQuad(java.lang.String strId, int enmOrient, double dblVol, double dblLen, double dblApt) Creates a new instance of IdealEQuad

Method Summary

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.
double	getAperture() Get the Aperture radius of the electrostatic quad.
int	getOrientation() Return the orientation enumeration code.
double	getVoltage() Get the voltage applied to the electrostatic quad pole tips.
void	initializeFrom(LatticeElement element) Conversion method to be provided by the user
void	print(java.io.PrintWriter os) Dump current state and content to output stream.
void	setAperture(double dblAperture) Set the Aperture radius of the electrostatic quad.
void	setOrientation(int enmOrient) Set the electrostatic quad orientation.
void	setVoltage(double dblVoltage) Set the applied Voltage on the electrostatic quad.
PhaseMap	transferMap(IProbe probe, double length) Compute the partial transfer map of an ideal Equadrupole for the particular probe.

Methods inherited from class xal.model.elem.ThickElectrostatic

getMagField, setMagField

Methods inherited from class xal.model.elem.ThickElement

getLength, setLength

Methods inherited from class xal.model.elem.Element

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

Methods inherited from class java.lang.Object

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

Field Detail

s_strType

public static final java.lang.String s_strType

string type identifier for all IdealEQuad objects

See Also:

Constant Field Values

s_strParamOrient

public static final java.lang.String s_strParamOrient

Parameter for XAL MODEL LATTICE dtd

See Also:

Constant Field Values

s_strParamVoltage

public static final java.lang.String s_strParamVoltage

Parameter for XAL MODEL LATTICE dtd

See Also:

Constant Field Values

s_strParamAperture

public static final java.lang.String s_strParamAperture

Parameter for XAL MODEL LATTICE dtd

See Also:

Constant Field Values

Constructor Detail

IdealEQuad

public IdealEQuad(java.lang.String strId,
                  int enmOrient,
                  double dblVol,
                  double dblLen,
                  double dblApt)

Creates a new instance of IdealEQuad

Parameters:

strId - identifier for this IdealEQuad object

enmOrient - enumeration specifying the quadrupole orientation (ORIENT_HOR or ORIENT_VER)

dblVol - Applied Voltage (kV)

dblLen - Length of the quadrupole (m)

dblApt - Aperture radius (m)

IdealEQuad

public IdealEQuad()

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

Method Detail

getOrientation

public int getOrientation()

Return the orientation enumeration code.

Specified by:

getOrientation in interface IElectrostatic

Overrides:

getOrientation in class ThickElectrostatic

Returns:

ORIENT_HOR - quadrupole focuses in x (horizontal) plane ORIENT_VER - quadrupole focuses in y ( vertical ) plane ORIENT_NONE - error

getVoltage

public double getVoltage()

Get the voltage applied to the electrostatic quad pole tips.

Returns:

Voltage (in kV).

setOrientation

public void setOrientation(int enmOrient)

Set the electrostatic quad orientation.

Specified by:

setOrientation in interface IElectrostatic

Overrides:

setOrientation in class ThickElectrostatic

Parameters:

enmOrient - quad orientation enumeration code

See Also:

getOrientation()

setVoltage

public void setVoltage(double dblVoltage)

Set the applied Voltage on the electrostatic quad.

Parameters:

dblVoltage - Voltage (in kV).

getAperture

public double getAperture()

Get the Aperture radius of the electrostatic quad.

Returns:

Aperture Radius (in m).

setAperture

public void setAperture(double dblAperture)

Set the Aperture radius of the electrostatic quad.

Parameters:

dblAperture - Aperture Radius (in m).

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 Element

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 Equadrupole 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 Equadrupole for the particular probe. Computes transfer map for a section of Equadrupole dblLen meters in length. The aperture used in the calculation is the aperture radius in meters.

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 Equadrupole for particular probe

See Also:

IElement.transferMap(IProbe,double)

print

public void print(java.io.PrintWriter os)

Dump current state and content to output stream.

Overrides:

print in class Element

Parameters:

os - output stream object

initializeFrom

public void initializeFrom(LatticeElement element)

Conversion method to be provided by the user

Specified by:

initializeFrom in interface IComponent

Overrides:

initializeFrom in class ThickElectrostatic

Parameters:

latticeElement - the SMF node to convert