Struct peroxide::numerical::ode::RKF45

source · 
pub struct RKF45 {
    pub tol: f64,
    pub safety_factor: f64,
    pub min_step_size: f64,
    pub max_step_size: f64,
    pub max_step_iter: usize,
}
Expand description

Runge-Kutta-Fehlberg 4/5th order integrator.

This integrator uses the Runge-Kutta-Fehlberg method, which is an adaptive step size integrator. It calculates six intermediate values (k1, k2, k3, k4, k5, k6) to estimate the next step solution and the error. The step size is automatically adjusted based on the estimated error to maintain the desired tolerance.

§Member variables

  • tol: The tolerance for the estimated error.
  • safety_factor: The safety factor for the step size adjustment.
  • min_step_size: The minimum step size.
  • max_step_size: The maximum step size.
  • max_step_iter: The maximum number of iterations per step.

Fields§

§tol: f64§safety_factor: f64§min_step_size: f64§max_step_size: f64§max_step_iter: usize

Implementations§

source§

impl RKF45

source

pub fn new( tol: f64, safety_factor: f64, min_step_size: f64, max_step_size: f64, max_step_iter: usize, ) -> Self

Trait Implementations§

source§

impl ButcherTableau for RKF45

source§

const C: &'static [f64] = _

source§

const A: &'static [&'static [f64]] = _

source§

const BU: &'static [f64] = _

source§

const BE: &'static [f64] = _

source§

fn tol(&self) -> f64

source§

fn safety_factor(&self) -> f64

source§

fn min_step_size(&self) -> f64

source§

fn max_step_size(&self) -> f64

source§

fn max_step_iter(&self) -> usize

source§

impl Clone for RKF45

source§

fn clone(&self) -> RKF45

Returns a copy 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 Debug for RKF45

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for RKF45

source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for RKF45

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Serialize for RKF45

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Copy for RKF45

Auto Trait Implementations§

§

impl Freeze for RKF45

§

impl RefUnwindSafe for RKF45

§

impl Send for RKF45

§

impl Sync for RKF45

§

impl Unpin for RKF45

§

impl UnwindSafe for RKF45

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

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

impl<BU> ODEIntegrator for BU
where BU: ButcherTableau,

source§

fn step<P>( &self, problem: &P, t: f64, y: &mut [f64], dt: f64, ) -> Result<f64, Error>
where P: ODEProblem,

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> Ungil for T
where T: Send,