src/Environment/environment.cxx

   1 // environment.cxx -- routines to model the natural environment
   2 //
   3 // Written by David Megginson, started February 2002.
   4 //
   5 // Copyright (C) 2002  David Megginson - david@megginson.com
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #ifdef HAVE_WINDOWS_H
  29 #  include <windows.h>
  30 #endif
  31
  32 #include <math.h>
  33
  34 #include <plib/sg.h>
  35
  36 #include <simgear/constants.h>
  37 #include <simgear/debug/logstream.hxx>
  38 #include <simgear/math/interpolater.hxx>
  39 #include <simgear/environment/visual_enviro.hxx>
  40
  41 #include <Main/fg_props.hxx>
  42 #include "environment.hxx"
  43
  44
  45 \f
  46 ////////////////////////////////////////////////////////////////////////
  47 // Atmosphere model.
  48 ////////////////////////////////////////////////////////////////////////
  49
  50 // Copied from YASim Atmosphere.cxx, with m converted to ft, degK
  51 // converted to degC, Pa converted to inHG, and kg/m^3 converted to
  52 // slug/ft^3; they were then converted to deltas from the sea-level
  53 // defaults (approx. 15degC, 29.92inHG, and 0.00237slugs/ft^3).
  54
  55 // Original comment from YASim:
  56
  57 // Copied from McCormick, who got it from "The ARDC Model Atmosphere"
  58 // Note that there's an error in the text in the first entry,
  59 // McCormick lists 299.16/101325/1.22500, but those don't agree with
  60 // R=287.  I chose to correct the temperature to 288.20, since 79F is
  61 // pretty hot for a "standard" atmosphere.
  62
  63 // Elevation (ft), temperature factor (degK), pressure factor (inHG)
  64 static double atmosphere_data[][3] = {
  65  { 0.00, 1.00, 1.000 },
  66  { 2952.76, 0.98, 0.898 },
  67  { 5905.51, 0.96, 0.804 },
  68  { 8858.27, 0.94, 0.719 },
  69  { 11811.02, 0.92, 0.641 },
  70  { 14763.78, 0.90, 0.570 },
  71  { 17716.54, 0.88, 0.506 },
  72  { 20669.29, 0.86, 0.447 },
  73  { 23622.05, 0.84, 0.394 },
  74  { 26574.80, 0.82, 0.347 },
  75  { 29527.56, 0.80, 0.304 },
  76  { 32480.31, 0.78, 0.266 },
  77  { 35433.07, 0.76, 0.231 },
  78  { 38385.83, 0.75, 0.201 },
  79  { 41338.58, 0.75, 0.174 },
  80  { 44291.34, 0.75, 0.151 },
  81  { 47244.09, 0.75, 0.131 },
  82  { 50196.85, 0.75, 0.114 },
  83  { 53149.61, 0.75, 0.099 },
  84  { 56102.36, 0.75, 0.086 },
  85  { 59055.12, 0.75, 0.075 },
  86  { 62007.87, 0.75, 0.065 },
  87  { -1, -1, -1 }
  88 };
  89
  90 static SGInterpTable * _temperature_degc_table = 0;
  91 static SGInterpTable * _pressure_inhg_table = 0;
  92
  93 static void
  94 _setup_tables ()
  95 {
  96   if (_temperature_degc_table != 0)
  97       return;
  98
  99   _temperature_degc_table = new SGInterpTable;
 100   _pressure_inhg_table = new SGInterpTable;
 101
 102   for (int i = 0; atmosphere_data[i][0] != -1; i++) {
 103     _temperature_degc_table->addEntry(atmosphere_data[i][0],
 104                                       atmosphere_data[i][1]);
 105     _pressure_inhg_table->addEntry(atmosphere_data[i][0],
 106                                    atmosphere_data[i][2]);
 107   }
 108 }
 109
 110
 111 \f
 112 ////////////////////////////////////////////////////////////////////////
 113 // Implementation of FGEnvironment.
 114 ////////////////////////////////////////////////////////////////////////
 115
 116 FGEnvironment::FGEnvironment()
 117   : elevation_ft(0),
 118     visibility_m(32000),
 119     temperature_sea_level_degc(15),
 120     temperature_degc(15),
 121     dewpoint_sea_level_degc(5), // guess
 122     dewpoint_degc(5),
 123     pressure_sea_level_inhg(29.92),
 124     pressure_inhg(29.92),
 125     turbulence_magnitude_norm(0),
 126     turbulence_rate_hz(1),
 127     wind_from_heading_deg(0),
 128     wind_speed_kt(0),
 129     wind_from_north_fps(0),
 130     wind_from_east_fps(0),
 131     wind_from_down_fps(0)
 132 {
 133   _setup_tables();
 134   _recalc_density();
 135 }
 136
 137 FGEnvironment::FGEnvironment (const FGEnvironment &env)
 138 {
 139     FGEnvironment();
 140     copy(env);
 141 }
 142
 143 FGEnvironment::~FGEnvironment()
 144 {
 145 }
 146
 147 void
 148 FGEnvironment::copy (const FGEnvironment &env)
 149 {
 150     elevation_ft = env.elevation_ft;
 151     visibility_m = env.visibility_m;
 152     temperature_sea_level_degc = env.temperature_sea_level_degc;
 153     temperature_degc = env.temperature_degc;
 154     dewpoint_sea_level_degc = env.dewpoint_sea_level_degc;
 155     dewpoint_degc = env.dewpoint_degc;
 156     pressure_sea_level_inhg = env.pressure_sea_level_inhg;
 157     wind_from_heading_deg = env.wind_from_heading_deg;
 158     wind_speed_kt = env.wind_speed_kt;
 159     wind_from_north_fps = env.wind_from_north_fps;
 160     wind_from_east_fps = env.wind_from_east_fps;
 161     wind_from_down_fps = env.wind_from_down_fps;
 162     turbulence_magnitude_norm = env.turbulence_magnitude_norm;
 163     turbulence_rate_hz = env.turbulence_rate_hz;
 164 }
 165
 166 static inline bool
 167 maybe_copy_value (FGEnvironment * env, const SGPropertyNode * node,
 168                   const char * name, void (FGEnvironment::*setter)(double))
 169 {
 170     const SGPropertyNode * child = node->getNode(name);
 171                                 // fragile: depends on not being typed
 172                                 // as a number
 173     if (child != 0 && child->hasValue() &&
 174         child->getStringValue()[0] != '\0') {
 175         (env->*setter)(child->getDoubleValue());
 176         return true;
 177     } else {
 178         return false;
 179     }
 180 }
 181
 182 void
 183 FGEnvironment::read (const SGPropertyNode * node)
 184 {
 185     maybe_copy_value(this, node, "visibility-m",
 186                      &FGEnvironment::set_visibility_m);
 187
 188     if (!maybe_copy_value(this, node, "temperature-sea-level-degc",
 189                           &FGEnvironment::set_temperature_sea_level_degc))
 190         maybe_copy_value(this, node, "temperature-degc",
 191                          &FGEnvironment::set_temperature_degc);
 192
 193     if (!maybe_copy_value(this, node, "dewpoint-sea-level-degc",
 194                           &FGEnvironment::set_dewpoint_sea_level_degc))
 195         maybe_copy_value(this, node, "dewpoint-degc",
 196                          &FGEnvironment::set_dewpoint_degc);
 197
 198     if (!maybe_copy_value(this, node, "pressure-sea-level-inhg",
 199                           &FGEnvironment::set_pressure_sea_level_inhg))
 200         maybe_copy_value(this, node, "pressure-inhg",
 201                          &FGEnvironment::set_pressure_inhg);
 202
 203     maybe_copy_value(this, node, "wind-from-heading-deg",
 204                      &FGEnvironment::set_wind_from_heading_deg);
 205
 206     maybe_copy_value(this, node, "wind-speed-kt",
 207                      &FGEnvironment::set_wind_speed_kt);
 208
 209     maybe_copy_value(this, node, "elevation-ft",
 210                      &FGEnvironment::set_elevation_ft);
 211
 212     maybe_copy_value(this, node, "turbulence/magnitude-norm",
 213                      &FGEnvironment::set_turbulence_magnitude_norm);
 214
 215     maybe_copy_value(this, node, "turbulence/rate-hz",
 216                      &FGEnvironment::set_turbulence_rate_hz);
 217 }
 218
 219
 220 double
 221 FGEnvironment::get_visibility_m () const
 222 {
 223   return visibility_m;
 224 }
 225
 226 double
 227 FGEnvironment::get_temperature_sea_level_degc () const
 228 {
 229   return temperature_sea_level_degc;
 230 }
 231
 232 double
 233 FGEnvironment::get_temperature_degc () const
 234 {
 235   return temperature_degc;
 236 }
 237
 238 double
 239 FGEnvironment::get_temperature_degf () const
 240 {
 241   return (temperature_degc * 9.0 / 5.0) + 32.0;
 242 }
 243
 244 double
 245 FGEnvironment::get_dewpoint_sea_level_degc () const
 246 {
 247   return dewpoint_sea_level_degc;
 248 }
 249
 250 double
 251 FGEnvironment::get_dewpoint_degc () const
 252 {
 253   return dewpoint_degc;
 254 }
 255
 256 double
 257 FGEnvironment::get_pressure_sea_level_inhg () const
 258 {
 259   return pressure_sea_level_inhg;
 260 }
 261
 262 double
 263 FGEnvironment::get_pressure_inhg () const
 264 {
 265   return pressure_inhg;
 266 }
 267
 268 double
 269 FGEnvironment::get_density_slugft3 () const
 270 {
 271   return density_slugft3;
 272 }
 273
 274 double
 275 FGEnvironment::get_wind_from_heading_deg () const
 276 {
 277   return wind_from_heading_deg;
 278 }
 279
 280 double
 281 FGEnvironment::get_wind_speed_kt () const
 282 {
 283   return wind_speed_kt;
 284 }
 285
 286 double
 287 FGEnvironment::get_wind_from_north_fps () const
 288 {
 289   return wind_from_north_fps;
 290 }
 291
 292 double
 293 FGEnvironment::get_wind_from_east_fps () const
 294 {
 295   return wind_from_east_fps;
 296 }
 297
 298 double
 299 FGEnvironment::get_wind_from_down_fps () const
 300 {
 301   return wind_from_down_fps;
 302 }
 303
 304 double
 305 FGEnvironment::get_turbulence_magnitude_norm () const
 306 {
 307   if( sgEnviro.get_turbulence_enable_state() )
 308     if (fgGetBool("/environment/params/real-world-weather-fetch") == true)
 309       return sgEnviro.get_cloud_turbulence();
 310   return turbulence_magnitude_norm;
 311 }
 312
 313 double
 314 FGEnvironment::get_turbulence_rate_hz () const
 315 {
 316   return turbulence_rate_hz;
 317 }
 318
 319 double
 320 FGEnvironment::get_elevation_ft () const
 321 {
 322   return elevation_ft;
 323 }
 324
 325 void
 326 FGEnvironment::set_visibility_m (double v)
 327 {
 328   visibility_m = v;
 329 }
 330
 331 void
 332 FGEnvironment::set_temperature_sea_level_degc (double t)
 333 {
 334   temperature_sea_level_degc = t;
 335   if (dewpoint_sea_level_degc > t)
 336       dewpoint_sea_level_degc = t;
 337   _recalc_alt_temperature();
 338   _recalc_density();
 339 }
 340
 341 void
 342 FGEnvironment::set_temperature_degc (double t)
 343 {
 344   temperature_degc = t;
 345   _recalc_sl_temperature();
 346   _recalc_density();
 347 }
 348
 349 void
 350 FGEnvironment::set_dewpoint_sea_level_degc (double t)
 351 {
 352   dewpoint_sea_level_degc = t;
 353   if (temperature_sea_level_degc < t)
 354       temperature_sea_level_degc = t;
 355   _recalc_alt_dewpoint();
 356   _recalc_density();
 357 }
 358
 359 void
 360 FGEnvironment::set_dewpoint_degc (double t)
 361 {
 362   dewpoint_degc = t;
 363   _recalc_sl_dewpoint();
 364   _recalc_density();
 365 }
 366
 367 void
 368 FGEnvironment::set_pressure_sea_level_inhg (double p)
 369 {
 370   pressure_sea_level_inhg = p;
 371   _recalc_alt_pressure();
 372   _recalc_density();
 373 }
 374
 375 void
 376 FGEnvironment::set_pressure_inhg (double p)
 377 {
 378   pressure_inhg = p;
 379   _recalc_sl_pressure();
 380   _recalc_density();
 381 }
 382
 383 void
 384 FGEnvironment::set_wind_from_heading_deg (double h)
 385 {
 386   wind_from_heading_deg = h;
 387   _recalc_ne();
 388 }
 389
 390 void
 391 FGEnvironment::set_wind_speed_kt (double s)
 392 {
 393   wind_speed_kt = s;
 394   _recalc_ne();
 395 }
 396
 397 void
 398 FGEnvironment::set_wind_from_north_fps (double n)
 399 {
 400   wind_from_north_fps = n;
 401   _recalc_hdgspd();
 402 }
 403
 404 void
 405 FGEnvironment::set_wind_from_east_fps (double e)
 406 {
 407   wind_from_east_fps = e;
 408   _recalc_hdgspd();
 409 }
 410
 411 void
 412 FGEnvironment::set_wind_from_down_fps (double d)
 413 {
 414   wind_from_down_fps = d;
 415   _recalc_hdgspd();
 416 }
 417
 418 void
 419 FGEnvironment::set_turbulence_magnitude_norm (double t)
 420 {
 421   turbulence_magnitude_norm = t;
 422 }
 423
 424 void
 425 FGEnvironment::set_turbulence_rate_hz (double r)
 426 {
 427   turbulence_rate_hz = r;
 428 }
 429
 430 void
 431 FGEnvironment::set_elevation_ft (double e)
 432 {
 433   elevation_ft = e;
 434   _recalc_alt_temperature();
 435   _recalc_alt_dewpoint();
 436   _recalc_alt_pressure();
 437   _recalc_density();
 438 }
 439
 440 void
 441 FGEnvironment::_recalc_hdgspd ()
 442 {
 443   double angle_rad;
 444
 445   if (wind_from_east_fps == 0) {
 446     angle_rad = (wind_from_north_fps >= 0 ? SGD_PI_2 : -SGD_PI_2);
 447   } else {
 448     angle_rad = atan(wind_from_north_fps/wind_from_east_fps);
 449   }
 450   wind_from_heading_deg = angle_rad * SGD_RADIANS_TO_DEGREES;
 451   if (wind_from_east_fps >= 0)
 452     wind_from_heading_deg = 90 - wind_from_heading_deg;
 453   else
 454     wind_from_heading_deg = 270 - wind_from_heading_deg;
 455
 456 #if 0
 457   // FIXME: Windspeed can become negative with these formulas.
 458   //        which can cause problems for animations that rely
 459   //        on the windspeed property.
 460   if (angle_rad == 0)
 461     wind_speed_kt = fabs(wind_from_east_fps
 462                          * SG_METER_TO_NM * SG_FEET_TO_METER * 3600);
 463   else
 464     wind_speed_kt = (wind_from_north_fps / sin(angle_rad))
 465       * SG_METER_TO_NM * SG_FEET_TO_METER * 3600;
 466 #else
 467   wind_speed_kt = sqrt(wind_from_north_fps * wind_from_north_fps +
 468                        wind_from_east_fps * wind_from_east_fps)
 469                   * SG_METER_TO_NM * SG_FEET_TO_METER * 3600;
 470 #endif
 471 }
 472
 473 void
 474 FGEnvironment::_recalc_ne ()
 475 {
 476   double speed_fps =
 477     wind_speed_kt * SG_NM_TO_METER * SG_METER_TO_FEET * (1.0/3600);
 478
 479   wind_from_north_fps = speed_fps *
 480     cos(wind_from_heading_deg * SGD_DEGREES_TO_RADIANS);
 481   wind_from_east_fps = speed_fps *
 482     sin(wind_from_heading_deg * SGD_DEGREES_TO_RADIANS);
 483 }
 484
 485 void
 486 FGEnvironment::_recalc_sl_temperature ()
 487 {
 488   // If we're in the stratosphere, leave sea-level temp alone
 489   if (elevation_ft < 38000) {
 490     temperature_sea_level_degc =
 491       (temperature_degc + 273.15)
 492       /_temperature_degc_table->interpolate(elevation_ft)
 493       - 273.15;
 494   }
 495 }
 496
 497 void
 498 FGEnvironment::_recalc_alt_temperature ()
 499 {
 500   if (elevation_ft < 38000) {
 501     temperature_degc =
 502       (temperature_sea_level_degc + 273.15) *
 503       _temperature_degc_table->interpolate(elevation_ft) - 273.15;
 504   } else {
 505     temperature_degc = -56.49;  // Stratosphere is constant
 506   }
 507 }
 508
 509 void
 510 FGEnvironment::_recalc_sl_dewpoint ()
 511 {
 512                                 // 0.2degC/1000ft
 513                                 // FIXME: this will work only for low
 514                                 // elevations
 515   dewpoint_sea_level_degc = dewpoint_degc + (elevation_ft * .0002);
 516   if (dewpoint_sea_level_degc > temperature_sea_level_degc)
 517     dewpoint_sea_level_degc = temperature_sea_level_degc;
 518 }
 519
 520 void
 521 FGEnvironment::_recalc_alt_dewpoint ()
 522 {
 523                                 // 0.2degC/1000ft
 524                                 // FIXME: this will work only for low
 525                                 // elevations
 526   dewpoint_degc = dewpoint_sea_level_degc + (elevation_ft * .0002);
 527   if (dewpoint_degc > temperature_degc)
 528     dewpoint_degc = temperature_degc;
 529 }
 530
 531 void
 532 FGEnvironment::_recalc_sl_pressure ()
 533 {
 534   pressure_sea_level_inhg =
 535     pressure_inhg / _pressure_inhg_table->interpolate(elevation_ft);
 536 }
 537
 538 void
 539 FGEnvironment::_recalc_alt_pressure ()
 540 {
 541   pressure_inhg =
 542     pressure_sea_level_inhg * _pressure_inhg_table->interpolate(elevation_ft);
 543 }
 544
 545 void
 546 FGEnvironment::_recalc_density ()
 547 {
 548   double pressure_psf = pressure_inhg * 70.7487;
 549
 550   // adjust for humidity
 551   // calculations taken from USA Today (oops!) at
 552   // http://www.usatoday.com/weather/basics/density-calculations.htm
 553   double temperature_degk = temperature_degc + 273.15;
 554   double pressure_mb = pressure_inhg * 33.86;
 555   double vapor_pressure_mb =
 556     6.11 * pow(10.0, 7.5 * dewpoint_degc / (237.7 + dewpoint_degc));
 557   double virtual_temperature_degk = temperature_degk / (1 - (vapor_pressure_mb / pressure_mb) * (1.0 - 0.622));
 558   double virtual_temperature_degr = virtual_temperature_degk * 1.8;
 559
 560   density_slugft3 = pressure_psf / (virtual_temperature_degr * 1718);
 561 }
 562
 563
 564 \f
 565 ////////////////////////////////////////////////////////////////////////
 566 // Functions.
 567 ////////////////////////////////////////////////////////////////////////
 568
 569 static inline double
 570 do_interp (double a, double b, double fraction)
 571 {
 572     double retval = (a + ((b - a) * fraction));
 573     return retval;
 574 }
 575
 576 static inline double
 577 do_interp_deg (double a, double b, double fraction)
 578 {
 579     a = fmod(a, 360);
 580     b = fmod(b, 360);
 581     if (fabs(b-a) > 180) {
 582         if (a < b)
 583             a += 360;
 584         else
 585             b += 360;
 586     }
 587     return fmod(do_interp(a, b, fraction), 360);
 588 }
 589
 590 void
 591 interpolate (const FGEnvironment * env1, const FGEnvironment * env2,
 592              double fraction, FGEnvironment * result)
 593 {
 594     result->set_visibility_m
 595         (do_interp(env1->get_visibility_m(),
 596                    env2->get_visibility_m(),
 597                    fraction));
 598
 599     result->set_temperature_sea_level_degc
 600         (do_interp(env1->get_temperature_sea_level_degc(),
 601                    env2->get_temperature_sea_level_degc(),
 602                    fraction));
 603
 604     result->set_dewpoint_degc
 605         (do_interp(env1->get_dewpoint_sea_level_degc(),
 606                    env2->get_dewpoint_sea_level_degc(),
 607                    fraction));
 608
 609     result->set_pressure_sea_level_inhg
 610         (do_interp(env1->get_pressure_sea_level_inhg(),
 611                    env2->get_pressure_sea_level_inhg(),
 612                    fraction));
 613
 614     result->set_wind_from_heading_deg
 615         (do_interp_deg(env1->get_wind_from_heading_deg(),
 616                        env2->get_wind_from_heading_deg(),
 617                        fraction));
 618
 619     result->set_wind_speed_kt
 620         (do_interp(env1->get_wind_speed_kt(),
 621                    env2->get_wind_speed_kt(),
 622                    fraction));
 623
 624     result->set_elevation_ft
 625         (do_interp(env1->get_elevation_ft(),
 626                    env2->get_elevation_ft(),
 627                    fraction));
 628
 629     result->set_turbulence_magnitude_norm
 630         (do_interp(env1->get_turbulence_magnitude_norm(),
 631                    env2->get_turbulence_magnitude_norm(),
 632                    fraction));
 633
 634     result->set_turbulence_rate_hz
 635         (do_interp(env1->get_turbulence_rate_hz(),
 636                    env2->get_turbulence_rate_hz(),
 637                    fraction));
 638 }
 639
 640 // end of environment.cxx