1 // simulates ridge lift
3 // Written by Patrice Poly
4 // Copyright (C) 2009 Patrice Poly - p.polypa@gmail.com
7 // Entirely based on the paper :
8 // http://carrier.csi.cam.ac.uk/forsterlewis/soaring/sim/fsx/dev/sim_probe/sim_probe_paper.html
9 // by Ian Forster-Lewis, University of Cambridge, 26th December 2007
12 // This program is free software; you can redistribute it and/or
13 // modify it under the terms of the GNU General Public License as
14 // published by the Free Software Foundation; either version 2 of the
15 // License, or (at your option) any later version.
17 // This program is distributed in the hope that it will be useful, but
18 // WITHOUT ANY WARRANTY; without even the implied warranty of
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 // General Public License for more details.
22 // You should have received a copy of the GNU General Public License
23 // along with this program; if not, write to the Free Software
24 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
33 #include <Main/fg_props.hxx>
34 #include <Main/globals.hxx>
35 #include <Main/util.hxx>
36 #include <Scenery/scenery.hxx>
43 #include "ridge_lift.hxx"
45 static string CreateIndexedPropertyName(string Property, int index)
47 std::stringstream str;
51 return Property + "[" + tmp + "]";
54 static inline double sign(double x) {
55 return x == 0 ? 0 : x > 0 ? 1.0 : -1.0;
58 static const double BOUNDARY1_m = 40.0;
60 const double FGRidgeLift::dist_probe_m[] = { // in meters
69 FGRidgeLift::FGRidgeLift ()
73 for( int i = 0; i < 5; i++ )
74 probe_elev_m[i] = probe_lat_deg[i] = probe_lon_deg[i] = 0.0;
76 for( int i = 0; i < 4; i++ )
81 FGRidgeLift::~FGRidgeLift()
86 void FGRidgeLift::init(void)
88 _enabled_node = fgGetNode( "/environment/ridge-lift/enabled", false );
90 _ridge_lift_fps_node = fgGetNode("/environment/ridge-lift-fps", true);
91 _surface_wind_from_deg_node =
92 fgGetNode("/environment/config/boundary/entry[0]/wind-from-heading-deg"
94 _surface_wind_speed_node =
95 fgGetNode("/environment/config/boundary/entry[0]/wind-speed-kt"
97 _user_longitude_node = fgGetNode("/position/longitude-deg", true);
98 _user_latitude_node = fgGetNode("/position/latitude-deg", true);
99 _user_altitude_agl_ft_node = fgGetNode("/position/altitude-agl-ft", true);
100 _ground_elev_node = fgGetNode("/position/ground-elev-ft", true );
103 void FGRidgeLift::bind() {
106 for( int i = 0; i < 5; i++ ) {
107 prop = CreateIndexedPropertyName("/environment/ridge-lift/probe-elev-m", i );
108 fgTie( prop.c_str(), this, i, &FGRidgeLift::get_probe_elev_m); // read-only
110 prop = CreateIndexedPropertyName("/environment/ridge-lift/probe-lat-deg", i );
111 fgTie( prop.c_str(), this, i, &FGRidgeLift::get_probe_lat_deg); // read-only
113 prop = CreateIndexedPropertyName("/environment/ridge-lift/probe-lon-deg", i );
114 fgTie( prop.c_str(), this, i, &FGRidgeLift::get_probe_lon_deg); // read-only
117 for( int i = 0; i < 4; i++ ) {
118 prop = CreateIndexedPropertyName("/environment/ridge-lift/slope", i );
119 fgTie( prop.c_str(), this, i, &FGRidgeLift::get_slope); // read-only
123 void FGRidgeLift::unbind() {
126 for( int i = 0; i < 5; i++ ) {
128 prop = CreateIndexedPropertyName("/environment/ridge-lift/probe-elev-m", i );
129 fgUntie( prop.c_str() );
131 prop = CreateIndexedPropertyName("/environment/ridge-lift/probe-lat-deg", i );
132 fgUntie( prop.c_str() );
134 prop = CreateIndexedPropertyName("/environment/ridge-lift/probe-lon-deg", i );
135 fgUntie( prop.c_str() );
138 for( int i = 0; i < 4; i++ ) {
139 prop = CreateIndexedPropertyName("/environment/ridge-lift/slope", i );
140 fgUntie( prop.c_str() );
144 void FGRidgeLift::update(double dt) {
146 if( dt <= SGLimitsd::min() ) // paused, do nothing but keep current lift
149 if( _enabled_node && false == _enabled_node->getBoolValue() ) {
150 // do nothing if lift has been zeroed
151 if( strength != 0.0 ) {
152 if( strength > 0.1 ) {
153 // slowly fade out strong lifts
154 strength = fgGetLowPass( strength, 0, dt );
158 _ridge_lift_fps_node->setDoubleValue( strength );
166 // probe0 is current position
167 probe_lat_deg[0] = _user_latitude_node->getDoubleValue();
168 probe_lon_deg[0] = _user_longitude_node->getDoubleValue();
169 probe_elev_m[0] = _ground_elev_node->getDoubleValue() * SG_FEET_TO_METER;
171 // position is geodetic, need geocentric for advanceRadM
172 SGGeod myGeodPos = SGGeod::fromDegM( probe_lon_deg[0], probe_lat_deg[0], 20000.0 );
173 SGGeoc myGeocPos = SGGeoc::fromGeod( myGeodPos );
174 double ground_wind_from_rad = _surface_wind_from_deg_node->getDoubleValue() * SG_DEGREES_TO_RADIANS + SG_PI;
176 // compute the remaining probes
177 for (int i = 1; i < sizeof(probe_elev_m)/sizeof(probe_elev_m[0]); i++) {
178 SGGeoc probe = myGeocPos.advanceRadM( ground_wind_from_rad, dist_probe_m[i] );
179 // convert to geodetic position for ground level computation
180 SGGeod probeGeod = SGGeod::fromGeoc( probe );
181 probe_lat_deg[i] = probeGeod.getLatitudeDeg();
182 probe_lon_deg[i] = probeGeod.getLongitudeDeg();
183 if (!globals->get_scenery()->get_elevation_m( probeGeod, probe_elev_m[i], NULL )) {
184 // no ground found? use elevation of previous probe :-(
185 probe_elev_m[i] = probe_elev_m[i-1];
190 double adj_slope[sizeof(slope)];
191 slope[0] = (probe_elev_m[0] - probe_elev_m[1]) / dist_probe_m[1];
192 slope[1] = (probe_elev_m[1] - probe_elev_m[2]) / dist_probe_m[2];
193 slope[2] = (probe_elev_m[2] - probe_elev_m[3]) / dist_probe_m[3];
194 slope[3] = (probe_elev_m[4] - probe_elev_m[0]) / -dist_probe_m[4];
196 for (int i = 0; i < sizeof(slope)/sizeof(slope[0]); i++)
197 adj_slope[i] = sin(atan(5.0 * pow ( (fabs(slope[i])),1.7) ) ) *sign(slope[i]);
202 if ( adj_slope [2] < 0.0 ) {
208 if ( ( adj_slope [0] >= 0.0 ) && ( adj_slope [3] < 0.0 ) ) {
213 lift_factor = adj_slope[0]+adj_slope[1]+adj_slope[2]+adj_slope[3];
219 //user altitude above ground
220 double user_altitude_agl_m = _user_altitude_agl_ft_node->getDoubleValue() * SG_FEET_TO_METER;
223 double boundary2_m = 130.0; // in the lift
224 if (lift_factor < 0.0) { // in the sink
225 double highest_probe_temp= max ( probe_elev_m[1], probe_elev_m[2] );
226 double highest_probe_downwind_m= max ( highest_probe_temp, probe_elev_m[3] );
227 boundary2_m = highest_probe_downwind_m - probe_elev_m[0];
231 if ( user_altitude_agl_m < BOUNDARY1_m ) {
232 agl_factor = 0.5+0.5*user_altitude_agl_m /BOUNDARY1_m ;
233 } else if ( user_altitude_agl_m < boundary2_m ) {
236 agl_factor = exp(-(2 + probe_elev_m[0] / 2000) *
237 (user_altitude_agl_m - boundary2_m) / max(probe_elev_m[0],200.0));
240 double ground_wind_speed_mps = _surface_wind_speed_node->getDoubleValue() * SG_NM_TO_METER / 3600;
241 double lift_mps = lift_factor* ground_wind_speed_mps * agl_factor;
243 //the updraft, finally, in ft per second
244 strength = fgGetLowPass( strength, lift_mps * SG_METER_TO_FEET, dt );
245 _ridge_lift_fps_node->setDoubleValue( strength );