EffectiveSolarAreaModel.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.
******************************************************************************/
/*
Effective Solar Area model header file
Author: Alex Jackson
*/
/*
Metadata for MS GUI:
imdata = {"displayname" : "Effective Solar Area",
          "exclude" : False,
          "category" : "Power"
}
aliases = {"pos_sc_sun__sun" : "Sun Rel. Position",
           "face_normal_vector__body" : "Panel Body Normal",
           "area" : "Surface Area",
           "quat_body_solar" : "Attitude Body/Solar",
           "eff_solar_area" : "Effective Area"
}
*/
 
#ifndef MODELS_SUPPORT_EFFECTIVE_SOLAR_AREA_H
#define MODELS_SUPPORT_EFFECTIVE_SOLAR_AREA_H
 
#include "simulation/Model.h"
#include "core/CartesianVector.hpp"
#include "dynamics/Quaternion.h"
 
namespace warptwin {

    MODEL(EffectiveSolarAreaModel)
    public:
 
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
            SIGNAL(pos_sc_sun__sun,          CartesianVector3,        CartesianVector3({0.0, 0.0, 0.0}))
            SIGNAL(face_normal_vector__body, CartesianVector3,        CartesianVector3({0.0, 0.0, 0.0}))
            SIGNAL(area,                     double,                   1.0)
            SIGNAL(quat_body_solar,          clockwerk::Quaternion,    clockwerk::Quaternion({1.0, 0.0, 0.0, 0.0}))
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            SIGNAL(eff_solar_area,          double,                 0.0)
        END_OUTPUTS
 
    protected:
        int16 execute() override; 

        CartesianVector3 _face_normal_vector__body;

        CartesianVector3 _face_normal_vector__sun;

        double _dot_product_normal_solar;
    };
 
}
 
#endif