conversions.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.
******************************************************************************/
/**
 * File: Conversions.h
 * 
 * This file contains analysis utilities to convert units in the circular restricted
 * three body problem (cr3bp).
 * 
 * All conversions are per Dr. Pernicka of Missouri S&T and the following online utilities:
 * https://orbital-mechanics.space/the-n-body-problem/circular-restricted-three-body-problem.html
 * 
 * Author: Alex Reynolds <alex.reynolds@attx.tech>
 */
#ifndef CR3BPUTILS_CONVERSIONS_H
#define CR3BPUTILS_CONVERSIONS_H
 
#include <cmath>
 
#include "core/CartesianVector.hpp"
#include "core/macros.h"
 
namespace modelspace {
 
    /// @brief Function to return the characteristic mass for CR3BP
    /// @param m1 The mass of the primary body
    /// @param m2 The mass of the secondary body
    /// @return The characteristic mass
    double muStar(double m1, double m2);
 
    /// @brief Function to return the characteristic length for CR3BP
    /// @param r The circular orbit radius of the secondary body about the first
    /// @return The characteristic length
    double lStar(double r);
 
    /// @brief Function to return the characteristic time for the CR3BP
    /// @param r The circular orbit radius of the secondary body about the first
    /// @param mu The mass of the primary body
    /// @return The characteristic time
    double tStar(double r, double mu);
 
    /// @brief Function to convert position from dimensional to characteristic units
    /// @param pos_d The position of the body in dimensional units
    /// @param l_star The characteristic length of the system
    /// @return Position in characteristic units
    CartesianVector3D convertPosDim2Nd(CartesianVector3D pos_d, double l_star);
 
    /// @brief Function to convert velocity from dimensional to characteristic units
    /// @param vel_d The velocity of the body in dimensional units
    /// @param l_star The characteristic length of the system
    /// @param t_star The characteristic time of the system
    /// @return Velocity in characteristic units
    CartesianVector3D convertVelDim2Nd(CartesianVector3D vel_d, double l_star, double t_star);
 
    /// @brief Function to convert position from characteristic to dimensional units
    /// @param pos_nd The position of the body in non-dimensional units
    /// @param l_star The characteristic length of the system
    /// @return Position in dimensional units
    CartesianVector3D convertPosNd2Dim(CartesianVector3D pos_nd, double l_star);
 
    /// @brief Function to convert velocity from characteristic to dimensional units
    /// @param vel_nd The velocity of the body in non-dimensional units
    /// @param l_star The characteristic length of the system
    /// @param t_star The characteristic time of the system
    /// @return Velocity in dimensional units
    CartesianVector3D convertVelNd2Dim(CartesianVector3D vel_nd, double l_star, double t_star);
 
}
 
#endif