src/FDM/JSBSim.cxx

   1 // JSBsim.cxx -- interface to the JSBsim flight model
   2 //
   3 // Written by Curtis Olson, started February 1999.
   4 //
   5 // Copyright (C) 1999  Curtis L. Olson  - curt@flightgear.org
   6 //
   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.
  11 //
  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.
  16 //
  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.
  20 //
  21 // $Id$
  22
  23
  24 #include <simgear/compiler.h>
  25
  26 #ifdef FG_MATH_EXCEPTION_CLASH
  27 #  include <math.h>
  28 #endif
  29
  30 #include STL_STRING
  31
  32 #include <simgear/constants.h>
  33 #include <simgear/debug/logstream.hxx>
  34 #include <simgear/math/sg_geodesy.hxx>
  35 #include <simgear/misc/fgpath.hxx>
  36
  37 #include <Scenery/scenery.hxx>
  38
  39 #include <Aircraft/aircraft.hxx>
  40 #include <Controls/controls.hxx>
  41 #include <Main/options.hxx>
  42
  43 #include <FDM/JSBSim/FGFDMExec.h>
  44 #include <FDM/JSBSim/FGAircraft.h>
  45 #include <FDM/JSBSim/FGFCS.h>
  46 #include <FDM/JSBSim/FGPosition.h>
  47 #include <FDM/JSBSim/FGRotation.h>
  48 #include <FDM/JSBSim/FGState.h>
  49 #include <FDM/JSBSim/FGTranslation.h>
  50 #include <FDM/JSBSim/FGAuxiliary.h>
  51 #include <FDM/JSBSim/FGDefs.h>
  52 #include <FDM/JSBSim/FGInitialCondition.h>
  53 #include <FDM/JSBSim/FGTrimLong.h>
  54 #include <FDM/JSBSim/FGAtmosphere.h>
  55
  56 #include "JSBSim.hxx"
  57
  58 /******************************************************************************/
  59
  60 // Initialize the JSBsim flight model, dt is the time increment for
  61 // each subsequent iteration through the EOM
  62
  63 int FGJSBsim::init( double dt ) {
  64
  65   bool result;
  66
  67   FG_LOG( FG_FLIGHT, FG_INFO, "Starting and initializing JSBsim" );
  68   FG_LOG( FG_FLIGHT, FG_INFO, "  created FDMExec" );
  69
  70   FGPath aircraft_path( current_options.get_fg_root() );
  71   aircraft_path.append( "Aircraft" );
  72
  73   FGPath engine_path( current_options.get_fg_root() );
  74   engine_path.append( "Engine" );
  75
  76   FDMExec.GetState()->Setdt( dt );
  77
  78   result = FDMExec.GetAircraft()->LoadAircraft( aircraft_path.str(),
  79                                        engine_path.str(),
  80                                        current_options.get_aircraft() );
  81
  82   if (result) {
  83     FG_LOG( FG_FLIGHT, FG_INFO, "  loaded aircraft" << current_options.get_aircraft() );
  84   } else {
  85     FG_LOG( FG_FLIGHT, FG_INFO, "  aircraft" << current_options.get_aircraft()
  86                                 << " does not exist");
  87     return 0;
  88   }
  89
  90   FDMExec.GetAtmosphere()->SetExTemperature(get_Static_temperature());
  91   FDMExec.GetAtmosphere()->SetExPressure(get_Static_pressure());
  92   FDMExec.GetAtmosphere()->SetExDensity(get_Density());
  93   FDMExec.GetAtmosphere()->SetWindNED(get_V_north_airmass(),
  94                                       get_V_east_airmass(),
  95                                       get_V_down_airmass());
  96
  97   FDMExec.GetAtmosphere()->UseInternal();
  98
  99   FG_LOG( FG_FLIGHT, FG_INFO, "  Initializing JSBSim with:" );
 100
 101   FGInitialCondition *fgic = new FGInitialCondition(&FDMExec);
 102   fgic->SetAltitudeFtIC(get_Altitude());
 103   if((current_options.get_mach() < 0) && (current_options.get_vc() < 0 )) {
 104     fgic->SetUBodyFpsIC(current_options.get_uBody());
 105     fgic->SetVBodyFpsIC(current_options.get_vBody());
 106     fgic->SetWBodyFpsIC(current_options.get_wBody());
 107     FG_LOG(FG_FLIGHT,FG_INFO, "  u,v,w= " << current_options.get_uBody()
 108            << ", " << current_options.get_vBody()
 109            << ", " << current_options.get_wBody());
 110   } else if (current_options.get_vc() < 0) {
 111     fgic->SetMachIC(current_options.get_mach());
 112     FG_LOG(FG_FLIGHT,FG_INFO, "  mach: " << current_options.get_mach() );
 113   } else {
 114     fgic->SetVcalibratedKtsIC(current_options.get_vc());
 115     FG_LOG(FG_FLIGHT,FG_INFO, "  vc: " << current_options.get_vc() );
 116     //this should cover the case in which no speed switches are used
 117     //current_options.get_vc() will return zero by default
 118   }
 119
 120
 121   fgic->SetRollAngleRadIC(get_Phi());
 122   fgic->SetPitchAngleRadIC(get_Theta());
 123   fgic->SetHeadingRadIC(get_Psi());
 124 //  fgic->SetLatitudeRadIC(get_Latitude());
 125   fgic->SetLatitudeRadIC(get_Lat_geocentric());
 126   fgic->SetLongitudeRadIC(get_Longitude());
 127
 128   FDMExec.GetPosition()->SetRunwayRadius(scenery.cur_radius*METER_TO_FEET);
 129   FDMExec.GetPosition()->SetSeaLevelRadius(get_Sea_level_radius());
 130
 131   FG_LOG( FG_FLIGHT, FG_INFO, "  phi: " <<  get_Phi());
 132   FG_LOG( FG_FLIGHT, FG_INFO, "  theta: " <<  get_Theta() );
 133   FG_LOG( FG_FLIGHT, FG_INFO, "  psi: " <<  get_Psi() );
 134   FG_LOG( FG_FLIGHT, FG_INFO, "  lat: " <<  get_Latitude() );
 135   FG_LOG( FG_FLIGHT, FG_INFO, "  lon: " <<  get_Longitude() );
 136   FG_LOG( FG_FLIGHT, FG_INFO, "  alt: " <<  get_Altitude() );
 137
 138   //must check > 0, != 0 will give bad result if --notrim set
 139   if(current_options.get_trim_mode() > 0) {
 140     FDMExec.RunIC(fgic);
 141     FG_LOG( FG_FLIGHT, FG_INFO, "  Starting trim..." );
 142     FGTrimLong *fgtrim=new FGTrimLong(&FDMExec,fgic);
 143     fgtrim->DoTrim();
 144     fgtrim->Report();
 145     fgtrim->TrimStats();
 146     fgtrim->ReportState();
 147
 148     controls.set_elevator_trim(FDMExec.GetFCS()->GetPitchTrimCmd());
 149     controls.set_throttle(FGControls::ALL_ENGINES,FDMExec.GetFCS()->GetThrottleCmd(0)/100);
 150     //the trimming routine only knows how to get 1 value for throttle
 151
 152
 153     delete fgtrim;
 154     FG_LOG( FG_FLIGHT, FG_INFO, "  Trim complete." );
 155   } else {
 156     FG_LOG( FG_FLIGHT, FG_INFO, "  Initializing without trim" );
 157     FDMExec.GetState()->Initialize(fgic);
 158
 159   }
 160
 161   delete fgic;
 162
 163   FG_LOG( FG_FLIGHT, FG_INFO, "  loaded initial conditions" );
 164
 165   FG_LOG( FG_FLIGHT, FG_INFO, "  set dt" );
 166
 167   FG_LOG( FG_FLIGHT, FG_INFO, "Finished initializing JSBSim" );
 168
 169   copy_from_JSBsim();
 170
 171   return 1;
 172 }
 173
 174 /******************************************************************************/
 175
 176 // Run an iteration of the EOM (equations of motion)
 177
 178 int FGJSBsim::update( int multiloop ) {
 179   double save_alt = 0.0;
 180   double time_step = (1.0 / current_options.get_model_hz()) * multiloop;
 181   double start_elev = get_Altitude();
 182
 183   // lets try to avoid really screwing up the JSBsim model
 184   if ( get_Altitude() < -9000 ) {
 185     save_alt = get_Altitude();
 186     set_Altitude( 0.0 );
 187   }
 188
 189   // copy control positions into the JSBsim structure
 190
 191   FDMExec.GetFCS()->SetDaCmd( controls.get_aileron());
 192   FDMExec.GetFCS()->SetDeCmd( controls.get_elevator());
 193   FDMExec.GetFCS()->SetPitchTrimCmd(controls.get_elevator_trim());
 194   FDMExec.GetFCS()->SetDrCmd( controls.get_rudder());
 195   FDMExec.GetFCS()->SetDfCmd( controls.get_flaps() );
 196   FDMExec.GetFCS()->SetDsbCmd( 0.0 ); //speedbrakes
 197   FDMExec.GetFCS()->SetDspCmd( 0.0 ); //spoilers
 198   FDMExec.GetFCS()->SetThrottleCmd( FGControls::ALL_ENGINES,
 199                                     controls.get_throttle( 0 ) * 100.0 );
 200
 201   // FCS->SetBrake( controls.get_brake( 0 ) );
 202
 203   // Inform JSBsim of the local terrain altitude; uncommented 5/3/00
 204   //  FDMExec.GetPosition()->SetRunwayElevation(get_Runway_altitude()); // seems to work
 205   FDMExec.GetPosition()->SetRunwayRadius(scenery.cur_radius*METER_TO_FEET);
 206   FDMExec.GetPosition()->SetSeaLevelRadius(get_Sea_level_radius());
 207
 208   FDMExec.GetAtmosphere()->SetExTemperature(get_Static_temperature());
 209   FDMExec.GetAtmosphere()->SetExPressure(get_Static_pressure());
 210   FDMExec.GetAtmosphere()->SetExDensity(get_Density());
 211   FDMExec.GetAtmosphere()->SetWindNED(get_V_north_airmass(),
 212                                       get_V_east_airmass(),
 213                                       get_V_down_airmass());
 214
 215   for ( int i = 0; i < multiloop; i++ ) {
 216     FDMExec.Run();
 217   }
 218
 219   // printf("%d FG_Altitude = %.2f\n", i, FG_Altitude * 0.3048);
 220   // printf("%d Altitude = %.2f\n", i, Altitude * 0.3048);
 221
 222   // translate JSBsim back to FG structure so that the
 223   // autopilot (and the rest of the sim can use the updated values
 224
 225   copy_from_JSBsim();
 226
 227   // but lets restore our original bogus altitude when we are done
 228
 229   if ( save_alt < -9000.0 ) {
 230     set_Altitude( save_alt );
 231   }
 232
 233   double end_elev = get_Altitude();
 234   //if ( time_step > 0.0 ) {
 235     // feet per second
 236   //  set_Climb_Rate( (end_elev - start_elev) / time_step );
 237   //}
 238
 239   return 1;
 240 }
 241
 242 /******************************************************************************/
 243
 244 // Convert from the FGInterface struct to the JSBsim generic_ struct
 245
 246 int FGJSBsim::copy_to_JSBsim() {
 247   return 1;
 248 }
 249
 250 /******************************************************************************/
 251
 252 // Convert from the JSBsim generic_ struct to the FGInterface struct
 253
 254 int FGJSBsim::copy_from_JSBsim() {
 255
 256   set_Inertias( FDMExec.GetAircraft()->GetMass(),
 257                 FDMExec.GetAircraft()->GetIxx(),
 258                 FDMExec.GetAircraft()->GetIyy(),
 259                 FDMExec.GetAircraft()->GetIzz(),
 260                 FDMExec.GetAircraft()->GetIxz() );
 261
 262   set_CG_Position ( FDMExec.GetAircraft()->GetXYZcg()(1),
 263                     FDMExec.GetAircraft()->GetXYZcg()(2),
 264                     FDMExec.GetAircraft()->GetXYZcg()(3) );
 265
 266   set_Accels_Body ( FDMExec.GetTranslation()->GetUVWdot()(1),
 267                     FDMExec.GetTranslation()->GetUVWdot()(2),
 268                     FDMExec.GetTranslation()->GetUVWdot()(3) );
 269
 270   set_Accels_CG_Body ( FDMExec.GetTranslation()->GetUVWdot()(1),
 271                        FDMExec.GetTranslation()->GetUVWdot()(2),
 272                        FDMExec.GetTranslation()->GetUVWdot()(3) );
 273
 274   //set_Accels_CG_Body_N ( FDMExec.GetTranslation()->GetNcg()(1),
 275   //                       FDMExec.GetTranslation()->GetNcg()(2),
 276   //                       FDMExec.GetTranslation()->GetNcg()(3) );
 277   //
 278   set_Accels_Pilot_Body( FDMExec.GetAuxiliary()->GetPilotAccel()(1),
 279                          FDMExec.GetAuxiliary()->GetPilotAccel()(2),
 280                          FDMExec.GetAuxiliary()->GetPilotAccel()(3) );
 281
 282   //set_Accels_Pilot_Body_N( FDMExec.GetAuxiliary()->GetNpilot()(1),
 283   //                         FDMExec.GetAuxiliary()->GetNpilot()(2),
 284   //                         FDMExec.GetAuxiliary()->GetNpilot()(3) );
 285
 286
 287
 288   set_Nlf( FDMExec.GetAircraft()->GetNlf());
 289
 290
 291
 292   // Velocities
 293
 294   set_Velocities_Local( FDMExec.GetPosition()->GetVn(),
 295                         FDMExec.GetPosition()->GetVe(),
 296                         FDMExec.GetPosition()->GetVd() );
 297
 298   set_Velocities_Wind_Body( FDMExec.GetTranslation()->GetUVW()(1),
 299                             FDMExec.GetTranslation()->GetUVW()(2),
 300                             FDMExec.GetTranslation()->GetUVW()(3)  );
 301
 302   set_V_equiv_kts( FDMExec.GetAuxiliary()->GetVequivalentKTS() );
 303
 304   //set_V_calibrated( FDMExec.GetAuxiliary()->GetVcalibratedFPS() );
 305
 306   set_V_calibrated_kts( FDMExec.GetAuxiliary()->GetVcalibratedKTS() );
 307
 308   set_V_ground_speed ( FDMExec.GetPosition()->GetVground() );
 309
 310   set_Omega_Body( FDMExec.GetState()->GetParameter(FG_ROLLRATE),
 311                   FDMExec.GetState()->GetParameter(FG_PITCHRATE),
 312                   FDMExec.GetState()->GetParameter(FG_YAWRATE) );
 313
 314   /* HUH!?! */ set_Euler_Rates( FDMExec.GetRotation()->Getphi(),
 315                    FDMExec.GetRotation()->Gettht(),
 316                    FDMExec.GetRotation()->Getpsi() );
 317
 318   // ***FIXME*** set_Geocentric_Rates( Latitude_dot, Longitude_dot, Radius_dot );
 319
 320   set_Mach_number( FDMExec.GetTranslation()->GetMach());
 321
 322   // Positions
 323
 324   double lat_geoc = FDMExec.GetPosition()->GetLatitude();
 325   double lon = FDMExec.GetPosition()->GetLongitude();
 326   double alt = FDMExec.GetPosition()->Geth();
 327   double lat_geod, tmp_alt, sl_radius1, sl_radius2, tmp_lat_geoc;
 328
 329   sgGeocToGeod( lat_geoc, EQUATORIAL_RADIUS_M + alt * FEET_TO_METER,
 330                 &lat_geod, &tmp_alt, &sl_radius1 );
 331   sgGeodToGeoc( lat_geod, alt * FEET_TO_METER, &sl_radius2, &tmp_lat_geoc );
 332
 333   FG_LOG( FG_FLIGHT, FG_DEBUG, "lon = " << lon << " lat_geod = " << lat_geod
 334           << " lat_geoc = " << lat_geoc
 335           << " alt = " << alt << " tmp_alt = " << tmp_alt * METER_TO_FEET
 336           << " sl_radius1 = " << sl_radius1 * METER_TO_FEET
 337           << " sl_radius2 = " << sl_radius2 * METER_TO_FEET
 338           << " Equator = " << EQUATORIAL_RADIUS_FT );
 339
 340   set_Geocentric_Position( lat_geoc, lon,
 341                            sl_radius2 * METER_TO_FEET + alt );
 342   set_Geodetic_Position( lat_geod, lon, alt );
 343   set_Euler_Angles( FDMExec.GetRotation()->Getphi(),
 344                     FDMExec.GetRotation()->Gettht(),
 345                     FDMExec.GetRotation()->Getpsi() );
 346
 347   set_Alpha( FDMExec.GetTranslation()->Getalpha() );
 348   set_Beta( FDMExec.GetTranslation()->Getbeta() );
 349
 350   set_Gamma_vert_rad( FDMExec.GetPosition()->GetGamma() );
 351   // set_Gamma_horiz_rad( Gamma_horiz_rad );
 352
 353   /* **FIXME*** */ set_Sea_level_radius( sl_radius2 * METER_TO_FEET );
 354   /* **FIXME*** */ set_Earth_position_angle( 0.0 );
 355
 356   // /* ***FIXME*** */ set_Runway_altitude( 0.0 );
 357
 358   set_sin_lat_geocentric( lat_geoc );
 359   set_cos_lat_geocentric( lat_geoc );
 360   set_sin_cos_longitude( lon );
 361   set_sin_cos_latitude( lat_geod );
 362
 363   set_Climb_Rate(FDMExec.GetPosition()->Gethdot());
 364
 365   return 1;
 366 }