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/fg_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()->UseInternal();
  91
  92   FG_LOG( FG_FLIGHT, FG_INFO, "  Initializing JSBsim with:" );
  93
  94   FGInitialCondition *fgic = new FGInitialCondition(&FDMExec);
  95   fgic->SetAltitudeFtIC(get_Altitude());
  96   if((current_options.get_mach() < 0) && (current_options.get_vc() < 0 )) {
  97     fgic->SetUBodyFpsIC(current_options.get_uBody());
  98     fgic->SetVBodyFpsIC(current_options.get_vBody());
  99     fgic->SetWBodyFpsIC(current_options.get_wBody());
 100     FG_LOG(FG_FLIGHT,FG_INFO, "  u,v,w= " << current_options.get_uBody()
 101            << ", " << current_options.get_vBody()
 102            << ", " << current_options.get_wBody());
 103   } else if (current_options.get_vc() < 0) {
 104     fgic->SetMachIC(current_options.get_mach());
 105     FG_LOG(FG_FLIGHT,FG_INFO, "  mach: " << current_options.get_mach() );
 106   } else {
 107     fgic->SetVcalibratedKtsIC(current_options.get_vc());
 108     FG_LOG(FG_FLIGHT,FG_INFO, "  vc: " << current_options.get_vc() );
 109     //this should cover the case in which no speed switches are used
 110     //current_options.get_vc() will return zero by default
 111   }
 112
 113
 114   fgic->SetRollAngleRadIC(get_Phi());
 115   fgic->SetPitchAngleRadIC(get_Theta());
 116   fgic->SetHeadingRadIC(get_Psi());
 117 //  fgic->SetLatitudeRadIC(get_Latitude());
 118   fgic->SetLatitudeRadIC(get_Lat_geocentric());
 119   fgic->SetLongitudeRadIC(get_Longitude());
 120
 121   FDMExec.GetPosition()->SetRunwayRadius(scenery.cur_radius*METER_TO_FEET);
 122   FDMExec.GetPosition()->SetSeaLevelRadius(get_Sea_level_radius());
 123
 124   FG_LOG( FG_FLIGHT, FG_INFO, "  phi: " <<  get_Phi());
 125   FG_LOG( FG_FLIGHT, FG_INFO, "  theta: " <<  get_Theta() );
 126   FG_LOG( FG_FLIGHT, FG_INFO, "  psi: " <<  get_Psi() );
 127   FG_LOG( FG_FLIGHT, FG_INFO, "  lat: " <<  get_Latitude() );
 128   FG_LOG( FG_FLIGHT, FG_INFO, "  lon: " <<  get_Longitude() );
 129   FG_LOG( FG_FLIGHT, FG_INFO, "  alt: " <<  get_Altitude() );
 130
 131   //must check > 0, != 0 will give bad result if --notrim set
 132   if(current_options.get_trim_mode() > 0) {
 133     FG_LOG( FG_FLIGHT, FG_INFO, "  Starting trim..." );
 134     FGTrimLong *fgtrim=new FGTrimLong(&FDMExec,fgic);
 135     fgtrim->DoTrim();
 136     fgtrim->Report();
 137     fgtrim->TrimStats();
 138     fgtrim->ReportState();
 139
 140     controls.set_elevator_trim(FDMExec.GetFCS()->GetDeCmd());
 141     controls.set_throttle(FGControls::ALL_ENGINES,FDMExec.GetFCS()->GetThrottleCmd(0)/100);
 142     //the trimming routine only knows how to get 1 value for throttle
 143
 144
 145     delete fgtrim;
 146     FG_LOG( FG_FLIGHT, FG_INFO, "  Trim complete." );
 147   } else {
 148     FG_LOG( FG_FLIGHT, FG_INFO, "  Initializing without trim" );
 149     FDMExec.GetState()->Initialize(fgic);
 150
 151   }
 152
 153   delete fgic;
 154
 155   FG_LOG( FG_FLIGHT, FG_INFO, "  loaded initial conditions" );
 156
 157   FG_LOG( FG_FLIGHT, FG_INFO, "  set dt" );
 158
 159   FG_LOG( FG_FLIGHT, FG_INFO, "Finished initializing JSBsim" );
 160
 161   copy_from_JSBsim();
 162
 163   return 1;
 164 }
 165
 166 /******************************************************************************/
 167
 168 // Run an iteration of the EOM (equations of motion)
 169
 170 int FGJSBsim::update( int multiloop ) {
 171   double save_alt = 0.0;
 172   double time_step = (1.0 / current_options.get_model_hz()) * multiloop;
 173   double start_elev = get_Altitude();
 174
 175   // lets try to avoid really screwing up the JSBsim model
 176   if ( get_Altitude() < -9000 ) {
 177     save_alt = get_Altitude();
 178     set_Altitude( 0.0 );
 179   }
 180
 181   // copy control positions into the JSBsim structure
 182
 183   FDMExec.GetFCS()->SetDaCmd( controls.get_aileron());
 184   FDMExec.GetFCS()->SetDeCmd( controls.get_elevator());
 185   FDMExec.GetFCS()->SetPitchTrimCmd(controls.get_elevator_trim());
 186   FDMExec.GetFCS()->SetDrCmd( controls.get_rudder());
 187   FDMExec.GetFCS()->SetDfCmd( controls.get_flaps() );
 188   FDMExec.GetFCS()->SetDsbCmd( 0.0 );
 189   FDMExec.GetFCS()->SetDspCmd( 0.0 );
 190   FDMExec.GetFCS()->SetThrottleCmd( FGControls::ALL_ENGINES,
 191                                     controls.get_throttle( 0 ) * 100.0 );
 192
 193   // FCS->SetBrake( controls.get_brake( 0 ) );
 194
 195   // Inform JSBsim of the local terrain altitude; uncommented 5/3/00
 196   //  FDMExec.GetPosition()->SetRunwayElevation(get_Runway_altitude()); // seems to work
 197   FDMExec.GetPosition()->SetRunwayRadius(scenery.cur_radius*METER_TO_FEET);
 198   FDMExec.GetPosition()->SetSeaLevelRadius(get_Sea_level_radius());
 199
 200   FDMExec.GetAtmosphere()->SetExTemperature(get_Static_temperature());
 201   FDMExec.GetAtmosphere()->SetExPressure(get_Static_pressure());
 202   FDMExec.GetAtmosphere()->SetExDensity(get_Density());
 203   FDMExec.GetAtmosphere()->SetWindNED(get_V_north_airmass(),
 204                                       get_V_east_airmass(),
 205                                       get_V_down_airmass());
 206
 207   for ( int i = 0; i < multiloop; i++ ) {
 208     FDMExec.Run();
 209   }
 210
 211   // printf("%d FG_Altitude = %.2f\n", i, FG_Altitude * 0.3048);
 212   // printf("%d Altitude = %.2f\n", i, Altitude * 0.3048);
 213
 214   // translate JSBsim back to FG structure so that the
 215   // autopilot (and the rest of the sim can use the updated values
 216
 217   copy_from_JSBsim();
 218
 219   // but lets restore our original bogus altitude when we are done
 220
 221   if ( save_alt < -9000.0 ) {
 222     set_Altitude( save_alt );
 223   }
 224
 225   double end_elev = get_Altitude();
 226   if ( time_step > 0.0 ) {
 227     // feet per second
 228     set_Climb_Rate( (end_elev - start_elev) / time_step );
 229   }
 230
 231   return 1;
 232 }
 233
 234 /******************************************************************************/
 235
 236 // Convert from the FGInterface struct to the JSBsim generic_ struct
 237
 238 int FGJSBsim::copy_to_JSBsim() {
 239   return 1;
 240 }
 241
 242 /******************************************************************************/
 243
 244 // Convert from the JSBsim generic_ struct to the FGInterface struct
 245
 246 int FGJSBsim::copy_from_JSBsim() {
 247
 248   // Velocities
 249
 250   set_Velocities_Local( FDMExec.GetPosition()->GetVn(),
 251                         FDMExec.GetPosition()->GetVe(),
 252                         FDMExec.GetPosition()->GetVd() );
 253
 254   set_V_equiv_kts( FDMExec.GetAuxiliary()->GetVequivalentKTS() );
 255
 256   //set_V_calibrated( FDMExec.GetAuxiliary()->GetVcalibratedFPS() );
 257
 258   set_V_calibrated_kts( FDMExec.GetAuxiliary()->GetVcalibratedKTS() );
 259
 260   set_Omega_Body( FDMExec.GetState()->GetParameter(FG_ROLLRATE),
 261                   FDMExec.GetState()->GetParameter(FG_PITCHRATE),
 262                   FDMExec.GetState()->GetParameter(FG_YAWRATE) );
 263
 264   set_Euler_Rates( FDMExec.GetRotation()->Getphi(),
 265                    FDMExec.GetRotation()->Gettht(),
 266                    FDMExec.GetRotation()->Getpsi() );
 267
 268   // ***FIXME*** set_Geocentric_Rates( Latitude_dot, Longitude_dot, Radius_dot );
 269
 270   set_Mach_number( FDMExec.GetTranslation()->GetMach());
 271
 272   // Positions
 273
 274   double lat_geoc = FDMExec.GetPosition()->GetLatitude();
 275   double lon = FDMExec.GetPosition()->GetLongitude();
 276   double alt = FDMExec.GetPosition()->Geth();
 277   double lat_geod, tmp_alt, sl_radius1, sl_radius2, tmp_lat_geoc;
 278
 279   fgGeocToGeod( lat_geoc, EQUATORIAL_RADIUS_M + alt * FEET_TO_METER,
 280                 &lat_geod, &tmp_alt, &sl_radius1 );
 281   fgGeodToGeoc( lat_geod, alt * FEET_TO_METER, &sl_radius2, &tmp_lat_geoc );
 282
 283   FG_LOG( FG_FLIGHT, FG_DEBUG, "lon = " << lon << " lat_geod = " << lat_geod
 284           << " lat_geoc = " << lat_geoc
 285           << " alt = " << alt << " tmp_alt = " << tmp_alt * METER_TO_FEET
 286           << " sl_radius1 = " << sl_radius1 * METER_TO_FEET
 287           << " sl_radius2 = " << sl_radius2 * METER_TO_FEET
 288           << " Equator = " << EQUATORIAL_RADIUS_FT );
 289
 290   set_Geocentric_Position( lat_geoc, lon,
 291                            sl_radius2 * METER_TO_FEET + alt );
 292   set_Geodetic_Position( lat_geod, lon, alt );
 293   set_Euler_Angles( FDMExec.GetRotation()->Getphi(),
 294                     FDMExec.GetRotation()->Gettht(),
 295                     FDMExec.GetRotation()->Getpsi() );
 296
 297   set_Alpha( FDMExec.GetTranslation()->Getalpha() );
 298   set_Beta( FDMExec.GetTranslation()->Getbeta() );
 299
 300   set_Gamma_vert_rad( FDMExec.GetPosition()->GetGamma() );
 301   // set_Gamma_horiz_rad( Gamma_horiz_rad );
 302
 303   /* **FIXME*** */ set_Sea_level_radius( sl_radius2 * METER_TO_FEET );
 304   /* **FIXME*** */ set_Earth_position_angle( 0.0 );
 305
 306   // /* ***FIXME*** */ set_Runway_altitude( 0.0 );
 307
 308   set_sin_lat_geocentric( lat_geoc );
 309   set_cos_lat_geocentric( lat_geoc );
 310   set_sin_cos_longitude( lon );
 311   set_sin_cos_latitude( lat_geod );
 312
 313   return 1;
 314 }
 315
 316 /******************************************************************************/
 317