EffectiveSolarAreaModel.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.
******************************************************************************/
/*
Effective Solar Area model header file
Author: Alex Jackson
*/
 
#ifndef MODELS_SUPPORT_EFFECTIVE_SOLAR_AREA_H
#define MODELS_SUPPORT_EFFECTIVE_SOLAR_AREA_H
 
#include "core/macros.h"
#include "simulation/Model.h"
#include "core/CartesianVector.hpp"
#include "six_dof_dynamics/Quaternion.hpp"
 
namespace modelspace {
 
    /**
     * @brief   Effective Solar Area model
     * 
     * This model defines simple solar area of a flat surface. This is computed by
     * taking the dot product of the normal vector of the surface and the solar vector. 
     * This value is expected to be negative if the panel is illuminated. If the value is 
     * positive, then the value is set to zero. If the value is negative, then the value is
     * negated to become positive. This value is then multiplied by the area of the surface.
     * 
     * Author: Alex Jackson
     * Email: alex.jackson@attx.tech 
    */
    class EffectiveSolarAreaModel : public Model {
    public:
 
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
            /** The solar vector in the solar frame (Sun to spacecraft)*/
            SIGNAL(pos_sc_sun__sun,              CartesianVector3D,        CartesianVector3D({0.0, 0.0, 0.0}))
            /** The normal vector pointing out of the surface in the body frame*/
            SIGNAL(face_normal_vector__body,             CartesianVector3D,        CartesianVector3D({0.0, 0.0, 0.0}))
            /** The area of the surface */
            SIGNAL(area,                    double,                  1.0)
            /** The quaternion relating the body frame to the solar frame */
            SIGNAL(quat_body_solar,        QuaternionD,              QuaternionD({1.0, 0.0, 0.0, 0.0}))
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            /** The effective solar area */
            SIGNAL(eff_solar_area,          double,                 0.0)
        END_OUTPUTS
 
        // Model-specific implementations of startup and derivative
        EffectiveSolarAreaModel();
        EffectiveSolarAreaModel(Model &pnt, const std::string &m_name="effective_solar_area");
        EffectiveSolarAreaModel(SimulationExecutive &e, const std::string &m_name="effective_solar_area");
        EffectiveSolarAreaModel(Model &pnt, int schedule_slot, const std::string &m_name="effective_solar_area");
        EffectiveSolarAreaModel(SimulationExecutive &e, int schedule_slot, const std::string &m_name="effective_solar_area");
        ~EffectiveSolarAreaModel() {}
 
    protected:
        int execute();
 
        /// @brief Temporary variable to hold the vector that is normal to the surface after converting to the solar frame
        CartesianVector3D _face_normal_vector__sun;
 
        /// @brief Temporary variable to hold the result of the dot product between the normal vector and solar vector
        double _dot_product_normal_solar;
    };
 
}
 
#endif