

PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 
public interface StateEvent
StateEvent defines an event consisting in that a given numeric value
changes sign from positive to negative. This numeric value usually
consists in an expression of the variables of an ODE.
Every valid model state must (in principle) provide a value f(t)>=+tolerance
at every instant of time, where tolerance is a (small positive) number
prescribed by the user.
However, values in the range (tolerance,+tolerance) are still accepted.
The event really happens when the value at the next instant of time
satisfies f(t+dt)<=tolerance.
Then, finding the moment when the event takes place corresponds to finding
a root of f(t). More precisely, and because of numerical approximation,
a root is considered to be found when tolerance
Method Summary  

boolean 
action()
What to do when the event has taken place. 
double 
evaluate(double[] state)
Returns the value f(t) for a given state of the model. 
double 
getTolerance()
Returns the tolerance for the event. 
Method Detail 

double getTolerance()
double evaluate(double[] state)
evaluate
in interface MultiVarFunction
state
 The current state of the ODE
boolean action()


PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 