Enum IntegratorMethod

pub enum IntegratorMethod {
    RungeKutta89,
    DormandPrince78,
    DormandPrince45,
    RungeKutta4,
    CashKarp45,
    Verner56,
}

Enum of supported integration methods, all of which are part of the Runge Kutta family of ordinary differential equation (ODE) solvers. Nomenclature: X-Y means that this is an X order solver with a Y order error correction step.

Variants

RungeKutta89

Runge Kutta 8-9 is the recommended integrator for most application.

DormandPrince78

Dormand78 is a Dormand-Prince integrator. Coefficients taken from GMAT src/base/propagator/PrinceDormand78.cpp.

DormandPrince45

Dormand45 is a Dormand-Prince integrator.

RungeKutta4

Runge Kutta 4 is a fixed step solver.

CashKarp45

Runge Kutta 4-5 Cash Karp integrator.

Verner56

Verner56 is an RK Verner integrator of order 5-6. Coefficients taken from here (PDF).

Implementations

impl IntegratorMethod

pub const fn order(self) -> u8

Returns the order of this integrator (as u8 because there probably isn’t an order greater than 255). The order is used for the adaptive step size only to compute the error between estimates.

pub const fn stages(self) -> usize

Returns the stages of this integrator, i.e. how many times the derivatives will be called

pub const fn a_coeffs(self) -> &'static [f64]

Returns a pointer to a list of f64 corresponding to the A coefficients of the Butcher table for that RK. This module only supports implicit integrators, and as such, Self.a_coeffs().len() must be of size (order+1)*(order)/2. Warning: this RK trait supposes that the implementation is consistent, i.e. c_i = \sum_j a_{ij}.

pub const fn b_coeffs(self) -> &'static [f64]

Returns a pointer to a list of f64 corresponding to the b_i and b^*_i coefficients of the Butcher table for that RK. Self.a_coeffs().len() must be of size (order+1)*2.

Trait Implementations

impl Clone for IntegratorMethod

fn clone(&self) -> IntegratorMethod

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IntegratorMethod

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

Formats the value using the given formatter.

impl Default for IntegratorMethod

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IntegratorMethod

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for IntegratorMethod

type Err = PropagationError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for IntegratorMethod

fn eq(&self, other: &IntegratorMethod) -> 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 Serialize for IntegratorMethod

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for IntegratorMethod

impl Eq for IntegratorMethod

impl StructuralPartialEq for IntegratorMethod