Struct ode_solvers::dopri5::Dopri5[−][src]

pub struct Dopri5<V, F> where
    F: System<V>,  { /* fields omitted */ }

Expand description

Structure containing the parameters for the numerical integration.

Implementations

[src]

impl<T, F, const N: usize> Dopri5<SVector<T, N>, F> where
    f64: From<T>,
    T: Copy + SubsetOf<f64> + Scalar + ClosedAdd + ClosedMul + ClosedSub + ClosedNeg + Zero,
    F: System<SVector<T, N>>,

[src]

pub fn new(
    f: F, 
    x: f64, 
    x_end: f64, 
    dx: f64, 
    y: SVector<T, N>, 
    rtol: f64, 
    atol: f64
) -> Self

Default initializer for the structure

Arguments

f - Structure implementing the System trait
x - Initial value of the independent variable (usually time)
x_end - Final value of the independent variable
dx - Increment in the dense output. This argument has no effect if the output type is Sparse
y - Initial value of the dependent variable(s)
rtol - Relative tolerance used in the computation of the adaptive step size
atol - Absolute tolerance used in the computation of the adaptive step size

[src]

pub fn from_param(
    f: F, 
    x: f64, 
    x_end: f64, 
    dx: f64, 
    y: SVector<T, N>, 
    rtol: f64, 
    atol: f64, 
    safety_factor: f64, 
    beta: f64, 
    fac_min: f64, 
    fac_max: f64, 
    h_max: f64, 
    h: f64, 
    n_max: u32, 
    n_stiff: u32, 
    out_type: OutputType
) -> Self

Advanced initializer for the structure.

Arguments

f - Structure implementing the System trait
x - Initial value of the independent variable (usually time)
x_end - Final value of the independent variable
dx - Increment in the dense output. This argument has no effect if the output type is Sparse
y - Initial value of the dependent variable(s)
rtol - Relative tolerance used in the computation of the adaptive step size
atol - Absolute tolerance used in the computation of the adaptive step size
safety_factor - Safety factor used in the computation of the adaptive step size
beta - Value of the beta coefficient of the PI controller. Default is 0.04
fac_min - Minimum factor between two successive steps. Default is 0.2
fac_max - Maximum factor between two successive steps. Default is 10.0
h_max - Maximum step size. Default is x_end-x
h - Initial value of the step size. If h = 0.0, the intial value of h is computed automatically
n_max - Maximum number of iterations. Default is 100000
n_stiff - Stifness is tested when the number of iterations is a multiple of n_stiff. Default is 1000
out_type - Type of the output. Must be a variant of the OutputType enum. Default is Dense

[src]

pub fn integrate(&mut self) -> Result<Stats, IntegrationError>

Core integration method.

[src]

pub fn x_out(&self) -> &Vec<f64>

Getter for the independent variable’s output.

[src]

pub fn y_out(&self) -> &Vec<SVector<T, N>>

Getter for the dependent variables’ output.

Auto Trait Implementations

impl<V, F> RefUnwindSafe for Dopri5<V, F> where
    F: RefUnwindSafe,
    V: RefUnwindSafe,

impl<V, F> Send for Dopri5<V, F> where
    F: Send,
    V: Send,

impl<V, F> Sync for Dopri5<V, F> where
    F: Sync,
    V: Sync,

impl<V, F> Unpin for Dopri5<V, F> where
    F: Unpin,
    V: Unpin,

impl<V, F> UnwindSafe for Dopri5<V, F> where
    F: UnwindSafe,
    V: UnwindSafe,

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

impl<T> Same<T> for T

type Output = T

Should always be Self

[src]

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

[src]

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

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

[src]

pub fn is_in_subset(&self) -> bool

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

[src]

pub fn to_subset_unchecked(&self) -> SS

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

[src]

pub fn from_subset(element: &SS) -> SP

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

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

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

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.