Package xal.model.elem

Class IdealMagQuad

java.lang.Object

xal.model.elem.Element

xal.model.elem.ThickElement

xal.model.elem.ThickElectromagnet

xal.model.elem.IdealMagQuad

All Implemented Interfaces:

IElectromagnet, IComponent, IElement

Direct Known Subclasses:

IdealMagSkewQuad

public class IdealMagQuad
extends ThickElectromagnet

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

Author:

Christopher K. Allen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_FIELD
static final String	PARAM_ORIENT	Parameters for XAL MODEL LATTICE dtd
static final String	TYPE	string type identifier for all IdealMagQuad 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
IdealMagQuad()	JavaBean constructor - creates a new uninitialized instance of IdealMagQuad BE CAREFUL
IdealMagQuad(String strId, int enmOrient, double dblFld, double dblLen)	Creates a new instance of IdealMagQuad

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.
double	getBRhoScaling()
double	getFieldPathFlag()
double	getFringeIntegral1Entr()
double	getFringeIntegral1Exit()
double	getFringeIntegral2Entr()
double	getFringeIntegral2Exit()
double	getK1()
double	getNominalKineEnergy()
double	getRadIn()
double	getRadOut()
void	print(PrintWriter os)	Dump current state and content to output stream.
void	setBRhoScaling(double d)
void	setFieldPathFlag(double ba)
void	setFringeIntegral1Entr(double dbl)
void	setFringeIntegral1Exit(double dbl)
void	setFringeIntegral2Entr(double dbl)
void	setFringeIntegral2Exit(double dbl)
void	setK1(double k1)
void	setNominalKineEnergy(double ba)
void	setRadIn(double ri)
void	setRadOut(double ro)
String	toString()
PhaseMap	transferMap(IProbe probe, double length)	Compute the partial transfer map of an ideal quadrupole 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

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 IdealMagQuad objects

See Also:

• Constant Field Values

PARAM_ORIENT

public static final String PARAM_ORIENT

Parameters for XAL MODEL LATTICE dtd

See Also:

• Constant Field Values

PARAM_FIELD

public static final String PARAM_FIELD

See Also:

• Constant Field Values

Constructor Details

IdealMagQuad

public IdealMagQuad(String strId,
 int enmOrient,
 double dblFld,
 double dblLen)

Creates a new instance of IdealMagQuad

Parameters:

strId - identifier for this IdealMagQuad object

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

dblFld - field gradient strength (in Tesla/meter)

dblLen - length of the quadrupole

IdealMagQuad

public IdealMagQuad()

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

Method Details

getBRhoScaling

public double getBRhoScaling()

setBRhoScaling

public void setBRhoScaling(double d)

getFringeIntegral1Entr

public double getFringeIntegral1Entr()

getFringeIntegral1Exit

public double getFringeIntegral1Exit()

getFringeIntegral2Entr

public double getFringeIntegral2Entr()

getFringeIntegral2Exit

public double getFringeIntegral2Exit()

setFringeIntegral1Entr

public void setFringeIntegral1Entr(double dbl)

setFringeIntegral1Exit

public void setFringeIntegral1Exit(double dbl)

setFringeIntegral2Entr

public void setFringeIntegral2Entr(double dbl)

setFringeIntegral2Exit

public void setFringeIntegral2Exit(double dbl)

setRadIn

public void setRadIn(double ri)

setRadOut

public void setRadOut(double ro)

getRadIn

public double getRadIn()

getRadOut

public double getRadOut()

setFieldPathFlag

public void setFieldPathFlag(double ba)

setNominalKineEnergy

public void setNominalKineEnergy(double ba)

getFieldPathFlag

public double getFieldPathFlag()

getNominalKineEnergy

public double getNominalKineEnergy()

getK1

public double getK1()

setK1

public void setK1(double k1)

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 quadrupole 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 quadrupole for the particular probe. Computes transfer map for a section of quadrupole 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)

toString

public String toString()

Overrides:

toString in class Element

Since:

Jan 27, 2015 by Christopher K. Allen

See Also:

• Element.toString()

print

public void print(PrintWriter os)

Dump current state and content to output stream.

Overrides:

print in class Element

Parameters:

os - output stream object