Skip to main content

EventDetection

oxiphysics_core::numerical_ode

Struct EventDetection 

Source 
pub struct EventDetection {
    pub tol: f64,
    pub max_iter: usize,
}
Expand description

Zero-crossing event detection via bisection root-finding.

After each ODE step, each registered event function g_i(t, y) is evaluated. If the sign of g_i changes, bisection is used to locate the crossing time to within tol.

Fields§

§tol: f64

Bisection tolerance for the event time.

§max_iter: usize

Maximum bisection iterations.

Implementations§

Source§

impl EventDetection

Source

pub fn new(tol: f64, max_iter: usize) -> Self

Construct with specified tolerance and iteration limit.

Source

pub fn default_params() -> Self

Construct with default parameters.

Source

pub fn detect<E>( &self, s_a: &OdeState, s_b: &OdeState, events: &[E], ) -> Vec<CrossingEvent>
where E: Fn(f64, &[f64]) -> f64,

Detect zero crossings of events[i](t, y) between states s_a and s_b.

Returns a list of CrossingEvent sorted by time. Uses linear interpolation of the state and bisection on each event function.

Auto Trait Implementations§

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.