stateinit.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.
******************************************************************************/
/*
Orbit Utilities header file
---------------------------
This file contains orbit utilities for converting between "classical"
keplerian orbital elements and xyz cartesian position and velocity.
 
TODO: Protect edge cases in these files. Right now they only work for 
elliptical orbits
 
The converters in this file are based on those found in Vallado's 
Fundamentals of Astrodynamics and Applications, fourth edition, Chapter
2.5. The test cases are drawn from that text as well.
 
Author: Alex Reynolds
*/
#ifndef STATE_INIT_H
#define STATE_INIT_H
 
#include "core/macros.h"
#include "core/CartesianVector.hpp"
#include "six_dof_dynamics/Frame.hpp"
 
namespace modelspace {
 
    /// @brief Function to initialize frame target relative to freame reference inertially
    /// @param target The target frame whose state we want to set
    /// @param reference The frame we are setting state relative to
    /// @param pos_tgt_ref__ref The position of target relative to reference, in ref frame coordinates
    /// @param vel_tgt_ref__ref The inertial velocity of target origin relative to reference origin, in ref frame coords
    /// @return Error code corresponding to success/failure
    int frameRelativeInit(FrameD &target, FrameD &reference,
                        const CartesianVector3D &pos_tgt_ref__ref, const CartesianVector3D &vel_tgt_ref__ref);
 
    /// @brief Function to initialize a body's position and velocity from an orbit
    /// @param target The target frame to initialize
    /// @param planet The planet frame our orbit is relative to
    /// @param mu Gravitational parameter of the planet
    /// @param a Orbit semimajor axis, in meters
    /// @param e Orbit eccentricity
    /// @param i Orbit inclination, radians
    /// @param RAAN Orbit Right Ascention of the Ascending Node, radians
    /// @param w Orbit argument of periapsis, radians
    /// @param f Orbit true anomaly, radians
    /// @return Error code corresponding to success/failure
    int orbitInit(FrameD &target, FrameD &planet, double mu, double a, double e, double i, double RAAN, double w, double f);
 
}
 
#endif