PointMassGravityModel.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.
******************************************************************************/
/*
Point mass gravity model header file
 
Author: Alex Reynolds
*/
 
#ifndef MODELS_ENVIRONMENT_POINT_MASS_GRAVITY_MODEL
#define MODELS_ENVIRONMENT_POINT_MASS_GRAVITY_MODEL
 
#include "core/macros.h"
#include "simulation/Model.h"
#include "six_dof_dynamics/Frame.hpp"
#include "six_dof_dynamics/Node.hpp"
#include "utils/frameutils.hpp"
#include "utils/planetdefaults.h"
 
namespace modelspace {
 
    /**
     * @brief   Point mass gravity model
     * 
     * This model generates forces acting on a body under the influence of a 
     * simple point mass gravity field. 
    */
    class PointMassGravityModel : public Model {
    public:
        // TODO: Replace need for mass with direct acceleration calculation when 
        // body accel methods are implemented
        // 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)
            /** This is the mass of the body, which will be multiplied by our force
             *  to get the force calculation... TODO to replace this with accel methods */
            SIGNAL(body_mass,               double,                 1.0)
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
            /** The position of the object body in the reference frame f */
            SIGNAL(pos_body__f,             CartesianVector3D,      CartesianVector3D({0.0, 0.0, 0.0}))
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            /** This is the acceleration due to gravity calculated in the same reference frame as pos_body__f */
            SIGNAL(grav_force__f,           CartesianVector3D,      CartesianVector3D({0.0, 0.0, 0.0}))
        END_OUTPUTS
 
        // Model-specific implementations of startup and derivative
        PointMassGravityModel();
        PointMassGravityModel(Model &pnt, const std::string &m_name="point_mass_gravity");
        PointMassGravityModel(SimulationExecutive &e, const std::string &m_name="point_mass_gravity");
        PointMassGravityModel(Model &pnt, int schedule_slot, const std::string &m_name="point_mass_gravity");
        PointMassGravityModel(SimulationExecutive &e, int schedule_slot, const std::string &m_name="point_mass_gravity");
        ~PointMassGravityModel() {}
 
    protected:
        int execute();
 
        // Temporary vectors and variables to carry out our calculations
        double _r;
        double _multiplier;
        CartesianVector3D _grav_force__planet;
    };
}
 
#endif