Struct ode_solvers::controller::Controller

source · [−]

pub struct Controller { /* private fields */ }

Expand description

Used for adaptive step size control

Implementations

source

impl Controller

source

pub fn new(
    alpha: f64,
    beta: f64,
    fac_max: f64,
    fac_min: f64,
    h_max: f64,
    safety_factor: f64,
    posneg: f64
) -> Controller

Creates a controller responsible for adaptive step size control.

Arguments

alpha - α coefficient of the PI controller
beta - β coefficient of the PI controller
fac_max - Maximum factor between two successive steps
fac_min - Minimum factor between two successive steps
h_max - Maximum step size
safety_factor - Safety factor of the PI controller

source

pub fn accept(&mut self, err: f64, h: f64, h_new: &mut f64) -> bool

Determines if the step must be accepted or rejected and adapts the step size accordingly.

source

pub fn h_max(&self) -> f64

Returns the maximum step size allowed.

Auto Trait Implementations

impl RefUnwindSafe for Controller

impl Send for Controller

impl Sync for Controller

impl Unpin for Controller

impl UnwindSafe for Controller

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · 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.

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

source

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

source

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

source

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

source

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct ode_solvers::controller::Controller

Implementations

impl Controller

pub fn new(
    alpha: f64,
    beta: f64,
    fac_max: f64,
    fac_min: f64,
    h_max: f64,
    safety_factor: f64,
    posneg: f64
) -> Controller

Arguments

pub fn accept(&mut self, err: f64, h: f64, h_new: &mut f64) -> bool

pub fn h_max(&self) -> f64

Auto Trait Implementations

impl RefUnwindSafe for Controller

impl Send for Controller

impl Sync for Controller

impl Unpin for Controller

impl UnwindSafe for Controller

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where
U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct ode_solvers::controller::Controller

Implementations

impl Controller

pub fn new( alpha: f64, beta: f64, fac_max: f64, fac_min: f64, h_max: f64, safety_factor: f64, posneg: f64) -> Controller

Arguments

pub fn accept(&mut self, err: f64, h: f64, h_new: &mut f64) -> bool

pub fn h_max(&self) -> f64

Auto Trait Implementations

impl RefUnwindSafe for Controller

impl Send for Controller

impl Sync for Controller

impl Unpin for Controller

impl UnwindSafe for Controller

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn new(
alpha: f64,
beta: f64,
fac_max: f64,
fac_min: f64,
h_max: f64,
safety_factor: f64,
posneg: f64
) -> Controller

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,