Struct DAEOptions

Source

pub struct DAEOptions<F: IntegrateFloat> {
    pub dae_type: DAEType,
    pub index: DAEIndex,
    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 max_newton_iterations: usize,
    pub newton_tol: F,
    pub max_order: Option<usize>,
}

Expand description

Options for controlling the behavior of DAE solvers

Fields§

§dae_type: DAEType

The DAE system type

§index: DAEIndex

The DAE index (classification)

§method: ODEMethod

The ODE solver method to use for the differential part

§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)

§max_newton_iterations: usize

Maximum iterations for the nonlinear solver

§newton_tol: F

Tolerance for the nonlinear solver

§max_order: Option<usize>

Maximum BDF order (optional, defaults to 5)

Trait Implementations§

Source §

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

Source §

fn clone(&self) -> DAEOptions<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 DAEOptions<F>

Source §

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

Formats the value using the given formatter. Read more

Source §

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

Source §

fn default() -> Self

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

Auto Trait Implementations§

§

impl<F> UnwindSafe for DAEOptions<F>
where F: 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> 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 §