PointMassGravityModel.h

Go to the documentation of this file.

/******************************************************************************
* Copyright (c) ATTX INC 2025. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX INC. 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 INC.
******************************************************************************/
/*
Point mass gravity model header file
 
Author: Alex Reynolds
*/
/*
Metadata for MS GUI:
imdata = {"exclude" : True}
*/
 
#ifndef MODELS_ENVIRONMENT_POINT_MASS_GRAVITY_MODEL
#define MODELS_ENVIRONMENT_POINT_MASS_GRAVITY_MODEL
 
#include "simulation/Model.h"
#include "frames/Frame.h"
#include "frames/Node.h"
#include "frames/frameutils.h"
#include "constants/planetdefaults.h"
 
namespace warptwin {

    MODEL(PointMassGravityModel)
    public:
        // TODO: Replace need for mass with direct acceleration calculation when 
        // body accel methods are implemented
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            SIGNAL(mu,                      double,                 warpos::earth_wgs84.mu)
            SIGNAL(body_mass,               double,                 1.0)
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
            SIGNAL(pos_body__f,             CartesianVector3,      CartesianVector3({0.0, 0.0, 0.0}))
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            SIGNAL(grav_force__f,           CartesianVector3,      CartesianVector3({0.0, 0.0, 0.0}))
        END_OUTPUTS
 
    protected:
        int16 execute() override; 
 
        // Temporary vectors and variables to carry out our calculations
        double _r;
        double _multiplier;
        CartesianVector3 _grav_force__planet;
    };
}
 
#endif