src/FDM/UIUCModel/uiuc_wrapper.cpp

   1 /**********************************************************************
   2
   3  FILENAME:     uiuc_wrapper.cpp
   4
   5 ----------------------------------------------------------------------
   6
   7  DESCRIPTION:  A wrapper(interface) between the UIUC Aeromodel (C++ files)
   8                and the LaRCsim FDM (C files)
   9
  10 ----------------------------------------------------------------------
  11
  12  STATUS:       alpha version
  13
  14 ----------------------------------------------------------------------
  15
  16  REFERENCES:
  17
  18 ----------------------------------------------------------------------
  19
  20  HISTORY:      01/26/2000   initial release
  21                03/09/2001   (DPM) added support for gear
  22                06/18/2001   (RD) Made uiuc_recorder its own routine.
  23                07/19/2001   (RD) Added uiuc_vel_init() to initialize
  24                             the velocities.
  25                08/27/2001   (RD) Added uiuc_initial_init() to help
  26                             in starting an A/C at an initial condition
  27                02/24/2002   (GD) Added uiuc_network_routine()
  28                03/27/2002   (RD) Changed how forces are calculated when
  29                             body-axis is used
  30                12/11/2002   (RD) Divided uiuc_network_routine into
  31                             uiuc_network_recv_routine and
  32                             uiuc_network_send_routine
  33                03/16/2003   (RD) Added trigger lines in recorder area
  34
  35 ----------------------------------------------------------------------
  36
  37  AUTHOR(S):    Bipin Sehgal       <bsehgal@uiuc.edu>
  38                Robert Deters      <rdeters@uiuc.edu>
  39                Glen Dimock        <dimock@uiuc.edu>
  40                David Megginson    <david@megginson.com>
  41
  42 ----------------------------------------------------------------------
  43
  44  VARIABLES:
  45
  46 ----------------------------------------------------------------------
  47
  48  INPUTS:       *
  49
  50 ----------------------------------------------------------------------
  51
  52  OUTPUTS:      *
  53
  54 ----------------------------------------------------------------------
  55
  56  CALLED BY:    *
  57
  58 ----------------------------------------------------------------------
  59
  60  CALLS TO:     *
  61
  62 ----------------------------------------------------------------------
  63
  64  COPYRIGHT:    (C) 2000 by Michael Selig
  65
  66  This program is free software; you can redistribute it and/or
  67  modify it under the terms of the GNU General Public License
  68  as published by the Free Software Foundation.
  69
  70  This program is distributed in the hope that it will be useful,
  71  but WITHOUT ANY WARRANTY; without even the implied warranty of
  72  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  73  GNU General Public License for more details.
  74
  75  You should have received a copy of the GNU General Public License
  76  along with this program; if not, write to the Free Software
  77  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  78
  79 **********************************************************************/
  80
  81 #ifdef HAVE_CONFIG_H
  82 #  include <config.h>
  83 #endif
  84
  85 #include <iostream>
  86
  87 #include <simgear/compiler.h>
  88 #include <simgear/misc/sg_path.hxx>
  89 #include <Main/fg_props.hxx>
  90
  91 #include "uiuc_aircraft.h"
  92 #include "uiuc_coefficients.h"
  93 #include "uiuc_getwind.h"
  94 #include "uiuc_engine.h"
  95 #include "uiuc_gear.h"
  96 #include "uiuc_aerodeflections.h"
  97 #include "uiuc_recorder.h"
  98 #include "uiuc_menu.h"
  99 #include "uiuc_betaprobe.h"
 100 #include <FDM/LaRCsim/ls_generic.h>
 101 //#include "Main/simple_udp.h"
 102 #include "uiuc_fog.h" //321654
 103 //#include "uiuc_network.h"
 104 #include "uiuc_get_flapper.h"
 105
 106 extern "C" void uiuc_initial_init ();
 107 extern "C" void uiuc_defaults_inits ();
 108 extern "C" void uiuc_vel_init ();
 109 extern "C" void uiuc_init_aeromodel ();
 110 extern "C" void uiuc_force_moment(double dt);
 111 extern "C" void uiuc_engine_routine();
 112 extern "C" void uiuc_wind_routine();
 113 extern "C" void uiuc_gear_routine();
 114 extern "C" void uiuc_record_routine(double dt);
 115 extern "C" void uiuc_network_recv_routine();
 116 extern "C" void uiuc_network_send_routine();
 117
 118 AIRCRAFT *aircraft_ = 0;
 119
 120 // SendArray testarray(4950);
 121
 122 /* Convert float to string */
 123 //string ftoa(double in)
 124 //{
 125 //  static char temp[20];
 126 //  sprintf(temp,"%g",in);
 127 //  return (string)temp;
 128 //}
 129
 130 void uiuc_initial_init ()
 131 {
 132   // This function is called from uiuc_init_2_wrapper (uiuc_aero.c in LaRCsim)
 133   // which is called from ls_step and ls_model.
 134   // Apply brute force initializations, which override unwanted changes
 135   // performed by LaRCsim.
 136   // Used during initialization (while Simtime=0).
 137   if (P_body_init_true)
 138     P_body = P_body_init;
 139   if (Q_body_init_true)
 140     Q_body = Q_body_init;
 141   if (R_body_init_true)
 142     R_body = R_body_init;
 143
 144   if (Phi_init_true)
 145     Phi = Phi_init;
 146   if (Theta_init_true)
 147     Theta = Theta_init;
 148   if (Psi_init_true)
 149     Psi = Psi_init;
 150
 151   if (U_body_init_true)
 152     U_body = U_body_init;
 153   if (V_body_init_true)
 154     V_body = V_body_init;
 155   if (W_body_init_true)
 156     W_body = W_body_init;
 157 }
 158
 159 void uiuc_defaults_inits ()
 160 {
 161   if (aircraft_ == 0)
 162     aircraft_ = new AIRCRAFT;
 163
 164   // set defaults and initialize (called once from uiuc_init_2_wrapper)
 165
 166   //fog inits
 167   fog_field = 0;
 168   fog_segments = 0;
 169   fog_point_index = -1;
 170   fog_time = NULL;
 171   fog_value = NULL;
 172   fog_next_time = 0.0;
 173   fog_current_segment = 0;
 174   Fog = 0;
 175
 176   use_V_rel_wind_2U = false;
 177   nondim_rate_V_rel_wind = false;
 178   use_abs_U_body_2U = false;
 179   use_dyn_on_speed_curve1 = false;
 180   use_Alpha_dot_on_speed = false;
 181   use_gamma_horiz_on_speed = false;
 182   b_downwashMode = false;
 183   P_body_init_true = false;
 184   Q_body_init_true = false;
 185   R_body_init_true = false;
 186   Phi_init_true = false;
 187   Theta_init_true = false;
 188   Psi_init_true = false;
 189   Alpha_init_true = false;
 190   Beta_init_true = false;
 191   U_body_init_true = false;
 192   V_body_init_true = false;
 193   W_body_init_true = false;
 194   trim_case_2 = false;
 195   use_uiuc_network = false;
 196   icing_demo = false;
 197   outside_control = false;
 198   set_Long_trim = false;
 199   zero_Long_trim = false;
 200   elevator_step = false;
 201   elevator_singlet = false;
 202   elevator_doublet = false;
 203   elevator_input = false;
 204   elevator_input_ntime = 0;
 205   aileron_input = false;
 206   aileron_input_ntime = 0;
 207   rudder_input = false;
 208   rudder_input_ntime = 0;
 209   pilot_elev_no = false;
 210   pilot_elev_no_check = false;
 211   pilot_ail_no = false;
 212   pilot_ail_no_check = false;
 213   pilot_rud_no = false;
 214   pilot_rud_no_check = false;
 215   use_flaps = false;
 216   use_spoilers = false;
 217   flap_pos_input = false;
 218   flap_pos_input_ntime = 0;
 219   use_elevator_sas_type1 = false;
 220   use_elevator_sas_max = false;
 221   use_elevator_sas_min = false;
 222   use_elevator_stick_gain = false;
 223   use_aileron_sas_type1 = false;
 224   use_aileron_sas_max = false;
 225   use_aileron_stick_gain = false;
 226   use_rudder_sas_type1 = false;
 227   use_rudder_sas_max = false;
 228   use_rudder_stick_gain = false;
 229   simpleSingleModel = false;
 230   Throttle_pct_input = false;
 231   Throttle_pct_input_ntime = 0;
 232   gyroForce_Q_body = false;
 233   gyroForce_R_body = false;
 234   b_slipstreamEffects = false;
 235   Xp_input = false;
 236   Xp_input_ntime = 0;
 237   Zp_input = false;
 238   Zp_input_ntime = 0;
 239   Mp_input = false;
 240   Mp_input_ntime = 0;
 241   b_CLK = false;
 242   //  gear_model[MAX_GEAR]
 243   memset(gear_model,false,MAX_GEAR*sizeof(gear_model[0]));
 244   use_gear = false;
 245   // start with gear down if it is ultimately used
 246   gear_pos_norm = 1;
 247   ice_model = false;
 248   ice_on = false;
 249   beta_model = false;
 250   //  bootTrue[20] = 0;
 251   memset(bootTrue,false,20*sizeof(gear_model[0]));
 252   eta_from_file = false;
 253   eta_wing_left_input = false;
 254   eta_wing_right_input = false;
 255   eta_tail_input = false;
 256   demo_eps_alpha_max = false;
 257   demo_eps_pitch_max = false;
 258   demo_eps_pitch_min = false;
 259   demo_eps_roll_max = false;
 260   demo_eps_thrust_min = false;
 261   demo_eps_airspeed_max = false;
 262   demo_eps_airspeed_min = false;
 263   demo_eps_flap_max = false;
 264   demo_boot_cycle_tail = false;
 265   demo_boot_cycle_wing_left = false;
 266   demo_boot_cycle_wing_right = false;
 267   demo_eps_pitch_input = false;
 268   tactilefadef = false;
 269   demo_ap_pah_on = false;
 270   demo_ap_alh_on = false;
 271   demo_ap_Theta_ref = false;
 272   demo_ap_alt_ref = false;
 273   demo_tactile = false;
 274   demo_ice_tail = false;
 275   demo_ice_left = false;
 276   demo_ice_right = false;
 277   flapper_model = false;
 278   ignore_unknown_keywords = false;
 279   pilot_throttle_no = false;
 280   Dx_cg = 0.0;
 281   Dy_cg = 0.0;
 282   Dz_cg = 0.0;
 283   ap_pah_on = 0;
 284   ap_alh_on = 0;
 285
 286 }
 287
 288 void uiuc_vel_init ()
 289 {
 290   // Calculates the local velocity (V_north, V_east, V_down) from the body
 291   // velocities.
 292   // Called from uiuc_local_vel_init which is called from ls_step.
 293   // Used during initialization (while Simtime=0)
 294   if (U_body_init_true && V_body_init_true && W_body_init_true)
 295     {
 296   double det_T_l_to_b, cof11, cof12, cof13, cof21, cof22, cof23, cof31, cof32, cof33;
 297
 298   det_T_l_to_b = T_local_to_body_11*(T_local_to_body_22*T_local_to_body_33-T_local_to_body_23*T_local_to_body_32) - T_local_to_body_12*(T_local_to_body_21*T_local_to_body_33-T_local_to_body_23*T_local_to_body_31) + T_local_to_body_13*(T_local_to_body_21*T_local_to_body_32-T_local_to_body_22*T_local_to_body_31);
 299   cof11 = T_local_to_body_22 * T_local_to_body_33 - T_local_to_body_23 * T_local_to_body_32;
 300   cof12 = T_local_to_body_23 * T_local_to_body_31 - T_local_to_body_21 * T_local_to_body_33;
 301   cof13 = T_local_to_body_21 * T_local_to_body_32 - T_local_to_body_22 * T_local_to_body_31;
 302   cof21 = T_local_to_body_13 * T_local_to_body_32 - T_local_to_body_12 * T_local_to_body_33;
 303   cof22 = T_local_to_body_11 * T_local_to_body_33 - T_local_to_body_13 * T_local_to_body_31;
 304   cof23 = T_local_to_body_12 * T_local_to_body_31 - T_local_to_body_11 * T_local_to_body_32;
 305   cof31 = T_local_to_body_12 * T_local_to_body_23 - T_local_to_body_13 * T_local_to_body_22;
 306   cof32 = T_local_to_body_13 * T_local_to_body_21 - T_local_to_body_11 * T_local_to_body_23;
 307   cof33 = T_local_to_body_11 * T_local_to_body_22 - T_local_to_body_12 * T_local_to_body_21;
 308
 309   V_north = (cof11*U_body+cof21*V_body+cof31*W_body)/det_T_l_to_b;
 310   V_east_rel_ground = (cof12*U_body+cof22*V_body+cof32*W_body)/det_T_l_to_b;
 311   V_down = (cof13*U_body+cof23*V_body+cof33*W_body)/det_T_l_to_b;
 312
 313   V_east = V_east_rel_ground + OMEGA_EARTH*Sea_level_radius*cos(Lat_geocentric);
 314     }
 315 }
 316
 317 void uiuc_init_aeromodel ()
 318 {
 319   // Initializes the UIUC aircraft model.
 320   // Called once from uiuc_init_2_wrapper
 321   SGPath path(globals->get_fg_root());
 322   path.append(fgGetString("/sim/aircraft-dir"));
 323   path.append("aircraft.dat");
 324   std::cout << "We are using "<< path.str() << std::endl;
 325   uiuc_initializemaps(); // Initialize the <string,int> maps
 326   uiuc_menu(path.str());   // Read the specified aircraft file
 327 }
 328
 329 void uiuc_force_moment(double dt)
 330 {
 331   double qS = Dynamic_pressure * Sw;
 332   double qScbar = qS * cbar;
 333   double qSb = qS * bw;
 334
 335   uiuc_aerodeflections(dt);
 336   uiuc_coefficients(dt);
 337
 338   /* Calculate the forces */
 339   if (CX && CZ)
 340     {
 341       F_X_aero = CX * qS;
 342       F_Y_aero = CY * qS;
 343       F_Z_aero = CZ * qS;
 344     }
 345   else
 346     {
 347       // Cos_beta * Cos_beta corrects V_rel_wind to get normal q onto wing,
 348       // hence Cos_beta * Cos_beta term included.
 349       // Same thing is done w/ moments below.
 350       // Without this "die-off" function, lift would be produced in a 90 deg sideslip, when
 351       // that should not be the case.  See FGFS notes 021105
 352       F_X_wind = -CD * qS  * Cos_beta * Cos_beta;
 353       F_Y_wind =  CY * qS;
 354       F_Z_wind = -CL * qS  * Cos_beta * Cos_beta;
 355       // F_X_wind = -CD * qS  * Cos_beta * Cos_beta;
 356       // F_Y_wind =  CY * qS  * Cos_beta * Cos_beta;
 357       // F_Z_wind = -CL * qS  * Cos_beta * Cos_beta;
 358
 359       // wind-axis to body-axis transformation
 360       F_X_aero = F_X_wind * Cos_alpha * Cos_beta - F_Y_wind * Cos_alpha * Sin_beta - F_Z_wind * Sin_alpha;
 361       F_Y_aero = F_X_wind * Sin_beta + F_Y_wind * Cos_beta;
 362       F_Z_aero = F_X_wind * Sin_alpha * Cos_beta - F_Y_wind * Sin_alpha * Sin_beta + F_Z_wind * Cos_alpha;
 363     }
 364   // Moment calculations
 365   M_l_aero = Cl * qSb    ;
 366   M_m_aero = Cm * qScbar * Cos_beta * Cos_beta;
 367   M_n_aero = Cn * qSb    ;
 368   // M_l_aero = Cl * qSb    * Cos_beta * Cos_beta;
 369   // M_m_aero = Cm * qScbar * Cos_beta * Cos_beta;
 370   // M_n_aero = Cn * qSb    * Cos_beta * Cos_beta;
 371
 372   // Adding in apparent mass effects
 373   if (Mass_appMass_ratio)
 374     F_Z_aero += -(Mass_appMass_ratio * Mass) * W_dot_body;
 375   if (I_xx_appMass_ratio)
 376     M_l_aero += -(I_xx_appMass_ratio * I_xx) * P_dot_body;
 377   if (I_yy_appMass_ratio)
 378     M_m_aero += -(I_yy_appMass_ratio * I_yy) * Q_dot_body;
 379   if (I_zz_appMass_ratio)
 380     M_n_aero += -(I_zz_appMass_ratio * I_zz) * R_dot_body;
 381
 382   // adding in apparent mass in body axis X direction
 383   // F_X_aero += -(0.05 * Mass) * U_dot_body;
 384
 385
 386   if (Mass_appMass)
 387     F_Z_aero += -Mass_appMass * W_dot_body;
 388   if (I_xx_appMass)
 389     M_l_aero += -I_xx_appMass * P_dot_body;
 390   if (I_yy_appMass)
 391     M_m_aero += -I_yy_appMass * Q_dot_body;
 392   if (I_zz_appMass)
 393     M_n_aero += -I_zz_appMass * R_dot_body;
 394
 395   // gyroscopic moments
 396   // engineOmega is positive when rotation is ccw when viewed from the front
 397   if (gyroForce_Q_body)
 398     M_n_aero +=  polarInertia * engineOmega * Q_body;
 399   if (gyroForce_R_body)
 400     M_m_aero += -polarInertia * engineOmega * R_body;
 401
 402   // ornithopter support
 403   if (flapper_model)
 404     {
 405       uiuc_get_flapper(dt);
 406       F_X_aero += F_X_aero_flapper;
 407       F_Z_aero += F_Z_aero_flapper;
 408       M_m_aero += flapper_Moment;
 409     }
 410
 411   // fog field update
 412    Fog = 0;
 413    if (fog_field)
 414      uiuc_fog();
 415
 416    double vis;
 417    if (Fog != 0)
 418    {
 419      vis = fgGetDouble("/environment/visibility-m");
 420      if (Fog > 0)
 421        vis /= 1.01;
 422      else
 423        vis *= 1.01;
 424      fgSetDouble("/environment/visibility-m", vis);
 425    }
 426
 427
 428   /* Send data on the network to the Glass Cockpit */
 429
 430    //  string input="";
 431
 432    //  input += " stick_right " + ftoa(Lat_control);
 433    //  input += " rudder_left " + ftoa(-Rudder_pedal);
 434    //  input += " stick_forward " + ftoa(Long_control);
 435    //  input += " stick_trim_forward " + ftoa(Long_trim);
 436    //  input += " vehicle_pitch " + ftoa(Theta * 180.0 / 3.14);
 437    //  input += " vehicle_roll " + ftoa(Phi * 180.0 / 3.14);
 438    //  input += " vehicle_speed " + ftoa(V_rel_wind);
 439    //  input += " throttle_forward " + ftoa(Throttle_pct);
 440    //  input += " altitude " + ftoa(Altitude);
 441    //  input += " climb_rate " + ftoa(-1.0*V_down_rel_ground);
 442
 443    //  testarray.getHello();
 444    //  testarray.sendData(input);
 445
 446   /* End of Networking */
 447
 448 }
 449
 450 void uiuc_wind_routine()
 451 {
 452   uiuc_getwind();
 453 }
 454
 455 void uiuc_engine_routine()
 456 {
 457   uiuc_engine();
 458 }
 459
 460 void uiuc_gear_routine ()
 461 {
 462   uiuc_gear();
 463 }
 464
 465 void uiuc_record_routine(double dt)
 466 {
 467   if (trigger_last_time_step == 0 && trigger_on == 1) {
 468     if (trigger_toggle == 0)
 469       trigger_toggle = 1;
 470     else
 471       trigger_toggle = 0;
 472     trigger_num++;
 473     if (trigger_num % 2 != 0)
 474       trigger_counter++;
 475   }
 476
 477   if (Simtime >= recordStartTime)
 478     uiuc_recorder(dt);
 479
 480   trigger_last_time_step = trigger_on;
 481 }
 482
 483 void uiuc_network_recv_routine()
 484 {
 485   //if (use_uiuc_network)
 486   //  uiuc_network(1);
 487 }
 488
 489 void uiuc_network_send_routine()
 490 {
 491   //if (use_uiuc_network)
 492   //  uiuc_network(2);
 493 }
 494 //end uiuc_wrapper.cpp