]> git.mxchange.org Git - flightgear.git/blobdiff - src/Environment/environment.cxx
Changed to use getId() instead of using a direct iterator comparison,
[flightgear.git] / src / Environment / environment.cxx
index fedccb3bd5ed0daf50e55be6b55ca85d45de9be7..026ebdcb8c3a7634f73252dacd873ceb155e9772 100644 (file)
@@ -16,7 +16,7 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
 #include <simgear/constants.h>
 #include <simgear/debug/logstream.hxx>
 #include <simgear/math/interpolater.hxx>
+#include <simgear/props/props.hxx>
+#include <simgear/environment/visual_enviro.hxx>
 
 #include <Main/fg_props.hxx>
+
 #include "environment.hxx"
 
 
+\f
+////////////////////////////////////////////////////////////////////////
+// Atmosphere model.
+////////////////////////////////////////////////////////////////////////
+
+// Calculated based on the ISA standard day, as found at e.g.
+// http://www.av8n.com/physics/altimetry.htm
+
+// Each line of data has 3 elements:
+//   Elevation (ft), 
+//   temperature factor (dimensionless ratio of absolute temp), 
+//   pressure factor (dimensionless ratio)
+static double atmosphere_data[][3] = {
+ {  -3000.00,   1.021,  1.1133 },
+ {      0.00,   1.000,  1.0000 },
+ {   2952.76,   0.980,  0.8978 },
+ {   5905.51,   0.959,  0.8042 },
+ {   8858.27,   0.939,  0.7187 },
+ {  11811.02,   0.919,  0.6407 },
+ {  14763.78,   0.898,  0.5697 },
+ {  17716.54,   0.878,  0.5052 },
+ {  20669.29,   0.858,  0.4468 },
+ {  23622.05,   0.838,  0.3940 },
+ {  26574.80,   0.817,  0.3463 },
+ {  29527.56,   0.797,  0.3034 },
+ {  32480.31,   0.777,  0.2649 },
+ {  35433.07,   0.756,  0.2305 },
+ {  38385.83,   0.752,  0.2000 },
+ {  41338.58,   0.752,  0.1736 },
+ {  44291.34,   0.752,  0.1506 },
+ {  47244.09,   0.752,  0.1307 },
+ {  50196.85,   0.752,  0.1134 },
+ {  53149.61,   0.752,  0.0984 },
+ {  56102.36,   0.752,  0.0854 },
+ {  59055.12,   0.752,  0.0741 },
+ {  62007.87,   0.752,  0.0643 },
+ {  65000.00,   0.752,  0.0557 },
+ {  68000.00,   0.754,  0.0482 },
+ {  71000.00,   0.758,  0.0418 },
+ {  74000.00,   0.761,  0.0362 },
+ {  77000.00,   0.764,  0.0314 },
+ {  80000.00,   0.767,  0.0273 },
+ {  83000.00,   0.770,  0.0237 },
+ {  86000.00,   0.773,  0.0206 },
+ {  89000.00,   0.777,  0.0179 },
+ {  92000.00,   0.780,  0.0156 },
+ {  95000.00,   0.783,  0.0135 },
+ {  98000.00,   0.786,  0.0118 },
+ { 101000.00,   0.789,  0.0103 },
+ { -1, -1, -1 }
+};
+
+static SGInterpTable * _temperature_degc_table = 0;
+static SGInterpTable * _pressure_inhg_table = 0;
+
+static void
+_setup_tables ()
+{
+  if (_temperature_degc_table != 0)
+      return;
+
+  _temperature_degc_table = new SGInterpTable;
+  _pressure_inhg_table = new SGInterpTable;
+
+  for (int i = 0; atmosphere_data[i][0] != -1; i++) {
+    _temperature_degc_table->addEntry(atmosphere_data[i][0],
+                                     atmosphere_data[i][1]);
+    _pressure_inhg_table->addEntry(atmosphere_data[i][0],
+                                  atmosphere_data[i][2]);
+  }
+}
+
+
+\f
+////////////////////////////////////////////////////////////////////////
+// Implementation of FGEnvironment.
+////////////////////////////////////////////////////////////////////////
+
 FGEnvironment::FGEnvironment()
-  : _temperature_degc_table(new SGInterpTable),
-    _pressure_inhg_table(new SGInterpTable),
-    elevation_ft(0),
+  : elevation_ft(0),
     visibility_m(32000),
     temperature_sea_level_degc(15),
     temperature_degc(15),
@@ -52,36 +131,101 @@ FGEnvironment::FGEnvironment()
     dewpoint_degc(5),
     pressure_sea_level_inhg(29.92),
     pressure_inhg(29.92),
+    turbulence_magnitude_norm(0),
+    turbulence_rate_hz(1),
     wind_from_heading_deg(0),
     wind_speed_kt(0),
     wind_from_north_fps(0),
     wind_from_east_fps(0),
-    wind_from_down_fps(0)
+    wind_from_down_fps(0),
+    altitude_half_to_sun_m(1000),
+    altitude_tropo_top_m(10000)
 {
   _setup_tables();
+  _recalc_density();
+  _recalc_relative_humidity();
 }
 
 FGEnvironment::FGEnvironment (const FGEnvironment &env)
-  : _temperature_degc_table(new SGInterpTable),
-    _pressure_inhg_table(new SGInterpTable),
-    elevation_ft(env.elevation_ft),
-    visibility_m(env.visibility_m),
-    temperature_sea_level_degc(env.temperature_sea_level_degc),
-    dewpoint_sea_level_degc(env.dewpoint_sea_level_degc),
-    pressure_sea_level_inhg(env.pressure_sea_level_inhg),
-    wind_from_heading_deg(env.wind_from_heading_deg),
-    wind_speed_kt(env.wind_speed_kt),
-    wind_from_north_fps(env.wind_from_north_fps),
-    wind_from_east_fps(env.wind_from_east_fps),
-    wind_from_down_fps(env.wind_from_down_fps)
 {
-  _setup_tables();
+    FGEnvironment();
+    copy(env);
 }
 
 FGEnvironment::~FGEnvironment()
 {
-  delete _temperature_degc_table;
-  delete _pressure_inhg_table;
+}
+
+void
+FGEnvironment::copy (const FGEnvironment &env)
+{
+    elevation_ft = env.elevation_ft;
+    visibility_m = env.visibility_m;
+    temperature_sea_level_degc = env.temperature_sea_level_degc;
+    temperature_degc = env.temperature_degc;
+    dewpoint_sea_level_degc = env.dewpoint_sea_level_degc;
+    dewpoint_degc = env.dewpoint_degc;
+    pressure_sea_level_inhg = env.pressure_sea_level_inhg;
+    wind_from_heading_deg = env.wind_from_heading_deg;
+    wind_speed_kt = env.wind_speed_kt;
+    wind_from_north_fps = env.wind_from_north_fps;
+    wind_from_east_fps = env.wind_from_east_fps;
+    wind_from_down_fps = env.wind_from_down_fps;
+    turbulence_magnitude_norm = env.turbulence_magnitude_norm;
+    turbulence_rate_hz = env.turbulence_rate_hz;
+}
+
+static inline bool
+maybe_copy_value (FGEnvironment * env, const SGPropertyNode * node,
+                  const char * name, void (FGEnvironment::*setter)(double))
+{
+    const SGPropertyNode * child = node->getNode(name);
+                                // fragile: depends on not being typed
+                                // as a number
+    if (child != 0 && child->hasValue() &&
+        child->getStringValue()[0] != '\0') {
+        (env->*setter)(child->getDoubleValue());
+        return true;
+    } else {
+        return false;
+    }
+}
+
+void
+FGEnvironment::read (const SGPropertyNode * node)
+{
+    maybe_copy_value(this, node, "visibility-m",
+                     &FGEnvironment::set_visibility_m);
+
+    if (!maybe_copy_value(this, node, "temperature-sea-level-degc",
+                          &FGEnvironment::set_temperature_sea_level_degc))
+        maybe_copy_value(this, node, "temperature-degc",
+                         &FGEnvironment::set_temperature_degc);
+
+    if (!maybe_copy_value(this, node, "dewpoint-sea-level-degc",
+                          &FGEnvironment::set_dewpoint_sea_level_degc))
+        maybe_copy_value(this, node, "dewpoint-degc",
+                         &FGEnvironment::set_dewpoint_degc);
+
+    if (!maybe_copy_value(this, node, "pressure-sea-level-inhg",
+                          &FGEnvironment::set_pressure_sea_level_inhg))
+        maybe_copy_value(this, node, "pressure-inhg",
+                         &FGEnvironment::set_pressure_inhg);
+
+    maybe_copy_value(this, node, "wind-from-heading-deg",
+                     &FGEnvironment::set_wind_from_heading_deg);
+
+    maybe_copy_value(this, node, "wind-speed-kt",
+                     &FGEnvironment::set_wind_speed_kt);
+
+    maybe_copy_value(this, node, "elevation-ft",
+                     &FGEnvironment::set_elevation_ft);
+
+    maybe_copy_value(this, node, "turbulence/magnitude-norm",
+                     &FGEnvironment::set_turbulence_magnitude_norm);
+
+    maybe_copy_value(this, node, "turbulence/rate-hz",
+                     &FGEnvironment::set_turbulence_rate_hz);
 }
 
 
@@ -103,6 +247,12 @@ FGEnvironment::get_temperature_degc () const
   return temperature_degc;
 }
 
+double
+FGEnvironment::get_temperature_degf () const
+{
+  return (temperature_degc * 9.0 / 5.0) + 32.0;
+}
+
 double
 FGEnvironment::get_dewpoint_sea_level_degc () const
 {
@@ -133,6 +283,30 @@ FGEnvironment::get_density_slugft3 () const
   return density_slugft3;
 }
 
+double
+FGEnvironment::get_relative_humidity () const
+{
+  return relative_humidity;
+}
+
+double
+FGEnvironment::get_density_tropo_avg_kgm3 () const
+{
+  return density_tropo_avg_kgm3;
+}
+
+double
+FGEnvironment::get_altitude_half_to_sun_m () const
+{
+  return altitude_half_to_sun_m;
+}
+
+double
+FGEnvironment::get_altitude_tropo_top_m () const
+{
+  return altitude_tropo_top_m;
+}
+
 double
 FGEnvironment::get_wind_from_heading_deg () const
 {
@@ -163,6 +337,21 @@ FGEnvironment::get_wind_from_down_fps () const
   return wind_from_down_fps;
 }
 
+double
+FGEnvironment::get_turbulence_magnitude_norm () const
+{
+  if( sgEnviro.get_turbulence_enable_state() )
+    if (fgGetBool("/environment/params/real-world-weather-fetch") == true)
+      return sgEnviro.get_cloud_turbulence();
+  return turbulence_magnitude_norm;
+}
+
+double
+FGEnvironment::get_turbulence_rate_hz () const
+{
+  return turbulence_rate_hz;
+}
+
 double
 FGEnvironment::get_elevation_ft () const
 {
@@ -191,6 +380,7 @@ FGEnvironment::set_temperature_degc (double t)
   temperature_degc = t;
   _recalc_sl_temperature();
   _recalc_density();
+  _recalc_relative_humidity();
 }
 
 void
@@ -209,6 +399,7 @@ FGEnvironment::set_dewpoint_degc (double t)
   dewpoint_degc = t;
   _recalc_sl_dewpoint();
   _recalc_density();
+  _recalc_relative_humidity();
 }
 
 void
@@ -262,6 +453,18 @@ FGEnvironment::set_wind_from_down_fps (double d)
   _recalc_hdgspd();
 }
 
+void
+FGEnvironment::set_turbulence_magnitude_norm (double t)
+{
+  turbulence_magnitude_norm = t;
+}
+
+void
+FGEnvironment::set_turbulence_rate_hz (double r)
+{
+  turbulence_rate_hz = r;
+}
+
 void
 FGEnvironment::set_elevation_ft (double e)
 {
@@ -270,68 +473,31 @@ FGEnvironment::set_elevation_ft (double e)
   _recalc_alt_dewpoint();
   _recalc_alt_pressure();
   _recalc_density();
+  _recalc_relative_humidity();
 }
 
-// Atmosphere model.
-
-// Copied from YASim Atmosphere.cxx, with m converted to ft, degK
-// converted to degC, Pa converted to inHG, and kg/m^3 converted to
-// slug/ft^3; they were then converted to deltas from the sea-level
-// defaults (approx. 15degC, 29.92inHG, and 0.00237slugs/ft^3).
-
-// Original comment from YASim:
-
-// Copied from McCormick, who got it from "The ARDC Model Atmosphere"
-// Note that there's an error in the text in the first entry,
-// McCormick lists 299.16/101325/1.22500, but those don't agree with
-// R=287.  I chose to correct the temperature to 288.20, since 79F is
-// pretty hot for a "standard" atmosphere.
-
-// Elevation (ft), temperature factor (degK), pressure factor (inHG)
-static double atmosphere_data[][3] = {
- { 0.00, 1.00, 1.000 },
- { 2952.76, 0.98, 0.898 },
- { 5905.51, 0.96, 0.804 },
- { 8858.27, 0.94, 0.719 },
- { 11811.02, 0.92, 0.641 },
- { 14763.78, 0.90, 0.570 },
- { 17716.54, 0.88, 0.506 },
- { 20669.29, 0.86, 0.447 },
- { 23622.05, 0.84, 0.394 },
- { 26574.80, 0.82, 0.347 },
- { 29527.56, 0.80, 0.304 },
- { 32480.31, 0.78, 0.266 },
- { 35433.07, 0.76, 0.231 },
- { 38385.83, 0.75, 0.201 },
- { 41338.58, 0.75, 0.174 },
- { 44291.34, 0.75, 0.151 },
- { 47244.09, 0.75, 0.131 },
- { 50196.85, 0.75, 0.114 },
- { 53149.61, 0.75, 0.099 },
- { 56102.36, 0.75, 0.086 },
- { 59055.12, 0.75, 0.075 },
- { 62007.87, 0.75, 0.065 },
- { -1, -1, -1 }
-};
+void
+FGEnvironment::set_altitude_half_to_sun_m (double alt)
+{
+ altitude_half_to_sun_m = alt;
+ _recalc_density_tropo_avg_kgm3();
+}
 
 void
-FGEnvironment::_setup_tables ()
+FGEnvironment::set_altitude_tropo_top_m (double alt)
 {
-  for (int i = 0; atmosphere_data[i][0] != -1; i++) {
-    _temperature_degc_table->addEntry(atmosphere_data[i][0],
-                                     atmosphere_data[i][1]);
-    _pressure_inhg_table->addEntry(atmosphere_data[i][0],
-                                  atmosphere_data[i][2]);
-  }
+ altitude_tropo_top_m = alt;
+ _recalc_density_tropo_avg_kgm3();
 }
 
+
 void
 FGEnvironment::_recalc_hdgspd ()
 {
   double angle_rad;
 
   if (wind_from_east_fps == 0) {
-    angle_rad = (wind_from_north_fps >= 0 ? SGD_PI/2 : -SGD_PI/2);
+    angle_rad = (wind_from_north_fps >= 0 ? SGD_PI_2 : -SGD_PI_2);
   } else {
     angle_rad = atan(wind_from_north_fps/wind_from_east_fps);
   }
@@ -340,12 +506,22 @@ FGEnvironment::_recalc_hdgspd ()
     wind_from_heading_deg = 90 - wind_from_heading_deg;
   else
     wind_from_heading_deg = 270 - wind_from_heading_deg;
+
+#if 0
+  // FIXME: Windspeed can become negative with these formulas.
+  //        which can cause problems for animations that rely
+  //        on the windspeed property.
   if (angle_rad == 0)
     wind_speed_kt = fabs(wind_from_east_fps
                         * SG_METER_TO_NM * SG_FEET_TO_METER * 3600);
   else
     wind_speed_kt = (wind_from_north_fps / sin(angle_rad))
       * SG_METER_TO_NM * SG_FEET_TO_METER * 3600;
+#else
+  wind_speed_kt = sqrt(wind_from_north_fps * wind_from_north_fps +
+                       wind_from_east_fps * wind_from_east_fps) 
+                  * SG_METER_TO_NM * SG_FEET_TO_METER * 3600;
+#endif
 }
 
 void
@@ -365,9 +541,8 @@ FGEnvironment::_recalc_sl_temperature ()
 {
   // If we're in the stratosphere, leave sea-level temp alone
   if (elevation_ft < 38000) {
-    temperature_sea_level_degc =
-      (temperature_degc + 273.15)
-      /_temperature_degc_table->interpolate(elevation_ft)
+    temperature_sea_level_degc = (temperature_degc + 273.15)
+        / _temperature_degc_table->interpolate(elevation_ft)
       - 273.15;
   }
 }
@@ -376,9 +551,8 @@ void
 FGEnvironment::_recalc_alt_temperature ()
 {
   if (elevation_ft < 38000) {
-    temperature_degc =
-      (temperature_sea_level_degc + 273.15) *
-      _temperature_degc_table->interpolate(elevation_ft) - 273.15;
+    temperature_degc = (temperature_sea_level_degc + 273.15) *
+        _temperature_degc_table->interpolate(elevation_ft) - 273.15;
   } else {
     temperature_degc = -56.49; // Stratosphere is constant
   }
@@ -436,6 +610,111 @@ FGEnvironment::_recalc_density ()
   double virtual_temperature_degr = virtual_temperature_degk * 1.8;
 
   density_slugft3 = pressure_psf / (virtual_temperature_degr * 1718);
+  _recalc_density_tropo_avg_kgm3();
+}
+
+// This is used to calculate the average density on the path 
+// of sunlight to the observer for calculating sun-color
+void
+FGEnvironment::_recalc_density_tropo_avg_kgm3 ()
+{
+  double pressure_mb = pressure_inhg * 33.86;
+  double vaporpressure = 6.11 * pow(10.0, ((7.5 * dewpoint_degc) / (237.7 + dewpoint_degc)));
+
+  double virtual_temp = (temperature_degc + 273.15) / (1 - 0.379 * (vaporpressure/pressure_mb));
+
+  double density_half = (100 * pressure_mb * exp(-altitude_half_to_sun_m / 8000))
+      / (287.05 * virtual_temp);
+  double density_tropo = (100 * pressure_mb * exp((-1 * altitude_tropo_top_m) / 8000))
+      / ( 287.05 * virtual_temp);
+
+  density_tropo_avg_kgm3 = ((density_slugft3 * 515.379) + density_half + density_tropo) / 3;
+}
+
+void
+FGEnvironment::_recalc_relative_humidity ()
+{
+  double vaporpressure = 6.11 * pow(10.0, ((7.5 * dewpoint_degc) / ( 237.7 + dewpoint_degc)));
+  double sat_vaporpressure = 6.11 * pow(10.0, ((7.5 * temperature_degc)
+      / ( 237.7 + temperature_degc)) );
+  relative_humidity = 100 * vaporpressure / sat_vaporpressure ;
+}
+
+
+
+////////////////////////////////////////////////////////////////////////
+// Functions.
+////////////////////////////////////////////////////////////////////////
+
+static inline double
+do_interp (double a, double b, double fraction)
+{
+    double retval = (a + ((b - a) * fraction));
+    return retval;
+}
+
+static inline double
+do_interp_deg (double a, double b, double fraction)
+{
+    a = fmod(a, 360);
+    b = fmod(b, 360);
+    if (fabs(b-a) > 180) {
+        if (a < b)
+            a += 360;
+        else
+            b += 360;
+    }
+    return fmod(do_interp(a, b, fraction), 360);
+}
+
+void
+interpolate (const FGEnvironment * env1, const FGEnvironment * env2,
+             double fraction, FGEnvironment * result)
+{
+    result->set_visibility_m
+        (do_interp(env1->get_visibility_m(),
+                   env2->get_visibility_m(),
+                   fraction));
+
+    result->set_temperature_sea_level_degc
+        (do_interp(env1->get_temperature_sea_level_degc(),
+                   env2->get_temperature_sea_level_degc(),
+                   fraction));
+
+    result->set_dewpoint_degc
+        (do_interp(env1->get_dewpoint_sea_level_degc(),
+                   env2->get_dewpoint_sea_level_degc(),
+                   fraction));
+
+    result->set_pressure_sea_level_inhg
+        (do_interp(env1->get_pressure_sea_level_inhg(),
+                   env2->get_pressure_sea_level_inhg(),
+                   fraction));
+
+    result->set_wind_from_heading_deg
+        (do_interp_deg(env1->get_wind_from_heading_deg(),
+                       env2->get_wind_from_heading_deg(),
+                       fraction));
+
+    result->set_wind_speed_kt
+        (do_interp(env1->get_wind_speed_kt(),
+                   env2->get_wind_speed_kt(),
+                   fraction));
+
+    result->set_elevation_ft
+        (do_interp(env1->get_elevation_ft(),
+                   env2->get_elevation_ft(),
+                   fraction));
+
+    result->set_turbulence_magnitude_norm
+        (do_interp(env1->get_turbulence_magnitude_norm(),
+                   env2->get_turbulence_magnitude_norm(),
+                   fraction));
+
+    result->set_turbulence_rate_hz
+        (do_interp(env1->get_turbulence_rate_hz(),
+                   env2->get_turbulence_rate_hz(),
+                   fraction));
 }
 
 // end of environment.cxx