Struct PropSettings 

pub struct PropSettings {
    pub gravity_degree: u16,
    pub gravity_order: u16,
    pub abs_error: f64,
    pub rel_error: f64,
    pub use_spaceweather: bool,
    pub use_sun_gravity: bool,
    pub use_moon_gravity: bool,
    pub enable_interp: bool,
    pub precomputed: Option<Precomputed>,
}

Propagation settings

These include

• gravity_degree - maximum degree of spherical harmonic gravity model. Default is 4
• gravity_order - maximum order of spherical harmonic gravity model. Default is same as gravity_degree. Must be ≤ gravity_degree.
• abs_error - the maximum absolute error for the infinity norm of the state in Runge-Kutta integrator. Default is 1e-8
• rel_error - the maximum relative error for the infinity norm of the state in Runge-Kutta integrator. Default is 1e-8
• use_spaceweather - Do we use space weather when computing the atmospheric density. Default is true
• use_sun_gravity - Do we include sun third-body gravitational perturbation. Default is true
• use_moon_gravity - Do we include moon third-body gravitational perturbation. Default is true
• enable_interp - Do we enable interpolation of the state between begin and end times. Default is true slight computation savings if set to false

Fields

gravity_degree: u16

gravity_order: u16

abs_error: f64

rel_error: f64

use_spaceweather: bool

use_sun_gravity: bool

use_moon_gravity: bool

enable_interp: bool

precomputed: Option<Precomputed>

Implementations

impl PropSettings

pub fn set_gravity(&mut self, degree: u16, order: u16) -> Result<()>

Set gravity degree and order, with validation

Arguments

• degree - Maximum degree of spherical harmonic gravity model
• order - Maximum order (must be ≤ degree)

Errors

Returns error if order > degree

pub fn precompute_terms<T: TimeLike>( &mut self, begin: &T, end: &T, ) -> Result<()>

Precompute terms between begin and end instants

Arguments

• begin - Begin instant
• end - End instant

Pre-computes inertial to earth-fixed rotation vector (used for Earth gravity calculation), sun, and moon positions between the begin and end instants. These are used in the force model when propagating orbits

Pre-computing these terms means the settings can be used for multiple propagations between the same begin and end instants without needing to recompute these terms each time. (significant speedup when propagating many orbits over the same time span)

Errors

Returns error if precomputation fails

Example

use satkit::orbitprop::PropSettings;
use satkit::Instant;

let begin = Instant::now();
let end = begin + satkit::Duration::from_hours(1.0);
let mut props = PropSettings::default();
props.precompute_terms(&begin, &end).unwrap();

pub fn precompute_terms_with_step<T: TimeLike>( &mut self, begin: &T, end: &T, step_secs: f64, ) -> Result<()>

Trait Implementations

impl Clone for PropSettings

fn clone(&self) -> PropSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PropSettings

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

Formats the value using the given formatter.

impl Default for PropSettings

fn default() -> Self

Returns the “default value” for a type.

impl Display for PropSettings

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

Formats the value using the given formatter.