AerodynamicsStateModel.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.
******************************************************************************/
/*
Aerodynamics state model header file
 
Author: Mickey Mathew
*/
/* 
Metadata for MS GUI:
imdata = {"displayname" : "Aerodynamic State",
          "exclude" : False,
          "category" : "Dynamics"
}
aliases = {"aero_frame_ptr" : "Vehicle Frame",
           "velo_frame_ptr" : "Velocity Frame",
           "wind_frame_ptr" : "Wind Frame",
           "v_obj__velo" : "Vehicle Velocity",
           "v_wind__wind" : "Wind Velocity",
           "speed_of_sound" : "Speed of Sound",
           "v_aero__aero" : "EXCLUDE",
           "v_inf__aero" : "V infinity",
           "angle_of_attack" : "Angle of Attack",
           "sideslip_angle" : "Sideslip Angle",
           "airspeed" : "Magnitude of Velocity",
           "mach_number" : "Mach Number",
}
*/
 
#ifndef MODELS_STATES_AERODYNAMICS_STATE_MODEL_H
#define MODELS_STATES_AERODYNAMICS_STATE_MODEL_H
 
#include "simulation/Model.h" 
#include "frames/Frame.h"
 
namespace warptwin {

    MODEL(AerodynamicsStateModel)
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            SIGNAL(aero_frame_ptr,          Frame*,                nullptr)
            SIGNAL(velo_frame_ptr,          Frame*,                nullptr) 
            SIGNAL(wind_frame_ptr,          Frame*,                nullptr) 
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
            SIGNAL(v_obj__velo,             CartesianVector3,      CartesianVector3({0.0, 0.0, 0.0}))
            SIGNAL(v_wind__wind,            CartesianVector3,      CartesianVector3({0.0, 0.0, 0.0}))
            SIGNAL(speed_of_sound,          double,                 343.0)
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            SIGNAL(v_aero__aero,            CartesianVector3,      CartesianVector3({0.0, 0.0, 0.0}))
            SIGNAL(v_inf__aero,             CartesianVector3,      CartesianVector3({0.0, 0.0, 0.0}))
            SIGNAL(angle_of_attack,         double,                  0.0)
            SIGNAL(sideslip_angle,          double,                  0.0)
            SIGNAL(airspeed,                double,                  0.0)
            SIGNAL(mach_number,             double,                  0.0)
        END_OUTPUTS
 
    protected:
        int16 start() override;
        int16 execute() override;
        
        // Temporary vectors and variables to carry out our calculations
        CartesianVector3 _v_obj__aero;
        CartesianVector3 _v_wind__aero;
        double _safesqrtresult;
    };
 
}
 
#endif