Skip to main content

OdeProblemBuilder

Struct OdeProblemBuilder 

Source
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

Source

pub fn new<F>(rhs: F, y0: Vec<f64>, t0: f64) -> Self
where F: Fn(f64, &[f64], &mut [f64]) + 'static,

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.

Source

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.

Source

pub fn rtol(self, rtol: f64) -> Self

Relative tolerance passed to the solver’s adaptive error control.

Source

pub fn atol(self, atol: f64) -> Self

Absolute tolerance passed to the solver’s adaptive error control.

Source

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.

Source

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.

Source

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§

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

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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