Skip to main content

IntegratorConfig

Struct IntegratorConfig 

Source
pub struct IntegratorConfig {
    pub initial_dt: Option<f64>,
    pub min_dt: Option<f64>,
    pub epsilon: Option<f64>,
    pub adaptive_mode: Option<Ias15AdaptiveMode>,
}
Expand description

Per-call IAS15 integrator knobs. None for any field leaves the REBOUND default in place.

Applied to a freshly-created Simulation before any particles are added.

Fields§

§initial_dt: Option<f64>

REBOUND r->dt (initial timestep). The integrator picks the sign automatically once the first step is taken.

§min_dt: Option<f64>

REBOUND r->ri_ias15.min_dt. When the adaptive step would shrink below this, it clamps. None (or 0) = no floor.

§epsilon: Option<f64>

REBOUND r->ri_ias15.epsilon (precision). REBOUND default 1e-9.

§adaptive_mode: Option<Ias15AdaptiveMode>

REBOUND r->ri_ias15.adaptive_mode. Default Prs23 since 2024-01.

Implementations§

Source§

impl IntegratorConfig

Source

pub fn apply(&self, sim: &mut Simulation)

Apply each Some field to sim. Should be called immediately after Simulation::new() and before adding particles.

Trait Implementations§

Source§

impl Clone for IntegratorConfig

Source§

fn clone(&self) -> IntegratorConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IntegratorConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for IntegratorConfig

Source§

fn default() -> IntegratorConfig

Returns the “default value” for a type. Read more
Source§

impl Copy for IntegratorConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.