public class ParticleProbe extends Probe<ParticleProbeState>
COMMENT_LABEL, PROBE_LABEL, stateCurrent, TEXT_LABEL, TIME_LABEL, trajHist, TYPE_LABEL
LightSpeed, Permittivity, UnitCharge
Constructor and Description |
---|
ParticleProbe()
Default constructor for ParticleProbe.
|
ParticleProbe(ParticleProbe probe)
Copy constructor for ParticleProbe.
|
Modifier and Type | Method and Description |
---|---|
ParticleProbe |
copy()
Creates a clone of this
ParticleProbe object and returns it. |
ParticleProbeState |
createEmptyProbeState()
Creates a new, empty
ParticleProbeState . |
ParticleProbeState |
createProbeState()
Captures the probe's state and return it as a new
ProbeState
object. |
Trajectory<ParticleProbeState> |
createTrajectory()
Creates a
Trajectory<ParticleProbeState> object of the
proper type for saving the probe's history. |
PhaseVector |
getFixedOrbit()
Deprecated.
This is a duplicate of
getPhaseCoordinates() but with a
misleading name. I plan to get rid of it. |
PhaseVector |
getPhaseCoordinates()
Returns homogeneous phase space coordinates of the particle.
|
PhaseMatrix |
getResponseMatrix()
Returns the response matrix Φ for the particle at the given
state location z.
|
protected ParticleProbeState |
readStateFrom(DataAdaptor container)
Read the contents of the supplied
DataAdaptor and return
an instance of the appropriate Trajectory species. |
void |
setPhaseCoordinates(PhaseVector vecPhase)
Set the phase space coordinates of the probe.
|
void |
setResponseMatrix(PhaseMatrix matResp)
Set the response matrix Φ for the particle at the given
state location z.
|
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
public ParticleProbe()
public ParticleProbe(ParticleProbe probe)
probe
- ParticleProbe object to be clonedpublic ParticleProbe copy()
ParticleProbe
object and returns it.
This method is essentially a proxy to the constructor ParticleProbe(ParticleProbe)
.copy
in class Probe<ParticleProbeState>
Probe.copy()
public void setPhaseCoordinates(PhaseVector vecPhase)
vecPhase
- new homogeneous phase space coordinate vector
z = (x, x', y, y', z, z', 1)Tpublic void setResponseMatrix(PhaseMatrix matResp)
Set the response matrix Φ for the particle at the given
state location z. The response matrix represents the sensitivity of
the current phase coordinate position z to the initial phase coordinate
location z0 at the start of the simulation. That is,
Φ ≡ ∂z/∂z0
so that small changes Δz0 in the initial phase position
yield a corresponding change Δz = ΦΔz0
in the current particle location.
matResp
- the response matrix Φ ≡
∂z/∂z0the matResp to setpublic PhaseVector getPhaseCoordinates()
public PhaseMatrix getResponseMatrix()
Returns the response matrix Φ for the particle at the given
state location z. The response matrix represents the sensitivity of
the current phase coordinate position z to the initial phase coordinate
location z0 at the start of the simulation. That is,
Φ ≡ ∂z/∂z0
so that small changes Δz0 in the initial phase position
yield a corresponding change Δz = ΦΔz0
in the current particle location.
@Deprecated public PhaseVector getFixedOrbit()
getPhaseCoordinates()
but with a
misleading name. I plan to get rid of it.public Trajectory<ParticleProbeState> createTrajectory()
Trajectory<ParticleProbeState>
object of the
proper type for saving the probe's history.createTrajectory
in class Probe<ParticleProbeState>
Trajectory<ParticleProbeState>
for saving the probe's historypublic ParticleProbeState createProbeState()
ProbeState
object.createProbeState
in class Probe<ParticleProbeState>
ParticleProbeState
object initialized to current stateProbe.createProbeState()
public ParticleProbeState createEmptyProbeState()
ParticleProbeState
.createEmptyProbeState
in class Probe<ParticleProbeState>
ParticleProbeState
protected ParticleProbeState readStateFrom(DataAdaptor container) throws ParsingException
Probe
DataAdaptor
and return
an instance of the appropriate Trajectory species.readStateFrom
in class Probe<ParticleProbeState>
container
- DataAdaptor
to read a Trajectory fromParsingException
- error encountered reading the DataAdaptor