src/FDM/YASim/YASim.cxx

   1
   2 #include <simgear/debug/logstream.hxx>
   3 #include <simgear/math/sg_geodesy.hxx>
   4 #include <simgear/misc/sg_path.hxx>
   5 #include <simgear/scene/model/placement.hxx>
   6 #include <simgear/xml/easyxml.hxx>
   7
   8 #include <Main/globals.hxx>
   9 #include <Main/fg_props.hxx>
  10
  11 #include "FGFDM.hpp"
  12 #include "Atmosphere.hpp"
  13 #include "Math.hpp"
  14 #include "Airplane.hpp"
  15 #include "Model.hpp"
  16 #include "Integrator.hpp"
  17 #include "Glue.hpp"
  18 #include "Gear.hpp"
  19 #include "Hook.hpp"
  20 #include "Launchbar.hpp"
  21 #include "FGGround.hpp"
  22 #include "PropEngine.hpp"
  23 #include "PistonEngine.hpp"
  24
  25 #include "YASim.hxx"
  26
  27 #include <fenv.h> // SIGFPE DEBUG
  28
  29 using namespace yasim;
  30
  31 static const float YASIM_PI = 3.14159265358979323846;
  32 static const float RAD2DEG = 180/YASIM_PI;
  33 static const float PI2 = YASIM_PI*2;
  34 static const float RAD2RPM = 9.54929658551;
  35 static const float M2FT = 3.2808399;
  36 static const float FT2M = 0.3048;
  37 static const float MPS2KTS = 3600.0/1852.0;
  38 static const float CM2GALS = 264.172037284; // gallons/cubic meter
  39 static const float KG2LBS = 2.20462262185;
  40 static const float W2HP = 1.3416e-3;
  41 static const float INHG2PA = 3386.389;
  42 static const float SLUG2KG = 14.59390;
  43
  44 YASim::YASim(double dt)
  45 {
  46 //     set_delta_t(dt);
  47     _fdm = new FGFDM();
  48
  49     _dt = dt;
  50
  51     _fdm->getAirplane()->getModel()->setGroundCallback( new FGGround(this) );
  52     _fdm->getAirplane()->getModel()->getIntegrator()->setInterval(_dt);
  53 }
  54
  55 void YASim::report()
  56 {
  57     Airplane* a = _fdm->getAirplane();
  58
  59     float aoa = a->getCruiseAoA() * RAD2DEG;
  60     float tail = -1 * a->getTailIncidence() * RAD2DEG;
  61     float drag = 1000 * a->getDragCoefficient();
  62
  63     SG_LOG(SG_FLIGHT,SG_INFO,"YASim solution results:");
  64     SG_LOG(SG_FLIGHT,SG_INFO,"       Iterations: "<<a->getSolutionIterations());
  65     SG_LOG(SG_FLIGHT,SG_INFO," Drag Coefficient: "<< drag);
  66     SG_LOG(SG_FLIGHT,SG_INFO,"       Lift Ratio: "<<a->getLiftRatio());
  67     SG_LOG(SG_FLIGHT,SG_INFO,"       Cruise AoA: "<< aoa);
  68     SG_LOG(SG_FLIGHT,SG_INFO,"   Tail Incidence: "<< tail);
  69     SG_LOG(SG_FLIGHT,SG_INFO,"Approach Elevator: "<<a->getApproachElevator());
  70
  71
  72     float cg[3];
  73     char buf[256];
  74     a->getModel()->getBody()->getCG(cg);
  75     sprintf(buf, "            CG: %.3f, %.3f, %.3f", cg[0], cg[1], cg[2]);
  76     SG_LOG(SG_FLIGHT, SG_INFO, buf);
  77
  78     if(a->getFailureMsg()) {
  79         SG_LOG(SG_FLIGHT, SG_ALERT, "YASim SOLUTION FAILURE:");
  80         SG_LOG(SG_FLIGHT, SG_ALERT, a->getFailureMsg());
  81         exit(1);
  82     }
  83 }
  84
  85 void YASim::bind()
  86 {
  87     // Run the superclass bind to set up a bunch of property ties
  88     FGInterface::bind();
  89
  90     // Now UNtie the ones that we are going to set ourselves.
  91     fgUntie("/consumables/fuel/tank[0]/level-gal_us");
  92     fgUntie("/consumables/fuel/tank[1]/level-gal_us");
  93
  94     char buf[256];
  95     for(int i=0; i<_fdm->getAirplane()->getModel()->numThrusters(); i++) {
  96         sprintf(buf, "/engines/engine[%d]/fuel-flow-gph", i); fgUntie(buf);
  97         sprintf(buf, "/engines/engine[%d]/rpm", i);           fgUntie(buf);
  98         sprintf(buf, "/engines/engine[%d]/mp-osi", i);        fgUntie(buf);
  99         sprintf(buf, "/engines/engine[%d]/egt-degf", i);      fgUntie(buf);
 100     }
 101 }
 102
 103 void YASim::init()
 104 {
 105     Airplane* a = _fdm->getAirplane();
 106     Model* m = a->getModel();
 107
 108     // Superclass hook
 109     common_init();
 110
 111     m->setCrashed(false);
 112
 113     // Figure out the initial speed type
 114     string speed_set = fgGetString("/sim/presets/speed-set", "UVW");
 115     if (speed_set == "NED")
 116         _speed_set = NED;
 117     else if (speed_set == "UVW")
 118         _speed_set = UVW;
 119     else if (speed_set == "knots")
 120         _speed_set = KNOTS;
 121     else if (speed_set == "mach")
 122         _speed_set = MACH;
 123     else {
 124         _speed_set = UVW;
 125         SG_LOG(SG_FLIGHT, SG_ALERT, "Unknown speed type " << speed_set);
 126     }
 127
 128     // Build a filename and parse it
 129     SGPath f(fgGetString("/sim/aircraft-dir"));
 130     f.append(fgGetString("/sim/aero"));
 131     f.concat(".xml");
 132     readXML(f.str(), *_fdm);
 133
 134     // Compile it into a real airplane, and tell the user what they got
 135     a->compile();
 136     report();
 137
 138     _fdm->init();
 139
 140     // Create some FG{Eng|Gear}Interface objects
 141     int i;
 142     for(i=0; i<a->numGear(); i++) {
 143         Gear* g = a->getGear(i);
 144         SGPropertyNode * node = fgGetNode("gear/gear", i, true);
 145         float pos[3];
 146         g->getPosition(pos);
 147         node->setDoubleValue("xoffset-in", pos[0]);
 148         node->setDoubleValue("yoffset-in", pos[1]);
 149         node->setDoubleValue("zoffset-in", pos[2]);
 150     }
 151
 152     // Are we at ground level?  If so, lift the plane up so the gear
 153     // clear the ground.
 154     double runway_altitude = get_Runway_altitude();
 155     if(get_Altitude() - runway_altitude < 50) {
 156         fgSetBool("/controls/gear/gear-down", false);
 157         float minGearZ = 1e18;
 158         for(i=0; i<a->numGear(); i++) {
 159             Gear* g = a->getGear(i);
 160             float pos[3];
 161             g->getPosition(pos);
 162             if(pos[2] < minGearZ)
 163                 minGearZ = pos[2];
 164         }
 165         _set_Altitude(runway_altitude - minGearZ*M2FT);
 166         fgSetBool("/controls/gear/gear-down", true);
 167     }
 168
 169     // Blank the state, and copy in ours
 170     State s;
 171     m->setState(&s);
 172     copyToYASim(true);
 173
 174     _fdm->getExternalInput();
 175     _fdm->getAirplane()->initEngines();
 176
 177     set_inited(true);
 178 }
 179
 180 void YASim::update(double dt)
 181 {
 182     if (is_suspended())
 183         return;
 184
 185     int iterations = _calc_multiloop(dt);
 186
 187     // If we're crashed, then we don't care
 188     if(_fdm->getAirplane()->getModel()->isCrashed()) {
 189         if(!fgGetBool("/sim/crashed"))
 190             fgSetBool("/sim/crashed", true);
 191         return;
 192     }
 193
 194     // ground.  Calculate a cartesian coordinate for the ground under
 195     // us, find the (geodetic) up vector normal to the ground, then
 196     // use that to find the final (radius) term of the plane equation.
 197     float v[3] = { get_uBody()*FT2M, get_vBody()*FT2M, get_wBody()*FT2M };
 198     float lat = get_Latitude(); float lon = get_Longitude();
 199     double xyz[3];
 200     sgGeodToCart(lat, lon, 0.0, xyz);
 201     // build the environment cache.
 202     float vr = _fdm->getVehicleRadius();
 203     vr += 2.0*dt*Math::mag3(v);
 204     prepare_ground_cache_m( 0.0, xyz, vr );
 205
 206     // Track time increments.
 207     FGGround* gr
 208       = (FGGround*)_fdm->getAirplane()->getModel()->getGroundCallback();
 209
 210     int i;
 211     for(i=0; i<iterations; i++) {
 212         gr->setTimeOffset(iterations*_dt);
 213         copyToYASim(false);
 214         _fdm->iterate(_dt);
 215         copyFromYASim();
 216     }
 217
 218     // Reset the time increment.
 219     gr->setTimeOffset(0.0);
 220 }
 221
 222 void YASim::copyToYASim(bool copyState)
 223 {
 224     // Physical state
 225     float lat = get_Latitude();
 226     float lon = get_Longitude();
 227     float alt = get_Altitude() * FT2M;
 228     float roll = get_Phi();
 229     float pitch = get_Theta();
 230     float hdg = get_Psi();
 231
 232     // Environment
 233     float wind[3];
 234     wind[0] = get_V_north_airmass() * FT2M * -1.0;
 235     wind[1] = get_V_east_airmass() * FT2M * -1.0;
 236     wind[2] = get_V_down_airmass() * FT2M * -1.0;
 237
 238     float pressure = fgGetFloat("/environment/pressure-inhg") * INHG2PA;
 239     float temp = fgGetFloat("/environment/temperature-degc") + 273.15;
 240     float dens = fgGetFloat("/environment/density-slugft3")
 241         * SLUG2KG * M2FT*M2FT*M2FT;
 242
 243     // Convert and set:
 244     Model* model = _fdm->getAirplane()->getModel();
 245     State s;
 246     float xyz2ned[9];
 247     Glue::xyz2nedMat(lat, lon, xyz2ned);
 248
 249     // position
 250     sgGeodToCart(lat, lon, alt, s.pos);
 251
 252     // orientation
 253     Glue::euler2orient(roll, pitch, hdg, s.orient);
 254     Math::mmul33(s.orient, xyz2ned, s.orient);
 255
 256     // Velocity
 257     string speed_set = fgGetString("/sim/presets/speed-set", "UVW");
 258     float v[3];
 259     bool needCopy = false;
 260     switch (_speed_set) {
 261     case NED:
 262         v[0] = get_V_north() * FT2M * -1.0;
 263         v[1] = get_V_east() * FT2M * -1.0;
 264         v[2] = get_V_down() * FT2M * -1.0;
 265         break;
 266     case UVW:
 267         v[0] = get_uBody() * FT2M;
 268         v[1] = get_vBody() * FT2M;
 269         v[2] = get_wBody() * FT2M;
 270         Math::tmul33(s.orient, v, v);
 271         break;
 272     case KNOTS:
 273         v[0] = Atmosphere::spdFromVCAS(get_V_calibrated_kts()/MPS2KTS,
 274                                        pressure, temp);
 275         v[1] = 0;
 276         v[2] = 0;
 277         Math::tmul33(s.orient, v, v);
 278         needCopy = true;
 279         break;
 280     case MACH:
 281         v[0] = Atmosphere::spdFromMach(get_Mach_number(), temp);
 282         v[1] = 0;
 283         v[2] = 0;
 284         Math::tmul33(s.orient, v, v);
 285         needCopy = true;
 286         break;
 287     default:
 288         v[0] = 0;
 289         v[1] = 0;
 290         v[2] = 0;
 291         break;
 292     }
 293     if (!copyState)
 294         _speed_set = UVW;       // change to this after initial setting
 295     Math::set3(v, s.v);
 296
 297     if(copyState || needCopy)
 298         model->setState(&s);
 299
 300     // wind
 301     Math::tmul33(xyz2ned, wind, wind);
 302     model->setWind(wind);
 303
 304     // air
 305     model->setAir(pressure, temp, dens);
 306
 307     // Query a ground plane for each gear/hook/launchbar and
 308     // write that value into the corresponding class.
 309     _fdm->getAirplane()->getModel()->updateGround(&s);
 310
 311     Launchbar* l = model->getLaunchbar();
 312     if (l)
 313         l->setLaunchCmd(0.0<fgGetFloat("/controls/gear/catapult-launch-cmd"));
 314 }
 315
 316 // All the settables:
 317 //
 318 // These are set below:
 319 // _set_Accels_Local
 320 // _set_Accels_Body
 321 // _set_Accels_CG_Body
 322 // _set_Accels_Pilot_Body
 323 // _set_Accels_CG_Body_N
 324 // _set_Velocities_Local
 325 // _set_Velocities_Ground
 326 // _set_Velocities_Wind_Body
 327 // _set_Omega_Body
 328 // _set_Euler_Rates
 329 // _set_Euler_Angles
 330 // _set_V_rel_wind
 331 // _set_V_ground_speed
 332 // _set_V_equiv_kts
 333 // _set_V_calibrated_kts
 334 // _set_Alpha
 335 // _set_Beta
 336 // _set_Mach_number
 337 // _set_Climb_Rate
 338 // _set_Tank1Fuel
 339 // _set_Tank2Fuel
 340 // _set_Altitude_AGL
 341 // _set_Geodetic_Position
 342 // _set_Runway_altitude
 343
 344 // Ignoring these, because they're unused:
 345 // _set_Geocentric_Position
 346 // _set_Geocentric_Rates
 347 // _set_Cos_phi
 348 // _set_Cos_theta
 349 // _set_Earth_position_angle (WTF?)
 350 // _set_Gamma_vert_rad
 351 // _set_Inertias
 352 // _set_T_Local_to_Body
 353 // _set_CG_Position
 354 // _set_Sea_Level_Radius
 355
 356 // Externally set via the weather code:
 357 // _set_Velocities_Local_Airmass
 358 // _set_Density
 359 // _set_Static_pressure
 360 // _set_Static_temperature
 361 void YASim::copyFromYASim()
 362 {
 363     Airplane* airplane = _fdm->getAirplane();
 364     Model* model = airplane->getModel();
 365     State* s = model->getState();
 366
 367     // position
 368     double lat, lon, alt;
 369     sgCartToGeod(s->pos, &lat, &lon, &alt);
 370     _set_Geodetic_Position(lat, lon, alt*M2FT);
 371
 372     // UNUSED
 373     //_set_Geocentric_Position(Glue::geod2geocLat(lat), lon, alt*M2FT);
 374
 375     _set_Altitude_AGL(model->getAGL() * M2FT);
 376
 377     // useful conversion matrix
 378     float xyz2ned[9];
 379     Glue::xyz2nedMat(lat, lon, xyz2ned);
 380
 381     // velocity
 382     float v[3];
 383     Math::vmul33(xyz2ned, s->v, v);
 384     _set_Velocities_Local(M2FT*v[0], M2FT*v[1], M2FT*v[2]);
 385     _set_V_ground_speed(Math::sqrt(M2FT*v[0]*M2FT*v[0] +
 386                                    M2FT*v[1]*M2FT*v[1]));
 387     _set_Climb_Rate(-M2FT*v[2]);
 388
 389     // The HUD uses this, but inverts down (?!)
 390     _set_Velocities_Ground(M2FT*v[0], M2FT*v[1], -M2FT*v[2]);
 391
 392     // _set_Geocentric_Rates(M2FT*v[0], M2FT*v[1], M2FT*v[2]); // UNUSED
 393
 394     // Airflow velocity.
 395     float wind[3];
 396     wind[0] = get_V_north_airmass() * FT2M * -1.0;  // Wind in NED
 397     wind[1] = get_V_east_airmass() * FT2M * -1.0;
 398     wind[2] = get_V_down_airmass() * FT2M * -1.0;
 399     Math::tmul33(xyz2ned, wind, wind);              // Wind in global
 400     Math::sub3(s->v, wind, v);                      // V - wind in global
 401     Math::vmul33(s->orient, v, v);               // to body coordinates
 402     _set_Velocities_Wind_Body(v[0]*M2FT, -v[1]*M2FT, -v[2]*M2FT);
 403     _set_V_rel_wind(Math::mag3(v)*M2FT); // units?
 404
 405     float P = fgGetDouble("/environment/pressure-inhg") * INHG2PA;
 406     float T = fgGetDouble("/environment/temperature-degC") + 273.15;
 407     float D = fgGetFloat("/environment/density-slugft3")
 408         *SLUG2KG * M2FT*M2FT*M2FT;
 409     _set_V_equiv_kts(Atmosphere::calcVEAS(v[0], P, T, D)*MPS2KTS);
 410     _set_V_calibrated_kts(Atmosphere::calcVCAS(v[0], P, T)*MPS2KTS);
 411     _set_Mach_number(Atmosphere::calcMach(v[0], T));
 412
 413     // acceleration
 414     Math::vmul33(xyz2ned, s->acc, v);
 415     _set_Accels_Local(M2FT*v[0], M2FT*v[1], M2FT*v[2]);
 416
 417     Math::vmul33(s->orient, s->acc, v);
 418     _set_Accels_Body(M2FT*v[0], -M2FT*v[1], -M2FT*v[2]);
 419     _set_Accels_CG_Body(M2FT*v[0], -M2FT*v[1], -M2FT*v[2]);
 420
 421     _fdm->getAirplane()->getPilotAccel(v);
 422     _set_Accels_Pilot_Body(-M2FT*v[0], M2FT*v[1], M2FT*v[2]);
 423
 424     // There is no property for pilot G's, but I need it for a panel
 425     // instrument.  Hack this in here, and REMOVE IT WHEN IT FINDS A
 426     // REAL HOME!
 427     fgSetFloat("/accelerations/pilot-g", -v[2]/9.8);
 428
 429     // The one appears (!) to want inverted pilot acceleration
 430     // numbers, in G's...
 431     Math::mul3(1.0/9.8, v, v);
 432     _set_Accels_CG_Body_N(v[0], -v[1], -v[2]);
 433
 434     // orientation
 435     float alpha, beta;
 436     Glue::calcAlphaBeta(s, &alpha, &beta);
 437     _set_Alpha(alpha);
 438     _set_Beta(beta);
 439
 440     float tmp[9];
 441     Math::trans33(xyz2ned, tmp);
 442     Math::mmul33(s->orient, tmp, tmp);
 443     float roll, pitch, hdg;
 444     Glue::orient2euler(tmp, &roll, &pitch, &hdg);
 445     // make heading positive value
 446     if(hdg < 0.0) hdg += PI2;
 447     _set_Euler_Angles(roll, pitch, hdg);
 448
 449     // rotation
 450     Math::vmul33(s->orient, s->rot, v);
 451     _set_Omega_Body(v[0], -v[1], -v[2]);
 452
 453     Glue::calcEulerRates(s, &roll, &pitch, &hdg);
 454     _set_Euler_Rates(roll, pitch, hdg);
 455
 456     // Fill out our engine and gear objects
 457     int i;
 458     for(i=0; i<airplane->numGear(); i++) {
 459         Gear* g = airplane->getGear(i);
 460         SGPropertyNode * node = fgGetNode("gear/gear", i, true);
 461         node->setBoolValue("has-brake", g->getBrake() != 0);
 462         node->setBoolValue("wow", g->getCompressFraction() != 0);
 463         node->setFloatValue("compression-norm", g->getCompressFraction());
 464         node->setFloatValue("caster-angle-deg", g->getCasterAngle() * RAD2DEG);
 465         node->setFloatValue("rollspeed-ms", g->getRollSpeed());
 466     }
 467
 468     Hook* h = airplane->getHook();
 469     if(h) {
 470         SGPropertyNode * node = fgGetNode("gear/tailhook", 0, true);
 471         node->setFloatValue("position-norm", h->getCompressFraction());
 472     }
 473
 474     Launchbar* l = airplane->getLaunchbar();
 475     if(l) {
 476         SGPropertyNode * node = fgGetNode("gear/launchbar", 0, true);
 477         node->setFloatValue("position-norm", l->getCompressFraction());
 478     }
 479 }