Struct nyx_space::propagators::PropInstance

pub struct PropInstance<'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 state: D::StateType,
    pub prop: &'a Propagator<'a, D, E>,
    pub details: IntegrationDetails,
    /* 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

state: D::StateType

The state of this propagator instance

prop: &'a Propagator<'a, D, E>

The propagator setup (kind, stages, etc.)

details: IntegrationDetails

Stores the details of the previous integration step

Implementations

impl<'a, D: Dynamics, E: ErrorCtrl> PropInstance<'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>,

pub fn set_step(&mut self, step_size: Duration, fixed: bool)

Allows setting the step size of the propagator

pub fn for_duration( &mut self, duration: Duration ) -> Result<D::StateType, NyxError>

This method propagates the provided Dynamics for the provided duration.

pub fn for_duration_with_channel( &mut self, duration: Duration, tx_chan: Sender<D::StateType> ) -> Result<D::StateType, NyxError>

This method propagates the provided Dynamics for the provided duration and publishes each state on the channel.

pub fn until_epoch(&mut self, end_time: Epoch) -> Result<D::StateType, NyxError>

Propagates the provided Dynamics until the provided epoch. Returns the end state.

pub fn until_epoch_with_channel( &mut self, end_time: Epoch, tx_chan: Sender<D::StateType> ) -> Result<D::StateType, NyxError>

Propagates the provided Dynamics until the provided epoch and publishes states on the provided channel. Returns the end state.

pub fn for_duration_with_traj( &mut self, duration: Duration ) -> Result<(D::StateType, Traj<D::StateType>), NyxError>where <DefaultAllocator as Allocator<f64, <D::StateType as State>::VecLength>>::Buffer: Send, D::StateType: InterpState,

Propagates the provided Dynamics for the provided duration and generate the trajectory of these dynamics on its own thread. Returns the end state and the trajectory. Known bug #190: Cannot generate a valid trajectory when propagating backward

pub fn until_epoch_with_traj( &mut self, end_time: Epoch ) -> Result<(D::StateType, Traj<D::StateType>), NyxError>where <DefaultAllocator as Allocator<f64, <D::StateType as State>::VecLength>>::Buffer: Send, D::StateType: InterpState,

Propagates the provided Dynamics until the provided epoch and generate the trajectory of these dynamics on its own thread. Returns the end state and the trajectory. Known bug #190: Cannot generate a valid trajectory when propagating backward

pub fn until_event<F: EventEvaluator<D::StateType>>( &mut self, max_duration: Duration, event: &F ) -> Result<(D::StateType, Traj<D::StateType>), NyxError>where <DefaultAllocator as Allocator<f64, <D::StateType as State>::VecLength>>::Buffer: Send, D::StateType: InterpState,

Propagate until a specific event is found once. Returns the state found and the trajectory until max_duration

pub fn until_nth_event<F: EventEvaluator<D::StateType>>( &mut self, max_duration: Duration, event: &F, trigger: usize ) -> Result<(D::StateType, Traj<D::StateType>), NyxError>where <DefaultAllocator as Allocator<f64, <D::StateType as State>::VecLength>>::Buffer: Send, D::StateType: InterpState,

Propagate until a specific event is found trigger times. Returns the state found and the trajectory until max_duration

pub fn single_step(&mut self) -> Result<(), NyxError>

Take a single propagator step and emit the result on the TX channel (if enabled)

pub fn latest_details(&self) -> &IntegrationDetails

Borrow the details of the latest integration step.

Trait Implementations

impl<'a, D: Debug + Dynamics, E: Debug + ErrorCtrl> Debug for PropInstance<'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>, D::StateType: Debug,

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

Formats the value using the given formatter.