public class TransferMapProbe extends Probe<TransferMapState>
Probe that tracks all the transfer maps between modeling elements. Note there is no beam dynamics per se, the probe simply collects all the transfer maps as provided by the beamline elements for the design synchronous particle.
If you wish to compute the transfer matrices for an envelope model that includes
space charge effects, then you should employ and
and call the method EnvelopeProbe
.
EnvelopeProbeState.getResponseMatrix()
COMMENT_LABEL, PROBE_LABEL, stateCurrent, TEXT_LABEL, TIME_LABEL, trajHist, TYPE_LABEL
LightSpeed, Permittivity, UnitCharge
Constructor and Description |
---|
TransferMapProbe()
Default constructor.
|
TransferMapProbe(TransferMapProbe probe)
Initializing constructor.
|
Modifier and Type | Method and Description |
---|---|
TransferMapProbe |
copy()
Creates a deep copy of the probe
|
TransferMapState |
createEmptyProbeState()
Creates a new, empty
TransferMapState . |
TransferMapState |
createProbeState()
Return a new
ProbeState object, of the appropriate type,
initialized to the current state of this probe. |
Trajectory<TransferMapState> |
createTrajectory()
Creates a
Trajectory<TransferMapState> object of the
proper type for saving the probe's history. |
PhaseMap |
getPartialTransferMap()
Get the partial transfer map for the current probe location.
|
PhaseMap |
getTransferMap()
Get the composite transfer map for the current probe location.
|
protected void |
initializeFrom(Probe<TransferMapState> probe)
Deprecated.
Never Used
|
protected TransferMapState |
readStateFrom(DataAdaptor container)
Read the contents of the supplied
DataAdaptor and return
an instance of the appropriate Trajectory species. |
void |
setPartialTransferMap(PhaseMap mapPhi)
Set the partial transfer map at the current probe
location.
|
void |
setTransferMap(PhaseMap mapTrans)
Set the current composite transfer map up to the current probe
location.
|
applyState, cloneCurrentProbeState, deepCopy, getAlgorithm, getArchive, getBeta, getComment, getCurrentElement, getCurrentHardwareId, getGamma, getKineticEnergy, getMomentum, getPosition, getSpeciesCharge, getSpeciesName, getSpeciesRestEnergy, getTime, getTimestamp, getTrajectory, initialize, load, newProbeInitializedFrom, performPostProcessing, readFrom, reset, save, setAlgorithm, setComment, setCurrentElement, setCurrentHardwareId, setKineticEnergy, setPosition, setSpeciesCharge, setSpeciesName, setSpeciesRestEnergy, setTime, setTimestamp, setTracking, update
public TransferMapProbe()
TransferMapProbe
with
zero initial state.public TransferMapProbe(TransferMapProbe probe)
TransferMapProbe
and
initialize its state to that of the given probe.probe
- probe containing initial state informationpublic TransferMapProbe copy()
Probe
copy
in class Probe<TransferMapState>
public void setTransferMap(PhaseMap mapTrans)
mapTrans
- transfer map in homogeneous phase coordinatesProbe.createTrajectory()
public void setPartialTransferMap(PhaseMap mapPhi)
mapPhi
- transfer map in homogeneous phase coordinatesProbe.createTrajectory()
public PhaseMap getTransferMap()
public PhaseMap getPartialTransferMap()
public Trajectory<TransferMapState> createTrajectory()
Trajectory<TransferMapState>
object of the
proper type for saving the probe's history.createTrajectory
in class Probe<TransferMapState>
Trajectory<TransferMapState>
for saving the probe's historypublic TransferMapState createProbeState()
ProbeState
object, of the appropriate type,
initialized to the current state of this probe.createProbeState
in class Probe<TransferMapState>
TransferMapState
Probe.createProbeState()
public TransferMapState createEmptyProbeState()
TransferMapState
.createEmptyProbeState
in class Probe<TransferMapState>
TransferMapState
@Deprecated protected void initializeFrom(Probe<TransferMapState> probe)
initializeFrom
in class Probe<TransferMapState>
probe
- the probe from which to initialize this oneprotected TransferMapState readStateFrom(DataAdaptor container) throws ParsingException
Probe
DataAdaptor
and return
an instance of the appropriate Trajectory species.readStateFrom
in class Probe<TransferMapState>
container
- DataAdaptor
to read a Trajectory fromParsingException
- error encountered reading the DataAdaptor