src/Environment/environment_ctrl.cxx

   1 // environment_ctrl.cxx -- manager for natural environment information.
   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 #include <simgear/debug/logstream.hxx>
  24
  25 #include <stdlib.h>
  26 #include <algorithm>
  27
  28 #include <simgear/structure/commands.hxx>
  29 #include <simgear/structure/exception.hxx>
  30
  31 #include <Airports/simple.hxx>
  32 #include <Main/fg_props.hxx>
  33 #include <Main/util.hxx>
  34
  35 #include "environment_mgr.hxx"
  36 #include "environment_ctrl.hxx"
  37
  38 SG_USING_STD(sort);
  39
  40
  41 \f
  42 ////////////////////////////////////////////////////////////////////////
  43 // Implementation of FGEnvironmentCtrl abstract base class.
  44 ////////////////////////////////////////////////////////////////////////
  45
  46 FGEnvironmentCtrl::FGEnvironmentCtrl ()
  47   : _environment(0),
  48     _lon_deg(0),
  49     _lat_deg(0),
  50     _elev_ft(0)
  51 {
  52 }
  53
  54 FGEnvironmentCtrl::~FGEnvironmentCtrl ()
  55 {
  56 }
  57
  58 void
  59 FGEnvironmentCtrl::setEnvironment (FGEnvironment * environment)
  60 {
  61   _environment = environment;
  62 }
  63
  64 void
  65 FGEnvironmentCtrl::setLongitudeDeg (double lon_deg)
  66 {
  67   _lon_deg = lon_deg;
  68 }
  69
  70 void
  71 FGEnvironmentCtrl::setLatitudeDeg (double lat_deg)
  72 {
  73   _lat_deg = lat_deg;
  74 }
  75
  76 void
  77 FGEnvironmentCtrl::setElevationFt (double elev_ft)
  78 {
  79   _elev_ft = elev_ft;
  80 }
  81
  82 void
  83 FGEnvironmentCtrl::setPosition (double lon_deg, double lat_deg, double elev_ft)
  84 {
  85   _lon_deg = lon_deg;
  86   _lat_deg = lat_deg;
  87   _elev_ft = elev_ft;
  88 }
  89
  90
  91 \f
  92 ////////////////////////////////////////////////////////////////////////
  93 // Implementation of FGUserDefEnvironmentCtrl.
  94 ////////////////////////////////////////////////////////////////////////
  95
  96 FGUserDefEnvironmentCtrl::FGUserDefEnvironmentCtrl ()
  97   : _base_wind_speed_node(0),
  98     _gust_wind_speed_node(0),
  99     _current_wind_speed_kt(0),
 100     _delta_wind_speed_kt(0)
 101 {
 102 }
 103
 104 FGUserDefEnvironmentCtrl::~FGUserDefEnvironmentCtrl ()
 105 {
 106 }
 107
 108 void
 109 FGUserDefEnvironmentCtrl::init ()
 110 {
 111                                 // Fill in some defaults.
 112   if (!fgHasNode("/environment/params/base-wind-speed-kt"))
 113     fgSetDouble("/environment/params/base-wind-speed-kt",
 114                 fgGetDouble("/environment/wind-speed-kt"));
 115   if (!fgHasNode("/environment/params/gust-wind-speed-kt"))
 116     fgSetDouble("/environment/params/gust-wind-speed-kt",
 117                 fgGetDouble("/environment/params/base-wind-speed-kt"));
 118
 119   _base_wind_speed_node =
 120     fgGetNode("/environment/params/base-wind-speed-kt", true);
 121   _gust_wind_speed_node =
 122     fgGetNode("/environment/params/gust-wind-speed-kt", true);
 123
 124   _current_wind_speed_kt = _base_wind_speed_node->getDoubleValue();
 125   _delta_wind_speed_kt = 0.1;
 126 }
 127
 128 void
 129 FGUserDefEnvironmentCtrl::update (double dt)
 130 {
 131   double base_wind_speed = _base_wind_speed_node->getDoubleValue();
 132   double gust_wind_speed = _gust_wind_speed_node->getDoubleValue();
 133
 134   if (gust_wind_speed < base_wind_speed) {
 135       gust_wind_speed = base_wind_speed;
 136       _gust_wind_speed_node->setDoubleValue(gust_wind_speed);
 137   }
 138
 139   if (base_wind_speed == gust_wind_speed) {
 140     _current_wind_speed_kt = base_wind_speed;
 141   } else {
 142     int rn = rand() % 128;
 143     int sign = (_delta_wind_speed_kt < 0 ? -1 : 1);
 144     double gust = _current_wind_speed_kt - base_wind_speed;
 145     double incr = gust / 50;
 146
 147     if (rn == 0)
 148       _delta_wind_speed_kt = - _delta_wind_speed_kt;
 149     else if (rn < 4)
 150       _delta_wind_speed_kt -= incr * sign;
 151     else if (rn < 16)
 152       _delta_wind_speed_kt += incr * sign;
 153
 154     _current_wind_speed_kt += _delta_wind_speed_kt;
 155
 156     if (_current_wind_speed_kt < base_wind_speed) {
 157       _current_wind_speed_kt = base_wind_speed;
 158       _delta_wind_speed_kt = 0.01;
 159     } else if (_current_wind_speed_kt > gust_wind_speed) {
 160       _current_wind_speed_kt = gust_wind_speed;
 161       _delta_wind_speed_kt = -0.01;
 162     }
 163   }
 164
 165   if (_environment != 0)
 166     _environment->set_wind_speed_kt(_current_wind_speed_kt);
 167 }
 168
 169
 170 \f
 171 ////////////////////////////////////////////////////////////////////////
 172 // Implementation of FGInterpolateEnvironmentCtrl.
 173 ////////////////////////////////////////////////////////////////////////
 174
 175 FGInterpolateEnvironmentCtrl::FGInterpolateEnvironmentCtrl ()
 176 {
 177 }
 178
 179 FGInterpolateEnvironmentCtrl::~FGInterpolateEnvironmentCtrl ()
 180 {
 181     unsigned int i;
 182     for (i = 0; i < _boundary_table.size(); i++)
 183         delete _boundary_table[i];
 184     for (i = 0; i < _aloft_table.size(); i++)
 185         delete _aloft_table[i];
 186 }
 187
 188
 189
 190 void
 191 FGInterpolateEnvironmentCtrl::init ()
 192 {
 193     read_table(fgGetNode("/environment/config/boundary", true),
 194                _boundary_table);
 195     read_table(fgGetNode("/environment/config/aloft", true),
 196                _aloft_table);
 197 }
 198
 199 void
 200 FGInterpolateEnvironmentCtrl::reinit ()
 201 {
 202     unsigned int i;
 203     for (i = 0; i < _boundary_table.size(); i++)
 204         delete _boundary_table[i];
 205     for (i = 0; i < _aloft_table.size(); i++)
 206         delete _aloft_table[i];
 207     _boundary_table.clear();
 208     _aloft_table.clear();
 209     init();
 210 }
 211
 212 void
 213 FGInterpolateEnvironmentCtrl::read_table (const SGPropertyNode * node,
 214                                           vector<bucket *> &table)
 215 {
 216     for (int i = 0; i < node->nChildren(); i++) {
 217         const SGPropertyNode * child = node->getChild(i);
 218         if ( strcmp(child->getName(), "entry") == 0
 219              && child->getStringValue("elevation-ft", "")[0] != '\0'
 220              && ( child->getDoubleValue("elevation-ft") > 0.1 || i == 0 ) )
 221         {
 222             bucket * b = new bucket;
 223             if (i > 0)
 224                 b->environment.copy(table[i-1]->environment);
 225             b->environment.read(child);
 226             b->altitude_ft = b->environment.get_elevation_ft();
 227             table.push_back(b);
 228         }
 229     }
 230     sort(table.begin(), table.end());
 231 }
 232
 233 void
 234 FGInterpolateEnvironmentCtrl::update (double delta_time_sec)
 235 {
 236                                 // FIXME
 237     double altitude_ft = fgGetDouble("/position/altitude-ft");
 238     double altitude_agl_ft = fgGetDouble("/position/altitude-agl-ft");
 239     double boundary_transition =
 240         fgGetDouble("/environment/config/boundary-transition-ft", 500);
 241
 242     // double ground_elevation_ft = altitude_ft - altitude_agl_ft;
 243
 244     int length = _boundary_table.size();
 245
 246     if (length > 0) {
 247                                 // boundary table
 248         double boundary_limit = _boundary_table[length-1]->altitude_ft;
 249         if (boundary_limit >= altitude_agl_ft) {
 250             do_interpolate(_boundary_table, altitude_agl_ft,
 251                            _environment);
 252             return;
 253         } else if ((boundary_limit + boundary_transition) >= altitude_agl_ft) {
 254                                 // both tables
 255             do_interpolate(_boundary_table, altitude_agl_ft, &env1);
 256             do_interpolate(_aloft_table, altitude_ft, &env2);
 257             double fraction =
 258                 (altitude_agl_ft - boundary_limit) / boundary_transition;
 259             interpolate(&env1, &env2, fraction, _environment);
 260             return;
 261         }
 262     }
 263
 264                                 // aloft table
 265     do_interpolate(_aloft_table, altitude_ft, _environment);
 266 }
 267
 268 void
 269 FGInterpolateEnvironmentCtrl::do_interpolate (vector<bucket *> &table,
 270                                               double altitude_ft,
 271                                               FGEnvironment * environment)
 272 {
 273     int length = table.size();
 274     if (length == 0)
 275         return;
 276
 277                                 // Boundary conditions
 278     if ((length == 1) || (table[0]->altitude_ft >= altitude_ft)) {
 279         environment->copy(table[0]->environment);
 280         return;
 281     } else if (table[length-1]->altitude_ft <= altitude_ft) {
 282         environment->copy(table[length-1]->environment);
 283         return;
 284     }
 285
 286                                 // Search the interpolation table
 287     for (int i = 0; i < length - 1; i++) {
 288         if ((i == length - 1) || (table[i]->altitude_ft <= altitude_ft)) {
 289                 FGEnvironment * env1 = &(table[i]->environment);
 290                 FGEnvironment * env2 = &(table[i+1]->environment);
 291                 double fraction;
 292                 if (table[i]->altitude_ft == table[i+1]->altitude_ft)
 293                     fraction = 1.0;
 294                 else
 295                     fraction =
 296                         ((altitude_ft - table[i]->altitude_ft) /
 297                          (table[i+1]->altitude_ft - table[i]->altitude_ft));
 298                 interpolate(env1, env2, fraction, environment);
 299
 300                 return;
 301         }
 302     }
 303 }
 304
 305 bool
 306 FGInterpolateEnvironmentCtrl::bucket::operator< (const bucket &b) const
 307 {
 308     return (altitude_ft < b.altitude_ft);
 309 }
 310
 311
 312 \f
 313 ////////////////////////////////////////////////////////////////////////
 314 // Implementation of FGMetarEnvironmentCtrl.
 315 ////////////////////////////////////////////////////////////////////////
 316
 317 FGMetarEnvironmentCtrl::FGMetarEnvironmentCtrl ()
 318     : env( new FGInterpolateEnvironmentCtrl ),
 319       _icao( fgGetString("/sim/presets/airport-id") ),
 320       update_interval_sec( 60.0 ),
 321       elapsed( 60.0 )
 322 {
 323 }
 324
 325 FGMetarEnvironmentCtrl::~FGMetarEnvironmentCtrl ()
 326 {
 327    delete env;
 328    env = NULL;
 329 }
 330
 331
 332 // use a "command" to set station temp at station elevation
 333 static void set_temp_at_altitude( float temp_degc, float altitude_ft ) {
 334     SGPropertyNode args;
 335     SGPropertyNode *node = args.getNode("temp-degc", 0, true);
 336     node->setFloatValue( temp_degc );
 337     node = args.getNode("altitude-ft", 0, true);
 338     node->setFloatValue( altitude_ft );
 339     globals->get_commands()->execute("set-outside-air-temp-degc", &args);
 340 }
 341
 342
 343 static void set_dewpoint_at_altitude( float dewpoint_degc, float altitude_ft ) {
 344     SGPropertyNode args;
 345     SGPropertyNode *node = args.getNode("dewpoint-degc", 0, true);
 346     node->setFloatValue( dewpoint_degc );
 347     node = args.getNode("altitude-ft", 0, true);
 348     node->setFloatValue( altitude_ft );
 349     globals->get_commands()->execute("set-dewpoint-temp-degc", &args);
 350 }
 351
 352
 353 void
 354 FGMetarEnvironmentCtrl::update_env_config ()
 355 {
 356     fgSetupWind( fgGetDouble("/environment/metar/base-wind-range-from"),
 357                  fgGetDouble("/environment/metar/base-wind-range-to"),
 358                  fgGetDouble("/environment/metar/base-wind-speed-kt"),
 359                  fgGetDouble("/environment/metar/gust-wind-speed-kt") );
 360
 361     fgDefaultWeatherValue( "visibility-m",
 362                            fgGetDouble("/environment/metar/min-visibility-m") );
 363     set_temp_at_altitude( fgGetDouble("/environment/metar/temperature-degc"),
 364                           station_elevation_ft );
 365     set_dewpoint_at_altitude( fgGetDouble("/environment/metar/dewpoint-degc"),
 366                               station_elevation_ft );
 367     fgDefaultWeatherValue( "pressure-sea-level-inhg",
 368                            fgGetDouble("/environment/metar/pressure-inhg") );
 369 }
 370
 371 void
 372 FGMetarEnvironmentCtrl::init ()
 373 {
 374     const SGPropertyNode *longitude
 375         = fgGetNode( "/position/longitude-deg", true );
 376     const SGPropertyNode *latitude
 377         = fgGetNode( "/position/latitude-deg", true );
 378
 379     bool found_metar = false;
 380     while ( !found_metar ) {
 381         FGAirport a = globals->get_airports()
 382             ->search( longitude->getDoubleValue(),
 383                       latitude->getDoubleValue(),
 384                       true );
 385         if ( fetch_data( a.id ) ) {
 386             cout << "closest station w/ metar = " << a.id << endl;
 387             _icao = a.id;
 388             elapsed = 0.0;
 389             update_env_config();
 390             env->init();
 391             found_metar = true;
 392         } else {
 393             // mark as no metar so it doesn't show up in subsequent
 394             // searches.
 395             cout << "no metar at metar = " << a.id << endl;
 396             globals->get_airports()->no_metar( a.id );
 397         }
 398     }
 399 }
 400
 401 void
 402 FGMetarEnvironmentCtrl::reinit ()
 403 {
 404 #if 0
 405     update_env_config();
 406 #endif
 407
 408     env->reinit();
 409 }
 410
 411 void
 412 FGMetarEnvironmentCtrl::update(double delta_time_sec)
 413 {
 414     const SGPropertyNode *longitude
 415         = fgGetNode( "/position/longitude-deg", true );
 416     const SGPropertyNode *latitude
 417         = fgGetNode( "/position/latitude-deg", true );
 418     elapsed += delta_time_sec;
 419     if ( elapsed > update_interval_sec ) {
 420         FGAirport a = globals->get_airports()
 421             ->search( longitude->getDoubleValue(),
 422                       latitude->getDoubleValue(),
 423                       true );
 424         if ( fetch_data( a.id ) ) {
 425             cout << "closest station w/ metar = " << a.id << endl;
 426            _icao = a.id;
 427             elapsed = 0.0;
 428             update_env_config();
 429             env->reinit();
 430         } else {
 431             // mark as no metar so it doesn't show up in subsequent
 432             // searches.
 433             cout << "no metar at metar = " << a.id << endl;
 434             globals->get_airports()->no_metar( a.id );
 435         }
 436     }
 437     env->update(delta_time_sec);
 438 }
 439
 440 void
 441 FGMetarEnvironmentCtrl::setEnvironment (FGEnvironment * environment)
 442 {
 443     env->setEnvironment(environment);
 444 }
 445
 446 bool
 447 FGMetarEnvironmentCtrl::fetch_data (const string &icao)
 448 {
 449     char s[128];
 450     double d, dt;
 451     int i;
 452
 453     if ((icao == "") && (_icao == "")) {
 454         _icao = fgGetString("/sim/presets/airport-id");
 455
 456     } else if (icao != "") {
 457         _icao = icao;
 458     }
 459
 460     // fetch station elevation if exists
 461     FGAirport a = globals->get_airports()->search( _icao );
 462     station_elevation_ft = a.elevation;
 463
 464     // fetch current metar data
 465     SGMetar *m;
 466     try {
 467         m = new SGMetar( _icao.c_str() );
 468     } catch (const sg_io_exception& e) {
 469         SG_LOG( SG_GENERAL, SG_WARN, "Error fetching live weather data: "
 470                                       << e.getFormattedMessage().c_str() );
 471         return false;
 472     }
 473
 474     d = m->getMinVisibility().getVisibility_m();
 475     d = (d != SGMetarNaN) ? d : 10000;
 476     fgSetDouble("/environment/metar/min-visibility-m", d);
 477
 478     dt =  m->getMaxVisibility().getVisibility_m();
 479     d = (dt != SGMetarNaN) ? dt : d;
 480     fgSetDouble("/environment/metar/max-visibility-m", d);
 481
 482     SGMetarVisibility *dirvis = m->getDirVisibility();
 483     for (i = 0; i < 8; i++, dirvis++) {
 484         const char *min = "/environment/metar/visibility[%d]/min-m";
 485         const char *max = "/environment/metar/visibility[%d]/max-m";
 486         char s[128];
 487
 488         d = dirvis->getVisibility_m();
 489         d = (d != SGMetarNaN) ? d : 10000;
 490
 491         snprintf(s, 128, min, i);
 492         fgSetDouble(s, d);
 493         snprintf(s, 128, max, i);
 494         fgSetDouble(s, d);
 495     }
 496
 497     i = m->getWindDir();
 498     if ( i == -1 ) {
 499         fgSetInt("/environment/metar/base-wind-range-from",
 500                     m->getWindRangeFrom() );
 501         fgSetInt("/environment/metar/base-wind-range-to",
 502                     m->getWindRangeTo() );
 503     } else {
 504         fgSetInt("/environment/metar/base-wind-range-from", i);
 505         fgSetInt("/environment/metar/base-wind-range-to", i);
 506     }
 507     fgSetDouble("/environment/metar/base-wind-speed-kt",
 508                 m->getWindSpeed_kt() );
 509
 510     d = m->getGustSpeed_kt();
 511     d = (d != SGMetarNaN) ? d : 0.0;
 512     fgSetDouble("/environment/metar/gust-wind-speed-kt", d);
 513
 514     d = m->getTemperature_C();
 515     if (d != SGMetarNaN) {
 516         dt = m->getDewpoint_C();
 517         dt = (dt != SGMetarNaN) ? dt : 0.0;
 518         fgSetDouble("/environment/metar/dewpoint-degc", dt);
 519         fgSetDouble("/environment/metar/rel-humidity-norm",
 520                     m->getRelHumidity() );
 521     }
 522     d = (d != SGMetarNaN) ? d : 15.0;
 523     fgSetDouble("/environment/metar/temperature-degc", d);
 524
 525     d = m->getPressure_inHg();
 526     d = (d != SGMetarNaN) ? d : 30.0;
 527     fgSetDouble("/environment/metar/pressure-inhg", d);
 528
 529     vector<SGMetarCloud> cv = m->getClouds();
 530     vector<SGMetarCloud>::iterator cloud;
 531
 532     const char *cl = "/environment/clouds/layer[%i]";
 533     for (i = 0, cloud = cv.begin(); cloud != cv.end(); cloud++, i++) {
 534         const char *coverage_string[5] =
 535             { "clear", "few", "scattered", "broken", "overcast" };
 536         const double thickness[5] = { 0, 65, 600,750, 1000};
 537         int q;
 538
 539         snprintf(s, 128, cl, i);
 540         strncat(s, "/coverage", 128);
 541         q = cloud->getCoverage();
 542         q = (q != -1 ) ? q : 0;
 543         fgSetString(s, coverage_string[q] );
 544
 545         snprintf(s, 128, cl, i);
 546         strncat(s, "/elevation-ft", 128);
 547         d = cloud->getAltitude_ft();
 548         d = (d != SGMetarNaN) ? d : -9999;
 549         fgSetDouble(s, d + station_elevation_ft);
 550
 551         snprintf(s, 128, cl, i);
 552         strncat(s, "/thickness-ft", 128);
 553         fgSetDouble(s, thickness[q]);
 554
 555         snprintf(s, 128, cl, i);
 556         strncat(s, "/span-m", 128);
 557         fgSetDouble(s, 40000.0);
 558     }
 559     for (; i < FGEnvironmentMgr::MAX_CLOUD_LAYERS; i++) {
 560         snprintf(s, 128, cl, i);
 561         strncat(s, "/coverage", 128);
 562         fgSetString(s, "clear");
 563
 564         snprintf(s, 128, cl, i);
 565         strncat(s, "/elevation-ft", 128);
 566         fgSetDouble(s, -9999);
 567
 568         snprintf(s, 128, cl, i);
 569         strncat(s, "/thickness-ft", 128);
 570         fgSetDouble(s, 0);
 571
 572         snprintf(s, 128, cl, i);
 573         strncat(s, "/span-m", 128);
 574         fgSetDouble(s, 40000.0);
 575     }
 576
 577     delete m;
 578
 579     return true;
 580 }
 581
 582
 583 // end of environment_ctrl.cxx