SolarPanelModel.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.
******************************************************************************/
/*
Solar panel model header file
 
Author: Alex Jackson
*/
/*
Metadata for MS GUI:
imdata = {"displayname" : "Solar Panel",
          "exclude" : False,
          "category" : "Power"
}
aliases = {"mass" : "Mass",
           "solar_irr" : "Solar Flux",
           "panel_eff" : "Solar Panel Efficiency",
           "panel_area" : "Solar Panel Area",
           "panel_normal__body" : "Panel Normal Vector",
           "sun_frame_ptr" : "Sun Frame",
           "r_sun" : "Solar Radius",
           "planet_frame_ptr" : "Planet Frame",
           "r_planet" : "Planet Radius",
           "body_frame_ptr" : "Body Frame",
           "power" : "Power",
           "vis_frac" : "Visible Fraction",
           "panel_body_fixed" : "Body Fixed Panel"
}
*/
 
#ifndef MODELS_POWER_SOLAR_PANEL_MODEL_H
#define MODELS_POWER_SOLAR_PANEL_MODEL_H 
 
#include "simulation/Model.h"
#include "models/environment/OccultationModel.h"
#include "models/support/EffectiveSolarAreaModel.h"
#include "models/power/SolarPanelPowerModel.h"
#include "models/states/FrameStateSensorModel.h"
 
namespace warptwin {

    MODEL(SolarPanelModel)  
    public:
        
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            SIGNAL(mass,                    double,                 0.0)
            SIGNAL(solar_irr,               double,                 1361.0)
            SIGNAL(panel_eff,               double,                 0.28)
            SIGNAL(panel_area,              double,                 1.0)
            SIGNAL(panel_normal__body,      CartesianVector3,       CartesianVector3({1.0,0.0,0.0}))
            SIGNAL(sun_frame_ptr,           Frame*,                 nullptr)
            SIGNAL(r_sun,                   double,                 695700000.0)
            SIGNAL(planet_frame_ptr,        Frame*,                 nullptr)
            SIGNAL(r_planet,                double,                 warpos::earth_wgs84.eq_radius)
            SIGNAL(body_frame_ptr,          Frame*,                 nullptr)
            SIGNAL(panel_body_fixed,        int,                    true)
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
        
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            SIGNAL(power,                   double,                 0.0)
            SIGNAL(vis_frac,                double,                 1.0)
        END_OUTPUTS
 
    protected:
        int16 start() override;
        int16 execute() override; 
        // Occultation model used internally
        OccultationModel _oc;
        // The frame state sensor for relative states between spacecraft and sun
        FrameStateSensorModel _fss_sc_s;
        // Effective solar area model used internally
        EffectiveSolarAreaModel _esa;
        // Solar panel power model used for internal calculations
        SolarPanelPowerModel _spp;
    };
 
}
 
#endif