pub struct RootFinder<V: Vector> { /* private fields */ }Implementations§
Source§impl<V: Vector> RootFinder<V>
impl<V: Vector> RootFinder<V>
pub fn new(nroots: usize, nstates: usize, ctx: V::C) -> Self
Sourcepub fn init(&self, root_fn: &impl NonLinearOp<V = V, T = V::T>, y: &V, t: V::T)
pub fn init(&self, root_fn: &impl NonLinearOp<V = V, T = V::T>, y: &V, t: V::T)
Set the lower boundary of the root search. This function should be called first after Self::new
Sourcepub fn check_root(
&self,
interpolate_inplace: &impl Fn(V::T, &mut V) -> Result<(), DiffsolError>,
root_fn: &impl NonLinearOp<V = V, T = V::T>,
y: &V,
t: V::T,
) -> Option<V::T>
pub fn check_root( &self, interpolate_inplace: &impl Fn(V::T, &mut V) -> Result<(), DiffsolError>, root_fn: &impl NonLinearOp<V = V, T = V::T>, y: &V, t: V::T, ) -> Option<V::T>
Set the upper boundary of the root search and checks for a zero crossing. If a zero crossing is found, the index of the crossing is returned
This function assumes that g0 and t0 have already beeen set via Self::init or previous iterations of Self::check_root
We find the root of a function using the method proposed by Sundials docs
Trait Implementations§
Auto Trait Implementations§
impl<V> !Freeze for RootFinder<V>
impl<V> !RefUnwindSafe for RootFinder<V>
impl<V> Send for RootFinder<V>where
V: Send,
impl<V> !Sync for RootFinder<V>
impl<V> Unpin for RootFinder<V>
impl<V> UnwindSafe for RootFinder<V>
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> DistributionExt for Twhere
T: ?Sized,
impl<T> DistributionExt for Twhere
T: ?Sized,
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.