SynodicFrameManagerModel.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.
******************************************************************************/
/*
Three body synodic frame manager header file
 
Author: Alex Reynolds
*/
 
#ifndef MODELS_SUPPORT_SYNODIC_FRAME_MODEL_H
#define MODELS_SUPPORT_SYNODIC_FRAME_MODEL_H
 
#include "core/macros.h"
#include "simulation/Model.h"
#include "six_dof_dynamics/Frame.hpp"
#include "utils/frameutils.hpp"
 
namespace modelspace {
 
    /**
     * @brief   Synodic Frame Manager Model
     * 
     * This model creates and maintains the three-body system Synodic frame
     * according to the definition here:
     * https://core.ac.uk/download/pdf/36695384.pdf
     * 
     * It creates a frame as a child of the simulation executive root frame.
     * This is a key assumption -- see below.
     * 
     * Definition:
     * Frame centered at the barycenter of the three body system (root frame origin)
     * +X axis directed from the primary body to the secondary body
     * +Z axis directed along the second body's angular momentum vector
     * +Y axis completes the right hand frame
     * 
     * Key assumptions:
     * - The simulation executive root frame is centered at the barycenter of the
     *   three-body system
    */
    class SynodicFrameManagerModel : public modelspace::Model {
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            /** The inertial parent frame which the target frame is orbiting */
            SIGNAL(primary_planet_ptr,      FrameD*,                nullptr)
            /** The reference target frame to which the LVLH frame should attach */
            SIGNAL(secondary_planet_ptr,    FrameD*,                nullptr)
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
 
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            /** The LVLH frame produced by this model */
            SIGNAL(synodic_frame_ptr,       FrameD*,                nullptr)
        END_OUTPUTS
 
        // Model-specific implementations of startup and derivative
        SynodicFrameManagerModel() : modelspace::Model() {outputs.synodic_frame_ptr(&_synodic_frame);}
        SynodicFrameManagerModel(modelspace::Model &pnt, int schedule_slot=0, const std::string &m_name="lvlh_frame_manager")
            : Model(pnt, schedule_slot, m_name) {outputs.synodic_frame_ptr(&_synodic_frame);}
        SynodicFrameManagerModel(modelspace::SimulationExecutive &e, int schedule_slot=0, const std::string &m_name="lvlh_frame_manager")
            : Model(e, schedule_slot, m_name) {outputs.synodic_frame_ptr(&_synodic_frame);}
        virtual ~SynodicFrameManagerModel() {}
 
    protected:
        int start();
        int execute();
 
        /// @brief  This is the actual LVLH frame
        FrameD _synodic_frame = FrameD("synodic_frame");
 
        /// @brief Temporary variable to hold lvlh attitude
        DCMD _synodic_attitude__r;
    };
 
}
 
#endif