Struct nyx_space::propagators::events::StopCondition

pub struct StopCondition<S: Copy> {
    pub max_prop_time: f64,
    pub event: Box<dyn Event<StateType = S>>,
    pub trigger: usize,
    pub max_iter: usize,
    pub epsilon: f64,
}

A condition to stop a propagator. Note: min_step of propagator options will guide how precise the solution can be!

Fields

max_prop_time: f64

Set to a negative number to search backward

event: Box<dyn Event<StateType = S>>

The event which should be the stopping condition

trigger: usize

The number of times the event must be hit prior to stopping (should be at least 1)

max_iter: usize

Maximum number of iterations of the Brent solver.

epsilon: f64

Maximum error in the event, used as convergence criteria.

Methods

impl<S: Copy> StopCondition<S>

pub fn new(
    event: Box<dyn Event<StateType = S>>,
    prop_time: f64,
    epsilon: f64
) -> Self

Finds the closest time at which this condition is met. Stops on first occurence.

pub fn after_hits(
    event: Box<dyn Event<StateType = S>>,
    hits: usize,
    prop_time: f64,
    epsilon: f64
) -> Self

Finds the closest time at which this condition is met. Stops on hits occurence (must be strictly greater than 1)

Trait Implementations

impl<S: Debug + Copy> Debug for StopCondition<S>

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

Formats the value using the given formatter.