1 // LaRCsim.cxx -- interface to the LaRCsim flight model
3 // Written by Curtis Olson, started October 1998.
5 // Copyright (C) 1998 Curtis L. Olson - curt@me.umn.edu
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., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include <simgear/constants.h>
25 #include <simgear/debug/logstream.hxx>
27 #include <Aircraft/aircraft.hxx>
28 #include <Controls/controls.hxx>
29 #include <FDM/flight.hxx>
30 #include <FDM/LaRCsim/ls_cockpit.h>
31 #include <FDM/LaRCsim/ls_generic.h>
32 #include <FDM/LaRCsim/ls_interface.h>
35 #include "LaRCsim.hxx"
38 // Initialize the LaRCsim flight model, dt is the time increment for
39 // each subsequent iteration through the EOM
40 int FGLaRCsim::init( double dt ) {
42 #ifdef USE_NEW_ENGINE_CODE
43 // Initialize our little engine that hopefully might
45 // dcl - in passing dt to init rather than update I am assuming
46 // that the LaRCsim dt is fixed at one value (yes it is 120hz CLO)
48 // update the engines interface
53 // cout << "FGLaRCsim::init()" << endl;
55 double save_alt = 0.0;
57 if ( get_Altitude() < -9000.0 ) {
58 save_alt = get_Altitude();
62 // translate FG to LaRCsim structure
65 // actual LaRCsim top level init
66 ls_toplevel_init( dt, (char *)current_options.get_aircraft().c_str() );
68 FG_LOG( FG_FLIGHT, FG_INFO, "FG pos = " <<
71 // translate LaRCsim back to FG structure
74 // but lets restore our original bogus altitude when we are done
75 if ( save_alt < -9000.0 ) {
76 set_Altitude( save_alt );
79 // set valid time for this record
86 // Run an iteration of the EOM (equations of motion)
87 int FGLaRCsim::update( int multiloop ) {
88 // cout << "FGLaRCsim::update()" << endl;
90 #ifdef USE_NEW_ENGINE_CODE
92 eng.set_IAS( V_calibrated_kts );
93 eng.set_Throttle_Lever_Pos( controls.get_throttle( 0 ) * 100.0 );
94 eng.set_Propeller_Lever_Pos( 100 );
95 if ( controls.get_mixture( 0 ) > 0.51 ) {
96 eng.set_Mixture_Lever_Pos( controls.get_mixture( 0 ) * 100.0 );
98 eng.set_Mixture_Lever_Pos( 51.0 );
101 // update engine model
104 // copy engine state values onto "bus"
105 FGEngInterface *e = get_engine( 0 );
106 e->set_Throttle( controls.get_throttle( 0 ) * 100.0 );
107 e->set_Mixture( 80 );
108 e->set_Prop_Advance( 100 );
109 e->set_RPM( eng.get_RPM() );
110 e->set_Manifold_Pressure( eng.get_Manifold_Pressure() );
111 e->set_MaxHP( eng.get_MaxHP() );
112 e->set_Percentage_Power( eng.get_Percentage_Power() );
113 e->set_EGT( eng.get_EGT() );
114 e->set_prop_thrust( eng.get_prop_thrust_SI() );
117 cout << "Throttle = " << controls.get_throttle( 0 ) * 100.0;
118 cout << " Mixture = " << 80;
119 cout << " RPM = " << eng.get_RPM();
120 cout << " MP = " << eng.get_Manifold_Pressure();
121 cout << " HP = " << ( eng.get_MaxHP() * eng.get_Percentage_Power()
123 cout << " EGT = " << eng.get_EGT();
124 cout << " Thrust (N) " << eng.get_prop_thrust_SI(); // Thrust in Newtons
128 F_X_engine = eng.get_prop_thrust_SI() * 0.07;
129 #endif // USE_NEW_ENGINE_CODE
131 double save_alt = 0.0;
132 double time_step = (1.0 / current_options.get_model_hz()) * multiloop;
133 double start_elev = get_Altitude();
135 // lets try to avoid really screwing up the LaRCsim model
136 if ( get_Altitude() < -9000.0 ) {
137 save_alt = get_Altitude();
141 // copy control positions into the LaRCsim structure
142 Lat_control = controls.get_aileron() / current_options.get_speed_up();
143 Long_control = controls.get_elevator();
144 Long_trim = controls.get_elevator_trim();
145 Rudder_pedal = controls.get_rudder() / current_options.get_speed_up();
146 Flap_handle = 30.0 * controls.get_flaps();
147 #ifdef USE_NEW_ENGINE_CODE
148 Throttle_pct = -1.0; // tells engine model to use propellor thrust
150 Throttle_pct = controls.get_throttle( 0 ) * 1.0;
152 Brake_pct[0] = controls.get_brake( 1 );
153 Brake_pct[1] = controls.get_brake( 0 );
155 // Inform LaRCsim of the local terrain altitude
156 Runway_altitude = get_Runway_altitude();
159 V_north_airmass = get_V_north_airmass();
160 V_east_airmass = get_V_east_airmass();
161 V_down_airmass = get_V_down_airmass();
163 // old -- FGInterface_2_LaRCsim() not needed except for Init()
164 // translate FG to LaRCsim structure
165 // FGInterface_2_LaRCsim(f);
166 // printf("FG_Altitude = %.2f\n", FG_Altitude * 0.3048);
167 // printf("Altitude = %.2f\n", Altitude * 0.3048);
168 // printf("Radius to Vehicle = %.2f\n", Radius_to_vehicle * 0.3048);
170 ls_update(multiloop);
172 // printf("%d FG_Altitude = %.2f\n", i, FG_Altitude * 0.3048);
173 // printf("%d Altitude = %.2f\n", i, Altitude * 0.3048);
175 // translate LaRCsim back to FG structure so that the
176 // autopilot (and the rest of the sim can use the updated
180 // but lets restore our original bogus altitude when we are done
181 if ( save_alt < -9000.0 ) {
182 set_Altitude( save_alt );
185 double end_elev = get_Altitude();
186 if ( time_step > 0.0 ) {
188 set_Climb_Rate( (end_elev - start_elev) / time_step );
195 // Convert from the FGInterface struct to the LaRCsim generic_ struct
196 int FGLaRCsim::copy_to_LaRCsim () {
202 // Dx_pilot = get_Dx_pilot();
203 // Dy_pilot = get_Dy_pilot();
204 // Dz_pilot = get_Dz_pilot();
211 // F_north = get_F_north();
212 // F_east = get_F_east();
213 // F_down = get_F_down();
214 // F_X_aero = get_F_X_aero();
215 // F_Y_aero = get_F_Y_aero();
216 // F_Z_aero = get_F_Z_aero();
217 // F_X_engine = get_F_X_engine();
218 // F_Y_engine = get_F_Y_engine();
219 // F_Z_engine = get_F_Z_engine();
220 // F_X_gear = get_F_X_gear();
221 // F_Y_gear = get_F_Y_gear();
222 // F_Z_gear = get_F_Z_gear();
223 // M_l_rp = get_M_l_rp();
224 // M_m_rp = get_M_m_rp();
225 // M_n_rp = get_M_n_rp();
226 // M_l_cg = get_M_l_cg();
227 // M_m_cg = get_M_m_cg();
228 // M_n_cg = get_M_n_cg();
229 // M_l_aero = get_M_l_aero();
230 // M_m_aero = get_M_m_aero();
231 // M_n_aero = get_M_n_aero();
232 // M_l_engine = get_M_l_engine();
233 // M_m_engine = get_M_m_engine();
234 // M_n_engine = get_M_n_engine();
235 // M_l_gear = get_M_l_gear();
236 // M_m_gear = get_M_m_gear();
237 // M_n_gear = get_M_n_gear();
238 // V_dot_north = get_V_dot_north();
239 // V_dot_east = get_V_dot_east();
240 // V_dot_down = get_V_dot_down();
241 // U_dot_body = get_U_dot_body();
242 // V_dot_body = get_V_dot_body();
243 // W_dot_body = get_W_dot_body();
244 // A_X_cg = get_A_X_cg();
245 // A_Y_cg = get_A_Y_cg();
246 // A_Z_cg = get_A_Z_cg();
247 // A_X_pilot = get_A_X_pilot();
248 // A_Y_pilot = get_A_Y_pilot();
249 // A_Z_pilot = get_A_Z_pilot();
250 // N_X_cg = get_N_X_cg();
251 // N_Y_cg = get_N_Y_cg();
252 // N_Z_cg = get_N_Z_cg();
253 // N_X_pilot = get_N_X_pilot();
254 // N_Y_pilot = get_N_Y_pilot();
255 // N_Z_pilot = get_N_Z_pilot();
256 // P_dot_body = get_P_dot_body();
257 // Q_dot_body = get_Q_dot_body();
258 // R_dot_body = get_R_dot_body();
259 V_north = get_V_north();
260 V_east = get_V_east();
261 V_down = get_V_down();
262 // V_north_rel_ground = get_V_north_rel_ground();
263 // V_east_rel_ground = get_V_east_rel_ground();
264 // V_down_rel_ground = get_V_down_rel_ground();
265 // V_north_airmass = get_V_north_airmass();
266 // V_east_airmass = get_V_east_airmass();
267 // V_down_airmass = get_V_down_airmass();
268 // V_north_rel_airmass = get_V_north_rel_airmass();
269 // V_east_rel_airmass = get_V_east_rel_airmass();
270 // V_down_rel_airmass = get_V_down_rel_airmass();
271 // U_gust = get_U_gust();
272 // V_gust = get_V_gust();
273 // W_gust = get_W_gust();
274 // U_body = get_U_body();
275 // V_body = get_V_body();
276 // W_body = get_W_body();
277 // V_rel_wind = get_V_rel_wind();
278 // V_true_kts = get_V_true_kts();
279 // V_rel_ground = get_V_rel_ground();
280 // V_inertial = get_V_inertial();
281 // V_ground_speed = get_V_ground_speed();
282 // V_equiv = get_V_equiv();
283 // V_equiv_kts = get_V_equiv_kts();
284 // V_calibrated = get_V_calibrated();
285 // V_calibrated_kts = get_V_calibrated_kts();
286 P_body = get_P_body();
287 Q_body = get_Q_body();
288 R_body = get_R_body();
289 // P_local = get_P_local();
290 // Q_local = get_Q_local();
291 // R_local = get_R_local();
292 // P_total = get_P_total();
293 // Q_total = get_Q_total();
294 // R_total = get_R_total();
295 // Phi_dot = get_Phi_dot();
296 // Theta_dot = get_Theta_dot();
297 // Psi_dot = get_Psi_dot();
298 // Latitude_dot = get_Latitude_dot();
299 // Longitude_dot = get_Longitude_dot();
300 // Radius_dot = get_Radius_dot();
301 Lat_geocentric = get_Lat_geocentric();
302 Lon_geocentric = get_Lon_geocentric();
303 Radius_to_vehicle = get_Radius_to_vehicle();
304 Latitude = get_Latitude();
305 Longitude = get_Longitude();
306 Altitude = get_Altitude();
310 // T_local_to_body_11 = get_T_local_to_body_11();
311 // T_local_to_body_12 = get_T_local_to_body_12();
312 // T_local_to_body_13 = get_T_local_to_body_13();
313 // T_local_to_body_21 = get_T_local_to_body_21();
314 // T_local_to_body_22 = get_T_local_to_body_22();
315 // T_local_to_body_23 = get_T_local_to_body_23();
316 // T_local_to_body_31 = get_T_local_to_body_31();
317 // T_local_to_body_32 = get_T_local_to_body_32();
318 // T_local_to_body_33 = get_T_local_to_body_33();
319 // Gravity = get_Gravity();
320 // Centrifugal_relief = get_Centrifugal_relief();
321 // Alpha = get_Alpha();
322 // Beta = get_Beta();
323 // Alpha_dot = get_Alpha_dot();
324 // Beta_dot = get_Beta_dot();
325 // Cos_alpha = get_Cos_alpha();
326 // Sin_alpha = get_Sin_alpha();
327 // Cos_beta = get_Cos_beta();
328 // Sin_beta = get_Sin_beta();
329 // Cos_phi = get_Cos_phi();
330 // Sin_phi = get_Sin_phi();
331 // Cos_theta = get_Cos_theta();
332 // Sin_theta = get_Sin_theta();
333 // Cos_psi = get_Cos_psi();
334 // Sin_psi = get_Sin_psi();
335 // Gamma_vert_rad = get_Gamma_vert_rad();
336 // Gamma_horiz_rad = get_Gamma_horiz_rad();
337 // Sigma = get_Sigma();
338 // Density = get_Density();
339 // V_sound = get_V_sound();
340 // Mach_number = get_Mach_number();
341 // Static_pressure = get_Static_pressure();
342 // Total_pressure = get_Total_pressure();
343 // Impact_pressure = get_Impact_pressure();
344 // Dynamic_pressure = get_Dynamic_pressure();
345 // Static_temperature = get_Static_temperature();
346 // Total_temperature = get_Total_temperature();
347 Sea_level_radius = get_Sea_level_radius();
348 Earth_position_angle = get_Earth_position_angle();
349 Runway_altitude = get_Runway_altitude();
350 // Runway_latitude = get_Runway_latitude();
351 // Runway_longitude = get_Runway_longitude();
352 // Runway_heading = get_Runway_heading();
353 // Radius_to_rwy = get_Radius_to_rwy();
354 // D_cg_north_of_rwy = get_D_cg_north_of_rwy();
355 // D_cg_east_of_rwy = get_D_cg_east_of_rwy();
356 // D_cg_above_rwy = get_D_cg_above_rwy();
357 // X_cg_rwy = get_X_cg_rwy();
358 // Y_cg_rwy = get_Y_cg_rwy();
359 // H_cg_rwy = get_H_cg_rwy();
360 // D_pilot_north_of_rwy = get_D_pilot_north_of_rwy();
361 // D_pilot_east_of_rwy = get_D_pilot_east_of_rwy();
362 // D_pilot_above_rwy = get_D_pilot_above_rwy();
363 // X_pilot_rwy = get_X_pilot_rwy();
364 // Y_pilot_rwy = get_Y_pilot_rwy();
365 // H_pilot_rwy = get_H_pilot_rwy();
371 // Convert from the LaRCsim generic_ struct to the FGInterface struct
372 int FGLaRCsim::copy_from_LaRCsim() {
374 // Mass properties and geometry values
375 set_Inertias( Mass, I_xx, I_yy, I_zz, I_xz );
376 // set_Pilot_Location( Dx_pilot, Dy_pilot, Dz_pilot );
377 set_CG_Position( Dx_cg, Dy_cg, Dz_cg );
380 // set_Forces_Body_Total( F_X, F_Y, F_Z );
381 // set_Forces_Local_Total( F_north, F_east, F_down );
382 // set_Forces_Aero( F_X_aero, F_Y_aero, F_Z_aero );
383 // set_Forces_Engine( F_X_engine, F_Y_engine, F_Z_engine );
384 // set_Forces_Gear( F_X_gear, F_Y_gear, F_Z_gear );
387 // set_Moments_Total_RP( M_l_rp, M_m_rp, M_n_rp );
388 // set_Moments_Total_CG( M_l_cg, M_m_cg, M_n_cg );
389 // set_Moments_Aero( M_l_aero, M_m_aero, M_n_aero );
390 // set_Moments_Engine( M_l_engine, M_m_engine, M_n_engine );
391 // set_Moments_Gear( M_l_gear, M_m_gear, M_n_gear );
394 set_Accels_Local( V_dot_north, V_dot_east, V_dot_down );
395 set_Accels_Body( U_dot_body, V_dot_body, W_dot_body );
396 set_Accels_CG_Body( A_X_cg, A_Y_cg, A_Z_cg );
397 set_Accels_Pilot_Body( A_X_pilot, A_Y_pilot, A_Z_pilot );
398 // set_Accels_CG_Body_N( N_X_cg, N_Y_cg, N_Z_cg );
399 // set_Accels_Pilot_Body_N( N_X_pilot, N_Y_pilot, N_Z_pilot );
400 // set_Accels_Omega( P_dot_body, Q_dot_body, R_dot_body );
403 set_Velocities_Local( V_north, V_east, V_down );
404 // set_Velocities_Ground( V_north_rel_ground, V_east_rel_ground,
405 // V_down_rel_ground );
406 // set_Velocities_Local_Airmass( V_north_airmass, V_east_airmass,
408 // set_Velocities_Local_Rel_Airmass( V_north_rel_airmass,
409 // V_east_rel_airmass, V_down_rel_airmass );
410 // set_Velocities_Gust( U_gust, V_gust, W_gust );
411 set_Velocities_Wind_Body( U_body, V_body, W_body );
413 // set_V_rel_wind( V_rel_wind );
414 // set_V_true_kts( V_true_kts );
415 // set_V_rel_ground( V_rel_ground );
416 // set_V_inertial( V_inertial );
417 set_V_ground_speed( V_ground_speed );
418 // set_V_equiv( V_equiv );
419 set_V_equiv_kts( V_equiv_kts );
420 // set_V_calibrated( V_calibrated );
421 set_V_calibrated_kts( V_calibrated_kts );
423 set_Omega_Body( P_body, Q_body, R_body );
424 // set_Omega_Local( P_local, Q_local, R_local );
425 // set_Omega_Total( P_total, Q_total, R_total );
427 set_Euler_Rates( Phi_dot, Theta_dot, Psi_dot );
428 set_Geocentric_Rates( Latitude_dot, Longitude_dot, Radius_dot );
430 set_Mach_number( Mach_number );
432 FG_LOG( FG_FLIGHT, FG_DEBUG, "lon = " << Longitude
433 << " lat_geoc = " << Lat_geocentric << " lat_geod = " << Latitude
434 << " alt = " << Altitude << " sl_radius = " << Sea_level_radius
435 << " radius_to_vehicle = " << Radius_to_vehicle );
437 double tmp_lon_geoc = Lon_geocentric;
438 while ( tmp_lon_geoc < -FG_PI ) { tmp_lon_geoc += FG_2PI; }
439 while ( tmp_lon_geoc > FG_PI ) { tmp_lon_geoc -= FG_2PI; }
441 double tmp_lon = Longitude;
442 while ( tmp_lon < -FG_PI ) { tmp_lon += FG_2PI; }
443 while ( tmp_lon > FG_PI ) { tmp_lon -= FG_2PI; }
446 set_Geocentric_Position( Lat_geocentric, tmp_lon_geoc,
448 set_Geodetic_Position( Latitude, tmp_lon, Altitude );
449 set_Euler_Angles( Phi, Theta, Psi );
451 // Miscellaneous quantities
452 set_T_Local_to_Body(T_local_to_body_m);
453 // set_Gravity( Gravity );
454 // set_Centrifugal_relief( Centrifugal_relief );
458 // set_Alpha_dot( Alpha_dot );
459 // set_Beta_dot( Beta_dot );
461 // set_Cos_alpha( Cos_alpha );
462 // set_Sin_alpha( Sin_alpha );
463 // set_Cos_beta( Cos_beta );
464 // set_Sin_beta( Sin_beta );
466 set_Cos_phi( Cos_phi );
467 // set_Sin_phi( Sin_phi );
468 set_Cos_theta( Cos_theta );
469 // set_Sin_theta( Sin_theta );
470 // set_Cos_psi( Cos_psi );
471 // set_Sin_psi( Sin_psi );
473 set_Gamma_vert_rad( Gamma_vert_rad );
474 // set_Gamma_horiz_rad( Gamma_horiz_rad );
476 // set_Sigma( Sigma );
477 set_Density( Density );
478 // set_V_sound( V_sound );
479 // set_Mach_number( Mach_number );
481 set_Static_pressure( Static_pressure );
482 // set_Total_pressure( Total_pressure );
483 // set_Impact_pressure( Impact_pressure );
484 // set_Dynamic_pressure( Dynamic_pressure );
486 set_Static_temperature( Static_temperature );
487 // set_Total_temperature( Total_temperature );
489 set_Sea_level_radius( Sea_level_radius );
490 set_Earth_position_angle( Earth_position_angle );
492 set_Runway_altitude( Runway_altitude );
493 // set_Runway_latitude( Runway_latitude );
494 // set_Runway_longitude( Runway_longitude );
495 // set_Runway_heading( Runway_heading );
496 // set_Radius_to_rwy( Radius_to_rwy );
498 // set_CG_Rwy_Local( D_cg_north_of_rwy, D_cg_east_of_rwy, D_cg_above_rwy);
499 // set_CG_Rwy_Rwy( X_cg_rwy, Y_cg_rwy, H_cg_rwy );
500 // set_Pilot_Rwy_Local( D_pilot_north_of_rwy, D_pilot_east_of_rwy,
501 // D_pilot_above_rwy );
502 // set_Pilot_Rwy_Rwy( X_pilot_rwy, Y_pilot_rwy, H_pilot_rwy );
504 set_sin_lat_geocentric(Lat_geocentric);
505 set_cos_lat_geocentric(Lat_geocentric);
506 set_sin_cos_longitude(Longitude);
507 set_sin_cos_latitude(Latitude);
509 // printf("sin_lat_geo %f cos_lat_geo %f\n", sin_Lat_geoc, cos_Lat_geoc);
510 // printf("sin_lat %f cos_lat %f\n",
511 // get_sin_latitude(), get_cos_latitude());
512 // printf("sin_lon %f cos_lon %f\n",
513 // get_sin_longitude(), get_cos_longitude());