PlanetInfo.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.
******************************************************************************/
/*
Simple Planet header file
 
Author: Alex Reynolds
*/
 
#ifndef MODELS_ASSEMBLIES_PLANET_INFO_MODEL_H
#define MODELS_ASSEMBLIES_PLANET_INFO_MODEL_H
 
#include "core/macros.h"
#include "core/CartesianVector.hpp"
#include "simulation/Model.h"
#include "utils/planetdefaults.h"
 
namespace modelspace {
 
    /**
     * @brief   Planet Information Model
     * 
     * The planet info model is a simple model designed to capture planet information,
     * which is currently held in clockwerk/utils/defaults.h. It is configured based 
     * on the name of the planet, which is parameterized at sim start. If the planet
     * name input by the user cannot be found, the planet information model will raise
     * an error on sim start.
     * 
     * Author: Alex Reynolds <alex.reynolds@attx.tech>
    */
    class PlanetInfo : public Model {
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            /** The planet name which will be used to query data from planetinfo */
            SIGNAL(planet_name,             std::string,            "earth")
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
 
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            /** A pointer to the planet info object itself for easy passing to other models.
             *  Is a void pointer and must be cast in downstream model. Nullptr is set to 
             *  self in constructor. */
            SIGNAL(self_id,                 void*,                  nullptr)
            /** Equatorial radius of the planet, in meters. Default is Earth R per WGS84 */
            SIGNAL(semimajor_axis,          double,                 clockwerk::earth_wgs84.semimajor_axis)
            /** Flattening for the planet. Default is WGS84 flattening */
            SIGNAL(flattening,              double,                 clockwerk::earth_wgs84.flattening)
            /** Gravitational parameter for planet. Default is WGS84 value */
            SIGNAL(mu,                      double,                 clockwerk::earth_wgs84.mu)
            /** J2 parameter for planet. Default is derived from WGS84 but inexact. */
            SIGNAL(J2,                      double,                 clockwerk::earth_wgs84.J2)
            /** J3 parameter for planet. Default is derived from WGS84 but inexact. */
            SIGNAL(J3,                      double,                 clockwerk::earth_wgs84.J3)
            /** Mean angular velocity of the planet. Assumes rotation about Z axis. Default is WGS84 Earth. */
            SIGNAL(mean_ang_vel,            CartesianVector3D,      CartesianVector3D({0.0,0.0,clockwerk::earth_wgs84.semimajor_axis}))
        END_OUTPUTS
 
        // Model-specific implementations of startup and derivative
        PlanetInfo();
        PlanetInfo(Model &pnt, const std::string &m_name="earth_info");
        PlanetInfo(SimulationExecutive &e, const std::string &m_name="earth_info");
        ~PlanetInfo() {}
    protected:
        int start();
    };
 
}
 
#endif