kepler.h

/******************************************************************************
* Copyright (c) ATTX LLC 2024. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX, LLC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX, LLC.
******************************************************************************/
/*
Kepler header file
-------------------
This file contains a number of utilities for calculating parameters associated
with keplerian orbits.
 
Author: Alex Reynolds
*/
#ifndef UTILS_KEPLER_H
#define UTILS_KEPLER_H
 
#include "core/CartesianVector.hpp"
#include "core/macros.h"
 
namespace clockwerk {
    /// @brief Function to propagate a body between two points in time using a keplerian orbit
    /// @param time The time for which the orbit should be propagated
    /// @param mu The gravitational parameter for the central planet
    /// @param pos_initial The initial position of the body
    /// @param vel_initial The initial velocity of the body
    /// @param pos_final The position of the body after propagation
    /// @param vel_final The velocity of the body after propagation
    /// @return Error code corresponding to success/failure
    int twoBodyPropagate(double time, double mu,
                         CartesianVector3D pos_initial, CartesianVector3D vel_initial,
                         CartesianVector3D &pos_final,  CartesianVector3D &vel_final);
 
    /// @brief Function to convert mean anomaly to eccentric anomaly
    /// @param mean_anomaly 
    /// @param eccentricity The orbit eccentricity
    /// @param eccentric_anomaly 
    /// @param tol The tolerance for iterative conversion
    /// @param max_iter The maximum number of iterations after which the solver will exit
    /// @return Error code corresponding to success/failure
    int mean2eccentric(double mean_anomaly, double eccentricity, double &eccentric_anomaly,
                       double tol, int max_iter);
 
    /// @brief Function to convert eccentric anomaly to true anomaly
    /// @param eccentric_anomaly 
    /// @param eccentricity The orbit eccentricity
    /// @param true_anomaly 
    /// @return Error code corresponding to success/failure
    int eccentric2true(double eccentric_anomaly, double eccentricity, double &true_anomaly);
 
    /// @brief Function to convert true anomaly to eccentric anomaly
    /// @param true_anomaly 
    /// @param eccentricity The orbit eccentricity
    /// @param eccentric_anomaly 
    /// @return Error code corresponding to success/failure
    int true2eccentric(double true_anomaly, double eccentricity, double &eccentric_anomaly);
 
    /// @brief Function to convert eccentric anomaly to mean anomaly
    /// @param eccentric_anomaly 
    /// @param eccentricity The orbit eccentricity
    /// @param mean_anomaly 
    /// @return Error code corresponding to success/failure
    int eccentric2mean(double eccentric_anomaly, double eccentricity, double &mean_anomaly);
}
 
#endif