CR3BPDynamicsModel.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.
******************************************************************************/
/*
Circular restricted three body dynamics header file
 
Author: Alex Reynolds
*/
/*
Metadata for MS GUI:
imdata = {"displayname" : "Three Body Dynamics",
          "exclude" : False,
          "category" : "Dynamics"
}
aliases = {"mu_primary" : "GM Primary",
           "mu_secondary" : "GM Secondary",
           "orbit_radius" : "Orbit Radius",
           "use_canonical" : "EXCLUDE",
           "pos_synodic" : "Position",
           "vel_synodic" : "Velocity",
           "accel_synodic" : "Acceleration"
}
*/
 
#ifndef MODELS_ACTUATORS_CR3BP_DYNAMICS_MODEL_H
#define MODELS_ACTUATORS_CR3BP_DYNAMICS_MODEL_H
 
#include "core/mathmacros.h"
#include "simulation/Model.h"
#include "cr3bputils/CR3BPDynamics.h"
#include "constants/planetdefaults.h"
 
namespace warptwin {

    MODEL(CR3BPDynamicsModel)
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            SIGNAL(mu_primary,              double,                 warpos::earth_wgs84.mu)
            SIGNAL(mu_secondary,            double,                 warpos::moon_nasa.mu)
            SIGNAL(orbit_radius,            double,                 384800000)
            SIGNAL(use_canonical,           int,                    true)
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
            SIGNAL(pos_synodic,             CartesianVector3,       CartesianVector3({0.0, 0.0, 0.0}))
            SIGNAL(vel_synodic,             CartesianVector3,       CartesianVector3({0.0, 0.0, 0.0}))
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            SIGNAL(accel_synodic,           CartesianVector3,       CartesianVector3({0.0, 0.0, 0.0}))
        END_OUTPUTS
 
    protected:
        int16 start();
        int16 execute();
 
        // CR3BP conversions
        double _mu_star;
        double _l_star;
        double _t_star;
 
        CartesianVector3 _internal_pos;
        CartesianVector3 _internal_vel;
 
        std::array<double, 6> _input_states;
        std::array<double, 6> _rates;
        CR3BPDynamics _dynamics;
        CartesianVector3 _tmp;
    };
}
 
#endif