JSBSim Flight Dynamics Model  1.1.11 (13 Feb 2022)
An Open Source Flight Dynamics and Control Software Library in C++
FGWinds.cpp
1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 
3  Module: FGWinds.cpp
4  Author: Jon Berndt, Tony Peden, Andreas Gaeb
5  Date started: Extracted from FGAtmosphere, which originated in 1998
6  5/2011
7  Purpose: Models winds, gusts, turbulence, and other atmospheric
8  disturbances
9  Called by: FGFDMExec
10 
11  ------------- Copyright (C) 2011 Jon S. Berndt (jon@jsbsim.org) -------------
12 
13  This program is free software; you can redistribute it and/or modify it under
14  the terms of the GNU Lesser General Public License as published by the Free
15  Software Foundation; either version 2 of the License, or (at your option) any
16  later version.
17 
18  This program is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20  FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
21  details.
22 
23  You should have received a copy of the GNU Lesser General Public License along
24  with this program; if not, write to the Free Software Foundation, Inc., 59
25  Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 
27  Further information about the GNU Lesser General Public License can also be
28  found on the world wide web at http://www.gnu.org.
29 
30 FUNCTIONAL DESCRIPTION
31 --------------------------------------------------------------------------------
32 
33 HISTORY
34 --------------------------------------------------------------------------------
35 
36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
37 COMMENTS, REFERENCES, and NOTES
38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
39 [1] Anderson, John D. "Introduction to Flight, Third Edition", McGraw-Hill,
40  1989, ISBN 0-07-001641-0
41 
42 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
43 INCLUDES
44 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
45 
46 #include "FGWinds.h"
47 #include "FGFDMExec.h"
48 #include "math/FGTable.h"
49 
50 using namespace std;
51 
52 namespace JSBSim {
53 
54 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
55 CLASS IMPLEMENTATION
56 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
57 
58 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
59 // square a value, but preserve the original sign
60 
61 /*
62 static inline double square_signed (double value)
63 {
64  if (value < 0)
65  return value * value * -1;
66  else
67  return value * value;
68 }
69 */
70 
72 constexpr double sqr(double x) { return x*x; }
73 
74 FGWinds::FGWinds(FGFDMExec* fdmex) : FGModel(fdmex)
75 {
76  Name = "FGWinds";
77 
78  MagnitudedAccelDt = MagnitudeAccel = Magnitude = TurbDirection = 0.0;
79  SetTurbType( ttMilspec );
80  TurbGain = 1.0;
81  TurbRate = 10.0;
82  Rhythmicity = 0.1;
83  spike = target_time = strength = 0.0;
84  wind_from_clockwise = 0.0;
85  psiw = 0.0;
86 
87  vGustNED.InitMatrix();
88  vTurbulenceNED.InitMatrix();
89  vCosineGust.InitMatrix();
90 
91  // Milspec turbulence model
92  windspeed_at_20ft = 0.;
93  probability_of_exceedence_index = 0;
94  POE_Table = new FGTable(7,12);
95  // this is Figure 7 from p. 49 of MIL-F-8785C
96  // rows: probability of exceedance curve index, cols: altitude in ft
97  *POE_Table
98  << 500.0 << 1750.0 << 3750.0 << 7500.0 << 15000.0 << 25000.0 << 35000.0 << 45000.0 << 55000.0 << 65000.0 << 75000.0 << 80000.0
99  << 1 << 3.2 << 2.2 << 1.5 << 0.0 << 0.0 << 0.0 << 0.0 << 0.0 << 0.0 << 0.0 << 0.0 << 0.0
100  << 2 << 4.2 << 3.6 << 3.3 << 1.6 << 0.0 << 0.0 << 0.0 << 0.0 << 0.0 << 0.0 << 0.0 << 0.0
101  << 3 << 6.6 << 6.9 << 7.4 << 6.7 << 4.6 << 2.7 << 0.4 << 0.0 << 0.0 << 0.0 << 0.0 << 0.0
102  << 4 << 8.6 << 9.6 << 10.6 << 10.1 << 8.0 << 6.6 << 5.0 << 4.2 << 2.7 << 0.0 << 0.0 << 0.0
103  << 5 << 11.8 << 13.0 << 16.0 << 15.1 << 11.6 << 9.7 << 8.1 << 8.2 << 7.9 << 4.9 << 3.2 << 2.1
104  << 6 << 15.6 << 17.6 << 23.0 << 23.6 << 22.1 << 20.0 << 16.0 << 15.1 << 12.1 << 7.9 << 6.2 << 5.1
105  << 7 << 18.7 << 21.5 << 28.4 << 30.2 << 30.7 << 31.0 << 25.2 << 23.1 << 17.5 << 10.7 << 8.4 << 7.2;
106 
107  bind();
108  Debug(0);
109 }
110 
111 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
112 
114 {
115  delete(POE_Table);
116  Debug(1);
117 }
118 
119 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
120 
121 bool FGWinds::InitModel(void)
122 {
123  if (!FGModel::InitModel()) return false;
124 
125  psiw = 0.0;
126 
127  vGustNED.InitMatrix();
128  vTurbulenceNED.InitMatrix();
129  vCosineGust.InitMatrix();
130 
131  oneMinusCosineGust.gustProfile.Running = false;
132  oneMinusCosineGust.gustProfile.elapsedTime = 0.0;
133 
134  return true;
135 }
136 
137 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
138 
139 bool FGWinds::Run(bool Holding)
140 {
141  if (FGModel::Run(Holding)) return true;
142  if (Holding) return false;
143 
144  if (turbType != ttNone) Turbulence(in.AltitudeASL);
145  if (oneMinusCosineGust.gustProfile.Running) CosineGust();
146 
147  vTotalWindNED = vWindNED + vGustNED + vCosineGust + vTurbulenceNED;
148 
149  // psiw (Wind heading) is the direction the wind is blowing towards
150  if (vWindNED(eX) != 0.0) psiw = atan2( vWindNED(eY), vWindNED(eX) );
151  if (psiw < 0) psiw += 2*M_PI;
152 
153  Debug(2);
154  return false;
155 }
156 
157 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
158 //
159 // psi is the angle that the wind is blowing *towards*
160 
161 void FGWinds::SetWindspeed(double speed)
162 {
163  if (vWindNED.Magnitude() == 0.0) {
164  psiw = 0.0;
165  vWindNED(eNorth) = speed;
166  } else {
167  vWindNED(eNorth) = speed * cos(psiw);
168  vWindNED(eEast) = speed * sin(psiw);
169  vWindNED(eDown) = 0.0;
170  }
171 }
172 
173 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
174 
175 double FGWinds::GetWindspeed(void) const
176 {
177  return vWindNED.Magnitude();
178 }
179 
180 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
181 //
182 // psi is the angle that the wind is blowing *towards*
183 
184 void FGWinds::SetWindPsi(double dir)
185 {
186  double mag = GetWindspeed();
187  psiw = dir;
188  SetWindspeed(mag);
189 }
190 
191 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
192 
193 void FGWinds::Turbulence(double h)
194 {
195  switch (turbType) {
196 
197  case ttCulp: {
198 
199  vTurbPQR(eP) = wind_from_clockwise;
200  if (TurbGain == 0.0) return;
201 
202  // keep the inputs within allowable limts for this model
203  if (TurbGain < 0.0) TurbGain = 0.0;
204  if (TurbGain > 1.0) TurbGain = 1.0;
205  if (TurbRate < 0.0) TurbRate = 0.0;
206  if (TurbRate > 30.0) TurbRate = 30.0;
207  if (Rhythmicity < 0.0) Rhythmicity = 0.0;
208  if (Rhythmicity > 1.0) Rhythmicity = 1.0;
209 
210  // generate a sine wave corresponding to turbulence rate in hertz
211  double time = FDMExec->GetSimTime();
212  double sinewave = sin( time * TurbRate * 6.283185307 );
213 
214  double random = 0.0;
215  if (target_time == 0.0) {
216  strength = random = 1 - 2.0*(double(rand())/double(RAND_MAX));
217  target_time = time + 0.71 + (random * 0.5);
218  }
219  if (time > target_time) {
220  spike = 1.0;
221  target_time = 0.0;
222  }
223 
224  // max vertical wind speed in fps, corresponds to TurbGain = 1.0
225  double max_vs = 40;
226 
227  vTurbulenceNED.InitMatrix();
228  double delta = strength * max_vs * TurbGain * (1-Rhythmicity) * spike;
229 
230  // Vertical component of turbulence.
231  vTurbulenceNED(eDown) = sinewave * max_vs * TurbGain * Rhythmicity;
232  vTurbulenceNED(eDown)+= delta;
233  if (in.DistanceAGL/in.wingspan < 3.0)
234  vTurbulenceNED(eDown) *= in.DistanceAGL/in.wingspan * 0.3333;
235 
236  // Yaw component of turbulence.
237  vTurbulenceNED(eNorth) = sin( delta * 3.0 );
238  vTurbulenceNED(eEast) = cos( delta * 3.0 );
239 
240  // Roll component of turbulence. Clockwise vortex causes left roll.
241  vTurbPQR(eP) += delta * 0.04;
242 
243  spike = spike * 0.9;
244  break;
245  }
246  case ttMilspec:
247  case ttTustin: {
248 
249  // an index of zero means turbulence is disabled
250  // airspeed occurs as divisor in the code below
251  if (probability_of_exceedence_index == 0 || in.V == 0) {
252  vTurbulenceNED(eNorth) = vTurbulenceNED(eEast) = vTurbulenceNED(eDown) = 0.0;
253  vTurbPQR(eP) = vTurbPQR(eQ) = vTurbPQR(eR) = 0.0;
254  return;
255  }
256 
257  // Turbulence model according to MIL-F-8785C (Flying Qualities of Piloted Aircraft)
258  double b_w = in.wingspan, L_u, L_w, sig_u, sig_w;
259 
260  if (b_w == 0.) b_w = 30.;
261 
262  // clip height functions at 10 ft
263  if (h <= 10.) h = 10;
264 
265  // Scale lengths L and amplitudes sigma as function of height
266  if (h <= 1000) {
267  L_u = h/pow(0.177 + 0.000823*h, 1.2); // MIL-F-8785c, Fig. 10, p. 55
268  L_w = h;
269  sig_w = 0.1*windspeed_at_20ft;
270  sig_u = sig_w/pow(0.177 + 0.000823*h, 0.4); // MIL-F-8785c, Fig. 11, p. 56
271  } else if (h <= 2000) {
272  // linear interpolation between low altitude and high altitude models
273  L_u = L_w = 1000 + (h-1000.)/1000.*750.;
274  sig_u = sig_w = 0.1*windspeed_at_20ft
275  + (h-1000.)/1000.*(POE_Table->GetValue(probability_of_exceedence_index, h) - 0.1*windspeed_at_20ft);
276  } else {
277  L_u = L_w = 1750.; // MIL-F-8785c, Sec. 3.7.2.1, p. 48
278  sig_u = sig_w = POE_Table->GetValue(probability_of_exceedence_index, h);
279  }
280 
281  // keep values from last timesteps
282  // TODO maybe use deque?
283  static double
284  xi_u_km1 = 0, nu_u_km1 = 0,
285  xi_v_km1 = 0, xi_v_km2 = 0, nu_v_km1 = 0, nu_v_km2 = 0,
286  xi_w_km1 = 0, xi_w_km2 = 0, nu_w_km1 = 0, nu_w_km2 = 0,
287  xi_p_km1 = 0, nu_p_km1 = 0,
288  xi_q_km1 = 0, xi_r_km1 = 0;
289 
290 
291  double
292  T_V = in.totalDeltaT, // for compatibility of nomenclature
293  sig_p = 1.9/sqrt(L_w*b_w)*sig_w, // Yeager1998, eq. (8)
294  //sig_q = sqrt(M_PI/2/L_w/b_w), // eq. (14)
295  //sig_r = sqrt(2*M_PI/3/L_w/b_w), // eq. (17)
296  L_p = sqrt(L_w*b_w)/2.6, // eq. (10)
297  tau_u = L_u/in.V, // eq. (6)
298  tau_w = L_w/in.V, // eq. (3)
299  tau_p = L_p/in.V, // eq. (9)
300  tau_q = 4*b_w/M_PI/in.V, // eq. (13)
301  tau_r =3*b_w/M_PI/in.V, // eq. (17)
302  nu_u = GaussianRandomNumber(),
303  nu_v = GaussianRandomNumber(),
304  nu_w = GaussianRandomNumber(),
305  nu_p = GaussianRandomNumber(),
306  xi_u=0, xi_v=0, xi_w=0, xi_p=0, xi_q=0, xi_r=0;
307 
308  // values of turbulence NED velocities
309 
310  if (turbType == ttTustin) {
311  // the following is the Tustin formulation of Yeager's report
312  double
313  omega_w = in.V/L_w, // hidden in nomenclature p. 3
314  omega_v = in.V/L_u, // this is defined nowhere
315  C_BL = 1/tau_u/tan(T_V/2/tau_u), // eq. (19)
316  C_BLp = 1/tau_p/tan(T_V/2/tau_p), // eq. (22)
317  C_BLq = 1/tau_q/tan(T_V/2/tau_q), // eq. (24)
318  C_BLr = 1/tau_r/tan(T_V/2/tau_r); // eq. (26)
319 
320  // all values calculated so far are strictly positive, except for
321  // the random numbers nu_*. This means that in the code below, all
322  // divisors are strictly positive, too, and no floating point
323  // exception should occur.
324  xi_u = -(1 - C_BL*tau_u)/(1 + C_BL*tau_u)*xi_u_km1
325  + sig_u*sqrt(2*tau_u/T_V)/(1 + C_BL*tau_u)*(nu_u + nu_u_km1); // eq. (18)
326  xi_v = -2*(sqr(omega_v) - sqr(C_BL))/sqr(omega_v + C_BL)*xi_v_km1
327  - sqr(omega_v - C_BL)/sqr(omega_v + C_BL) * xi_v_km2
328  + sig_u*sqrt(3*omega_v/T_V)/sqr(omega_v + C_BL)*(
329  (C_BL + omega_v/sqrt(3.))*nu_v
330  + 2/sqrt(3.)*omega_v*nu_v_km1
331  + (omega_v/sqrt(3.) - C_BL)*nu_v_km2); // eq. (20) for v
332  xi_w = -2*(sqr(omega_w) - sqr(C_BL))/sqr(omega_w + C_BL)*xi_w_km1
333  - sqr(omega_w - C_BL)/sqr(omega_w + C_BL) * xi_w_km2
334  + sig_w*sqrt(3*omega_w/T_V)/sqr(omega_w + C_BL)*(
335  (C_BL + omega_w/sqrt(3.))*nu_w
336  + 2/sqrt(3.)*omega_w*nu_w_km1
337  + (omega_w/sqrt(3.) - C_BL)*nu_w_km2); // eq. (20) for w
338  xi_p = -(1 - C_BLp*tau_p)/(1 + C_BLp*tau_p)*xi_p_km1
339  + sig_p*sqrt(2*tau_p/T_V)/(1 + C_BLp*tau_p) * (nu_p + nu_p_km1); // eq. (21)
340  xi_q = -(1 - 4*b_w*C_BLq/M_PI/in.V)/(1 + 4*b_w*C_BLq/M_PI/in.V) * xi_q_km1
341  + C_BLq/in.V/(1 + 4*b_w*C_BLq/M_PI/in.V) * (xi_w - xi_w_km1); // eq. (23)
342  xi_r = - (1 - 3*b_w*C_BLr/M_PI/in.V)/(1 + 3*b_w*C_BLr/M_PI/in.V) * xi_r_km1
343  + C_BLr/in.V/(1 + 3*b_w*C_BLr/M_PI/in.V) * (xi_v - xi_v_km1); // eq. (25)
344 
345  } else if (turbType == ttMilspec) {
346  // the following is the MIL-STD-1797A formulation
347  // as cited in Yeager's report
348  xi_u = (1 - T_V/tau_u) *xi_u_km1 + sig_u*sqrt(2*T_V/tau_u)*nu_u; // eq. (30)
349  xi_v = (1 - 2*T_V/tau_u)*xi_v_km1 + sig_u*sqrt(4*T_V/tau_u)*nu_v; // eq. (31)
350  xi_w = (1 - 2*T_V/tau_w)*xi_w_km1 + sig_w*sqrt(4*T_V/tau_w)*nu_w; // eq. (32)
351  xi_p = (1 - T_V/tau_p) *xi_p_km1 + sig_p*sqrt(2*T_V/tau_p)*nu_p; // eq. (33)
352  xi_q = (1 - T_V/tau_q) *xi_q_km1 + M_PI/4/b_w*(xi_w - xi_w_km1); // eq. (34)
353  xi_r = (1 - T_V/tau_r) *xi_r_km1 + M_PI/3/b_w*(xi_v - xi_v_km1); // eq. (35)
354  }
355 
356  // rotate by wind azimuth and assign the velocities
357  double cospsi = cos(psiw), sinpsi = sin(psiw);
358  vTurbulenceNED(eNorth) = cospsi*xi_u + sinpsi*xi_v;
359  vTurbulenceNED(eEast) = -sinpsi*xi_u + cospsi*xi_v;
360  vTurbulenceNED(eDown) = xi_w;
361 
362  vTurbPQR(eP) = cospsi*xi_p + sinpsi*xi_q;
363  vTurbPQR(eQ) = -sinpsi*xi_p + cospsi*xi_q;
364  vTurbPQR(eR) = xi_r;
365 
366  // vTurbPQR is in the body fixed frame, not NED
367  vTurbPQR = in.Tl2b*vTurbPQR;
368 
369  // hand on the values for the next timestep
370  xi_u_km1 = xi_u; nu_u_km1 = nu_u;
371  xi_v_km2 = xi_v_km1; xi_v_km1 = xi_v; nu_v_km2 = nu_v_km1; nu_v_km1 = nu_v;
372  xi_w_km2 = xi_w_km1; xi_w_km1 = xi_w; nu_w_km2 = nu_w_km1; nu_w_km1 = nu_w;
373  xi_p_km1 = xi_p; nu_p_km1 = nu_p;
374  xi_q_km1 = xi_q;
375  xi_r_km1 = xi_r;
376 
377  }
378  default:
379  break;
380  }
381 
382  TurbDirection = atan2( vTurbulenceNED(eEast), vTurbulenceNED(eNorth))*radtodeg;
383 
384 }
385 
386 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
387 
388 double FGWinds::CosineGustProfile(double startDuration, double steadyDuration, double endDuration, double elapsedTime)
389 {
390  double factor = 0.0;
391  if (elapsedTime >= 0 && elapsedTime <= startDuration) {
392  factor = (1.0 - cos(M_PI*elapsedTime/startDuration))/2.0;
393  } else if (elapsedTime > startDuration && (elapsedTime <= (startDuration + steadyDuration))) {
394  factor = 1.0;
395  } else if (elapsedTime > (startDuration + steadyDuration) && elapsedTime <= (startDuration + steadyDuration + endDuration)) {
396  factor = (1-cos(M_PI*(1-(elapsedTime-(startDuration + steadyDuration))/endDuration)))/2.0;
397  } else {
398  factor = 0.0;
399  }
400 
401  return factor;
402 }
403 
404 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
405 
406 void FGWinds::CosineGust()
407 {
408  struct OneMinusCosineProfile& profile = oneMinusCosineGust.gustProfile;
409 
410  double factor = CosineGustProfile( profile.startupDuration,
411  profile.steadyDuration,
412  profile.endDuration,
413  profile.elapsedTime);
414  // Normalize the gust wind vector
415  oneMinusCosineGust.vWind.Normalize();
416 
417  if (oneMinusCosineGust.vWindTransformed.Magnitude() == 0.0) {
418  switch (oneMinusCosineGust.gustFrame) {
419  case gfBody:
420  oneMinusCosineGust.vWindTransformed = in.Tl2b.Inverse() * oneMinusCosineGust.vWind;
421  break;
422  case gfWind:
423  oneMinusCosineGust.vWindTransformed = in.Tl2b.Inverse() * in.Tw2b * oneMinusCosineGust.vWind;
424  break;
425  case gfLocal:
426  // this is the native frame - and the default.
427  oneMinusCosineGust.vWindTransformed = oneMinusCosineGust.vWind;
428  break;
429  default:
430  break;
431  }
432  }
433 
434  vCosineGust = factor * oneMinusCosineGust.vWindTransformed * oneMinusCosineGust.magnitude;
435 
436  profile.elapsedTime += in.totalDeltaT;
437 
438  if (profile.elapsedTime > (profile.startupDuration + profile.steadyDuration + profile.endDuration)) {
439  profile.Running = false;
440  profile.elapsedTime = 0.0;
441  oneMinusCosineGust.vWindTransformed.InitMatrix();
442  vCosineGust.InitMatrix(0);
443  }
444 }
445 
446 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
447 
448 void FGWinds::NumberOfUpDownburstCells(int num)
449 {
450  for (unsigned int i=0; i<UpDownBurstCells.size();i++) delete UpDownBurstCells[i];
451  UpDownBurstCells.clear();
452  if (num >= 0) {
453  for (int i=0; i<num; i++) UpDownBurstCells.push_back(new struct UpDownBurst);
454  }
455 }
456 
457 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
458 // Calculates the distance between a specified point (where presumably the
459 // Up/Downburst is centered) and the current vehicle location. The distance
460 // here is calculated from the Haversine formula.
461 
462 double FGWinds::DistanceFromRingCenter(double lat, double lon)
463 {
464  double deltaLat = in.latitude - lat;
465  double deltaLong = in.longitude - lon;
466  double dLat2 = deltaLat/2.0;
467  double dLong2 = deltaLong/2.0;
468  double a = sin(dLat2)*sin(dLat2)
469  + cos(lat)*cos(in.latitude)*sin(dLong2)*sin(dLong2);
470  double c = 2.0*atan2(sqrt(a), sqrt(1.0 - a));
471  double d = in.planetRadius*c;
472  return d;
473 }
474 
475 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
476 
477 void FGWinds::UpDownBurst()
478 {
479 
480  for (unsigned int i=0; i<UpDownBurstCells.size(); i++) {
481  /*double d =*/ DistanceFromRingCenter(UpDownBurstCells[i]->ringLatitude, UpDownBurstCells[i]->ringLongitude);
482 
483  }
484 }
485 
486 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
487 
488 void FGWinds::bind(void)
489 {
490  typedef double (FGWinds::*PMF)(int) const;
491  typedef int (FGWinds::*PMFt)(void) const;
492  typedef void (FGWinds::*PMFd)(int,double);
493  typedef void (FGWinds::*PMFi)(int);
494  typedef double (FGWinds::*Ptr)(void) const;
495 
496  // User-specified steady, constant, wind properties (local navigational/geographic frame: N-E-D)
497  PropertyManager->Tie("atmosphere/psiw-rad", this, &FGWinds::GetWindPsi, &FGWinds::SetWindPsi);
498  PropertyManager->Tie("atmosphere/wind-north-fps", this, eNorth, (PMF)&FGWinds::GetWindNED,
499  (PMFd)&FGWinds::SetWindNED);
500  PropertyManager->Tie("atmosphere/wind-east-fps", this, eEast, (PMF)&FGWinds::GetWindNED,
501  (PMFd)&FGWinds::SetWindNED);
502  PropertyManager->Tie("atmosphere/wind-down-fps", this, eDown, (PMF)&FGWinds::GetWindNED,
503  (PMFd)&FGWinds::SetWindNED);
504  PropertyManager->Tie("atmosphere/wind-mag-fps", this, &FGWinds::GetWindspeed,
505  &FGWinds::SetWindspeed);
506 
507  // User-specifieded gust (local navigational/geographic frame: N-E-D)
508  PropertyManager->Tie("atmosphere/gust-north-fps", this, eNorth, (PMF)&FGWinds::GetGustNED,
509  (PMFd)&FGWinds::SetGustNED);
510  PropertyManager->Tie("atmosphere/gust-east-fps", this, eEast, (PMF)&FGWinds::GetGustNED,
511  (PMFd)&FGWinds::SetGustNED);
512  PropertyManager->Tie("atmosphere/gust-down-fps", this, eDown, (PMF)&FGWinds::GetGustNED,
513  (PMFd)&FGWinds::SetGustNED);
514 
515  // User-specified 1 - cosine gust parameters (in specified frame)
516  PropertyManager->Tie("atmosphere/cosine-gust/startup-duration-sec", this, (Ptr)0L, &FGWinds::StartupGustDuration);
517  PropertyManager->Tie("atmosphere/cosine-gust/steady-duration-sec", this, (Ptr)0L, &FGWinds::SteadyGustDuration);
518  PropertyManager->Tie("atmosphere/cosine-gust/end-duration-sec", this, (Ptr)0L, &FGWinds::EndGustDuration);
519  PropertyManager->Tie("atmosphere/cosine-gust/magnitude-ft_sec", this, (Ptr)0L, &FGWinds::GustMagnitude);
520  PropertyManager->Tie("atmosphere/cosine-gust/frame", this, (PMFt)0L, (PMFi)&FGWinds::GustFrame);
521  PropertyManager->Tie("atmosphere/cosine-gust/X-velocity-ft_sec", this, (Ptr)0L, &FGWinds::GustXComponent);
522  PropertyManager->Tie("atmosphere/cosine-gust/Y-velocity-ft_sec", this, (Ptr)0L, &FGWinds::GustYComponent);
523  PropertyManager->Tie("atmosphere/cosine-gust/Z-velocity-ft_sec", this, (Ptr)0L, &FGWinds::GustZComponent);
524  PropertyManager->Tie("atmosphere/cosine-gust/start", this, static_cast<bool (FGWinds::*)(void) const>(nullptr), &FGWinds::StartGust);
525 
526  // User-specified Up- Down-burst parameters
527  PropertyManager->Tie("atmosphere/updownburst/number-of-cells", this, (PMFt)0L, &FGWinds::NumberOfUpDownburstCells);
528 // PropertyManager->Tie("atmosphere/updownburst/", this, (Ptr)0L, &FGWinds::);
529 // PropertyManager->Tie("atmosphere/updownburst/", this, (Ptr)0L, &FGWinds::);
530 // PropertyManager->Tie("atmosphere/updownburst/", this, (Ptr)0L, &FGWinds::);
531 // PropertyManager->Tie("atmosphere/updownburst/", this, (Ptr)0L, &FGWinds::);
532 // PropertyManager->Tie("atmosphere/updownburst/", this, (Ptr)0L, &FGWinds::);
533 // PropertyManager->Tie("atmosphere/updownburst/", this, (Ptr)0L, &FGWinds::);
534 // PropertyManager->Tie("atmosphere/updownburst/", this, (Ptr)0L, &FGWinds::);
535 
536  // User-specified turbulence (local navigational/geographic frame: N-E-D)
537  PropertyManager->Tie("atmosphere/turb-north-fps", this, eNorth, (PMF)&FGWinds::GetTurbNED,
538  (PMFd)&FGWinds::SetTurbNED);
539  PropertyManager->Tie("atmosphere/turb-east-fps", this, eEast, (PMF)&FGWinds::GetTurbNED,
540  (PMFd)&FGWinds::SetTurbNED);
541  PropertyManager->Tie("atmosphere/turb-down-fps", this, eDown, (PMF)&FGWinds::GetTurbNED,
542  (PMFd)&FGWinds::SetTurbNED);
543  // Experimental turbulence parameters
544  PropertyManager->Tie("atmosphere/p-turb-rad_sec", this,1, (PMF)&FGWinds::GetTurbPQR);
545  PropertyManager->Tie("atmosphere/q-turb-rad_sec", this,2, (PMF)&FGWinds::GetTurbPQR);
546  PropertyManager->Tie("atmosphere/r-turb-rad_sec", this,3, (PMF)&FGWinds::GetTurbPQR);
547  PropertyManager->Tie("atmosphere/turb-type", this, (PMFt)&FGWinds::GetTurbType, (PMFi)&FGWinds::SetTurbType);
548  PropertyManager->Tie("atmosphere/turb-rate", this, &FGWinds::GetTurbRate, &FGWinds::SetTurbRate);
549  PropertyManager->Tie("atmosphere/turb-gain", this, &FGWinds::GetTurbGain, &FGWinds::SetTurbGain);
550  PropertyManager->Tie("atmosphere/turb-rhythmicity", this, &FGWinds::GetRhythmicity,
551  &FGWinds::SetRhythmicity);
552 
553  // Parameters for milspec turbulence
554  PropertyManager->Tie("atmosphere/turbulence/milspec/windspeed_at_20ft_AGL-fps",
555  this, &FGWinds::GetWindspeed20ft,
556  &FGWinds::SetWindspeed20ft);
557  PropertyManager->Tie("atmosphere/turbulence/milspec/severity",
558  this, &FGWinds::GetProbabilityOfExceedence,
560 
561  // Total, calculated winds (local navigational/geographic frame: N-E-D). Read only.
562  PropertyManager->Tie("atmosphere/total-wind-north-fps", this, eNorth, (PMF)&FGWinds::GetTotalWindNED);
563  PropertyManager->Tie("atmosphere/total-wind-east-fps", this, eEast, (PMF)&FGWinds::GetTotalWindNED);
564  PropertyManager->Tie("atmosphere/total-wind-down-fps", this, eDown, (PMF)&FGWinds::GetTotalWindNED);
565 
566 }
567 
568 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
569 // The bitmasked value choices are as follows:
570 // unset: In this case (the default) JSBSim would only print
571 // out the normally expected messages, essentially echoing
572 // the config files as they are read. If the environment
573 // variable is not set, debug_lvl is set to 1 internally
574 // 0: This requests JSBSim not to output any messages
575 // whatsoever.
576 // 1: This value explicity requests the normal JSBSim
577 // startup messages
578 // 2: This value asks for a message to be printed out when
579 // a class is instantiated
580 // 4: When this value is set, a message is displayed when a
581 // FGModel object executes its Run() method
582 // 8: When this value is set, various runtime state variables
583 // are printed out periodically
584 // 16: When set various parameters are sanity checked and
585 // a message is printed out when they go out of bounds
586 
587 void FGWinds::Debug(int from)
588 {
589  if (debug_lvl <= 0) return;
590 
591  if (debug_lvl & 1) { // Standard console startup message output
592  if (from == 0) { // Constructor
593  }
594  }
595  if (debug_lvl & 2 ) { // Instantiation/Destruction notification
596  if (from == 0) cout << "Instantiated: FGWinds" << endl;
597  if (from == 1) cout << "Destroyed: FGWinds" << endl;
598  }
599  if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
600  }
601  if (debug_lvl & 8 ) { // Runtime state variables
602  }
603  if (debug_lvl & 16) { // Sanity checking
604  }
605  if (debug_lvl & 128) { //
606  }
607  if (debug_lvl & 64) {
608  if (from == 0) { // Constructor
609  }
610  }
611 }
612 
613 } // namespace JSBSim
JSBSim::FGFDMExec
Encapsulates the JSBSim simulation executive.
Definition: FGFDMExec.h:185
JSBSim::FGModel
Base class for all scheduled JSBSim models.
Definition: FGModel.h:68
JSBSim::FGWinds::SetGustNED
virtual void SetGustNED(int idx, double gust)
Sets a gust component in NED frame.
Definition: FGWinds.h:230
JSBSim::FGWinds::SetWindPsi
virtual void SetWindPsi(double dir)
Sets the direction that the wind is coming from.
Definition: FGWinds.cpp:184
JSBSim::FGWinds::SetTurbNED
virtual void SetTurbNED(int idx, double turb)
Sets a turbulence component in NED frame.
Definition: FGWinds.h:233
JSBSim::FGWinds::StartGust
virtual void StartGust(bool running)
Initiates the execution of the gust.
Definition: FGWinds.h:328
JSBSim::FGWinds::EndGustDuration
virtual void EndGustDuration(double dur)
Specifies the length of time it takes for the gust to return to zero velocity.
Definition: FGWinds.h:334
JSBSim::FGWinds::StartupGustDuration
virtual void StartupGustDuration(double dur)
Specifies the duration of the startup portion of the gust.
Definition: FGWinds.h:330
JSBSim::FGWinds::GetTotalWindNED
virtual const FGColumnVector3 & GetTotalWindNED(void) const
Retrieves the total wind components in NED frame.
Definition: FGWinds.h:187
JSBSim::FGTable
Lookup table class.
Definition: FGTable.h:233
JSBSim::FGWinds::SetWindNED
virtual void SetWindNED(double wN, double wE, double wD)
Sets the wind components in NED frame.
Definition: FGWinds.h:195
JSBSim::FGFDMExec::GetSimTime
double GetSimTime(void) const
Returns the cumulative simulation time in seconds.
Definition: FGFDMExec.h:542
JSBSim::FGWinds::GustYComponent
virtual void GustYComponent(double y)
Specifies the Y component of velocity in the specified gust frame (ft/sec).
Definition: FGWinds.h:348
JSBSim::FGMatrix33::Inverse
FGMatrix33 Inverse(void) const
Return the inverse of the matrix.
Definition: FGMatrix33.cpp:229
JSBSim::FGColumnVector3::Magnitude
double Magnitude(void) const
Length of the vector.
Definition: FGColumnVector3.cpp:109
JSBSim::FGWinds::OneMinusCosineProfile::Running
bool Running
Definition: FGWinds.h:276
JSBSim::FGWinds::OneMinusCosineProfile::elapsedTime
double elapsedTime
Definition: FGWinds.h:277
JSBSim::FGWinds::OneMinusCosineGust::vWindTransformed
FGColumnVector3 vWindTransformed
Definition: FGWinds.h:296
JSBSim::FGWinds::GetGustNED
virtual const FGColumnVector3 & GetGustNED(void) const
Retrieves the gust components in NED frame.
Definition: FGWinds.h:245
JSBSim::FGWinds::GetWindPsi
virtual double GetWindPsi(void) const
Retrieves the direction that the wind is coming from.
Definition: FGWinds.h:212
JSBSim::FGWinds::OneMinusCosineGust::gustFrame
eGustFrame gustFrame
Definition: FGWinds.h:298
JSBSim::FGWinds::GustMagnitude
virtual void GustMagnitude(double mag)
Specifies the magnitude of the gust in feet/second.
Definition: FGWinds.h:336
JSBSim::FGWinds::OneMinusCosineGust::gustProfile
struct OneMinusCosineProfile gustProfile
Definition: FGWinds.h:299
JSBSim::FGWinds::GetTurbNED
virtual double GetTurbNED(int idx) const
Retrieves a turbulence component in NED frame.
Definition: FGWinds.h:242
JSBSim::FGWinds::SetTurbType
virtual void SetTurbType(tType tt)
Turbulence models available: ttNone, ttStandard, ttBerndt, ttCulp, ttMilspec, ttTustin.
Definition: FGWinds.h:249
JSBSim::FGModel::Run
virtual bool Run(bool Holding)
Runs the model; called by the Executive.
Definition: FGModel.cpp:89
JSBSim::FGWinds::GetWindNED
virtual const FGColumnVector3 & GetWindNED(void) const
Retrieves the wind components in NED frame.
Definition: FGWinds.h:204
JSBSim::FGColumnVector3::Normalize
FGColumnVector3 & Normalize(void)
Normalize.
Definition: FGColumnVector3.cpp:116
JSBSim::FGWinds::GustFrame
virtual void GustFrame(eGustFrame gFrame)
Specifies the frame that the gust direction vector components are specified in.
Definition: FGWinds.h:344
JSBSim::FGWinds::GustXComponent
virtual void GustXComponent(double x)
Specifies the X component of velocity in the specified gust frame (ft/sec).
Definition: FGWinds.h:346
JSBSim::FGWinds::Run
bool Run(bool Holding) override
Runs the winds model; called by the Executive Can pass in a value indicating if the executive is dire...
Definition: FGWinds.cpp:139
JSBSim::FGWinds::~FGWinds
~FGWinds()
Destructor.
Definition: FGWinds.cpp:113
JSBSim::FGWinds::GustZComponent
virtual void GustZComponent(double z)
Specifies the Z component of velocity in the specified gust frame (ft/sec).
Definition: FGWinds.h:350
JSBSim::FGWinds::SetProbabilityOfExceedence
virtual void SetProbabilityOfExceedence(int idx)
allowable range: 0-7, 3=light, 4=moderate, 6=severe turbulence
Definition: FGWinds.h:270
JSBSim::FGWinds::OneMinusCosineGust::vWind
FGColumnVector3 vWind
Definition: FGWinds.h:295
JSBSim::FGWinds::OneMinusCosineGust::magnitude
double magnitude
Definition: FGWinds.h:297
JSBSim::FGWinds::FGWinds
FGWinds(FGFDMExec *)
Constructor.
Definition: FGWinds.cpp:74
JSBSim::FGWinds::SteadyGustDuration
virtual void SteadyGustDuration(double dur)
Specifies the length of time that the gust is at a steady, full strength.
Definition: FGWinds.h:332
JSBSim::FGPropertyManager::Tie
void Tie(const std::string &name, T *pointer)
Tie a property to an external variable.
Definition: FGPropertyManager.h:449