Skip to main content

OdeOptions

Struct OdeOptions 

Source
pub struct OdeOptions<T: Float> {
    pub atol: T,
    pub rtol: T,
    pub first_step: Option<T>,
    pub max_steps: usize,
    pub event_fn: Option<EventFn<T>>,
}
Expand description

Options for ODE solvers.

§Examples

let opts = OdeOptions::<f64>::default();
assert_eq!(opts.max_steps, 10_000);

Fields§

§atol: T

Absolute tolerance for adaptive methods.

§rtol: T

Relative tolerance for adaptive methods.

§first_step: Option<T>

Initial step size. If None, a reasonable default is chosen.

§max_steps: usize

Maximum number of steps before giving up.

§event_fn: Option<EventFn<T>>

Optional event function. Integration terminates when the return value crosses zero.

Trait Implementations§

Source§

impl<T: Float> Default for OdeOptions<T>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<T> Freeze for OdeOptions<T>
where T: Freeze,

§

impl<T> !RefUnwindSafe for OdeOptions<T>

§

impl<T> !Send for OdeOptions<T>

§

impl<T> !Sync for OdeOptions<T>

§

impl<T> Unpin for OdeOptions<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for OdeOptions<T>
where T: UnsafeUnpin,

§

impl<T> !UnwindSafe for OdeOptions<T>

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