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 duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for IntegratorMethod

impl Debug for IntegratorMethod

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

Formats the value using the given formatter.

impl Default for IntegratorMethod

fn default() -> IntegratorMethod

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 Eq for IntegratorMethod

impl<'a, 'py> FromPyObject<'a, 'py> for IntegratorMethod

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

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<'py> IntoPyObject<'py> for IntegratorMethod

type Target = IntegratorMethod

The Python output type

type Output = Bound<'py, <IntegratorMethod as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'py>>::Output, <Self as IntoPyObject<'py>>::Error>

Performs the conversion.

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 PyClass for IntegratorMethod

const NAME: &str = "IntegratorMethod"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for IntegratorMethod

const MODULE: Option<&str> = ::core::option::Option::None

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// 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.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<IntegratorMethod as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<IntegratorMethod>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForIntegratorMethod

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyTypeInfo for IntegratorMethod

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

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 StaticType for IntegratorMethod

fn static_type() -> SimpleType

Return the Dhall type that represents this type.

impl StructuralPartialEq for IntegratorMethod