Skip to main content

IntegratorConfig

Struct IntegratorConfig 

Source
pub struct IntegratorConfig {
    pub abs_tol: f64,
    pub rel_tol: f64,
    pub initial_step: Option<f64>,
    pub min_step: Option<f64>,
    pub max_step: Option<f64>,
    pub step_safety_factor: Option<f64>,
    pub min_step_scale_factor: Option<f64>,
    pub max_step_scale_factor: Option<f64>,
    pub max_step_attempts: usize,
    pub fixed_step_size: Option<f64>,
}
Expand description

Configuration options for numerical integrators.

§Example

use brahe::integrators::IntegratorConfig;

// Create config with tight tolerances for high-precision integration
let config = IntegratorConfig {
    abs_tol: 1e-12,
    rel_tol: 1e-9,
    max_step: Some(100.0),
    ..Default::default()
};

Fields§

§abs_tol: f64

Absolute error tolerance for adaptive stepping

§rel_tol: f64

Relative error tolerance for adaptive stepping

§initial_step: Option<f64>

Initial step size (if None, integrator determines automatically)

§min_step: Option<f64>

Minimum allowed step size (if None, no minimum enforced)

§max_step: Option<f64>

Maximum allowed step size (if None, no maximum enforced)

§step_safety_factor: Option<f64>

Safety factor for adaptive step size control (typically 0.8-0.9) If None, no safety factor applied (uses raw error-based scaling)

§min_step_scale_factor: Option<f64>

Minimum step size scaling factor (prevents too-aggressive decreases) If None, no minimum limit on step reduction

§max_step_scale_factor: Option<f64>

Maximum step size scaling factor (prevents too-aggressive increases) If None, no maximum limit on step growth

§max_step_attempts: usize

Maximum attempts to find acceptable step size

§fixed_step_size: Option<f64>

Fixed step size for fixed-step integrators When set, fixed-step integrators will use this value if no dt is provided to step()

Implementations§

Source§

impl IntegratorConfig

Source

pub fn fixed_step(step_size: f64) -> Self

Create a new configuration for fixed-step integration.

Sets the fixed step size that will be used by fixed-step integrators when no explicit dt is provided to the step() method. The step size can still be overridden on a per-step basis by providing a dt value.

§Arguments
  • step_size: The step size to use for fixed-step integration (seconds)
§Returns

IntegratorConfig with fixed_step_size set

§Example
use brahe::integrators::IntegratorConfig;

// Create config with 1.0 second step size
let config = IntegratorConfig::fixed_step(1.0);
assert_eq!(config.fixed_step_size, Some(1.0));
Source

pub fn adaptive(abs_tol: f64, rel_tol: f64) -> Self

Create a new configuration for adaptive-step integration.

§Arguments
  • abs_tol: Absolute error tolerance
  • rel_tol: Relative error tolerance
§Returns

IntegratorConfig configured for adaptive stepping

§Example
use brahe::integrators::IntegratorConfig;

let config = IntegratorConfig::adaptive(1e-8, 1e-6);

Trait Implementations§

Source§

impl Clone for IntegratorConfig

Source§

fn clone(&self) -> IntegratorConfig

Returns a duplicate of the value. Read more
1.0.0 · 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

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

impl Default for IntegratorConfig

Source§

fn default() -> Self

Default configuration matching typical defaults

  • abs_tol: 1e-6
  • rel_tol: 1e-3
  • initial_step: None (auto-determined)
  • min_step: Some(1e-12)
  • max_step: Some(900.0) (15 minutes)
  • step_safety_factor: Some(0.9)
  • min_step_scale_factor: Some(0.2)
  • max_step_scale_factor: Some(10.0)
  • max_step_attempts: 10
  • fixed_step_size: None
Source§

impl<'de> Deserialize<'de> for IntegratorConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for IntegratorConfig

Source§

fn eq(&self, other: &IntegratorConfig) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for IntegratorConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromDhall for T

Source§

fn from_dhall(v: &Value) -> Result<T, Error>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn align() -> usize

The alignment necessary for the key. Must return a power of two.
Source§

fn size(&self) -> usize

The size of the key in bytes.
Source§

unsafe fn init(&self, ptr: *mut u8)

Initialize the key in the given memory location. Read more
Source§

unsafe fn get<'a>(ptr: *const u8) -> &'a T

Get a reference to the key from the given memory location. Read more
Source§

unsafe fn drop_in_place(ptr: *mut u8)

Drop the key in place. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToDhall for T
where T: Serialize,

Source§

fn to_dhall(&self, ty: Option<&SimpleType>) -> Result<Value, Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> PlanCallbackArgs for T

Source§

impl<T> PlanCallbackOut for T

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,