Numerical Tools  1.0
Numerical tools from SciPy and Numerical Methods in Physics with Python
Public Attributes | List of all members
NumericalTools.Ivp.Event Struct Reference

Structure to define an Event for the DE solver. More...

Public Attributes

bool terminal
 
double direction
 
EventFunction function
 
RTEventCallback rtCallback
 

Detailed Description

Structure to define an Event for the DE solver.

An event is triggered when the provided event function returns zero and the direction is satisfied.

Direction is set to (-1, 0, 1) for a negative, don-care, positive transition of the event value thru zero.

If terminal is set, the triggering of the event will result in an exit from SolveIvp. In the realtime use case, the integrator will terminate the EvolveTo and return status=1

The documentation for this struct was generated from the following file: