src/Environment/metarproperties.cxx

   1 // metarproperties.cxx -- Parse a METAR and write properties
   2 //
   3 // Written by David Megginson, started May 2002.
   4 // Rewritten by Torsten Dreyer, August 2010
   5 //
   6 // Copyright (C) 2002  David Megginson - david@megginson.com
   7 //
   8 // This program is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU General Public License as
  10 // published by the Free Software Foundation; either version 2 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful, but
  14 // WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  21 //
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include <config.h>
  25 #endif
  26
  27 #include <cstring> // for strlen
  28
  29 #include "metarproperties.hxx"
  30 #include "fgmetar.hxx"
  31 #include "environment.hxx"
  32 #include "atmosphere.hxx"
  33 #include "metarairportfilter.hxx"
  34 #include <simgear/scene/sky/cloud.hxx>
  35 #include <simgear/structure/exception.hxx>
  36 #include <simgear/misc/strutils.hxx>
  37 #include <simgear/magvar/magvar.hxx>
  38 #include <simgear/timing/sg_time.hxx>
  39 #include <Main/fg_props.hxx>
  40
  41 using std::string;
  42
  43 namespace Environment {
  44
  45 static vector<string> coverage_string;
  46
  47 /**
  48  * @brief Helper class to wrap SGMagVar functionality and cache the variation and dip for
  49  *        a certain position.
  50  */
  51 class MagneticVariation : public SGMagVar {
  52 public:
  53   /**
  54    * Constructor
  55    */
  56   MagneticVariation() : _lat(1), _lon(1), _alt(1) {
  57     recalc( 0.0, 0.0, 0.0 );
  58   }
  59
  60   /**
  61    * @brief get the magnetic variation for a specific position at the current time
  62    * @param lon the positions longitude in degrees
  63    * @param lat the positions latitude in degrees
  64    * @param alt the positions height above MSL (aka altitude) in feet
  65    * @return the magnetic variation in degrees
  66    */
  67   double get_variation_deg( double lon, double lat, double alt );
  68
  69   /**
  70    * @brief get the magnetic dip for a specific position at the current time
  71    * @param lon the positions longitude in degrees
  72    * @param lat the positions latitude in degrees
  73    * @param alt the positions height above MSL (aka altitude) in feet
  74    * @return the magnetic dip in degrees
  75    */
  76   double get_dip_deg( double lon, double lat, double alt );
  77 private:
  78   void recalc( double lon, double lat, double alt );
  79   SGTime _time;
  80   double _lat, _lon, _alt;
  81 };
  82
  83 inline void MagneticVariation::recalc( double lon, double lat, double alt )
  84 {
  85   // calculation of magnetic variation is expensive. Cache the position
  86   // and perform this calculation only if it has changed
  87   if( _lon != lon || _lat != lat || _alt != alt ) {
  88     SG_LOG(SG_ENVIRONMENT, SG_DEBUG, "Recalculating magvar for lon=" << lon << ", lat=" << lat << ", alt=" << alt );
  89     _lon = lon;
  90     _lat = lat;
  91     _alt = alt;
  92
  93     SGGeod location(SGGeod::fromDegFt(lon, lat, alt));
  94    _time.update( location, 0, 0 );
  95     update( lon, lat, alt, _time.getJD() );
  96   }
  97 }
  98
  99 inline double MagneticVariation::get_variation_deg( double lon, double lat, double alt )
 100 {
 101   recalc( lon, lat, alt );
 102   return get_magvar() * SGD_RADIANS_TO_DEGREES;
 103 }
 104
 105 inline double MagneticVariation::get_dip_deg( double lon, double lat, double alt )
 106 {
 107   recalc( lon, lat, alt );
 108   return get_magdip() * SGD_RADIANS_TO_DEGREES;
 109 }
 110
 111 MetarProperties::MetarProperties( SGPropertyNode_ptr rootNode ) :
 112   _rootNode(rootNode),
 113   _metarValidNode( rootNode->getNode( "valid", true ) ),
 114   _station_elevation(0.0),
 115   _station_latitude(0.0),
 116   _station_longitude(0.0),
 117   _min_visibility(16000.0),
 118   _max_visibility(16000.0),
 119   _base_wind_dir(0),
 120   _base_wind_range_from(0),
 121   _base_wind_range_to(0),
 122   _wind_speed(0.0),
 123   _wind_from_north_fps(0.0),
 124   _wind_from_east_fps(0.0),
 125   _gusts(0.0),
 126   _temperature(0.0),
 127   _dewpoint(0.0),
 128   _humidity(0.0),
 129   _pressure(0.0),
 130   _sea_level_temperature(0.0),
 131   _sea_level_dewpoint(0.0),
 132   _sea_level_pressure(29.92),
 133   _rain(0.0),
 134   _hail(0.0),
 135   _snow(0.0),
 136   _snow_cover(false),
 137   _day(0),
 138   _hour(0),
 139   _minute(0),
 140   _magneticVariation(new MagneticVariation())
 141 {
 142   // Hack to avoid static initialization order problems on OSX
 143   if( coverage_string.empty() ) {
 144     coverage_string.push_back(SGCloudLayer::SG_CLOUD_CLEAR_STRING);
 145     coverage_string.push_back(SGCloudLayer::SG_CLOUD_FEW_STRING);
 146     coverage_string.push_back(SGCloudLayer::SG_CLOUD_SCATTERED_STRING);
 147     coverage_string.push_back(SGCloudLayer::SG_CLOUD_BROKEN_STRING);
 148     coverage_string.push_back(SGCloudLayer::SG_CLOUD_OVERCAST_STRING);
 149   }
 150   // don't tie metar-valid, so listeners get triggered
 151   _metarValidNode->setBoolValue( false );
 152   _tiedProperties.setRoot( _rootNode );
 153   _tiedProperties.Tie("data", this, &MetarProperties::get_metar, &MetarProperties::set_metar );
 154   _tiedProperties.Tie("station-id", this, &MetarProperties::get_station_id, &MetarProperties::set_station_id );
 155   _tiedProperties.Tie("station-elevation-ft", &_station_elevation );
 156   _tiedProperties.Tie("station-latitude-deg", &_station_latitude );
 157   _tiedProperties.Tie("station-longitude-deg", &_station_longitude );
 158   _tiedProperties.Tie("station-magnetic-variation-deg", this, &MetarProperties::get_magnetic_variation_deg );
 159   _tiedProperties.Tie("station-magnetic-dip-deg", this, &MetarProperties::get_magnetic_dip_deg );
 160   _tiedProperties.Tie("min-visibility-m", &_min_visibility );
 161   _tiedProperties.Tie("max-visibility-m", &_max_visibility );
 162   _tiedProperties.Tie("base-wind-range-from", &_base_wind_range_from );
 163   _tiedProperties.Tie("base-wind-range-to", &_base_wind_range_to );
 164   _tiedProperties.Tie("base-wind-speed-kt", this, &MetarProperties::get_wind_speed, &MetarProperties::set_wind_speed );
 165   _tiedProperties.Tie("base-wind-dir-deg", this, &MetarProperties::get_base_wind_dir, &MetarProperties::set_base_wind_dir );
 166   _tiedProperties.Tie("base-wind-from-north-fps", this, &MetarProperties::get_wind_from_north_fps, &MetarProperties::set_wind_from_north_fps );
 167   _tiedProperties.Tie("base-wind-from-east-fps",this, &MetarProperties::get_wind_from_east_fps, &MetarProperties::set_wind_from_east_fps );
 168   _tiedProperties.Tie("gust-wind-speed-kt", &_gusts );
 169   _tiedProperties.Tie("temperature-degc", &_temperature );
 170   _tiedProperties.Tie("dewpoint-degc", &_dewpoint );
 171   _tiedProperties.Tie("rel-humidity-norm", &_humidity );
 172   _tiedProperties.Tie("pressure-inhg", &_pressure );
 173   _tiedProperties.Tie("temperature-sea-level-degc", &_sea_level_temperature );
 174   _tiedProperties.Tie("dewpoint-sea-level-degc", &_sea_level_dewpoint );
 175   _tiedProperties.Tie("pressure-sea-level-inhg", &_sea_level_pressure );
 176   _tiedProperties.Tie("rain-norm", &_rain );
 177   _tiedProperties.Tie("hail-norm", &_hail );
 178   _tiedProperties.Tie("snow-norm", &_snow);
 179   _tiedProperties.Tie("snow-cover", &_snow_cover );
 180   _tiedProperties.Tie("day", &_day );
 181   _tiedProperties.Tie("hour", &_hour );
 182   _tiedProperties.Tie("minute", &_minute );
 183   _tiedProperties.Tie("decoded", this, &MetarProperties::get_decoded );
 184 }
 185
 186 MetarProperties::~MetarProperties()
 187 {
 188   delete _magneticVariation;
 189 }
 190
 191
 192 static const double thickness_value[] = { 0, 65, 600, 750, 1000 };
 193
 194 const char* MetarProperties::get_metar() const
 195 {
 196     if (!_metar) return "";
 197     return _metar->getData();
 198 }
 199
 200 void MetarProperties::set_metar( const char * metarString )
 201 {
 202     SGSharedPtr<FGMetar> m;
 203     if ((metarString == NULL) || (strlen(metarString) == 0)) {
 204         setMetar(m);
 205         return;
 206     }
 207
 208     try {
 209         m = new FGMetar( metarString );
 210     }
 211     catch( sg_io_exception ) {
 212         SG_LOG( SG_ENVIRONMENT, SG_WARN, "Can't parse metar: " << metarString );
 213         _metarValidNode->setBoolValue(false);
 214         return;
 215     }
 216
 217     setMetar(m);
 218 }
 219
 220 void MetarProperties::setMetar( SGSharedPtr<FGMetar> m )
 221 {
 222     _metar = m;
 223     _decoded.clear();
 224     if (!m) {
 225         return;
 226     }
 227
 228     const vector<string> weather = m->getWeather();
 229     for( vector<string>::const_iterator it = weather.begin(); it != weather.end(); ++it ) {
 230         if( false == _decoded.empty() ) _decoded.append(", ");
 231         _decoded.append(*it);
 232     }
 233
 234     _min_visibility = m->getMinVisibility().getVisibility_m();
 235     _max_visibility = m->getMaxVisibility().getVisibility_m();
 236
 237     const SGMetarVisibility *dirvis = m->getDirVisibility();
 238     for ( int i = 0; i < 8; i++, dirvis++) {
 239         SGPropertyNode *vis = _rootNode->getChild("visibility", i, true);
 240         double v = dirvis->getVisibility_m();
 241
 242         vis->setDoubleValue("min-m", v);
 243         vis->setDoubleValue("max-m", v);
 244     }
 245
 246     set_base_wind_dir(m->getWindDir());
 247     _base_wind_range_from = m->getWindRangeFrom();
 248     _base_wind_range_to = m->getWindRangeTo();
 249     set_wind_speed(m->getWindSpeed_kt());
 250
 251     _gusts = m->getGustSpeed_kt();
 252     _temperature = m->getTemperature_C();
 253     _dewpoint = m->getDewpoint_C();
 254     _humidity = m->getRelHumidity();
 255     _pressure = m->getPressure_inHg();
 256
 257     {
 258         // 1. check the id given in the metar
 259         FGAirport* a = FGAirport::findByIdent(m->getId());
 260
 261         // 2. if unknown, find closest airport with metar to current position
 262         if( a == NULL ) {
 263             SGGeod pos = SGGeod::fromDeg(
 264                 fgGetDouble( "/position/longitude-deg", 0.0 ),
 265                 fgGetDouble( "/position/latitude-deg", 0.0 ) );
 266             a = FGAirport::findClosest(pos, 10000.0, MetarAirportFilter::instance() );
 267         }
 268
 269         // 3. otherwise use ground elevation
 270         if( a != NULL ) {
 271             _station_elevation = a->getElevation();
 272             const SGGeod & towerPosition = a->getTowerLocation();
 273             _station_latitude = towerPosition.getLatitudeDeg();
 274             _station_longitude = towerPosition.getLongitudeDeg();
 275             _station_id = a->ident();
 276         } else {
 277             _station_elevation = fgGetDouble("/position/ground-elev-m", 0.0 ) * SG_METER_TO_FEET;
 278             _station_latitude = fgGetDouble( "/position/latitude-deg", 0.0 );
 279             _station_longitude = fgGetDouble( "/position/longitude-deg", 0.0 );
 280             _station_id = "XXXX";
 281         }
 282     }
 283
 284     {    // calculate sea level temperature, dewpoint and pressure
 285         FGEnvironment dummy; // instantiate a dummy so we can leech a method
 286         dummy.set_elevation_ft( _station_elevation );
 287         dummy.set_temperature_degc( _temperature );
 288         dummy.set_dewpoint_degc( _dewpoint );
 289         _sea_level_temperature = dummy.get_temperature_sea_level_degc();
 290         _sea_level_dewpoint = dummy.get_dewpoint_sea_level_degc();
 291
 292         double elevation_m = _station_elevation * SG_FEET_TO_METER;
 293         double fieldPressure = FGAtmo::fieldPressure( elevation_m, _pressure * atmodel::inHg );
 294         _sea_level_pressure = P_layer(0, elevation_m, fieldPressure, _temperature + atmodel::freezing, atmodel::ISA::lam0) / atmodel::inHg;
 295     }
 296
 297     bool isBC = false;
 298     bool isBR = false;
 299     bool isFG = false;
 300     bool isMI = false;
 301     bool isHZ = false;
 302
 303     {
 304         for( unsigned i = 0; i < 3; i++ ) {
 305             SGPropertyNode_ptr n = _rootNode->getChild("weather", i, true );
 306             vector<struct SGMetar::Weather> weather = m->getWeather2();
 307             struct SGMetar::Weather * w = i < weather.size() ? &weather[i] : NULL;
 308             n->getNode("intensity",true)->setIntValue( w != NULL ? w->intensity : 0 );
 309             n->getNode("vincinity",true)->setBoolValue( w != NULL ? w->vincinity : false );
 310             for( unsigned j = 0; j < 3; j++ ) {
 311
 312                 const string & phenomenon = w != NULL && j < w->phenomena.size() ? w->phenomena[j].c_str() : "";
 313                 n->getChild( "phenomenon", j, true )->setStringValue( phenomenon );
 314
 315                 const string & description = w != NULL && j < w->descriptions.size() ? w->descriptions[j].c_str() : "";
 316                 n->getChild( "description", j, true )->setStringValue( description );
 317
 318                 // need to know later,
 319                 // if its fog(FG) (might be shallow(MI) or patches(BC)) or haze (HZ) or mist(BR)
 320                 if( phenomenon == "FG" ) isFG = true;
 321                 if( phenomenon == "HZ" ) isHZ = true;
 322                 if( phenomenon == "BR" ) isBR = true;
 323                 if( description == "MI" ) isMI = true;
 324                 if( description == "BC" ) isBC = true;
 325             }
 326         }
 327     }
 328
 329     {
 330         static const char * LAYER = "layer";
 331         SGPropertyNode_ptr cloudsNode = _rootNode->getNode("clouds", true );
 332         const vector<SGMetarCloud> & metarClouds = m->getClouds();
 333         unsigned layerOffset = 0; // Oh, this is ugly!
 334
 335         // fog/mist/haze cloud layer does not work with 3d clouds yet :-(
 336         bool setGroundCloudLayer = _rootNode->getBoolValue("set-ground-cloud-layer", false ) &&
 337               false == (fgGetBool("/sim/rendering/shader-effects", false ) &&
 338                         fgGetBool("/sim/rendering/clouds3d-enable", false ) );
 339
 340         if( setGroundCloudLayer ) {
 341             // create a cloud layer #0 starting at the ground if its fog, mist or haze
 342
 343             // make sure layer actually starts at ground and set it's bottom at a constant
 344             // value below the station's elevation
 345             const double LAYER_BOTTOM_STATION_OFFSET =
 346               fgGetDouble( "/environment/params/fog-mist-haze-layer/offset-from-station-elevation-ft", -200 );
 347
 348             SGMetarCloud::Coverage coverage = SGMetarCloud::COVERAGE_NIL;
 349             double thickness = 0;
 350             double alpha = 1.0;
 351
 352             if( isFG ) { // fog
 353                 coverage = SGMetarCloud::getCoverage( isBC ?
 354                     fgGetString( "/environment/params/fog-mist-haze-layer/fog-bc-2dlayer-coverage", SGMetarCloud::COVERAGE_SCATTERED_STRING ) :
 355                     fgGetString( "/environment/params/fog-mist-haze-layer/fog-2dlayer-coverage", SGMetarCloud::COVERAGE_BROKEN_STRING )
 356                 );
 357
 358                 thickness = isMI ?
 359                    fgGetDouble("/environment/params/fog-mist-haze-layer/fog-shallow-thickness-ft",30) - LAYER_BOTTOM_STATION_OFFSET : // shallow fog, 10m/30ft
 360                    fgGetDouble("/environment/params/fog-mist-haze-layer/fog-thickness-ft",500) - LAYER_BOTTOM_STATION_OFFSET; // fog, 150m/500ft
 361                 alpha =  fgGetDouble("/environment/params/fog-mist-haze-layer/fog-2dlayer-alpha", 1.0);
 362             } else if( isBR ) { // mist
 363                 coverage = SGMetarCloud::getCoverage(fgGetString("/environment/params/fog-mist-haze-layer/mist-2dlayer-coverage", SGMetarCloud::COVERAGE_OVERCAST_STRING));
 364                 thickness =  fgGetDouble("/environment/params/fog-mist-haze-layer/mist-thickness-ft",2000) - LAYER_BOTTOM_STATION_OFFSET;
 365                 alpha =  fgGetDouble("/environment/params/fog-mist-haze-layer/mist-2dlayer-alpha",0.8);
 366             } else if( isHZ ) { // haze
 367                 coverage = SGMetarCloud::getCoverage(fgGetString("/environment/params/fog-mist-haze-layer/mist-2dlayer-coverage", SGMetarCloud::COVERAGE_OVERCAST_STRING));
 368                 thickness =  fgGetDouble("/environment/params/fog-mist-haze-layer/haze-thickness-ft",2000) - LAYER_BOTTOM_STATION_OFFSET;
 369                 alpha =  fgGetDouble("/environment/params/fog-mist-haze-layer/haze-2dlayer-alpha",0.6);
 370             }
 371
 372             if( coverage != SGMetarCloud::COVERAGE_NIL ) {
 373
 374                 // if there is a layer above the fog, limit the top to one foot below that layer's bottom
 375                 if( metarClouds.size() > 0 && metarClouds[0].getCoverage() != SGMetarCloud::COVERAGE_CLEAR )
 376                     thickness = metarClouds[0].getAltitude_ft() - LAYER_BOTTOM_STATION_OFFSET - 1;
 377
 378                 SGPropertyNode_ptr layerNode = cloudsNode->getChild(LAYER, 0, true );
 379                 layerNode->setDoubleValue( "coverage-type", SGCloudLayer::getCoverageType(coverage_string[coverage]) );
 380                 layerNode->setStringValue( "coverage", coverage_string[coverage] );
 381                 layerNode->setDoubleValue( "elevation-ft", _station_elevation + LAYER_BOTTOM_STATION_OFFSET );
 382                 layerNode->setDoubleValue( "thickness-ft", thickness );
 383                 layerNode->setDoubleValue( "visibility-m", _min_visibility );
 384                 layerNode->setDoubleValue( "alpha", alpha );
 385                 _min_visibility = _max_visibility =
 386                   fgGetDouble("/environment/params/fog-mist-haze-layer/visibility-above-layer-m",20000.0); // assume good visibility above the fog
 387                 layerOffset = 1;  // shudder
 388             }
 389         }
 390
 391         for( unsigned i = 0; i < 5-layerOffset; i++ ) {
 392             SGPropertyNode_ptr layerNode = cloudsNode->getChild(LAYER, i+layerOffset, true );
 393             SGMetarCloud::Coverage coverage = i < metarClouds.size() ? metarClouds[i].getCoverage() : SGMetarCloud::COVERAGE_CLEAR;
 394             double elevation =
 395                 i >= metarClouds.size() || coverage == SGMetarCloud::COVERAGE_CLEAR ?
 396                 -9999.0 :
 397                 metarClouds[i].getAltitude_ft() + _station_elevation;
 398
 399             layerNode->setDoubleValue( "alpha", 1.0 );
 400             layerNode->setStringValue( "coverage", coverage_string[coverage] );
 401             layerNode->setDoubleValue( "coverage-type", SGCloudLayer::getCoverageType(coverage_string[coverage]) );
 402             layerNode->setDoubleValue( "elevation-ft", elevation );
 403             layerNode->setDoubleValue( "thickness-ft", thickness_value[coverage]);
 404             layerNode->setDoubleValue( "span-m", 40000 );
 405             layerNode->setDoubleValue( "visibility-m", 50.0 );
 406         }
 407     }
 408
 409     _rain = m->getRain();
 410     _hail = m->getHail();
 411     _snow = m->getSnow();
 412     _snow_cover = m->getSnowCover();
 413     _day = m->getDay();
 414     _hour = m->getHour();
 415     _minute = m->getMinute();
 416     _metarValidNode->setBoolValue(true);
 417 }
 418
 419 void MetarProperties::setStationId( const std::string & value )
 420 {
 421     set_station_id(simgear::strutils::strip(value).c_str());
 422 }
 423
 424 double MetarProperties::get_magnetic_variation_deg() const
 425 {
 426   return _magneticVariation->get_variation_deg( _station_longitude, _station_latitude, _station_elevation );
 427 }
 428
 429 double MetarProperties::get_magnetic_dip_deg() const
 430 {
 431   return _magneticVariation->get_dip_deg( _station_longitude, _station_latitude, _station_elevation );
 432 }
 433
 434 static inline void calc_wind_hs( double north_fps, double east_fps, int & heading_deg, double & speed_kt )
 435 {
 436     speed_kt = sqrt((north_fps)*(north_fps)+(east_fps)*(east_fps)) * 3600.0 / (SG_NM_TO_METER * SG_METER_TO_FEET);
 437     heading_deg = SGMiscd::roundToInt(
 438         SGMiscd::normalizeAngle2( atan2( east_fps, north_fps ) ) * SGD_RADIANS_TO_DEGREES );
 439 }
 440
 441 void MetarProperties::set_wind_from_north_fps( double value )
 442 {
 443     _wind_from_north_fps = value;
 444     calc_wind_hs( _wind_from_north_fps, _wind_from_east_fps, _base_wind_dir, _wind_speed );
 445 }
 446
 447 void MetarProperties::set_wind_from_east_fps( double value )
 448 {
 449     _wind_from_east_fps = value;
 450     calc_wind_hs( _wind_from_north_fps, _wind_from_east_fps, _base_wind_dir, _wind_speed );
 451 }
 452
 453 static inline void calc_wind_ne( double heading_deg, double speed_kt, double & north_fps, double & east_fps )
 454 {
 455     double speed_fps = speed_kt * SG_NM_TO_METER * SG_METER_TO_FEET / 3600.0;
 456     north_fps = speed_fps * cos(heading_deg * SGD_DEGREES_TO_RADIANS);
 457     east_fps = speed_fps * sin(heading_deg * SGD_DEGREES_TO_RADIANS);
 458 }
 459
 460 void MetarProperties::set_base_wind_dir( double value )
 461 {
 462     _base_wind_dir = value;
 463     calc_wind_ne( (double)_base_wind_dir, _wind_speed, _wind_from_north_fps, _wind_from_east_fps );
 464 }
 465
 466 void MetarProperties::set_wind_speed( double value )
 467 {
 468     _wind_speed = value;
 469     calc_wind_ne( (double)_base_wind_dir, _wind_speed, _wind_from_north_fps, _wind_from_east_fps );
 470 }
 471
 472
 473 } // namespace Environment