Enum peroxide::numerical::ode::ODEError

pub enum ODEError {
    ConstraintViolation(f64, Vec<f64>, Vec<f64>),
    ReachedMaxStepIter,
}

Enum for ODE errors.

Variants

• ReachedMaxStepIter: Reached maximum number of steps per step. (internal error for integrator)
• ConstraintViolation: Constraint violation. (user-defined error)

If you define constraints in your problem, you can use this error to report constraint violations.

Example

use peroxide::fuga::*;

struct ConstrainedProblem {
    y_constraint: f64
}

impl ODEProblem for ConstrainedProblem {
    fn initial_conditions(&self) -> Vec<f64> { vec![0.0] } // y_0 = 0
    fn rhs(&self, t: f64, y: &[f64], dy: &mut [f64]) -> anyhow::Result<()> {
        if y[0] < self.y_constraint {
            anyhow::bail!(ODEError::ConstraintViolation(t, y.to_vec(), dy.to_vec()));
        } else {
            // some function
            Ok(())
        }
    }
}

Variants

ConstraintViolation(f64, Vec<f64>, Vec<f64>)

ReachedMaxStepIter

Trait Implementations

impl Clone for ODEError

fn clone(&self) -> ODEError

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ODEError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ODEError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.