ThickDipole

java.lang.Object
- xal.model.elem.Element
- - xal.model.elem.ThickElement
  - - xal.model.elem.ThickElectromagnet
    - - xal.model.elem.ThickDipole

All Implemented Interfaces:

IElectromagnet, IComponent, IElement
```
public class ThickDipole
extends ThickElectromagnet
```
Represents a thick magnetic dipole magnet for a beam transport/accelerator system. NOTE: - !!! Bending is assumed to be horizontal for now !!!! It has provisions for a general wedge magnet, with arbitrary entrance / exit angles. The MAD convention for sector magnets is followed for coordinates, signs, and lengths. The formulation from D. Carey's Optics book + Transport manual are used. TODO - Add "tilt" angle of the dipole, and add charge of the probe to get the right bend radius.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`s_strEntranceAngle`
`static java.lang.String`	`s_strExitAngle`
`static java.lang.String`	`s_strField`
`static java.lang.String`	`s_strPathLength` Parameters for XAL MODEL LATTICE dtd
`static java.lang.String`	`s_strQuadComponent`
`static java.lang.String`	`s_strType` string type identifier for all ThickDipole objects

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
`ThickDipole()` JavaBean constructor - creates a new unitialized instance of ThickDipole * This is the constructor called in automatic lattice generation.
`ThickDipole(java.lang.String strId, double fld, double len, double entAng, double exitAng, double gap, double fInt)` Creates a new instance of ThickDipole

Method Summary

All Methods Instance Methods Concrete Methods
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`	`getALignX()`
`double`	`getAlignY()`
`double`	`getAlignZ()`
`double`	`getBendAngle()`
`double`	`getEntranceAngle()` Gets the entrance angle of the beam into the dipole.
`double`	`getExitAngle()` Gets the exit angle of the beam into the dipole.
`double`	`getFieldIndex(IProbe probe)` get field index nQ
`double`	`getFieldPathFlag()`
`double`	`getKQuad()` Gets the quad.
`double`	`getPathLength()`
`void`	`print(java.io.PrintWriter os)` Dump current state and content to output stream.
`void`	`setAlignX(double x)`
`void`	`setAlignY(double y)`
`void`	`setAlignZ(double z)`
`void`	`setBendAngle(double ba)`
`void`	`setEntranceAngle(double dblAng)` Sets the entrance angle of the beam into the dipole.
`void`	`setExitAngle(double dblAng)` Sets the entrance angle of the beam into the dipole.
`void`	`setFieldIntegral(double fint)` set the fring field integral factor
`void`	`setFieldPathFlag(double ba)`
`void`	`setGapHeight(double gap)` set the gap height
`void`	`setKQuad(double k)` Sets the quad.
`void`	`setPathLength(double pl)`
`PhaseMap`	`transferMap(IProbe probe, double dL)` 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
getLength, setLength

Methods inherited from class xal.model.elem.Element
addCloseElements, applyAlignError, backPropagate, backPropagate, compDriftingTime, compProbeLocation, getAlignX, getCloseElements, getHardwareNodeId, getId, getPosition, getType, getUID, propagate, propagate, setAlign, 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 ThickDipole objects
    
    See Also:
    
    Constant Field Values
  - s_strPathLength
```
public static final java.lang.String s_strPathLength
```
    Parameters for XAL MODEL LATTICE dtd
    
    See Also:
    
    Constant Field Values
  - s_strField
```
public static final java.lang.String s_strField
```
    See Also:
    
    Constant Field Values
  - s_strEntranceAngle
```
public static final java.lang.String s_strEntranceAngle
```
    See Also:
    
    Constant Field Values
  - s_strExitAngle
```
public static final java.lang.String s_strExitAngle
```
    See Also:
    
    Constant Field Values
  - s_strQuadComponent
```
public static final java.lang.String s_strQuadComponent
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ThickDipole
```
public ThickDipole(java.lang.String strId,
                   double fld,
                   double len,
                   double entAng,
                   double exitAng,
                   double gap,
                   double fInt)
```
    Creates a new instance of ThickDipole
    
    Parameters:
    
    strId - identifier for this ThickDipole object
    
    fld - field gradient strength (in Tesla)
    
    len - pathLength of the dipole (in m)
    
    entAng - entrance angle of the dipole (in rad)
    
    exitAng - exit angle of the dipole (in rad)
    
    gap - full pole gap of the dipole (in m)
    
    fInt - The dimensionless integral term for the extended fringe field focsing, Should be = 1/6 for linear drop off, ~ 0.4 for clamped Rogowski coil, or 0.7 for an unclamped Rogowski coil. (dimensionless)
  - ThickDipole
```
public ThickDipole()
```
    JavaBean constructor - creates a new unitialized instance of ThickDipole * This is the constructor called in automatic lattice generation. Thus, all element properties are set following construction. BE CAREFUL
- Method Detail
  - setAlignX
```
public void setAlignX(double x)
```
    Overrides:
    
    setAlignX in class Element
  - setAlignY
```
public void setAlignY(double y)
```
    Overrides:
    
    setAlignY in class Element
  - setAlignZ
```
public void setAlignZ(double z)
```
    Overrides:
    
    setAlignZ in class Element
  - getALignX
```
public double getALignX()
```
  - getAlignY
```
public double getAlignY()
```
    Overrides:
    
    getAlignY in class Element
  - getAlignZ
```
public double getAlignZ()
```
    Overrides:
    
    getAlignZ in class Element
  - setPathLength
```
public void setPathLength(double pl)
```
  - setBendAngle
```
public void setBendAngle(double ba)
```
  - setFieldPathFlag
```
public void setFieldPathFlag(double ba)
```
  - getPathLength
```
public double getPathLength()
```
  - getBendAngle
```
public double getBendAngle()
```
  - getFieldPathFlag
```
public double getFieldPathFlag()
```
  - setEntranceAngle
```
public void setEntranceAngle(double dblAng)
```
    Sets the entrance angle of the beam into the dipole.
    
    Parameters:
    
    dblAng - entrance angle in radians
  - getEntranceAngle
```
public double getEntranceAngle()
```
    Gets the entrance angle of the beam into the dipole.
  - setExitAngle
```
public void setExitAngle(double dblAng)
```
    Sets the entrance angle of the beam into the dipole.
    
    Parameters:
    
    dblAng - exit angle in radians
  - getExitAngle
```
public double getExitAngle()
```
    Gets the exit angle of the beam into the dipole.
  - setKQuad
```
public void setKQuad(double k)
```
    Sets the quad. field index term
    
    Parameters:
    
    k - = 1/B-rho) * d B_y/dx
  - getKQuad
```
public double getKQuad()
```
    Gets the quad. field index term = 1/B-rho * d B_y/dx
  - 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 quadrupole magnet this value is always zero.
    
    Specified by:
    
    energyGain in interface IElement
    
    Specified by:
    
    energyGain in class ThickElement
    
    Parameters:
    
    dblLen - dummy argument
    
    probe - dummy argument
    
    Returns:
    
    returns a zero value
  - setFieldIntegral
```
public void setFieldIntegral(double fint)
```
    set the fring field integral factor
    
    Parameters:
    
    fint - the field integral a la MAD = 1/6 for linear drop off = 0.4 for clamped Rogowski coil = 0.7 for unclamped Rogowski coil = 0.45 for square edge - non saturating magnet
  - setGapHeight
```
public void setGapHeight(double gap)
```
    set the gap height
    
    Parameters:
    
    gap - = full gap height (m)
  - getFieldIndex
```
public double getFieldIndex(IProbe probe)
```
    get field index nQ
  - transferMap
```
public PhaseMap transferMap(IProbe probe,
                            double dL)
                     throws ModelException
```
    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:
    
    dL - compute transfer matrix for section of this path length
    
    probe - uses the rest and kinetic energy parameters from the probe
    
    Returns:
    
    transfer map of ideal quadrupole for particular probe
    
    Throws:
    
    ModelException - unknown quadrupole orientation
    
    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

Class ThickDipole

Field Summary

Fields inherited from class xal.model.elem.ThickElectromagnet

Fields inherited from interface xal.model.elem.IElectromagnet

Fields inherited from interface xal.model.IElement

Constructor Summary

Method Summary

Methods inherited from class xal.model.elem.ThickElectromagnet

Methods inherited from class xal.model.elem.ThickElement

Methods inherited from class xal.model.elem.Element

Methods inherited from class java.lang.Object

Field Detail

s_strType

s_strPathLength

s_strField

s_strEntranceAngle

s_strExitAngle

s_strQuadComponent

Constructor Detail

ThickDipole

ThickDipole

Method Detail

setAlignX

setAlignY

setAlignZ

getALignX

getAlignY

getAlignZ

setPathLength

setBendAngle

setFieldPathFlag

getPathLength

getBendAngle

getFieldPathFlag

setEntranceAngle

getEntranceAngle

setExitAngle

getExitAngle

setKQuad

getKQuad

elapsedTime

energyGain

setFieldIntegral

setGapHeight

getFieldIndex

transferMap

print