Skip to main content

EventDetector

Struct EventDetector 

Source
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>

Source

pub fn new() -> Self

Create an empty event detector.

Source

pub fn add_event(self, event: EventDef<F>) -> Self

Add an event definition. Returns self for chaining.

Source

pub fn n_events(&self) -> usize

Number of registered events.

Source

pub fn initialize(&mut self, t: F, y: &Array1<F>)

Initialize at t0, y0 (must be called before check_step).

Source

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>
where I: Fn(F) -> Array1<F>,

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).

Source

pub fn get_detected(&self) -> &[DetectedEvent<F>]

Get all detected events.

Source

pub fn events_by_name(&self, name: &str) -> Vec<&DetectedEvent<F>>

Get events by name.

Source

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>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V