xal.model.probe

Class SynchronousProbe

java.lang.Object

xal.model.probe.Probe<SynchronousState>

xal.model.probe.SynchronousProbe

All Implemented Interfaces:

IProbe, IArchive

public class SynchronousProbe
extends Probe<SynchronousState>

This class represents the behavior of the synchronous particle of a particle beam bunch. Thus, its use is intended for evaluation of machine designs and the variation of design trajectories with respect to machine parameters.

Field Summary

Fields inherited from class xal.model.probe.Probe

COMMENT_LABEL, PROBE_LABEL, stateCurrent, TEXT_LABEL, TIME_LABEL, trajHist, TYPE_LABEL

Fields inherited from interface xal.model.IProbe

LightSpeed, Permittivity, UnitCharge

Constructor Summary

Constructors

Constructor and Description
SynchronousProbe()
SynchronousProbe(SynchronousProbe probe)

Method Summary

Modifier and Type	Method and Description
SynchronousProbe	copy() Creates a deep copy of the probe
SynchronousState	createEmptyProbeState() Creates a new, empty SynchronousState.
SynchronousState	createProbeState() Return a new ProbeState object, of the appropriate type, initialized to the current state of this probe.
Trajectory<SynchronousState>	createTrajectory() Creates a Trajectory<SynchronousState> object of the proper type for saving the probe's history.
R3	getBetatronPhase() Return the set of betatron phase advances for any particle in the synchronous bucket.
double	getRfPhase() Return the phase of the synchronous particle with respect to any RF drive power.
protected SynchronousState	readStateFrom(DataAdaptor container) Read the contents of the supplied DataAdaptor and return an instance of the appropriate Trajectory species.
void	setBetatronPhase(R3 vecPhase) Set the betatron phase of the synchronous particle without space charge.
void	setRfPhase(double dblPhase) Set the phase location of the synchronous particle with respect to the drive RF power.

Methods inherited from class xal.model.probe.Probe

applyState, cloneCurrentProbeState, deepCopy, getAlgorithm, getArchive, getBeta, getComment, getCurrentElement, getCurrentHardwareId, getGamma, getKineticEnergy, getMomentum, getPosition, getSpeciesCharge, getSpeciesName, getSpeciesRestEnergy, getTime, getTimestamp, getTrajectory, initialize, initializeFrom, load, newProbeInitializedFrom, performPostProcessing, readFrom, reset, save, setAlgorithm, setComment, setCurrentElement, setCurrentHardwareId, setKineticEnergy, setPosition, setSpeciesCharge, setSpeciesName, setSpeciesRestEnergy, setTime, setTimestamp, setTracking, update

Methods inherited from class java.lang.Object

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

Constructor Detail

SynchronousProbe

public SynchronousProbe()

SynchronousProbe

public SynchronousProbe(SynchronousProbe probe)

Parameters:

probe -

Method Detail

copy

public SynchronousProbe copy()

Description copied from class: Probe

Creates a deep copy of the probe

Specified by:

copy in class Probe<SynchronousState>

setBetatronPhase

public void setBetatronPhase(R3 vecPhase)

Set the betatron phase of the synchronous particle without space charge. The betatron phase of all three planes is maintained as an R3 vector object. Thus, the betatron phase of each plane is set simultaneously.

Parameters:

vecPhase - vector (psix,psiy,psiz) of betatron phases in radians

setRfPhase

public void setRfPhase(double dblPhase)

Set the phase location of the synchronous particle with respect to the drive RF power.

Parameters:

dblPhase - synchronous particle phase w.r.t. RF in radians

getRfPhase

public double getRfPhase()

Return the phase of the synchronous particle with respect to any RF drive power.

Returns:

phase location of synchronous particle in radians

getBetatronPhase

public R3 getBetatronPhase()

Return the set of betatron phase advances for any particle in the synchronous bucket. The phase advances for all threes planes are returned. Space charge is not considered.

Returns:

vector (sigx,sigy,sigz) of phase advances without space charge

createTrajectory

public Trajectory<SynchronousState> createTrajectory()

Creates a Trajectory<SynchronousState> object of the proper type for saving the probe's history.

Specified by:

createTrajectory in class Probe<SynchronousState>

Returns:

a new, empty Trajectory<SynchronousState> for saving the probe's history

createProbeState

public SynchronousState createProbeState()

Return a new ProbeState object, of the appropriate type, initialized to the current state of this probe.

Specified by:

createProbeState in class Probe<SynchronousState>

Returns:

probe state object of type SynchronousState

See Also:

Probe.createProbeState()

createEmptyProbeState

public SynchronousState createEmptyProbeState()

Creates a new, empty SynchronousState.

Specified by:

createEmptyProbeState in class Probe<SynchronousState>

Returns:

a new, empty SynchronousState

Since:

Jul 1, 2014

readStateFrom

protected SynchronousState readStateFrom(DataAdaptor container)
                                  throws ParsingException

Description copied from class: Probe

Read the contents of the supplied DataAdaptor and return an instance of the appropriate Trajectory species.

Specified by:

readStateFrom in class Probe<SynchronousState>

Parameters:

container - DataAdaptor to read a Trajectory from

Returns:

a ProbeState for the contents of the DataAdaptor

Throws:

ParsingException - error encountered reading the DataAdaptor