EnvTrackerAdapt
@Deprecated public abstract class TrackerAdaptive extends Tracker
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTRTAG_ERRTOL
Deprecated.
attribute label for error tolerance
|
static java.lang.String |
ATTRTAG_INITSTEP
Deprecated.
attribute label for initial step size
|
static java.lang.String |
ATTRTAG_MAXITER
Deprecated.
attribute label for maximum iteration count
|
static java.lang.String |
ATTRTAG_MAXSTEP
Deprecated.
attribute label for maximum step size
|
static java.lang.String |
ATTRTAG_MAXSTEP_DRIFTPMQ
Deprecated.
attribute label for maximum step size for drift space with pmq , sako 21 jul 06
|
static java.lang.String |
ATTRTAG_NORM
Deprecated.
attribute label for residual norm
|
static java.lang.String |
ATTRTAG_ORDER
Deprecated.
attribute label for order of accuracy in algorithm
|
static java.lang.String |
ATTRTAG_SLACK
Deprecated.
attribute label for slack tolerance
|
protected double |
m_dblErrTol
Deprecated.
Residual error tolerance parameter.
|
protected double |
m_dblMaxStep
Deprecated.
Maximum distance we may travel before requiring another space charge kick.
|
protected double |
m_dblMaxStepDriftPmq
Deprecated.
m_dbleMaxStep for drift field from PMQ
|
protected double |
m_dblSlack
Deprecated.
Step size adjustment slack tolerance.
|
protected double |
m_dblStepSize
Deprecated.
The current step size.
|
protected int |
m_enmNorm
Deprecated.
The type of Lebesque norm used in the residual calculations.
|
static java.lang.String |
NODETAG_ADAPT
Deprecated.
data node label for EnvTrackerAdapt settings
|
ATTRTAG_DEBUG, ATTRTAG_RFGAP_PHASE, ATTRTAG_TYPE, ATTRTAG_UPDATE, ATTRTAG_VER, NODETAG_ALG, NODETAG_TRACKER, TBL_PRIM_KEY_NAME, UPDATE_ALWAYS, UPDATE_CUSTOM, UPDATE_ENTRANCE, UPDATE_ENTRANCEANDEXIT, UPDATE_EXIT
Modifier | Constructor and Description |
---|---|
protected |
TrackerAdaptive(java.lang.String strType,
int intVersion,
java.lang.Class<? extends IProbe> clsProbeType)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
abstract int |
getAccuracyOrder()
Deprecated.
Get the current accuracy order of the space charge stepping
algorithm.
|
double |
getErrorTolerance()
Deprecated.
Return the acceptable tolerance in the residual error between
a full step and two half steps.
|
double |
getInitStepSize()
Deprecated.
Returns the integration step size used at the initialization of the
algorithm.
|
int |
getMatrixNorm()
Deprecated.
Get the type of Lebesque norm used for matrices.
|
abstract int |
getMaxIterations()
Deprecated.
Return the maximum allowable number of steps to progate a probe through
an element.
|
double |
getMaxStepSize()
Deprecated.
Return the maximum allowable step size.
|
double |
getMaxStepSizeDriftPmq()
Deprecated.
Return the maximum allowable step size.
|
double |
getSlackTolerance()
Deprecated.
Step size adjustment slack tolerance.
|
double |
getStepSize()
Deprecated.
Return the current step size.
|
void |
initialize()
Deprecated.
Resets the state of the algorithm object.
|
void |
initializeFromEditContext(java.lang.String locationID,
AcceleratorSeq sequence)
Deprecated.
Load the sequence's model parameters for the adaptive tracker from the edit context.
|
abstract void |
setAccuracyOrder(int intOrder)
Deprecated.
Set the integration accuracy order for the underlying
stepping algorithm.
|
void |
setErrorTolerance(double dblErr)
Deprecated.
Set the acceptable error in the residual correlation matrix.
|
void |
setInitStepSize(double stepSize)
Deprecated.
Sets the integration step size to be used at the beginning of
the algorithm or after
is
called. |
void |
setMatrixNorm(int enmNorm)
Deprecated.
Set the type of Lebesque norm used in the matrix calculations.
|
abstract void |
setMaxIterations(int intMaxIter)
Deprecated.
Sets the maximum allowable number of steps to progate a probe through
an element.
|
void |
setMaxStepSize(double dblMaxStep)
Deprecated.
Set the maximum allowable step size.
|
void |
setMaxStepSizeDriftPmq(double dblMaxStepDriftPmq)
Deprecated.
Set the maximum allowable step size.
|
void |
setSlackTolerance(double dblSlack)
Deprecated.
Set the slack size in the adaptive step size determination.
|
void |
setStepSize(double dblStepSize)
Deprecated.
Set the initial step size for applying space charge
corrections.
|
abstract boolean |
supportsConditionalTermination()
Deprecated.
Determine whether this algorithm supports the optional accuracy odrer and maximum iteration methods.
|
advanceProbe, doPropagation, getDebugMode, getElemPosition, getProbeType, getProbeUpdatePolicy, getStartElementId, getStopElementId, getType, getVersion, isStopElementIncluded, load, load, newFromEditContext, newFromEditContext, newInstance, propagate, registerProbeType, retractProbe, save, setDebugMode, setElemPosition, setIncludeStopElement, setProbeUpdatePolicy, setRfGapPhaseCalculation, setStartElementId, setStopElementId, unsetStartElementId, unsetStopElementId, useRfGapPhaseCalculation, validElement, validProbe
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
copy
public static final java.lang.String NODETAG_ADAPT
public static final java.lang.String ATTRTAG_ORDER
public static final java.lang.String ATTRTAG_MAXSTEP
public static final java.lang.String ATTRTAG_MAXSTEP_DRIFTPMQ
public static final java.lang.String ATTRTAG_INITSTEP
public static final java.lang.String ATTRTAG_ERRTOL
public static final java.lang.String ATTRTAG_SLACK
public static final java.lang.String ATTRTAG_NORM
public static final java.lang.String ATTRTAG_MAXITER
protected double m_dblMaxStep
protected double m_dblMaxStepDriftPmq
protected double m_dblStepSize
protected double m_dblErrTol
protected double m_dblSlack
protected int m_enmNorm
protected TrackerAdaptive(java.lang.String strType, int intVersion, java.lang.Class<? extends IProbe> clsProbeType)
strType
- intVersion
- clsProbeType
- public void initializeFromEditContext(java.lang.String locationID, AcceleratorSeq sequence)
locationID
- The location ID of the entrance parameters to usesequence
- The sequence for which to get the adaptive tracker parameters.public abstract boolean supportsConditionalTermination()
public abstract void setAccuracyOrder(int intOrder)
intOrder
- integration orderpublic void setMaxStepSize(double dblMaxStep)
dblMaxStep
- maximum allowable step size in meterspublic void setInitStepSize(double stepSize)
initialize()
is
called.stepSize
- step size to be used after algorithm initializationpublic void setMaxStepSizeDriftPmq(double dblMaxStepDriftPmq)
dblMaxStepDriftPmq
- maximum allowable step size in meterspublic abstract void setMaxIterations(int intMaxIter)
intMaxIter
- maximum allowable single-element step countpublic void setErrorTolerance(double dblErr)
dblErr
- acceptable residual errorpublic void setSlackTolerance(double dblSlack)
dblSlack
- size of the slack region in meterspublic void setStepSize(double dblStepSize)
dblStepSize
- initial step size in public void setMatrixNorm(int enmNorm)
enmNorm
- enumeration constant of family EnvTrackerAdapt.NORM_*
public abstract int getAccuracyOrder()
setAccuracyOrder(int)
public double getStepSize()
public double getMaxStepSize()
public double getMaxStepSizeDriftPmq()
public abstract int getMaxIterations()
public double getErrorTolerance()
public double getSlackTolerance()
public int getMatrixNorm()
public double getInitStepSize()
initialize()
public void initialize()
initialize
in interface IAlgorithm
initialize
in class Tracker
Tracker.initialize()