Struct kidou::orbit::Orbit

pub struct Orbit {
    id: String,
    hc_initials: HCInitials,
    gca_initials: GCaInitials,
    gcy_initials: GCyInitials,
    n: I,
    results: Results,
}

An orbit of a globular cluster

Fields

id: String

ID of the object

hc_initials: HCInitials

Initial coordinates and velocities in the Heliocentric Cartesian system

gca_initials: GCaInitials

Initial coordinates and velocities in the Galactic Cartesian system

gcy_initials: GCyInitials

Initial coordinates and velocities in the Galactic Cylindrical system

n: I

Number of iterations used in the last integration

results: Results

Integrated coordinates of a globular cluster in the Galactic Cylindrical system

Implementations

impl Orbit

pub fn integrate(&mut self, model: &dyn Model, n: I, h: F, rev: bool)

Integrate the orbit with the specified number of iterations n and the time step h using the fourth-order Runge-Kutta algorithm

impl Orbit

pub fn simulate(
    &mut self,
    model: &dyn Model,
    folder: &Path,
    fields: &[&str],
    s: I,
    n: I,
    h: F
)

Apply the Monte Carlo method: simulate sampling from Normal distribution using the mean and standard deviation of the input data, use that as the input to the integrate routine s times with the number of iterations n and the time step h; write the coordinates and total energy in the folder if they’re specified in the fields

Panics

Can panic if standard deviations aren’t finite. This should be handled in the load routine.

impl Orbit

pub fn load(files: Vec<&str>) -> (Vec<Orbit>, Log<'_>)

Parse the file(s) with initial positions and velocities

Return all of the proper orbits found in the file(s) and the log of status codes.

impl Orbit

pub fn write(&self, folder: &Path, fields: &[&str], append: bool)

Write the results of integration to the specified file

impl Orbit

pub fn from(id: String, hc_initials: HCInitials) -> Self

Initialize an orbit with an ID from the initial coordinates and velocities in the Heliocentric Cartesian system

pub fn id(&self) -> &String

Get the ID of the object