1 // environment.cxx -- routines to model the natural environment
3 // Written by David Megginson, started February 2002.
5 // Copyright (C) 2002 David Megginson - david@megginson.com
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
36 #include <simgear/constants.h>
37 #include <simgear/debug/logstream.hxx>
38 #include <simgear/math/interpolater.hxx>
39 #include <simgear/environment/visual_enviro.hxx>
41 #include <Main/fg_props.hxx>
42 #include "environment.hxx"
46 ////////////////////////////////////////////////////////////////////////
48 ////////////////////////////////////////////////////////////////////////
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).
55 // Original comment from YASim:
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.
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 },
90 static SGInterpTable * _temperature_degc_table = 0;
91 static SGInterpTable * _pressure_inhg_table = 0;
96 if (_temperature_degc_table != 0)
99 _temperature_degc_table = new SGInterpTable;
100 _pressure_inhg_table = new SGInterpTable;
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]);
112 ////////////////////////////////////////////////////////////////////////
113 // Implementation of FGEnvironment.
114 ////////////////////////////////////////////////////////////////////////
116 FGEnvironment::FGEnvironment()
119 temperature_sea_level_degc(15),
120 temperature_degc(15),
121 dewpoint_sea_level_degc(5), // guess
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),
129 wind_from_north_fps(0),
130 wind_from_east_fps(0),
131 wind_from_down_fps(0)
137 FGEnvironment::FGEnvironment (const FGEnvironment &env)
143 FGEnvironment::~FGEnvironment()
148 FGEnvironment::copy (const FGEnvironment &env)
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;
167 maybe_copy_value (FGEnvironment * env, const SGPropertyNode * node,
168 const char * name, void (FGEnvironment::*setter)(double))
170 const SGPropertyNode * child = node->getNode(name);
171 // fragile: depends on not being typed
173 if (child != 0 && child->hasValue() &&
174 child->getStringValue()[0] != '\0') {
175 (env->*setter)(child->getDoubleValue());
183 FGEnvironment::read (const SGPropertyNode * node)
185 maybe_copy_value(this, node, "visibility-m",
186 &FGEnvironment::set_visibility_m);
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);
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);
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);
203 maybe_copy_value(this, node, "wind-from-heading-deg",
204 &FGEnvironment::set_wind_from_heading_deg);
206 maybe_copy_value(this, node, "wind-speed-kt",
207 &FGEnvironment::set_wind_speed_kt);
209 maybe_copy_value(this, node, "elevation-ft",
210 &FGEnvironment::set_elevation_ft);
212 maybe_copy_value(this, node, "turbulence/magnitude-norm",
213 &FGEnvironment::set_turbulence_magnitude_norm);
215 maybe_copy_value(this, node, "turbulence/rate-hz",
216 &FGEnvironment::set_turbulence_rate_hz);
221 FGEnvironment::get_visibility_m () const
227 FGEnvironment::get_temperature_sea_level_degc () const
229 return temperature_sea_level_degc;
233 FGEnvironment::get_temperature_degc () const
235 return temperature_degc;
239 FGEnvironment::get_temperature_degf () const
241 return (temperature_degc * 9.0 / 5.0) + 32.0;
245 FGEnvironment::get_dewpoint_sea_level_degc () const
247 return dewpoint_sea_level_degc;
251 FGEnvironment::get_dewpoint_degc () const
253 return dewpoint_degc;
257 FGEnvironment::get_pressure_sea_level_inhg () const
259 return pressure_sea_level_inhg;
263 FGEnvironment::get_pressure_inhg () const
265 return pressure_inhg;
269 FGEnvironment::get_density_slugft3 () const
271 return density_slugft3;
275 FGEnvironment::get_wind_from_heading_deg () const
277 return wind_from_heading_deg;
281 FGEnvironment::get_wind_speed_kt () const
283 return wind_speed_kt;
287 FGEnvironment::get_wind_from_north_fps () const
289 return wind_from_north_fps;
293 FGEnvironment::get_wind_from_east_fps () const
295 return wind_from_east_fps;
299 FGEnvironment::get_wind_from_down_fps () const
301 return wind_from_down_fps;
305 FGEnvironment::get_turbulence_magnitude_norm () const
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;
314 FGEnvironment::get_turbulence_rate_hz () const
316 return turbulence_rate_hz;
320 FGEnvironment::get_elevation_ft () const
326 FGEnvironment::set_visibility_m (double v)
332 FGEnvironment::set_temperature_sea_level_degc (double t)
334 temperature_sea_level_degc = t;
335 if (dewpoint_sea_level_degc > t)
336 dewpoint_sea_level_degc = t;
337 _recalc_alt_temperature();
342 FGEnvironment::set_temperature_degc (double t)
344 temperature_degc = t;
345 _recalc_sl_temperature();
350 FGEnvironment::set_dewpoint_sea_level_degc (double t)
352 dewpoint_sea_level_degc = t;
353 if (temperature_sea_level_degc < t)
354 temperature_sea_level_degc = t;
355 _recalc_alt_dewpoint();
360 FGEnvironment::set_dewpoint_degc (double t)
363 _recalc_sl_dewpoint();
368 FGEnvironment::set_pressure_sea_level_inhg (double p)
370 pressure_sea_level_inhg = p;
371 _recalc_alt_pressure();
376 FGEnvironment::set_pressure_inhg (double p)
379 _recalc_sl_pressure();
384 FGEnvironment::set_wind_from_heading_deg (double h)
386 wind_from_heading_deg = h;
391 FGEnvironment::set_wind_speed_kt (double s)
398 FGEnvironment::set_wind_from_north_fps (double n)
400 wind_from_north_fps = n;
405 FGEnvironment::set_wind_from_east_fps (double e)
407 wind_from_east_fps = e;
412 FGEnvironment::set_wind_from_down_fps (double d)
414 wind_from_down_fps = d;
419 FGEnvironment::set_turbulence_magnitude_norm (double t)
421 turbulence_magnitude_norm = t;
425 FGEnvironment::set_turbulence_rate_hz (double r)
427 turbulence_rate_hz = r;
431 FGEnvironment::set_elevation_ft (double e)
434 _recalc_alt_temperature();
435 _recalc_alt_dewpoint();
436 _recalc_alt_pressure();
441 FGEnvironment::_recalc_hdgspd ()
445 if (wind_from_east_fps == 0) {
446 angle_rad = (wind_from_north_fps >= 0 ? SGD_PI_2 : -SGD_PI_2);
448 angle_rad = atan(wind_from_north_fps/wind_from_east_fps);
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;
454 wind_from_heading_deg = 270 - wind_from_heading_deg;
457 // FIXME: Windspeed can become negative with these formulas.
458 // which can cause problems for animations that rely
459 // on the windspeed property.
461 wind_speed_kt = fabs(wind_from_east_fps
462 * SG_METER_TO_NM * SG_FEET_TO_METER * 3600);
464 wind_speed_kt = (wind_from_north_fps / sin(angle_rad))
465 * SG_METER_TO_NM * SG_FEET_TO_METER * 3600;
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;
474 FGEnvironment::_recalc_ne ()
477 wind_speed_kt * SG_NM_TO_METER * SG_METER_TO_FEET * (1.0/3600);
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);
486 FGEnvironment::_recalc_sl_temperature ()
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)
498 FGEnvironment::_recalc_alt_temperature ()
500 if (elevation_ft < 38000) {
502 (temperature_sea_level_degc + 273.15) *
503 _temperature_degc_table->interpolate(elevation_ft) - 273.15;
505 temperature_degc = -56.49; // Stratosphere is constant
510 FGEnvironment::_recalc_sl_dewpoint ()
513 // FIXME: this will work only for low
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;
521 FGEnvironment::_recalc_alt_dewpoint ()
524 // FIXME: this will work only for low
526 dewpoint_degc = dewpoint_sea_level_degc + (elevation_ft * .0002);
527 if (dewpoint_degc > temperature_degc)
528 dewpoint_degc = temperature_degc;
532 FGEnvironment::_recalc_sl_pressure ()
534 pressure_sea_level_inhg =
535 pressure_inhg / _pressure_inhg_table->interpolate(elevation_ft);
539 FGEnvironment::_recalc_alt_pressure ()
542 pressure_sea_level_inhg * _pressure_inhg_table->interpolate(elevation_ft);
546 FGEnvironment::_recalc_density ()
548 double pressure_psf = pressure_inhg * 70.7487;
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;
560 density_slugft3 = pressure_psf / (virtual_temperature_degr * 1718);
565 ////////////////////////////////////////////////////////////////////////
567 ////////////////////////////////////////////////////////////////////////
570 do_interp (double a, double b, double fraction)
572 double retval = (a + ((b - a) * fraction));
577 do_interp_deg (double a, double b, double fraction)
581 if (fabs(b-a) > 180) {
587 return fmod(do_interp(a, b, fraction), 360);
591 interpolate (const FGEnvironment * env1, const FGEnvironment * env2,
592 double fraction, FGEnvironment * result)
594 result->set_visibility_m
595 (do_interp(env1->get_visibility_m(),
596 env2->get_visibility_m(),
599 result->set_temperature_sea_level_degc
600 (do_interp(env1->get_temperature_sea_level_degc(),
601 env2->get_temperature_sea_level_degc(),
604 result->set_dewpoint_degc
605 (do_interp(env1->get_dewpoint_sea_level_degc(),
606 env2->get_dewpoint_sea_level_degc(),
609 result->set_pressure_sea_level_inhg
610 (do_interp(env1->get_pressure_sea_level_inhg(),
611 env2->get_pressure_sea_level_inhg(),
614 result->set_wind_from_heading_deg
615 (do_interp_deg(env1->get_wind_from_heading_deg(),
616 env2->get_wind_from_heading_deg(),
619 result->set_wind_speed_kt
620 (do_interp(env1->get_wind_speed_kt(),
621 env2->get_wind_speed_kt(),
624 result->set_elevation_ft
625 (do_interp(env1->get_elevation_ft(),
626 env2->get_elevation_ft(),
629 result->set_turbulence_magnitude_norm
630 (do_interp(env1->get_turbulence_magnitude_norm(),
631 env2->get_turbulence_magnitude_norm(),
634 result->set_turbulence_rate_hz
635 (do_interp(env1->get_turbulence_rate_hz(),
636 env2->get_turbulence_rate_hz(),
640 // end of environment.cxx