pub struct EventDetector<F: IntegrateFloat> {
pub detected: Vec<DetectedEvent<F>>,
/* private fields */
}Expand description
Multi-event detector for ODE integration.
Manages a collection of event definitions, tracks state between steps, and locates events precisely using root-finding algorithms.
Fields§
§detected: Vec<DetectedEvent<F>>All detected events in chronological order
Implementations§
Source§impl<F: IntegrateFloat> EventDetector<F>
impl<F: IntegrateFloat> EventDetector<F>
Sourcepub fn add_event(self, event: EventDef<F>) -> Self
pub fn add_event(self, event: EventDef<F>) -> Self
Add an event definition. Returns self for chaining.
Sourcepub fn initialize(&mut self, t: F, y: &Array1<F>)
pub fn initialize(&mut self, t: F, y: &Array1<F>)
Initialize at t0, y0 (must be called before check_step).
Sourcepub fn check_step<I>(
&mut self,
t_old: F,
y_old: &Array1<F>,
t_new: F,
y_new: &Array1<F>,
interpolant: Option<&I>,
) -> IntegrateResult<bool>
pub fn check_step<I>( &mut self, t_old: F, y_old: &Array1<F>, t_new: F, y_new: &Array1<F>, interpolant: Option<&I>, ) -> IntegrateResult<bool>
Check for events between (t_old, y_old) and (t_new, y_new).
If an interpolant is provided, it is used for precise event location; otherwise linear interpolation between the endpoints is used.
Returns true if a terminal event was detected (integration should stop).
Sourcepub fn get_detected(&self) -> &[DetectedEvent<F>]
pub fn get_detected(&self) -> &[DetectedEvent<F>]
Get all detected events.
Sourcepub fn events_by_name(&self, name: &str) -> Vec<&DetectedEvent<F>>
pub fn events_by_name(&self, name: &str) -> Vec<&DetectedEvent<F>>
Get events by name.
Sourcepub fn first_terminal_event(&self) -> Option<&DetectedEvent<F>>
pub fn first_terminal_event(&self) -> Option<&DetectedEvent<F>>
Get the first terminal event (if any).
Trait Implementations§
Source§impl<F: IntegrateFloat> Default for EventDetector<F>
impl<F: IntegrateFloat> Default for EventDetector<F>
Auto Trait Implementations§
impl<F> Freeze for EventDetector<F>
impl<F> !RefUnwindSafe for EventDetector<F>
impl<F> Send for EventDetector<F>where
F: Send,
impl<F> Sync for EventDetector<F>where
F: Sync,
impl<F> Unpin for EventDetector<F>where
F: Unpin,
impl<F> UnsafeUnpin for EventDetector<F>
impl<F> !UnwindSafe for EventDetector<F>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more