Struct ODEOptions

Source

pub struct ODEOptions<F: IntegrateFloat> {Show 15 fields
    pub method: ODEMethod,
    pub rtol: F,
    pub atol: F,
    pub h0: Option<F>,
    pub max_steps: usize,
    pub max_step: Option<F>,
    pub min_step: Option<F>,
    pub dense_output: bool,
    pub max_order: Option<usize>,
    pub jac: Option<Array1<F>>,
    pub use_banded_jacobian: bool,
    pub ml: Option<usize>,
    pub mu: Option<usize>,
    pub mass_matrix: Option<MassMatrix<F>>,
    pub jacobian_strategy: Option<JacobianStrategy>,
}

Expand description

Options for controlling the behavior of ODE solvers

Fields§

§method: ODEMethod

The ODE solver method to use

§rtol: F

Relative tolerance for error control

§atol: F

Absolute tolerance for error control

§h0: Option<F>

Initial step size (optional, if not provided, it will be estimated)

§max_steps: usize

Maximum number of steps to take

§max_step: Option<F>

Maximum step size (optional)

§min_step: Option<F>

Minimum step size (optional)

§dense_output: bool

Dense output flag - whether to enable dense output

§max_order: Option<usize>

Maximum order for BDF method (1-5)

§jac: Option<Array1<F>>

Jacobian matrix (optional, for implicit methods)

§use_banded_jacobian: bool

Whether to use a banded Jacobian matrix

§ml: Option<usize>

Number of lower diagonals for banded Jacobian

§mu: Option<usize>

Number of upper diagonals for banded Jacobian

§mass_matrix: Option<MassMatrix<F>>

Mass matrix for M(t,y)·y’ = f(t,y) form (optional)

§jacobian_strategy: Option<JacobianStrategy>

Strategy for Jacobian approximation/computation

Trait Implementations§

Source §

impl<F: Clone + IntegrateFloat> Clone for ODEOptions<F>

Source §

fn clone(&self) -> ODEOptions<F>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<F: Debug + IntegrateFloat> Debug for ODEOptions<F>

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<F: IntegrateFloat> Default for ODEOptions<F>

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<F> !UnwindSafe for ODEOptions<F>

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> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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 §