Struct nyx_space::propagators::PropOpts

pub struct PropOpts<E: ErrorCtrl> {
    pub init_step: Duration,
    pub min_step: Duration,
    pub max_step: Duration,
    pub tolerance: f64,
    pub attempts: u8,
    pub fixed_step: bool,
    pub _errctrl: E,
}

PropOpts stores the integrator options, including the minimum and maximum step sizes, and the max error size.

Note that different step sizes and max errors are only used for adaptive methods. To use a fixed step integrator, initialize the options using with_fixed_step, and use whichever adaptive step integrator is desired. For example, initializing an RK45 with fixed step options will lead to an RK4 being used instead of an RK45.

Fields

init_step: Duration

min_step: Duration

max_step: Duration

tolerance: f64

attempts: u8

fixed_step: bool

_errctrl: E

Implementations

impl<E: ErrorCtrl> PropOpts<E>

pub fn with_adaptive_step(
    min_step: Duration,
    max_step: Duration,
    tolerance: f64,
    errctrl: E
) -> Self

with_adaptive_step initializes an PropOpts such that the integrator is used with an adaptive step size. The number of attempts is currently fixed to 50 (as in GMAT).

pub fn with_adaptive_step_s(
    min_step: f64,
    max_step: f64,
    tolerance: f64,
    errctrl: E
) -> Self

pub fn info(&self) -> String

Returns a string with the information about these options

pub fn set_max_step(&mut self, max_step: Duration)

Set the maximum step size and sets the initial step to that value if currently greater

pub fn set_min_step(&mut self, min_step: Duration)

Set the minimum step size and sets the initial step to that value if currently smaller

impl PropOpts<RSSCartesianStep>

pub fn with_fixed_step(step: Duration) -> Self

with_fixed_step initializes an PropOpts such that the integrator is used with a fixed step size.

pub fn with_fixed_step_s(step: f64) -> Self

pub fn with_tolerance(tolerance: f64) -> Self

Returns the default options with a specific tolerance.

pub fn with_max_step(max_step: Duration) -> Self

Creates a propagator with the provided max step, and sets the initial step to that value as well.

Trait Implementations

impl<E: Clone + ErrorCtrl> Clone for PropOpts<E>

fn clone(&self) -> PropOpts<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug + ErrorCtrl> Debug for PropOpts<E>

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

Formats the value using the given formatter.

impl Default for PropOpts<RSSCartesianStep>

fn default() -> PropOpts<RSSCartesianStep>

default returns the same default options as GMAT.

impl<E: Copy + ErrorCtrl> Copy for PropOpts<E>