Struct nyx_space::io::gravity::HarmonicsMem

pub struct HarmonicsMem { /* fields omitted */ }

HarmonicsMem loads the requested gravity potential files and stores them in memory (in a HashMap).

WARNING: This memory backend may require a lot of RAM (e.g. EMG2008 2190x2190 requires nearly 400 MB of RAM).

Implementations

impl HarmonicsMem

pub fn from_j2(j2: f64) -> HarmonicsMem

Initialize HarmonicsMem with a custom J2 value

pub fn j2_jgm3() -> HarmonicsMem

Initialize HarmonicsMem as an EARTH J₂ only using the JGM3 model (available in GMAT)

Use the embedded Earth parameter. If others are needed, load from from_shadr or from_egm. WARNING: This is an EARTH gravity model, and should not be used around any other body.

pub fn j2_jgm2() -> HarmonicsMem

Initialize HarmonicsMem as an EARTH J₂ only using the JGM2 model (available in GMAT)

Use the embedded Earth parameter. If others are needed, load from from_shadr or from_egm. WARNING: This is an EARTH gravity model, and should not be used around any other body.

pub fn j2_egm2008() -> HarmonicsMem

Initialize HarmonicsMem as J₂ only using the EGM2008 model (from the GRACE mission, best model as of 2018)

WARNING: This is an EARTH gravity model, and should not be used around any other body.

pub fn from_shadr(
    filepath: &str,
    degree: usize,
    order: usize,
    gunzipped: bool
) -> Result<HarmonicsMem, NyxError>

Initialize HarmonicsMem from the file path (must be a gunzipped file)

Gravity models provided by nyx: + EMG2008 to 2190 for Earth (tide free) + Moon to 1500 (from SHADR file) + Mars to 120 (from SHADR file) + Venus to 150 (from SHADR file)

pub fn from_egm(
    filepath: &str,
    degree: usize,
    order: usize,
    gunzipped: bool
) -> Result<HarmonicsMem, NyxError>

pub fn from_cof(
    filepath: &str,
    degree: usize,
    order: usize,
    gunzipped: bool
) -> Result<HarmonicsMem, NyxError>

Trait Implementations

impl Clone for HarmonicsMem

fn clone(&self) -> HarmonicsMem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl GravityPotentialStor for HarmonicsMem

fn max_order_m(&self) -> usize

Returns the maximum order of this gravity potential storage (Jnm=Jn2,Jn3…)

fn max_degree_n(&self) -> usize

Returns the maximum degree of this gravity potential storage (Jn=J2,J3…)

fn cs_nm(&self, degree: usize, order: usize) -> (f64, f64)

Returns the C_nm and S_nm for the provided order and degree.