SimpleMeanWindModel.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 mean wind model header file
 
Author: James Tabony
*/
/*
Metadata for MS GUI:
imdata = {"exclude" : True}
*/
 
#ifndef MODELS_ENVIRONMENT_SIMPLE_MEAN_WIND_MODEL_H 
#define MODELS_ENVIRONMENT_SIMPLE_MEAN_WIND_MODEL_H
 
#include "simulation/Model.h"
#include "constants/unitutils.h"
#include "simulation/UniformRandom.hpp"
#include "utils/Interpolate2D.h"
 
namespace warptwin {

    MODEL(SimpleMeanWindModel)
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            SIGNAL(wind_speed_ref,          double,                 25.0*warpos::FEET_TO_METERS)
            SIGNAL(wind_azimuth_ref,        double,                 0.0)
            SIGNAL(altitude_ref,            double,                 20.0*warpos::FEET_TO_METERS)
            SIGNAL(altitude_surface,        double,                 0.0)
            SIGNAL(wind_shear_exponent,     double,                 0.2)
            SIGNAL(wind_direction_shift_max, 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_mean__NED,          CartesianVector3,      CartesianVector3({0.0, 0.0, 0.0}))
        END_OUTPUTS
 
    protected:
        int16 start() override;
        int16 execute() override;

        void _configureInternal();
 
        // Internal variable for the ordered image set of the vector shear function (see confluence)
        std::vector<double> _image_set;
 
        // Internal variable for true altitude, altitude relative to surface not WGS84 Ellipsoid
        double _altitude_true;
 
        // Internal vairbale for wind azimuth and wind magnitude
        double _azimuth;
        double _magnitude;
 
        // Internal model for generating a random number under a uniform distribution
        UniformRandom<double> _uniform_random;
 
        // Internal model for linear interlopolation
        Interpolate2D _interpolate2D_model;
    };
 
}
 
#endif