Struct nyx_space::propagators::Propagator

pub struct Propagator<'a, D: Dynamics, E: ErrorCtrl>where
    DefaultAllocator: Allocator<f64, <D::StateType as State>::Size> + Allocator<f64, <D::StateType as State>::Size, <D::StateType as State>::Size> + Allocator<usize, <D::StateType as State>::Size, <D::StateType as State>::Size> + Allocator<f64, <D::StateType as State>::VecLength>,{
    pub dynamics: D,
    pub opts: PropOpts<E>,
    /* private fields */
}

A Propagator allows propagating a set of dynamics forward or backward in time. It is an EventTracker, without any event tracking. It includes the options, the integrator details of the previous step, and the set of coefficients used for the monomorphic instance.

Fields

dynamics: D

opts: PropOpts<E>

Implementations

impl<'a, D: Dynamics, E: ErrorCtrl> Propagator<'a, D, E>where
    DefaultAllocator: Allocator<f64, <D::StateType as State>::Size> + Allocator<f64, <D::StateType as State>::Size, <D::StateType as State>::Size> + Allocator<usize, <D::StateType as State>::Size, <D::StateType as State>::Size> + Allocator<f64, <D::StateType as State>::VecLength>,

The Propagator trait defines the functions of a propagator and of an event tracker.

pub fn new<T: RK>(dynamics: D, opts: PropOpts<E>) -> Self

Each propagator must be initialized with new which stores propagator information.

pub fn set_tolerance(&mut self, tol: f64)

Set the tolerance for the propagator

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

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

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

pub fn rk89(dynamics: D, opts: PropOpts<E>) -> Self

An RK89 propagator (the default) with custom propagator options.

pub fn dp78(dynamics: D, opts: PropOpts<E>) -> Self

A Dormand Prince 7-8 propagator with custom propagator options: it’s about 20% faster than an RK98, and more stable in two body dynamics. WARNINGS: Dormand Prince may have issues with generating proper trajectories, leading to glitches in event finding.

pub fn with(&'a self, state: D::StateType) -> PropInstance<'a, D, E>

impl<'a, D: Dynamics> Propagator<'a, D, RSSCartesianStep>where
    DefaultAllocator: Allocator<f64, <D::StateType as State>::Size> + Allocator<f64, <D::StateType as State>::Size, <D::StateType as State>::Size> + Allocator<usize, <D::StateType as State>::Size, <D::StateType as State>::Size> + Allocator<f64, <D::StateType as State>::VecLength>,

pub fn default(dynamics: D) -> Self

Default propagator is an RK89 with the default PropOpts.

pub fn default_dp78(dynamics: D) -> Self

A default Dormand Prince 78 propagator with the default PropOpts. Faster and more stable than an RK89 (default) but seems to cause issues for event finding. WARNINGS: Dormand Prince may have issues with generating proper trajectories, leading to glitches in event finding.

Trait Implementations

impl<'a, D: Clone + Dynamics, E: Clone + ErrorCtrl> Clone for Propagator<'a, D, E>where
    DefaultAllocator: Allocator<f64, <D::StateType as State>::Size> + Allocator<f64, <D::StateType as State>::Size, <D::StateType as State>::Size> + Allocator<usize, <D::StateType as State>::Size, <D::StateType as State>::Size> + Allocator<f64, <D::StateType as State>::VecLength>,

fn clone(&self) -> Propagator<'a, D, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, D: Debug + Dynamics, E: Debug + ErrorCtrl> Debug for Propagator<'a, D, E>where
    DefaultAllocator: Allocator<f64, <D::StateType as State>::Size> + Allocator<f64, <D::StateType as State>::Size, <D::StateType as State>::Size> + Allocator<usize, <D::StateType as State>::Size, <D::StateType as State>::Size> + Allocator<f64, <D::StateType as State>::VecLength>,

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

Formats the value using the given formatter.