Struct EventDef 

pub struct EventDef<F: IntegrateFloat> {
    pub name: String,
    pub direction: CrossingDirection,
    pub response: EventResponse,
    pub root_method: RootFindingMethod,
    pub tolerance: F,
    pub max_root_iter: usize,
    pub max_count: Option<usize>,
    /* private fields */
}

Configuration for a single event.

Fields

name: String

Unique name for this event

direction: CrossingDirection

Direction of zero-crossing to detect

response: EventResponse

Action when event is detected

root_method: RootFindingMethod

Root-finding method for precise location

tolerance: F

Tolerance for root finding

max_root_iter: usize

Maximum iterations for root finding

max_count: Option<usize>

Maximum number of times this event can fire (None = unlimited)

Implementations

impl<F: IntegrateFloat> EventDef<F>

pub fn new<G>(name: &str, event_fn: G) -> Self

where G: Fn(F, &Array1<F>) -> F + Send + Sync + 'static,

Create a new event definition with a name and event function.

pub fn with_direction(self, dir: CrossingDirection) -> Self

Set the crossing direction.

pub fn with_response(self, resp: EventResponse) -> Self

Set the event response.

pub fn with_root_method(self, method: RootFindingMethod) -> Self

Set the root-finding method.

pub fn with_max_count(self, count: usize) -> Self

Set maximum fire count.

pub fn with_tolerance(self, tol: F) -> Self

Set root-finding tolerance.

pub fn evaluate(&self, t: F, y: &Array1<F>) -> F

Evaluate the event function.