Skip to main content

OdeProblem

Struct OdeProblem 

Source
pub struct OdeProblem<S: Scalar, F>
where F: Fn(S, &[S], &mut [S]),
{ pub f: F, pub t0: S, pub tf: S, pub y0: Vec<S>, }
Expand description

ODE initial value problem.

Represents: dy/dt = f(t, y), y(t0) = y0, solve from t0 to tf

Fields§

§f: F

Right-hand side function

§t0: S

Initial time

§tf: S

Final time

§y0: Vec<S>

Initial state

Implementations§

Source§

impl<S: Scalar, F> OdeProblem<S, F>
where F: Fn(S, &[S], &mut [S]),

Source

pub fn new(f: F, t0: S, tf: S, y0: Vec<S>) -> Self

Create a new ODE problem.

Examples found in repository?
examples/radau5_step_audit.rs (line 14)
10fn run<F>(name: &str, rhs: F, t0: f64, tf: f64, y0: Vec<f64>, rtol: f64, atol: f64)
11where
12    F: Fn(f64, &[f64], &mut [f64]) + Copy,
13{
14    let problem = OdeProblem::new(rhs, t0, tf, y0.clone());
15    let opts = SolverOptions::default().rtol(rtol).atol(atol);
16    let res = Radau5::solve(&problem, t0, tf, &y0, &opts).expect("solve failed");
17    println!(
18        "{:<32} acc={:>4}  rej={:>3}  rhs={:>5}  jac={:>3}  lu={:>4}",
19        name,
20        res.stats.n_accept,
21        res.stats.n_reject,
22        res.stats.n_eval,
23        res.stats.n_jac,
24        res.stats.n_lu,
25    );
26}
Source

pub fn dim(&self) -> usize

Dimension of the system.

Source

pub fn tspan(&self) -> (S, S)

Time span.

Source

pub fn direction(&self) -> S

Integration direction: 1 for forward, -1 for backward.

Trait Implementations§

Source§

impl<S: Scalar, F> OdeSystem<S> for OdeProblem<S, F>
where F: Fn(S, &[S], &mut [S]),

Source§

fn dim(&self) -> usize

Dimension of the system.
Source§

fn rhs(&self, t: S, y: &[S], dydt: &mut [S])

Compute the right-hand side: dydt = f(t, y)
Source§

fn jacobian(&self, t: S, y: &[S], jac: &mut [S])

Optionally compute the Jacobian: J = ∂f/∂y, row-major (jac[i*n + j] = ∂f_i/∂y_j, length ). Read more
Source§

fn is_autonomous(&self) -> bool

Is the system autonomous? (f does not depend on t explicitly)
Source§

fn has_mass_matrix(&self) -> bool

Does this system have a mass matrix?
Source§

fn mass_matrix(&self, mass: &mut [S])

Get the mass matrix M for the DAE: M * y’ = f(t, y) Read more
Source§

fn is_singular_mass(&self) -> bool

Is the mass matrix singular? (i.e., is this a DAE?)
Source§

fn algebraic_indices(&self) -> Vec<usize>

Return indices of algebraic variables (where M[i,i] = 0). Read more

Auto Trait Implementations§

§

impl<S, F> Freeze for OdeProblem<S, F>
where F: Freeze, S: Freeze,

§

impl<S, F> RefUnwindSafe for OdeProblem<S, F>

§

impl<S, F> Send for OdeProblem<S, F>
where F: Send,

§

impl<S, F> Sync for OdeProblem<S, F>
where F: Sync,

§

impl<S, F> Unpin for OdeProblem<S, F>
where F: Unpin, S: Unpin,

§

impl<S, F> UnsafeUnpin for OdeProblem<S, F>
where F: UnsafeUnpin, S: UnsafeUnpin,

§

impl<S, F> UnwindSafe for OdeProblem<S, F>
where F: UnwindSafe, S: UnwindSafe,

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