Struct nyx_space::propagators::PropOpts [−][src]
pub struct PropOpts<E: ErrorCtrl> { /* fields omitted */ }
Expand description
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.
Implementations
pub fn with_adaptive_step(
min_step: Duration,
max_step: Duration,
tolerance: f64,
errctrl: E
) -> Self
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).
with_fixed_step
initializes an PropOpts
such that the integrator is used with a fixed
step size.
Returns the default options with a specific tolerance.
Trait Implementations
default
returns the same default options as GMAT.
Auto Trait Implementations
impl<E> RefUnwindSafe for PropOpts<E> where
E: RefUnwindSafe,
impl<E> UnwindSafe for PropOpts<E> where
E: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
type Output = T
type Output = T
Should always be Self
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.