Package xal.extension.jels.model.elem

Class ThinMagFieldMap

java.lang.Object

xal.model.elem.Element

xal.model.elem.ThinElement

xal.model.elem.ThinElectromagnet

xal.extension.jels.model.elem.ThinMagFieldMap

All Implemented Interfaces:

IElectromagnet, IComponent, IElement

public class ThinMagFieldMap
extends ThinElectromagnet

Magnetic fieldmap 3D implementation.

Author:

Juan F. Esteban Müller <JuanF.EstebanMuller@esss.se>

Field Summary

Fields inherited from class xal.model.elem.ThinElectromagnet

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
ThinMagFieldMap()
ThinMagFieldMap(String strId)

Method Summary

Modifier and Type	Method	Description
protected double	elapsedTime(IProbe probe)	Returns the time taken for the probe to propagate through element.
double	energyGain(IProbe probe)	Calculate the energy gain for this element on the supplied probe.
void	initializeFrom(LatticeElement latticeElement)	Conversion method to be provided by the user
PhaseMap	transferMap(IProbe probe)	Method calculates transfer matrix for the field map for a given data point in the field map.

Methods inherited from class xal.model.elem.ThinElectromagnet

getMagField, getOrientation, setMagField, setOrientation

Methods inherited from class xal.model.elem.ThinElement

applyErrors, elapsedTime, energyGain, getLength, longitudinalPhaseAdvance, longitudinalPhaseAdvance, transferMap

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, print, propagate, propagate, setAlign, setAlignX, setAlignY, setAlignZ, setHardwareNodeId, setId, setParent, setPhiX, setPhiY, setPhiZ, setPosition, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ThinMagFieldMap

public ThinMagFieldMap()

ThinMagFieldMap

public ThinMagFieldMap(String strId)

Method Details

initializeFrom

public void initializeFrom(LatticeElement latticeElement)

Description copied from class: ThinElectromagnet

Conversion method to be provided by the user

Specified by:

initializeFrom in interface IComponent

Overrides:

initializeFrom in class ThinElectromagnet

Parameters:

latticeElement - the SMF node to convert

transferMap

public PhaseMap transferMap(IProbe probe)
                     throws ModelException

Method calculates transfer matrix for the field map for a given data point in the field map. Drift spaces are calculated separately.

Specified by:

transferMap in class ThinElement

Returns:

Throws:

ModelException

energyGain

public double energyGain(IProbe probe)

Description copied from class: ThinElement

Calculate the energy gain for this element on the supplied probe.

Specified by:

energyGain in class ThinElement

Returns:

this element's energy gain

elapsedTime

protected double elapsedTime(IProbe probe)

Description copied from class: ThinElement

Returns the time taken for the probe to propagate through element.

Specified by:

elapsedTime in class ThinElement

Parameters:

probe - propagating probe

Returns:

elapsed time through element Units: seconds