Struct SolverState

pub struct SolverState {
    pub dt: f64,
    pub n_iter: u8,
    pub norm_err: Option<f64>,
    pub norm_err_rel: Option<f64>,
    pub t_curr: f64,
    pub states: Vec<f64>,
}

Solver is considered considered converged when any one of the following conditions are met:

• norm_err is less than atol
• norm_err_rel is less than rtol
• n_iter >= n_max_iter

Fields

dt: f64

time step size used by solver

n_iter: u8

number of iterations to achieve tolerance

norm_err: Option<f64>

Absolute error based on difference in L2 (euclidean) norm

norm_err_rel: Option<f64>

Relative error based on difference in L2 (euclidean) norm

t_curr: f64

current system time used in solver

states: Vec<f64>

current values of states

Trait Implementations

impl Clone for SolverState

fn clone(&self) -> SolverState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SolverState

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

Formats the value using the given formatter.

impl Default for SolverState

fn default() -> SolverState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SolverState

fn deserialize<__D>( __deserializer: __D, ) -> Result<SolverState, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SolverState

fn eq(&self, other: &SolverState) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SolverState

fn partial_cmp(&self, other: &SolverState) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SolverState

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SolverState