OrbitalElementsStateInit.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.
******************************************************************************/
/*
Orbital elements model header file
 
Author: Alex Reynolds
*/
 
#ifndef MODELS_STATES_ORBITAL_ELEMENTS_STATE_INIT_H
#define MODELS_STATES_ORBITAL_ELEMENTS_STATE_INIT_H
 
#include "core/macros.h"
#include "simulation/Model.h"
#include "six_dof_dynamics/Frame.hpp"
#include "utils/frameutils.hpp"
#include "utils/planetdefaults.h"
 
namespace modelspace {
 
    /**
     * @brief   Model to produce position/velocity vector from orbital elements
     * 
     * This model produces the xyz cartesian state of a spacecraft from 
     * orbital elements for state initialization.
    */
    class OrbitalElementsStateInit : public Model {
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            /** This is the gravitational parameter of our parent planet. Defaults to
             * Earth's gravitational parameter for ease of use */
            SIGNAL(mu,                      double,                 clockwerk::earth_wgs84.mu)
            /** The semimajor axis of the spacecraft orbit, in meters */
            SIGNAL(a,                       double,                 0.0)
            /** The orbit eccentricity */
            SIGNAL(e,                       double,                 0.0)
            /** The orbit inclination, in radians */
            SIGNAL(i,                       double,                 0.0)
            /** The orbit RAAN, in radians */
            SIGNAL(RAAN,                    double,                 0.0)
            /** The orbit argument of periapsis */
            SIGNAL(w,                       double,                 0.0)
            /** The true anomaly, in radians */
            SIGNAL(f,                       double,                 0.0)
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
 
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            /** The position of the spacecraft in a generic inertial frame */
            SIGNAL(pos__inertial,           CartesianVector3D,      CartesianVector3D({0.0,0.0,0.0}))
            /** The velocity of the spacecraft in a generic inertial frame */
            SIGNAL(vel__inertial,           CartesianVector3D,      CartesianVector3D({0.0,0.0,0.0}))
        END_OUTPUTS
 
        // Model-specific implementations of startup and derivative
        OrbitalElementsStateInit();
        OrbitalElementsStateInit(Model &pnt, const std::string &m_name="orbit_init");
        OrbitalElementsStateInit(SimulationExecutive &e, const std::string &m_name="orbit_init");
        OrbitalElementsStateInit(Model &pnt, int schedule_slot, const std::string &m_name="orbit_init");
        OrbitalElementsStateInit(SimulationExecutive &e, int schedule_slot, const std::string &m_name="orbit_init");
        virtual ~OrbitalElementsStateInit() {}
 
    protected:
        int start();
 
        // Temporary vector to hold orbital elements input
        CartesianVector6D _orbital_elements;
 
        // Temporary vectors to hold position/velocity output
        CartesianVector3D _pos;
        CartesianVector3D _vel;
    };
 
}
 
#endif