SpicePlanet.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.
******************************************************************************/
/*
SPICE Planet header file
 
Author: Alex Reynolds
*/
 
#ifndef MODELS_ASSEMBLIES_SPICE_PLANET_MODEL_H
#define MODELS_ASSEMBLIES_SPICE_PLANET_MODEL_H
 
#include "core/macros.h"
#include "core/CartesianVector.hpp"
#include "simulation/Model.h"
#include "six_dof_dynamics/Frame.hpp"
#include "simulation/SimScheduler.h"
 
namespace modelspace {
 
    /**
     * @brief   The model to maintain planet state using SPICE
     * 
     * The SPICE planet mode uses the JPL cspice framework to
     * generate highly precise planet state. 
     * 
     * All planet states are set with the inertial state aligned
     * to the J2000 frame. The rotating frame is then set at the
     * same position. The root frame is treated as the base of the
     * J2000 frame used in SPICE, as observed from the Sun. 
     * All states are set relative to that point using the TDB 
     * time maintained by the simulation.
     * 
     * All DISTANCE units are meters or meters/second
     * All ANGULAR RATE units are radians/second
     * 
     * Author: Alex Reynolds <alex.reynolds@attx.tech>
    */
    class SpicePlanet : public Model {
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            /** This flag enables or disables outputting attitude states from the SPICE planet. True is enabled */
            SIGNAL(enable_attitude,         int,                    true)
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
 
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            /** Accessor to the inertial frame of the planet. Set to point to _planet_inertial in constructor. */
            SIGNAL(inertial_frame,          FrameD*,                nullptr)
            /** Accessor to the rotating frame of the planet. Set to point to _planet_inertial in constructor. */
            SIGNAL(rotating_frame,          FrameD*,                nullptr)
        END_OUTPUTS
 
        // Model-specific implementations of startup and derivative
        SpicePlanet(SimulationExecutive &e, const std::string &m_name="earth");
        ~SpicePlanet() {}
    protected:
        int start();
        int execute();
 
        // The inertial frame of the planet
        FrameD _planet_inertial = FrameD("planet_inertial_frame");
 
        // The planet rotating frame
        FrameD _planet_rotating = FrameD("planet_rotating_frame");
 
        // Temporary state variables to hold calculations from spice
        DCMD _tmp_dcm_p_pci;
        CartesianVector3D _tmp_vec;
        std::string _attitude_name;
    };
 
}
 
#endif