EventHandler

Struct EventHandler 

Source
pub struct EventHandler<F: IntegrateFloat> {
    pub specs: Vec<EventSpec<F>>,
    pub record: EventRecord<F>,
    /* private fields */
}
Expand description

Event detection and handling during ODE integration

Fields§

§specs: Vec<EventSpec<F>>

List of event specifications to detect

§record: EventRecord<F>

Record of detected events

Implementations§

Source§

impl<F: IntegrateFloat> EventHandler<F>

Source

pub fn new(specs: Vec<EventSpec<F>>) -> Self

Create a new event handler with the given event specifications

Source

pub fn initialize<Func>( &mut self, t: F, y: &Array1<F>, event_funcs: &[Func], ) -> IntegrateResult<()>
where Func: Fn(F, ArrayView1<'_, F>) -> F,

Initialize the event handler with the initial state

Source

pub fn check_events<Func>( &mut self, t: F, y: &Array1<F>, dense_output: Option<&DenseSolution<F>>, event_funcs: &[Func], ) -> IntegrateResult<EventAction>
where Func: Fn(F, ArrayView1<'_, F>) -> F,

Check for events between the last state and the current state

Source

pub fn get_record(&self) -> &EventRecord<F>

Get the record of all detected events

Source

pub fn should_stop(&self) -> bool

Check if an event occurred that requires stopping the integration

Trait Implementations§

Source§

impl<F: Debug + IntegrateFloat> Debug for EventHandler<F>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<F> Freeze for EventHandler<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for EventHandler<F>
where F: RefUnwindSafe,

§

impl<F> Send for EventHandler<F>
where F: Send,

§

impl<F> Sync for EventHandler<F>
where F: Sync,

§

impl<F> Unpin for EventHandler<F>
where F: Unpin,

§

impl<F> UnwindSafe for EventHandler<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