 |
JSBSim Flight Dynamics Model
1.2.0 (05 Nov 2023)
An Open Source Flight Dynamics and Control Software Library in C++
|
|
JSBSim Flight Dynamics Model
1.2.0 (05 Nov 2023)
An Open Source Flight Dynamics and Control Software Library in C++
|
Models atmospheric disturbances: winds, gusts, turbulence, downbursts, etc.
Various turbulence models are available. They are specified via the property atmosphere/turb-type. The following models are available:
The Milspec and Tustin models are described in the Yeager report cited below. They both use a Dryden spectrum model whose parameters (scale lengths and intensities) are modelled according to MIL-F-8785C. Parameters are modelled differently for altitudes below 1000ft and above 2000ft, for altitudes in between they are interpolated linearly.
The two models differ in the implementation of the transfer functions described in the milspec.
To use one of these two models, set atmosphere/turb-type to 4 resp. 5, and specify values for atmosphere/turbulence/milspec/windspeed_at_20ft_AGL-fps and atmosphere/turbulence/milspec/severity (the latter corresponds to the probability of exceedence curves from Fig. 7 of the milspec, allowable range is 0 (disabled) to 7). atmosphere/psiw-rad is respected as well; note that you have to specify a positive wind magnitude to prevent psiw from being reset to zero.
Reference values (cf. figures 7 and 9 from the milspec):
| Intensity | windspeed_at_20ft_AGL-fps | severity |
| light | 25 (15 knots) | 3 |
| moderate | 50 (30 knots) | 4 |
| severe | 75 (45 knots) | 6 |
A one minus cosine gust model is available. This permits a configurable, predictable gust to be input to JSBSim for testing handling and dynamics. Here is how a gust can be entered in a script:
The x, y, z velocity components are meant to define the direction vector. The vector will be normalized by the routine, so it does not need to be a unit vector.
The startup duration is the time it takes to build up to full strength (magnitude-ft_sec) from zero. Steady duration is the time the gust stays at the specified magnitude. End duration is the time it takes to dwindle to zero from the specified magnitude. The start and end transients are in a smooth cosine shape.
The frame is specified from the following enum:
enum eGustFrame {gfNone=0, gfBody, gfWind, gfLocal};
That is, if you specify the X, Y, Z gust direction vector in the body frame, frame will be "1". If the X, Y, and Z gust direction vector is in the Wind frame, use frame = 2. If you specify the gust direction vector in the local frame (N-E-D) use frame = 3. Note that an internal local frame direction vector is created based on the X, Y, Z direction vector you specify and the frame at the time the gust is begun. The direction vector is not updated after the initial creation. This is to keep the gust at the same direction independent of aircraft dynamics.
The gust is triggered when the property atmosphere/cosine-gust/start is set to 1. It can be used repeatedly - the gust resets itself after it has completed.
The cosine gust is global: it affects the whole world not just the vicinity of the aircraft.
#include <FGWinds.h>
Inheritance diagram for FGWinds: Collaboration diagram for FGWinds:Classes | |
| struct | Inputs |
| struct | OneMinusCosineGust |
| Stores the information about a single one minus cosine gust instance. More... | |
| struct | OneMinusCosineProfile |
| struct | UpDownBurst |
| Stores information about a specified Up- or Down-burst. More... | |
Public Types | |
| enum | eGustFrame { gfNone =0 , gfBody , gfWind , gfLocal } |
| enum | tType { ttNone , ttStandard , ttCulp , ttMilspec , ttTustin } |
| Public Types inherited from FGJSBBase | |
| enum | { eL = 1 , eM , eN } |
| Moments L, M, N. | |
| enum | { eP = 1 , eQ , eR } |
| Rates P, Q, R. | |
| enum | { eU = 1 , eV , eW } |
| Velocities U, V, W. | |
| enum | { eX = 1 , eY , eZ } |
| Positions X, Y, Z. | |
| enum | { ePhi = 1 , eTht , ePsi } |
| Euler angles Phi, Theta, Psi. | |
| enum | { eDrag = 1 , eSide , eLift } |
| Stability axis forces, Drag, Side force, Lift. | |
| enum | { eRoll = 1 , ePitch , eYaw } |
| Local frame orientation Roll, Pitch, Yaw. | |
| enum | { eNorth = 1 , eEast , eDown } |
| Local frame position North, East, Down. | |
| enum | { eLat = 1 , eLong , eRad } |
| Locations Radius, Latitude, Longitude. | |
| enum | { inNone = 0 , inDegrees , inRadians , inMeters , inFeet } |
| Conversion specifiers. | |
Public Member Functions | |
| FGWinds (FGFDMExec *) | |
| Constructor. | |
| ~FGWinds () | |
| Destructor. | |
| virtual void | EndGustDuration (double dur) |
| Specifies the length of time it takes for the gust to return to zero velocity. | |
| virtual double | GetGustNED (int idx) const |
| Retrieves a gust component in NED frame. | |
| virtual const FGColumnVector3 & | GetGustNED (void) const |
| Retrieves the gust components in NED frame. | |
| virtual int | GetProbabilityOfExceedence () const |
| virtual double | GetRhythmicity () const |
| virtual double | GetTotalWindNED (int idx) const |
| Retrieves a total wind component in NED frame. | |
| virtual const FGColumnVector3 & | GetTotalWindNED (void) const |
| Retrieves the total wind components in NED frame. | |
| virtual double | GetTurbDirection (void) const |
| virtual double | GetTurbGain () const |
| virtual double | GetTurbMagnitude (void) const |
| virtual double | GetTurbNED (int idx) const |
| Retrieves a turbulence component in NED frame. | |
| virtual double | GetTurbPQR (int idx) const |
| virtual const FGColumnVector3 & | GetTurbPQR (void) const |
| virtual double | GetTurbRate () const |
| virtual tType | GetTurbType () const |
| virtual double | GetWindNED (int idx) const |
| Retrieves a wind component in NED frame. | |
| virtual const FGColumnVector3 & | GetWindNED (void) const |
| Retrieves the wind components in NED frame. | |
| virtual double | GetWindPsi (void) const |
| Retrieves the direction that the wind is coming from. More... | |
| virtual double | GetWindspeed (void) const |
| virtual double | GetWindspeed20ft () const |
| virtual void | GustFrame (eGustFrame gFrame) |
| Specifies the frame that the gust direction vector components are specified in. More... | |
| virtual void | GustMagnitude (double mag) |
| Specifies the magnitude of the gust in feet/second. | |
| virtual void | GustXComponent (double x) |
| Specifies the X component of velocity in the specified gust frame (ft/sec). | |
| virtual void | GustYComponent (double y) |
| Specifies the Y component of velocity in the specified gust frame (ft/sec). | |
| virtual void | GustZComponent (double z) |
| Specifies the Z component of velocity in the specified gust frame (ft/sec). | |
| bool | InitModel (void) override |
| void | NumberOfUpDownburstCells (int num) |
| bool | Run (bool Holding) override |
| Runs the winds model; called by the Executive Can pass in a value indicating if the executive is directing the simulation to Hold. More... | |
| virtual void | SetGustNED (double gN, double gE, double gD) |
| Sets the gust components in NED frame. | |
| virtual void | SetGustNED (int idx, double gust) |
| Sets a gust component in NED frame. | |
| virtual void | SetProbabilityOfExceedence (int idx) |
| allowable range: 0-7, 3=light, 4=moderate, 6=severe turbulence | |
| virtual void | SetRhythmicity (double r) |
| virtual void | SetTurbGain (double tg) |
| virtual void | SetTurbNED (int idx, double turb) |
| Sets a turbulence component in NED frame. | |
| virtual void | SetTurbRate (double tr) |
| virtual void | SetTurbType (tType tt) |
| Turbulence models available: ttNone, ttStandard, ttBerndt, ttCulp, ttMilspec, ttTustin. | |
| virtual void | SetWindNED (const FGColumnVector3 &wind) |
| Sets the wind components in NED frame. | |
| virtual void | SetWindNED (double wN, double wE, double wD) |
| Sets the wind components in NED frame. | |
| virtual void | SetWindNED (int idx, double wind) |
| Sets a wind component in NED frame. | |
| virtual void | SetWindPsi (double dir) |
| Sets the direction that the wind is coming from. More... | |
| virtual void | SetWindspeed (double speed) |
| virtual void | SetWindspeed20ft (double ws) |
| virtual void | StartGust (bool running) |
| Initiates the execution of the gust. | |
| virtual void | StartupGustDuration (double dur) |
| Specifies the duration of the startup portion of the gust. | |
| virtual void | SteadyGustDuration (double dur) |
| Specifies the length of time that the gust is at a steady, full strength. | |
| Public Member Functions inherited from FGModel | |
| FGModel (FGFDMExec *) | |
| Constructor. | |
| ~FGModel () override | |
| Destructor. | |
| virtual SGPath | FindFullPathName (const SGPath &path) const |
| FGFDMExec * | GetExec (void) |
| const std::string & | GetName (void) |
| unsigned int | GetRate (void) |
| Get the output rate for the model in frames. | |
| virtual bool | Load (Element *el) |
| void | SetPropertyManager (std::shared_ptr< FGPropertyManager > fgpm) |
| void | SetRate (unsigned int tt) |
| Set the ouput rate for the model in frames. | |
| Public Member Functions inherited from FGModelFunctions | |
| std::string | GetFunctionStrings (const std::string &delimeter) const |
| Gets the strings for the current set of functions. More... | |
| std::string | GetFunctionValues (const std::string &delimeter) const |
| Gets the function values. More... | |
| std::shared_ptr< FGFunction > | GetPreFunction (const std::string &name) |
| Get one of the "pre" function. More... | |
| bool | Load (Element *el, FGFDMExec *fdmex, std::string prefix="") |
| void | PostLoad (Element *el, FGFDMExec *fdmex, std::string prefix="") |
| void | PreLoad (Element *el, FGFDMExec *fdmex, std::string prefix="") |
| void | RunPostFunctions (void) |
| void | RunPreFunctions (void) |
| Public Member Functions inherited from FGJSBBase | |
| FGJSBBase () | |
| Constructor for FGJSBBase. | |
| virtual | ~FGJSBBase () |
| Destructor for FGJSBBase. | |
| void | disableHighLighting (void) |
| Disables highlighting in the console output. | |
Public Attributes | |
| struct JSBSim::FGWinds::Inputs | in |
| enum JSBSim::FGWinds::tType | turbType |
Additional Inherited Members | |
| Static Public Member Functions inherited from FGJSBBase | |
| static const std::string & | GetVersion (void) |
| Returns the version number of JSBSim. More... | |
| static constexpr double | KelvinToFahrenheit (double kelvin) |
| Converts from degrees Kelvin to degrees Fahrenheit. More... | |
| static constexpr double | CelsiusToRankine (double celsius) |
| Converts from degrees Celsius to degrees Rankine. More... | |
| static constexpr double | RankineToCelsius (double rankine) |
| Converts from degrees Rankine to degrees Celsius. More... | |
| static constexpr double | KelvinToRankine (double kelvin) |
| Converts from degrees Kelvin to degrees Rankine. More... | |
| static constexpr double | RankineToKelvin (double rankine) |
| Converts from degrees Rankine to degrees Kelvin. More... | |
| static constexpr double | FahrenheitToCelsius (double fahrenheit) |
| Converts from degrees Fahrenheit to degrees Celsius. More... | |
| static constexpr double | CelsiusToFahrenheit (double celsius) |
| Converts from degrees Celsius to degrees Fahrenheit. More... | |
| static constexpr double | CelsiusToKelvin (double celsius) |
| Converts from degrees Celsius to degrees Kelvin. More... | |
| static constexpr double | KelvinToCelsius (double kelvin) |
| Converts from degrees Kelvin to degrees Celsius. More... | |
| static constexpr double | FeetToMeters (double measure) |
| Converts from feet to meters. More... | |
| static bool | EqualToRoundoff (double a, double b) |
| Finite precision comparison. More... | |
| static bool | EqualToRoundoff (float a, float b) |
| Finite precision comparison. More... | |
| static bool | EqualToRoundoff (float a, double b) |
| Finite precision comparison. More... | |
| static bool | EqualToRoundoff (double a, float b) |
| Finite precision comparison. More... | |
| static constexpr double | Constrain (double min, double value, double max) |
| Constrain a value between a minimum and a maximum value. | |
| static constexpr double | sign (double num) |
| Static Public Attributes inherited from FGJSBBase | |
| static char | highint [5] = {27, '[', '1', 'm', '\0' } |
| highlights text | |
| static char | halfint [5] = {27, '[', '2', 'm', '\0' } |
| low intensity text | |
| static char | normint [6] = {27, '[', '2', '2', 'm', '\0' } |
| normal intensity text | |
| static char | reset [5] = {27, '[', '0', 'm', '\0' } |
| resets text properties | |
| static char | underon [5] = {27, '[', '4', 'm', '\0' } |
| underlines text | |
| static char | underoff [6] = {27, '[', '2', '4', 'm', '\0' } |
| underline off | |
| static char | fgblue [6] = {27, '[', '3', '4', 'm', '\0' } |
| blue text | |
| static char | fgcyan [6] = {27, '[', '3', '6', 'm', '\0' } |
| cyan text | |
| static char | fgred [6] = {27, '[', '3', '1', 'm', '\0' } |
| red text | |
| static char | fggreen [6] = {27, '[', '3', '2', 'm', '\0' } |
| green text | |
| static char | fgdef [6] = {27, '[', '3', '9', 'm', '\0' } |
| default text | |
| static short | debug_lvl = 1 |
| Protected Member Functions inherited from FGModel | |
| bool | Upload (Element *el, bool preLoad) |
| Uploads this model in memory. More... | |
| Static Protected Member Functions inherited from FGJSBBase | |
| static std::string | CreateIndexedPropertyName (const std::string &Property, int index) |
| Protected Attributes inherited from FGModel | |
| unsigned int | exe_ctr |
| FGFDMExec * | FDMExec |
| std::string | Name |
| std::shared_ptr< FGPropertyManager > | PropertyManager |
| unsigned int | rate |
| Protected Attributes inherited from FGModelFunctions | |
| FGPropertyReader | LocalProperties |
| std::vector< std::shared_ptr< FGFunction > > | PostFunctions |
| std::vector< std::shared_ptr< FGFunction > > | PreFunctions |
| Static Protected Attributes inherited from FGJSBBase | |
| static constexpr double | radtodeg = 180. / M_PI |
| static constexpr double | degtorad = M_PI / 180. |
| static constexpr double | hptoftlbssec = 550.0 |
| static constexpr double | psftoinhg = 0.014138 |
| static constexpr double | psftopa = 47.88 |
| static constexpr double | fttom = 0.3048 |
| static constexpr double | ktstofps = 1852./(3600*fttom) |
| static constexpr double | fpstokts = 1.0 / ktstofps |
| static constexpr double | inchtoft = 1.0/12.0 |
| static constexpr double | m3toft3 = 1.0/(fttom*fttom*fttom) |
| static constexpr double | in3tom3 = inchtoft*inchtoft*inchtoft/m3toft3 |
| static constexpr double | inhgtopa = 3386.38 |
| static constexpr double | slugtolb = 32.174049 |
| Note that definition of lbtoslug by the inverse of slugtolb and not to a different constant you can also get from some tables will make lbtoslug*slugtolb == 1 up to the magnitude of roundoff. More... | |
| static constexpr double | lbtoslug = 1.0/slugtolb |
| static constexpr double | kgtolb = 2.20462 |
| static constexpr double | kgtoslug = 0.06852168 |
| static const std::string | needed_cfg_version = "2.0" |
| static const std::string | JSBSim_version = JSBSIM_VERSION " " __DATE__ " " __TIME__ |
|
inlinevirtual |
|
inlinevirtual |
Specifies the frame that the gust direction vector components are specified in.
The body frame is defined with the X direction forward, and the Y direction positive out the right wing. The wind frame is defined with the X axis pointing into the velocity vector, the Z axis perpendicular to the X axis, in the aircraft XZ plane, and the Y axis completing the system. The local axis is a navigational frame with X pointing north, Y pointing east, and Z pointing down. This is a locally vertical, locally horizontal frame, with the XY plane tangent to the geocentric surface.
Definition at line 344 of file FGWinds.h.
|
overridevirtual |
Runs the winds model; called by the Executive Can pass in a value indicating if the executive is directing the simulation to Hold.
| Holding | if true, the executive has been directed to hold the sim from advancing time. Some models may ignore this flag, such as the Input model, which may need to be active to listen on a socket for the "Resume" command to be given. |
Reimplemented from FGModel.
Definition at line 140 of file FGWinds.cpp.
Here is the call graph for this function:
|
virtual |
Sets the direction that the wind is coming from.
The direction is defined as north=0 and increases counterclockwise to 2*pi (radians). The vertical component of wind is assumed to be zero - and is forcibly set to zero. This function sets the vWindNED vector components based on the supplied direction. The magnitude of the wind set in the vector is preserved (assuming the vertical component is non-zero).
| dir | wind direction in the horizontal plane, in radians. |
Definition at line 185 of file FGWinds.cpp.
1.9.1 
