RhsResult

Enum RhsResult 

Source
pub enum RhsResult {
    Ok,
    RecoverableError(u8),
    NonRecoverableError(u8),
}
Expand description

A return type for the right-hand-side rust function.

Adapted from Sundials cv-ode guide version 5.7 (BSD Licensed), setcion 4.6.1 :

If a recoverable error occurred, cvode will attempt to correct, if the error is unrecoverable, the integration is halted.

A recoverable failure error return is typically used to flag a value of the dependent variableythat is “illegal” in some way (e.g., negative where only a non-negative value is physically meaningful). If such a return is made, cvode will attempt to recover (possibly repeating the nonlinear solve, or reducing the step size) in order to avoid this recoverable error return.

Variants§

§

Ok

Indicates that there was no error

§

RecoverableError(u8)

Indicate that there was a recoverable error and its code

§

NonRecoverableError(u8)

Indicatest hat there was a non recoverable error

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