pub struct OdeProblemBuilder { /* private fields */ }Expand description
Builder for an OdeProblem. Use OdeProblem::new for the common case
(default tolerances), or configure tolerances/step size here first.
Implementations§
Source§impl OdeProblemBuilder
impl OdeProblemBuilder
Sourcepub fn new<F>(rhs: F, y0: Vec<f64>, t0: f64) -> Self
pub fn new<F>(rhs: F, y0: Vec<f64>, t0: f64) -> Self
Start building a problem for dy/dt = rhs(t, y) with initial state
y0 at time t0. The right-hand side is given as a closure
Fn(f64, &[f64], &mut [f64]), which is the common case.
Sourcepub fn from_rhs<R: RhsCallable + 'static>(rhs: R, y0: Vec<f64>, t0: f64) -> Self
pub fn from_rhs<R: RhsCallable + 'static>(rhs: R, y0: Vec<f64>, t0: f64) -> Self
Start building a problem from any RhsCallable (e.g. a
JitRhs with the cranelift-jit feature, compiled by the Cranelift JIT). Use this instead of
OdeProblemBuilder::new when the RHS is not a plain closure.
Sourcepub fn rtol(self, rtol: f64) -> Self
pub fn rtol(self, rtol: f64) -> Self
Relative tolerance passed to the solver’s adaptive error control.
Sourcepub fn atol(self, atol: f64) -> Self
pub fn atol(self, atol: f64) -> Self
Absolute tolerance passed to the solver’s adaptive error control.
Sourcepub fn jacobian_pattern(self, pattern: JacobianPattern) -> Self
pub fn jacobian_pattern(self, pattern: JacobianPattern) -> Self
Declare the Jacobian’s sparsity pattern for the implicit sparse path.
With a pattern, sparse Newton solves (state size at least
SPARSE_LU_MIN_N (a private constant)) build the Jacobian
with one RHS call per color (see
CsrMatrix::jacobian_colored)
rather than one per state. The pattern must cover every structural
nonzero, or the Newton iteration uses an incomplete Jacobian.
Sourcepub fn h0(self, h0: f64) -> Self
pub fn h0(self, h0: f64) -> Self
Initial step size. If not set, the solver picks one from the interval length. The value is clamped to the solver’s step limits.
Sourcepub fn build(self) -> Result<OdeProblem, OdeError>
pub fn build(self) -> Result<OdeProblem, OdeError>
Finalise the builder into a ready-to-solve OdeProblem.
§Errors
Returns OdeError::Invalid if y0 is empty or if rtol/atol are
not strictly positive.
Auto Trait Implementations§
impl !RefUnwindSafe for OdeProblemBuilder
impl !Send for OdeProblemBuilder
impl !Sync for OdeProblemBuilder
impl !UnwindSafe for OdeProblemBuilder
impl Freeze for OdeProblemBuilder
impl Unpin for OdeProblemBuilder
impl UnsafeUnpin for OdeProblemBuilder
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> DistributionExt for Twhere
T: ?Sized,
impl<T> DistributionExt for Twhere
T: ?Sized,
impl<T, U> Imply<T> for U
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> ⓘ
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> ⓘ
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
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
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>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
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
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.