|
JNISpice version 2.0.0 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectspice.basic.GFSearchUtils
public class GFSearchUtils
Class GFDefaultSearchUtils is the default GF search utility class that provides user-defined GF search step, convergence tolerance, refinement, progress reporting, and interrupt handling functions.
Normally SPICE users wishing to customize GF search functionality should subclass this class, overriding any methods for which custom functionality is sought. Note that certain subsets of methods of this class work cooperatively, so all methods of such a subset must be overridden if any one of them is overridden. For example, all of the progress reporting methods must be overridden together if custom progress reporting is desired.
Note that the calling application must set the
search step size via a call to setSearchStep(double)
prior to starting a GF search that uses these utilities.
Version 1.0.0 30-DEC-2009 (NJB)
Constructor Summary | |
---|---|
GFSearchUtils()
No-arguments constructor. |
Method Summary | |
---|---|
void |
clearInterruptStatus()
Clear interrupt status. |
void |
finalizeReport()
Finalize a GF progress report. |
double |
getRefinement(double t1,
double t2,
boolean s2,
boolean s1)
Get a refined root estimate. |
double |
getSearchStep(double et)
Return the search step size last set by setSearchStep(double) . |
double |
getTolerance()
Get the convergence tolerance. |
void |
initializeReport(SpiceWindow confine,
java.lang.String begmsg,
java.lang.String endmsg)
Initialize a GF progress report. |
boolean |
interruptOccurred()
Indicate whether an interrupt occurred. |
boolean |
isInterruptHandlingEnabled()
Determine whether interrupt handling is enabled. |
boolean |
isReportingEnabled()
Determine whether progress reporting is enabled. |
void |
setInterruptHandlingEnabled(boolean isEnabled)
Enable or disable interrupt handling. |
void |
setReportingEnabled(boolean isEnabled)
Enable or disable progress reporting. |
void |
setSearchStep(double step)
Set the search step size. |
void |
setTolerance(double tol)
Set the convergence tolerance. |
void |
updateReport(double ivbeg,
double ivend,
double t)
Update a GF progress report. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GFSearchUtils()
Method Detail |
---|
public void setSearchStep(double step) throws SpiceException
SpiceException
public double getSearchStep(double et) throws SpiceException
setSearchStep(double)
.
SpiceException
public double getRefinement(double t1, double t2, boolean s2, boolean s1) throws SpiceException
SpiceException
public void setReportingEnabled(boolean isEnabled)
public boolean isReportingEnabled()
public void setInterruptHandlingEnabled(boolean isEnabled)
public boolean isInterruptHandlingEnabled()
public boolean interruptOccurred() throws SpiceException
This is currently a no-op function which must be overridden by the user if GF interrupt detection is desired.
SpiceException
public void clearInterruptStatus() throws SpiceException
This is currently a no-op function which must be overridden by the user if GF interrupt detection is desired.
SpiceException
public void setTolerance(double tol)
public double getTolerance()
public void initializeReport(SpiceWindow confine, java.lang.String begmsg, java.lang.String endmsg) throws SpiceException
SpiceException
public void updateReport(double ivbeg, double ivend, double t) throws SpiceException
SpiceException
public void finalizeReport() throws SpiceException
SpiceException
|
JNISpice version 2.0.0 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |