SimpleDisturbanceWindModel.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.
******************************************************************************/
/*
Simple disturbance wind model header file
 
Author: James Tabony
*/
/*
Metadata for MS GUI:
imdata = {"exclude" : True}
*/
 
#ifndef MODELS_ENVIRONMENT_SIMPLE_DISTURBANCE_WIND_MODEL_H 
#define MODELS_ENVIRONMENT_SIMPLE_DISTURBANCE_WIND_MODEL_H
 
#include "simulation/Model.h"
#include "simulation/NormalRandom.hpp"
#include "utils/Interpolate2D.h"
 
namespace warptwin {

    MODEL(SimpleDisturbanceWindModel)
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            SIGNAL(wind_speed_ref,          double,                 15.4333)
            SIGNAL(altitude_surface,        double,                 0.0)
            SIGNAL(seed_value,              int,                    0)
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
            SIGNAL(altitude,                double,                 0.0)
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            SIGNAL(wind_dist__MWF,          CartesianVector3,      CartesianVector3({0.0, 0.0, 0.0}))
        END_OUTPUTS
 
    protected:
        int16 start() override;
        int16 execute() override;

        void _configureInternal();
 
        // Internal variables for turbulence intensity and scale length in each direction
        double _turb_intensity_u;
        double _turb_intensity_v;
        double _turb_intensity_w;
        double _scale_length_u;
        double _scale_length_v;
        double _scale_length_w;
 
        // Interal variable for the altitude in feet
        double _altitude_feet;
 
        // Internal variables for the output wind components (feet/second)
        double _wind_u_feet;
        double _wind_v_feet;
        double _wind_w_feet;
 
        // Internal model for generating a random number under a uniform distribution
        NormalRandom<double>* _normal_random;
 
        // Internal model for linear interlopolation
        Interpolate2D _interpolate2D_model;
    };
 
}
 
#endif