xal.model.elem

Class IdealMagSkewQuad

java.lang.Object

xal.model.elem.Element

xal.model.elem.ThickElement

xal.model.elem.ThickElectromagnet

xal.model.elem.IdealMagQuad

xal.model.elem.IdealMagSkewQuad

All Implemented Interfaces:

IElectromagnet, IComponent, IElement

public class IdealMagSkewQuad
extends IdealMagQuad

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	s_strType string type identifier for all IdealMagSkewQuad objects

Fields inherited from class xal.model.elem.IdealMagQuad

s_strParamField, s_strParamOrient

Fields inherited from class xal.model.elem.ThickElectromagnet

dblField, enmOrient

Fields inherited from interface xal.model.elem.IElectromagnet

ORIENT_HOR, ORIENT_NONE, ORIENT_VER

Fields inherited from interface xal.model.IElement

LightSpeed, Permeability, Permittivity, UnitCharge

Constructor Summary

Constructors

Constructor and Description
IdealMagSkewQuad(java.lang.String strId, int enmOrient, double dblFld, double dblLen, double dblAng) Creates a new instance of IdealMagSkewQuad

Method Summary

Modifier and Type	Method and Description
double	getSkewAngle() Get the rotation angle of the electromagnet.
void	print(java.io.PrintWriter os) Dump current state and content to output stream.
void	setSkewAngle(double dblAngle) Set the rotation angle of the electromagnet.
PhaseMap	transferMap(IProbe probe, double length) Compute the partial transfer map of an ideal skew quadrupole for the particular probe.

Methods inherited from class xal.model.elem.IdealMagQuad

elapsedTime, energyGain, getBRhoScaling, getFieldPathFlag, getFringeIntegral1Entr, getFringeIntegral1Exit, getFringeIntegral2Entr, getFringeIntegral2Exit, getK1, getNominalKineEnergy, getRadIn, getRadOut, setBRhoScaling, setFieldPathFlag, setFringeIntegral1Entr, setFringeIntegral1Exit, setFringeIntegral2Entr, setFringeIntegral2Exit, setK1, setNominalKineEnergy, setRadIn, setRadOut

Methods inherited from class xal.model.elem.ThickElectromagnet

getMagField, getOrientation, initializeFrom, setMagField, setOrientation

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

See Also:

Constant Field Values

Constructor Detail

IdealMagSkewQuad

public IdealMagSkewQuad(java.lang.String strId,
                        int enmOrient,
                        double dblFld,
                        double dblLen,
                        double dblAng)

Creates a new instance of IdealMagSkewQuad

Parameters:

strId - identifier for this IdealMagSkewQuad object

enmOrient - enumeration specifying the skew quadrupole orientation (13 focuses in quadrants 1 and 3 and 24 focuses in quadrants 2 and 4)

dblFld - field gradient strength (in Tesla/meter)

dblLen - length of the skew quadrupole

dblAng - angle of the skew quadrupole: dblAng > 0 -> focuses in quadrants 1 and 3 dblAng < 0 -> focuses in quadrants 2 and 4

Method Detail

getSkewAngle

public double getSkewAngle()

Get the rotation angle of the electromagnet.

Returns:

rotation angle (in degrees).

setSkewAngle

public void setSkewAngle(double dblAngle)

Set the rotation angle of the electromagnet.

Parameters:

dblAngle - rotation angle (in degrees).

transferMap

public PhaseMap transferMap(IProbe probe,
                            double length)

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

Specified by:

transferMap in interface IElement

Overrides:

transferMap in class IdealMagQuad

Parameters:

probe - supplies the charge, rest and kinetic energy parameters

length - compute transfer matrix for section of this length

Returns:

transfer map of ideal skew quadrupole 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 IdealMagQuad

Parameters:

os - output stream object