xal.model.probe.traj

Class BunchProbeState<S extends BunchProbeState<S>>

java.lang.Object

xal.model.probe.traj.ProbeState<S>

xal.model.probe.traj.BunchProbeState<S>

All Implemented Interfaces:

IProbeState, IArchive

Direct Known Subclasses:

EnsembleProbeState, EnvelopeProbeState, TwissProbeState

public abstract class BunchProbeState<S extends BunchProbeState<S>>
extends ProbeState<S>

Encapsulates a BunchProbe's state at a point in time. Contains addition state variables for probes with beam-like behavior.

Field Summary

Fields inherited from class xal.model.probe.traj.ProbeState

STATE_LABEL, TYPE_LABEL

Fields inherited from interface xal.model.probe.traj.IProbeState

LightSpeed

Constructor Summary

Constructors

Constructor and Description
BunchProbeState() Default constructor.
BunchProbeState(BunchProbe<S> probe) Initializing constructor.
BunchProbeState(S state) Copy constructor for BunchProbeState.

Method Summary

Modifier and Type	Method and Description
protected void	addPropertiesTo(DataAdaptor daSink) Save the state values particular to BunchProbeState objects to the data sink.
double	beamPerveance() Returns the generalized, three-dimensional beam perveance K.
double	bunchCharge() Computes and returns the charge in each beam bunch
double	getBeamCurrent() Returns the total beam current, which is the bunch charge Q times the bunch frequency f.
double	getBunchFrequency() Returns the bunch frequency, that is, the rate at which beam bunches pass a stationary point (in laboratory coordinates).
protected void	readPropertiesFrom(DataAdaptor daSource) Recover the state values particular to BunchProbeState objects from the data source.
void	setBeamCurrent(double I) Set the total beam current
void	setBunchFrequency(double f) Set the bunch arrival time frequency.
java.lang.String	toString() Write out state information to a string.

Methods inherited from class xal.model.probe.traj.ProbeState

computeBetaFromGamma, computeGammaFromBeta, computeGammaFromW, copy, getBeta, getBetaGamma, getElementId, getGamma, getHardwareNodeId, getKineticEnergy, getMomentum, getPosition, getSpeciesCharge, getSpeciesRestEnergy, getTime, load, save, setElementId, setHardwareNodeId, setKineticEnergy, setPosition, setSpeciesCharge, setSpeciesRestEnergy, setTime

Methods inherited from class java.lang.Object

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

Constructor Detail

BunchProbeState

public BunchProbeState()

Default constructor. Creates an empty BunchProbeState.

BunchProbeState

public BunchProbeState(S state)

Copy constructor for BunchProbeState. Initializes the new BunchProbeState objects with the state attributes of the given BunchProbeState.

Parameters:

state - initializing state

Since:

Jun 26, 2014

BunchProbeState

public BunchProbeState(BunchProbe<S> probe)

Initializing constructor. Creates a new BunchProbe object initialized to the argument's state.

Parameters:

probe - probe object with which to initialize this state

Method Detail

setBunchFrequency

public void setBunchFrequency(double f)

Set the bunch arrival time frequency.

Parameters:

f - new bunch frequency in Hz

setBeamCurrent

public void setBeamCurrent(double I)

Set the total beam current

Parameters:

I - new beam current in Amperes

getBunchFrequency

public double getBunchFrequency()

Returns the bunch frequency, that is, the rate at which beam bunches pass a stationary point (in laboratory coordinates). The frequency f of the bunches determines the beam current I.

The bunch frequency f is related to the beam current I and bunch charge Q as

f = I/Q

Returns:

bunch frequency in Hertz

getBeamCurrent

public double getBeamCurrent()

Returns the total beam current, which is the bunch charge Q times the bunch frequency f.

Returns:

beam current in amps

bunchCharge

public double bunchCharge()

Computes and returns the charge in each beam bunch

Returns:

beam charge in coulombs

beamPerveance

public double beamPerveance()

Returns the generalized, three-dimensional beam perveance K. This value is defined to be

K = (Q/4*π*ε₀)(1/γ³β²)(|q|/E_R)

where Q is the bunch charge, ε₀ is the permittivity of free space, γ is the relativistic factor, β is the normalized design velocity, q is the individual particle charge and E_R is the rest energy of the beam particles.

NOTES:

- The value (1/4πε₀) is equal to 10^-7c² where c is the speed of light.

Returns:

generalized beam perveance Units: radians^2/meter

toString

public java.lang.String toString()

Write out state information to a string.

Overrides:

toString in class ProbeState<S extends BunchProbeState<S>>

Returns:

text version of internal state data

addPropertiesTo

protected void addPropertiesTo(DataAdaptor daSink)

Save the state values particular to BunchProbeState objects to the data sink.

Overrides:

addPropertiesTo in class ProbeState<S extends BunchProbeState<S>>

Parameters:

daSink - data sink represented by DataAdaptor interface

readPropertiesFrom

protected void readPropertiesFrom(DataAdaptor daSource)
                           throws ParsingException

Recover the state values particular to BunchProbeState objects from the data source.

Overrides:

readPropertiesFrom in class ProbeState<S extends BunchProbeState<S>>

Parameters:

daSource - data source represented by a IIDataAdaptor interface

Throws:

ParsingException - state information in data source is malformatted