src/Environment/environment_mgr.cxx

   1 // environment-mgr.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 #include <simgear/scene/sky/sky.hxx>
  25
  26 #include <Main/main.hxx>
  27 #include <Main/fg_props.hxx>
  28 #include <Aircraft/aircraft.hxx>
  29
  30 #include "environment.hxx"
  31 #include "environment_ctrl.hxx"
  32 #include "environment_mgr.hxx"
  33
  34
  35 FGEnvironmentMgr::FGEnvironmentMgr ()
  36   : _environment(new FGEnvironment),
  37     _controller(new FGInterpolateEnvironmentCtrl)
  38 {
  39   _controller->setEnvironment(_environment);
  40   set_subsystem("controller", _controller, 0.5);
  41 }
  42
  43 FGEnvironmentMgr::~FGEnvironmentMgr ()
  44 {
  45   delete _environment;
  46   delete _controller;
  47 }
  48
  49 void
  50 FGEnvironmentMgr::init ()
  51 {
  52   SG_LOG( SG_GENERAL, SG_INFO, "Initializing environment subsystem");
  53   SGSubsystemGroup::init();
  54   _update_fdm();
  55 }
  56
  57 void
  58 FGEnvironmentMgr::reinit ()
  59 {
  60   SG_LOG( SG_GENERAL, SG_INFO, "Reinitializing environment subsystem");
  61   SGSubsystemGroup::reinit();
  62   _update_fdm();
  63 }
  64
  65 void
  66 FGEnvironmentMgr::bind ()
  67 {
  68   fgTie("/environment/visibility-m", _environment,
  69         &FGEnvironment::get_visibility_m, &FGEnvironment::set_visibility_m);
  70   fgSetArchivable("/environment/visibility-m");
  71   fgTie("/environment/temperature-sea-level-degc", _environment,
  72         &FGEnvironment::get_temperature_sea_level_degc,
  73         &FGEnvironment::set_temperature_sea_level_degc);
  74   fgSetArchivable("/environment/temperature-sea-level-degc");
  75   fgTie("/environment/temperature-degc", _environment,
  76         &FGEnvironment::get_temperature_degc); // FIXME: read-only for now
  77   fgTie("/environment/dewpoint-sea-level-degc", _environment,
  78         &FGEnvironment::get_dewpoint_sea_level_degc,
  79         &FGEnvironment::set_dewpoint_sea_level_degc);
  80   fgSetArchivable("/environment/dewpoint-sea-level-degc");
  81   fgTie("/environment/dewpoint-degc", _environment,
  82         &FGEnvironment::get_dewpoint_degc); // FIXME: read-only for now
  83   fgTie("/environment/pressure-sea-level-inhg", _environment,
  84         &FGEnvironment::get_pressure_sea_level_inhg,
  85         &FGEnvironment::set_pressure_sea_level_inhg);
  86   fgSetArchivable("/environment/pressure-sea-level-inhg");
  87   fgTie("/environment/pressure-inhg", _environment,
  88         &FGEnvironment::get_pressure_inhg); // FIXME: read-only for now
  89   fgTie("/environment/density-slugft3", _environment,
  90         &FGEnvironment::get_density_slugft3); // read-only
  91   fgTie("/environment/wind-from-heading-deg", _environment,
  92         &FGEnvironment::get_wind_from_heading_deg,
  93         &FGEnvironment::set_wind_from_heading_deg);
  94   fgTie("/environment/wind-speed-kt", _environment,
  95         &FGEnvironment::get_wind_speed_kt, &FGEnvironment::set_wind_speed_kt);
  96   fgTie("/environment/wind-from-north-fps", _environment,
  97         &FGEnvironment::get_wind_from_north_fps,
  98         &FGEnvironment::set_wind_from_north_fps);
  99   fgSetArchivable("/environment/wind-from-north-fps");
 100   fgTie("/environment/wind-from-east-fps", _environment,
 101         &FGEnvironment::get_wind_from_east_fps,
 102         &FGEnvironment::set_wind_from_east_fps);
 103   fgSetArchivable("/environment/wind-from-east-fps");
 104   fgTie("/environment/wind-from-down-fps", _environment,
 105         &FGEnvironment::get_wind_from_down_fps,
 106         &FGEnvironment::set_wind_from_down_fps);
 107   fgSetArchivable("/environment/wind-from-down-fps");
 108   fgTie("/environment/turbulence/magnitude-norm", _environment,
 109         &FGEnvironment::get_turbulence_magnitude_norm,
 110         &FGEnvironment::set_turbulence_magnitude_norm);
 111   fgSetArchivable("/environment/turbulence/magnitude-norm");
 112   fgTie("/environment/turbulence/rate-hz", _environment,
 113         &FGEnvironment::get_turbulence_rate_hz,
 114         &FGEnvironment::set_turbulence_rate_hz);
 115   fgSetArchivable("/environment/turbulence/rate-hz");
 116
 117   for (int i = 0; i < MAX_CLOUD_LAYERS; i++) {
 118     char buf[128];
 119     sprintf(buf, "/environment/clouds/layer[%d]/span-m", i);
 120     fgTie(buf, this, i,
 121           &FGEnvironmentMgr::get_cloud_layer_span_m,
 122           &FGEnvironmentMgr::set_cloud_layer_span_m);
 123     fgSetArchivable(buf);
 124     sprintf(buf, "/environment/clouds/layer[%d]/elevation-ft", i);
 125     fgTie(buf, this, i,
 126           &FGEnvironmentMgr::get_cloud_layer_elevation_ft,
 127           &FGEnvironmentMgr::set_cloud_layer_elevation_ft);
 128     fgSetArchivable(buf);
 129     sprintf(buf, "/environment/clouds/layer[%d]/thickness-ft", i);
 130     fgTie(buf, this, i,
 131           &FGEnvironmentMgr::get_cloud_layer_thickness_ft,
 132           &FGEnvironmentMgr::set_cloud_layer_thickness_ft);
 133     fgSetArchivable(buf);
 134     sprintf(buf, "/environment/clouds/layer[%d]/transition-ft", i);
 135     fgTie(buf, this, i,
 136           &FGEnvironmentMgr::get_cloud_layer_transition_ft,
 137           &FGEnvironmentMgr::set_cloud_layer_transition_ft);
 138     fgSetArchivable(buf);
 139     sprintf(buf, "/environment/clouds/layer[%d]/coverage", i);
 140     fgTie(buf, this, i,
 141           &FGEnvironmentMgr::get_cloud_layer_coverage,
 142           &FGEnvironmentMgr::set_cloud_layer_coverage);
 143     fgSetArchivable(buf);
 144   }
 145 }
 146
 147 void
 148 FGEnvironmentMgr::unbind ()
 149 {
 150   fgUntie("/environment/visibility-m");
 151   fgUntie("/environment/temperature-sea-level-degc");
 152   fgUntie("/environment/temperature-degc");
 153   fgUntie("/environment/dewpoint-sea-level-degc");
 154   fgUntie("/environment/dewpoint-degc");
 155   fgUntie("/environment/pressure-sea-level-inhg");
 156   fgUntie("/environment/pressure-inhg");
 157   fgUntie("/environment/density-inhg");
 158   fgUntie("/environment/wind-from-north-fps");
 159   fgUntie("/environment/wind-from-east-fps");
 160   fgUntie("/environment/wind-from-down-fps");
 161   for (int i = 0; i < MAX_CLOUD_LAYERS; i++) {
 162     char buf[128];
 163     sprintf(buf, "/environment/clouds/layer[%d]/span-m", i);
 164     fgUntie(buf);
 165     sprintf(buf, "/environment/clouds/layer[%d]/elevation-ft", i);
 166     fgUntie(buf);
 167     sprintf(buf, "/environment/clouds/layer[%d]/thickness-ft", i);
 168     fgUntie(buf);
 169     sprintf(buf, "/environment/clouds/layer[%d]/transition-ft", i);
 170     fgUntie(buf);
 171     sprintf(buf, "/environment/clouds/layer[%d]/type", i);
 172     fgUntie(buf);
 173   }
 174 }
 175
 176 void
 177 FGEnvironmentMgr::update (double dt)
 178 {
 179   SGSubsystemGroup::update(dt);
 180
 181                                 // FIXME: the FDMs should update themselves
 182   current_aircraft.fdm_state
 183     ->set_Velocities_Local_Airmass(_environment->get_wind_from_north_fps(),
 184                                    _environment->get_wind_from_east_fps(),
 185                                    _environment->get_wind_from_down_fps());
 186   _environment->set_elevation_ft(fgGetDouble("/position/altitude-ft"));
 187
 188   _update_fdm();
 189 }
 190
 191 FGEnvironment
 192 FGEnvironmentMgr::getEnvironment () const
 193 {
 194   return *_environment;
 195 }
 196
 197 FGEnvironment
 198 FGEnvironmentMgr::getEnvironment (double lat, double lon, double alt) const
 199 {
 200                                 // Always returns the same environment
 201                                 // for now; we'll make it interesting
 202                                 // later.
 203   FGEnvironment env = *_environment;
 204   env.set_elevation_ft(alt);
 205   return env;
 206 }
 207
 208 void
 209 FGEnvironmentMgr::_update_fdm () const
 210 {
 211   //
 212   // Pass atmosphere on to FDM
 213   // FIXME: have FDMs read properties directly.
 214   //
 215   if (fgGetBool("/environment/params/control-fdm-atmosphere")) {
 216                                 // convert from Rankine to Celsius
 217     cur_fdm_state
 218       ->set_Static_temperature((9.0/5.0)
 219                                * (_environment->get_temperature_degc() + 273.15));
 220                                 // convert from inHG to PSF
 221     cur_fdm_state
 222       ->set_Static_pressure(_environment->get_pressure_inhg() * 70.726566);
 223                                 // keep in slugs/ft^3
 224     cur_fdm_state
 225       ->set_Density(_environment->get_density_slugft3());
 226   }
 227 }
 228
 229 double
 230 FGEnvironmentMgr::get_cloud_layer_span_m (int index) const
 231 {
 232   return thesky->get_cloud_layer(index)->getSpan_m();
 233 }
 234
 235 void
 236 FGEnvironmentMgr::set_cloud_layer_span_m (int index, double span_m)
 237 {
 238   thesky->get_cloud_layer(index)->setSpan_m(span_m);
 239 }
 240
 241 double
 242 FGEnvironmentMgr::get_cloud_layer_elevation_ft (int index) const
 243 {
 244   return thesky->get_cloud_layer(index)->getElevation_m() * SG_METER_TO_FEET;
 245 }
 246
 247 void
 248 FGEnvironmentMgr::set_cloud_layer_elevation_ft (int index, double elevation_ft)
 249 {
 250   FGEnvironment env = *_environment;
 251   env.set_elevation_ft(elevation_ft);
 252
 253   thesky->get_cloud_layer(index)
 254     ->setElevation_m(elevation_ft * SG_FEET_TO_METER);
 255
 256   thesky->get_cloud_layer(index)
 257     ->setSpeed(env.get_wind_speed_kt() * 0.5151);       // 1 kt = 0.5151 m/s
 258
 259   thesky->get_cloud_layer(index)
 260     ->setDirection(env.get_wind_from_heading_deg());
 261 }
 262
 263 double
 264 FGEnvironmentMgr::get_cloud_layer_thickness_ft (int index) const
 265 {
 266   return thesky->get_cloud_layer(index)->getThickness_m() * SG_METER_TO_FEET;
 267 }
 268
 269 void
 270 FGEnvironmentMgr::set_cloud_layer_thickness_ft (int index, double thickness_ft)
 271 {
 272   thesky->get_cloud_layer(index)
 273     ->setThickness_m(thickness_ft * SG_FEET_TO_METER);
 274 }
 275
 276 double
 277 FGEnvironmentMgr::get_cloud_layer_transition_ft (int index) const
 278 {
 279   return thesky->get_cloud_layer(index)->getTransition_m() * SG_METER_TO_FEET;
 280 }
 281
 282 void
 283 FGEnvironmentMgr::set_cloud_layer_transition_ft (int index,
 284                                                  double transition_ft)
 285 {
 286   thesky->get_cloud_layer(index)
 287     ->setTransition_m(transition_ft * SG_FEET_TO_METER);
 288 }
 289
 290 const char *
 291 FGEnvironmentMgr::get_cloud_layer_coverage (int index) const
 292 {
 293   switch (thesky->get_cloud_layer(index)->getCoverage()) {
 294   case SGCloudLayer::SG_CLOUD_OVERCAST:
 295     return "overcast";
 296   case SGCloudLayer::SG_CLOUD_BROKEN:
 297     return "broken";
 298   case SGCloudLayer::SG_CLOUD_SCATTERED:
 299     return "scattered";
 300   case SGCloudLayer::SG_CLOUD_FEW:
 301     return "few";
 302   case SGCloudLayer::SG_CLOUD_CIRRUS:
 303     return "cirrus";
 304   case SGCloudLayer::SG_CLOUD_CLEAR:
 305     return "clear";
 306   default:
 307     return "unknown";
 308   }
 309 }
 310
 311 void
 312 FGEnvironmentMgr::set_cloud_layer_coverage (int index,
 313                                             const char * coverage_name)
 314 {
 315   SGCloudLayer::Coverage coverage;
 316   if (!strcmp(coverage_name, "overcast"))
 317     coverage = SGCloudLayer::SG_CLOUD_OVERCAST;
 318   else if (!strcmp(coverage_name, "broken"))
 319     coverage = SGCloudLayer::SG_CLOUD_BROKEN;
 320   else if (!strcmp(coverage_name, "scattered"))
 321     coverage = SGCloudLayer::SG_CLOUD_SCATTERED;
 322   else if (!strcmp(coverage_name, "few"))
 323     coverage = SGCloudLayer::SG_CLOUD_FEW;
 324   else if (!strcmp(coverage_name, "cirrus"))
 325     coverage = SGCloudLayer::SG_CLOUD_CIRRUS;
 326   else if (!strcmp(coverage_name, "clear"))
 327     coverage = SGCloudLayer::SG_CLOUD_CLEAR;
 328   else {
 329     SG_LOG(SG_INPUT, SG_WARN, "Unknown cloud type " << coverage_name);
 330     coverage = SGCloudLayer::SG_CLOUD_CLEAR;
 331   }
 332   thesky->get_cloud_layer(index)->setCoverage(coverage);
 333 }
 334
 335
 336
 337 // end of environment-mgr.cxx