DenseSolout

Struct DenseSolout 

Source
pub struct DenseSolout { /* private fields */ }
Expand description

An output handler that provides a dense set of interpolated points between solver steps.

§Overview

DenseSolout enhances the solution output by interpolating additional points between the naturally computed solver steps. This creates a smoother, more detailed trajectory that can better represent the continuous solution, especially when the solver takes large steps.

§Example

use differential_equations::prelude::*;
use differential_equations::solout::DenseSolout;
use nalgebra::{Vector2, vector};

// Simple harmonic oscillator
struct HarmonicOscillator;

impl ODE<f64, Vector2<f64>> for HarmonicOscillator {
    fn diff(&self, _t: f64, y: &Vector2<f64>, dydt: &mut Vector2<f64>) {
        // y[0] = position, y[1] = velocity
        dydt[0] = y[1];
        dydt[1] = -y[0];
    }
}

// Create the system and solver
let system = HarmonicOscillator;
let t0 = 0.0;
let tf = 10.0;
let y0 = vector![1.0, 0.0];
let mut solver = ExplicitRungeKutta::dop853().rtol(1e-6).atol(1e-8);

// Generate 9 additional points between each solver step (10 total per interval)
let mut dense_output = DenseSolout::new(10);

// Solve with dense output
let problem = ODEProblem::new(system, t0, tf, y0);
let solution = problem.solout(&mut dense_output).solve(&mut solver).unwrap();

// Note: This is equivalent to using the convenience method:
let solution = problem.dense(10).solve(&mut solver).unwrap();

§Output Characteristics

The output will contain both the original solver steps and additional interpolated points between them. The interpolated points are evenly spaced within each step.

For example, with n=5:

  • Original solver steps: t₀, t₁, t₂, …
  • Dense output: t₀, t₀+h/5, t₀+2h/5, t₀+3h/5, t₀+4h/5, t₁, t₁+h/5, …

§Performance Considerations

Increasing the number of interpolation points increases computational cost and memory usage. Choose a value that balances the need for smooth output with performance requirements.

Implementations§

Source§

impl DenseSolout

Source

pub fn new(n: usize) -> Self

Creates a new DenseSolout instance with the specified number of points per interval.

§Arguments
  • n - Number of points per interval, including endpoints. For example, n=5 will add 4 interpolated points between each solver step, plus the solver step itself.
§Returns
  • A new DenseSolout instance

Trait Implementations§

Source§

impl<T, Y> Solout<T, Y> for DenseSolout
where T: Real, Y: State<T>,

Source§

fn solout<I>( &mut self, t_curr: T, t_prev: T, y_curr: &Y, _y_prev: &Y, interpolator: &mut I, solution: &mut Solution<T, Y>, ) -> ControlFlag<T, Y>
where I: Interpolation<T, Y>,

Solout function to choose which points to output during the solving process. Read more

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