Skip to main content

PIController

Struct PIController 

Source
pub struct PIController<S: Scalar> {
    pub safety: S,
    pub fac_min: S,
    pub fac_max: S,
    pub beta1: S,
    pub beta2: S,
    /* private fields */
}
Expand description

PI (Proportional-Integral) step size controller.

This is the standard controller used in most production ODE codes. It provides smoother step size changes than a simple error-based controller.

The new step size is computed as: h_new = h * (1/err)^(beta1/p) * (err_old/err)^(beta2/p)

where p is the method order.

Fields§

§safety: S

Safety factor (typically 0.9)

§fac_min: S

Minimum step size factor

§fac_max: S

Maximum step size factor

§beta1: S

I-controller gain (typically 0.7/p)

§beta2: S

P-controller gain (typically 0.4/p)

Implementations§

Source§

impl<S: Scalar> PIController<S>

Source

pub fn new() -> Self

Create a new PI controller with default parameters.

Source

pub fn with_params( safety: S, fac_min: S, fac_max: S, beta1: S, beta2: S, ) -> Self

Create with custom parameters.

Source

pub fn for_order(order: usize) -> Self

Create a controller tuned for a specific method order.

Trait Implementations§

Source§

impl<S: Clone + Scalar> Clone for PIController<S>

Source§

fn clone(&self) -> PIController<S>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<S: Debug + Scalar> Debug for PIController<S>

Source§

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

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

impl<S: Scalar> Default for PIController<S>

Source§

fn default() -> Self

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

impl<S: Scalar> StepController<S> for PIController<S>

Source§

fn propose(&mut self, h: S, err: S, order: usize) -> StepProposal<S>

Propose a new step size based on the error estimate. Read more
Source§

fn accept(&mut self, h: S, err: S)

Called when a step is accepted.
Source§

fn reject(&mut self, _h: S, _err: S)

Called when a step is rejected.
Source§

fn reset(&mut self)

Reset the controller state.

Auto Trait Implementations§

§

impl<S> Freeze for PIController<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for PIController<S>
where S: RefUnwindSafe,

§

impl<S> Send for PIController<S>

§

impl<S> Sync for PIController<S>

§

impl<S> Unpin for PIController<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for PIController<S>
where S: UnsafeUnpin,

§

impl<S> UnwindSafe for PIController<S>
where S: 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<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<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

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

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

Source§

fn vzip(self) -> V