src/FDM/YASim/YASim.cxx

   1 #include <simgear/misc/sg_path.hxx>
   2 #include <simgear/debug/logstream.hxx>
   3 #include <simgear/xml/easyxml.hxx>
   4 #include <Main/globals.hxx>
   5 #include <Main/fg_props.hxx>
   6 #include <Scenery/scenery.hxx>
   7
   8 #include "FGFDM.hpp"
   9 #include "Atmosphere.hpp"
  10 #include "Math.hpp"
  11 #include "Airplane.hpp"
  12 #include "Model.hpp"
  13 #include "Integrator.hpp"
  14 #include "Glue.hpp"
  15 #include "Gear.hpp"
  16 #include "PropEngine.hpp"
  17 #include "PistonEngine.hpp"
  18
  19 #include "YASim.hxx"
  20
  21 using namespace yasim;
  22
  23 static const float RAD2DEG = 180/3.14159265358979323846;
  24 static const float RAD2RPM = 9.54929658551;
  25 static const float M2FT = 3.2808399;
  26 static const float FT2M = 0.3048;
  27 static const float MPS2KTS = 3600.0/1852.0;
  28 static const float CM2GALS = 264.172037284; // gallons/cubic meter
  29 static const float KG2LBS = 2.20462262185;
  30 static const float W2HP = 1.3416e-3;
  31
  32 void YASim::printDEBUG()
  33 {
  34     static int debugCount = 0;
  35
  36     debugCount++;
  37     if(debugCount >= 3) {
  38         debugCount = 0;
  39
  40 //      printf("N1 %5.1f N2 %5.1f FF %7.1f EPR %4.2f EGT %6.1f\n",
  41 //             fgGetFloat("/engines/engine[0]/n1"),
  42 //             fgGetFloat("/engines/engine[0]/n2"),
  43 //             fgGetFloat("/engines/engine[0]/fuel-flow-gph"),
  44 //             fgGetFloat("/engines/engine[0]/epr"),
  45 //             fgGetFloat("/engines/engine[0]/egt"));
  46
  47 //      printf("gear: %f\n", fgGetFloat("/controls/gear-down"));
  48
  49 //      printf("alpha %5.1f beta %5.1f\n", get_Alpha()*57.3, get_Beta()*57.3);
  50
  51 //      printf("pilot: %f %f %f\n",
  52 //             fgGetDouble("/sim/view/pilot/x-offset-m"),
  53 //             fgGetDouble("/sim/view/pilot/y-offset-m"),
  54 //             fgGetDouble("/sim/view/pilot/z-offset-m"));
  55     }
  56 }
  57
  58 YASim::YASim(double dt)
  59 {
  60     set_delta_t(dt);
  61     _fdm = new FGFDM();
  62
  63     _dt = dt;
  64
  65     _fdm->getAirplane()->getModel()->getIntegrator()->setInterval(_dt);
  66 }
  67
  68 void YASim::report()
  69 {
  70     Airplane* a = _fdm->getAirplane();
  71
  72     float aoa = a->getCruiseAoA() * RAD2DEG;
  73     float tail = -1 * a->getTailIncidence() * RAD2DEG;
  74     float drag = 1000 * a->getDragCoefficient();
  75
  76     SG_LOG(SG_FLIGHT,SG_INFO,"YASim solution results:");
  77     SG_LOG(SG_FLIGHT,SG_INFO,"      Iterations: "<<a->getSolutionIterations());
  78     SG_LOG(SG_FLIGHT,SG_INFO,"Drag Coefficient: "<< drag);
  79     SG_LOG(SG_FLIGHT,SG_INFO,"      Lift Ratio: "<<a->getLiftRatio());
  80     SG_LOG(SG_FLIGHT,SG_INFO,"      Cruise AoA: "<< aoa);
  81     SG_LOG(SG_FLIGHT,SG_INFO,"  Tail Incidence: "<< tail);
  82
  83     float cg[3];
  84     char buf[256];
  85     a->getModel()->getBody()->getCG(cg);
  86     sprintf(buf, "            CG: %.1f, %.1f, %.1f", cg[0], cg[1], cg[2]);
  87     SG_LOG(SG_FLIGHT, SG_INFO, buf);
  88
  89     if(a->getFailureMsg()) {
  90         SG_LOG(SG_FLIGHT, SG_ALERT, "YASim SOLUTION FAILURE:");
  91         SG_LOG(SG_FLIGHT, SG_ALERT, a->getFailureMsg());
  92         exit(1);
  93     }
  94 }
  95
  96 void YASim::bind()
  97 {
  98     // Run the superclass bind to set up a bunch of property ties
  99     FGInterface::bind();
 100
 101     // Now UNtie the ones that we are going to set ourselves.
 102     fgUntie("/consumables/fuel/tank[0]/level-gal_us");
 103     fgUntie("/consumables/fuel/tank[1]/level-gal_us");
 104
 105     char buf[256];
 106     for(int i=0; i<_fdm->getAirplane()->getModel()->numThrusters(); i++) {
 107         sprintf(buf, "/engines/engine[%d]/fuel-flow-gph", i); fgUntie(buf);
 108         sprintf(buf, "/engines/engine[%d]/rpm", i);           fgUntie(buf);
 109         sprintf(buf, "/engines/engine[%d]/mp-osi", i);        fgUntie(buf);
 110         sprintf(buf, "/engines/engine[%d]/egt-degf", i);      fgUntie(buf);
 111     }
 112
 113 }
 114
 115 void YASim::init()
 116 {
 117     Airplane* a = _fdm->getAirplane();
 118     Model* m = a->getModel();
 119
 120     // Superclass hook
 121     common_init();
 122
 123     m->setCrashed(false);
 124
 125     // Build a filename and parse it
 126     SGPath f(globals->get_fg_root());
 127     f.append("Aircraft-yasim");
 128     f.append(fgGetString("/sim/aero"));
 129     f.concat(".xml");
 130     readXML(f.str(), *_fdm);
 131
 132     // Compile it into a real airplane, and tell the user what they got
 133     a->compile();
 134     report();
 135
 136     _fdm->init();
 137
 138     // Create some FG{Eng|Gear}Interface objects
 139     int i;
 140     for(i=0; i<a->numGear(); i++) {
 141         Gear* g = a->getGear(i);
 142         SGPropertyNode * node = fgGetNode("gear/gear", i, true);
 143         float pos[3];
 144         g->getPosition(pos);
 145         node->setDoubleValue("xoffset-in", pos[0]);
 146         node->setDoubleValue("yoffset-in", pos[1]);
 147         node->setDoubleValue("zoffset-in", pos[2]);
 148     }
 149     for(i=0; i<m->numThrusters(); i++) {
 150         // Sanify the initial input conditions
 151         char buf[64];
 152         sprintf(buf, "/controls/throttle[%d]", i);        fgSetFloat(buf, 0);
 153         sprintf(buf, "/controls/mixture[%d]", i);         fgSetFloat(buf, 1);
 154         sprintf(buf, "/controls/propeller-pitch[%d]", i); fgSetFloat(buf, 1);
 155         sprintf(buf, "/controls/afterburner[%d]", i);     fgSetFloat(buf, 0);
 156     }
 157
 158     fgSetFloat("/controls/slats", 0);
 159     fgSetFloat("/controls/spoilers", 0);
 160
 161     // Are we at ground level?  If so, lift the plane up so the gear
 162     // clear the ground.
 163     double runway_altitude =
 164       fgGetDouble("/environment/ground-elevation-m") * SG_METER_TO_FEET;
 165     fgSetBool("/controls/gear-down", false);
 166     if(get_Altitude() - runway_altitude < 50) {
 167         float minGearZ = 1e18;
 168         for(i=0; i<a->numGear(); i++) {
 169             Gear* g = a->getGear(i);
 170             float pos[3];
 171             g->getPosition(pos);
 172             if(pos[2] < minGearZ)
 173                 minGearZ = pos[2];
 174         }
 175         _set_Altitude(runway_altitude - minGearZ*M2FT);
 176         fgSetBool("/controls/gear-down", true);
 177     }
 178
 179     // The pilot's eyepoint
 180     float pilot[3];
 181     a->getPilotPos(pilot);
 182     fgSetFloat("/sim/view/pilot/x-offset-m", -pilot[0]);
 183     fgSetFloat("/sim/view/pilot/y-offset-m", -pilot[1]);
 184     fgSetFloat("/sim/view/pilot/z-offset-m", pilot[2]);
 185
 186     // Blank the state, and copy in ours
 187     State s;
 188     m->setState(&s);
 189     copyToYASim(true);
 190
 191     _fdm->getExternalInput();
 192     _fdm->getAirplane()->initEngines();
 193
 194     set_inited(true);
 195 }
 196
 197 void YASim::update(int iterations)
 198 {
 199     // If we're crashed, then we don't care
 200     if(_fdm->getAirplane()->getModel()->isCrashed())
 201       return;
 202
 203     int i;
 204     for(i=0; i<iterations; i++) {
 205             copyToYASim(false);
 206             _fdm->iterate(_dt);
 207             copyFromYASim();
 208
 209             printDEBUG();
 210     }
 211 }
 212
 213 void YASim::copyToYASim(bool copyState)
 214 {
 215     // Physical state
 216     float lat = get_Latitude();
 217     float lon = get_Longitude();
 218     float alt = get_Altitude() * FT2M;
 219     float roll = get_Phi();
 220     float pitch = get_Theta();
 221     float hdg = get_Psi();
 222
 223     // Environment
 224     float wind[3];
 225     wind[0] = get_V_north_airmass() * FT2M * -1.0;
 226     wind[1] = get_V_east_airmass() * FT2M * -1.0;
 227     wind[2] = get_V_down_airmass() * FT2M * -1.0;
 228
 229     // The ground elevation doesn't come from FGInterface; query it
 230     // from the scenery and set it for others to find.
 231     double ground = scenery.get_cur_elev();
 232     _set_Runway_altitude(ground * FT2M);
 233     // cout << "YASIM: ground = " << ground << endl;
 234
 235     // You'd this this would work, but it doesn't.  These values are
 236     // always zero.  Use a "standard" pressure intstead.
 237     //
 238     // float pressure = get_Static_pressure();
 239     // float temp = get_Static_temperature();
 240     float pressure = Atmosphere::getStdPressure(alt);
 241     float temp = Atmosphere::getStdTemperature(alt);
 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     Glue::geod2xyz(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     // Copy in the existing velocity for now...
 257     Math::set3(model->getState()->v, s.v);
 258
 259     if(copyState)
 260         model->setState(&s);
 261
 262     // wind
 263     Math::tmul33(xyz2ned, wind, wind);
 264     model->setWind(wind);
 265
 266     // ground.  Calculate a cartesian coordinate for the ground under
 267     // us, find the (geodetic) up vector normal to the ground, then
 268     // use that to find the final (radius) term of the plane equation.
 269     double xyz[3], gplane[3]; float up[3];
 270     Glue::geod2xyz(lat, lon, ground, xyz);
 271     Glue::geodUp(xyz, up); // FIXME, needless reverse computation...
 272     int i;
 273     for(i=0; i<3; i++) gplane[i] = up[i];
 274     double rad = gplane[0]*xyz[0] + gplane[1]*xyz[1] + gplane[2]*xyz[2];
 275     model->setGroundPlane(gplane, rad);
 276
 277     // air
 278     model->setAir(pressure, temp);
 279 }
 280
 281 // All the settables:
 282 //
 283 // These are set below:
 284 // _set_Accels_Local
 285 // _set_Accels_Body
 286 // _set_Accels_CG_Body
 287 // _set_Accels_Pilot_Body
 288 // _set_Accels_CG_Body_N
 289 // _set_Velocities_Local
 290 // _set_Velocities_Ground
 291 // _set_Velocities_Wind_Body
 292 // _set_Omega_Body
 293 // _set_Euler_Rates
 294 // _set_Euler_Angles
 295 // _set_V_rel_wind
 296 // _set_V_ground_speed
 297 // _set_V_equiv_kts
 298 // _set_V_calibrated_kts
 299 // _set_Alpha
 300 // _set_Beta
 301 // _set_Mach_number
 302 // _set_Climb_Rate
 303 // _set_Tank1Fuel
 304 // _set_Tank2Fuel
 305 // _set_Altitude_AGL
 306 // _set_Geodetic_Position
 307 // _set_Runway_altitude
 308
 309 // Ignoring these, because they're unused:
 310 // _set_Geocentric_Position
 311 // _set_Geocentric_Rates
 312 // _set_Cos_phi
 313 // _set_Cos_theta
 314 // _set_Earth_position_angle (WTF?)
 315 // _set_Gamma_vert_rad
 316 // _set_Inertias
 317 // _set_T_Local_to_Body
 318 // _set_CG_Position
 319 // _set_Sea_Level_Radius
 320
 321 // Externally set via the weather code:
 322 // _set_Velocities_Local_Airmass
 323 // _set_Density
 324 // _set_Static_pressure
 325 // _set_Static_temperature
 326 void YASim::copyFromYASim()
 327 {
 328     Airplane* airplane = _fdm->getAirplane();
 329     Model* model = airplane->getModel();
 330     State* s = model->getState();
 331
 332     // position
 333     double lat, lon, alt;
 334     Glue::xyz2geod(s->pos, &lat, &lon, &alt);
 335     _set_Geodetic_Position(lat, lon, alt*M2FT);
 336
 337     // UNUSED
 338     //_set_Geocentric_Position(Glue::geod2geocLat(lat), lon, alt*M2FT);
 339
 340     _set_Altitude_AGL(model->getAGL() * M2FT);
 341
 342     // useful conversion matrix
 343     float xyz2ned[9];
 344     Glue::xyz2nedMat(lat, lon, xyz2ned);
 345
 346     // velocity
 347     float v[3];
 348     Math::vmul33(xyz2ned, s->v, v);
 349     _set_Velocities_Local(M2FT*v[0], M2FT*v[1], M2FT*v[2]);
 350     _set_V_ground_speed(Math::sqrt(M2FT*v[0]*M2FT*v[0] +
 351                                    M2FT*v[1]*M2FT*v[1]));
 352     _set_Climb_Rate(-M2FT*v[2]);
 353
 354     // The HUD uses this, but inverts down (?!)
 355     _set_Velocities_Ground(M2FT*v[0], M2FT*v[1], -M2FT*v[2]);
 356
 357     // _set_Geocentric_Rates(M2FT*v[0], M2FT*v[1], M2FT*v[2]); // UNUSED
 358
 359     // Airflow velocity.
 360     float wind[3];
 361     wind[0] = get_V_north_airmass() * FT2M * -1.0;  // Wind in NED
 362     wind[1] = get_V_east_airmass() * FT2M * -1.0;
 363     wind[2] = get_V_down_airmass() * FT2M * -1.0;
 364     Math::tmul33(xyz2ned, wind, wind);              // Wind in global
 365     Math::sub3(s->v, wind, v);                      // V - wind in global
 366     Math::vmul33(s->orient, s->v, v);               // to body coordinates
 367     _set_Velocities_Wind_Body(v[0]*M2FT, -v[1]*M2FT, -v[2]*M2FT);
 368     _set_V_rel_wind(Math::mag3(v)*M2FT); // units?
 369
 370
 371     // These don't work, use a dummy based on altitude
 372     // float P = get_Static_pressure();
 373     // float T = get_Static_temperature();
 374     float P = Atmosphere::getStdPressure(alt);
 375     float T = Atmosphere::getStdTemperature(alt);
 376     _set_V_equiv_kts(Atmosphere::calcVEAS(v[0], P, T)*MPS2KTS);
 377     _set_V_calibrated_kts(Atmosphere::calcVCAS(v[0], P, T)*MPS2KTS);
 378     _set_Mach_number(Atmosphere::calcMach(v[0], T));
 379
 380     // acceleration
 381     Math::vmul33(xyz2ned, s->acc, v);
 382     _set_Accels_Local(M2FT*v[0], M2FT*v[1], M2FT*v[2]);
 383
 384     Math::vmul33(s->orient, s->acc, v);
 385     _set_Accels_Body(M2FT*v[0], -M2FT*v[1], -M2FT*v[2]);
 386     _set_Accels_CG_Body(M2FT*v[0], -M2FT*v[1], -M2FT*v[2]);
 387
 388     _fdm->getAirplane()->getPilotAccel(v);
 389     _set_Accels_Pilot_Body(M2FT*v[0], M2FT*v[1], -M2FT*v[2]);
 390
 391     // The one appears (!) to want inverted pilot acceleration
 392     // numbers, in G's...
 393     Math::mul3(1.0/9.8, v, v);
 394     _set_Accels_CG_Body_N(v[0], -v[1], -v[2]);
 395
 396     // orientation
 397     float alpha, beta;
 398     Glue::calcAlphaBeta(s, &alpha, &beta);
 399     _set_Alpha(alpha);
 400     _set_Beta(beta);
 401
 402     float tmp[9];
 403     Math::trans33(xyz2ned, tmp);
 404     Math::mmul33(s->orient, tmp, tmp);
 405     float roll, pitch, hdg;
 406     Glue::orient2euler(tmp, &roll, &pitch, &hdg);
 407     _set_Euler_Angles(roll, pitch, hdg);
 408
 409     // rotation
 410     Math::vmul33(s->orient, s->rot, v);
 411     _set_Omega_Body(v[0], -v[1], -v[2]);
 412
 413     Glue::calcEulerRates(s, &roll, &pitch, &hdg);
 414     _set_Euler_Rates(roll, pitch, hdg);
 415
 416     // Fill out our engine and gear objects
 417     int i;
 418     for(i=0; i<airplane->numGear(); i++) {
 419         Gear* g = airplane->getGear(i);
 420         SGPropertyNode * node = fgGetNode("gear/gear", i, true);
 421         node->setBoolValue("has-brake", g->getBrake() != 0);
 422         node->setBoolValue("wow", g->getCompressFraction() != 0);
 423         node->setFloatValue("compression-norm", g->getCompressFraction());
 424     }
 425
 426     for(i=0; i<model->numThrusters(); i++) {
 427         SGPropertyNode * node = fgGetNode("engines/engine", i, true);
 428         Thruster* t = model->getThruster(i);
 429
 430         node->setBoolValue("running", t->isRunning());
 431         node->setBoolValue("cranking", t->isCranking());
 432
 433         // Note: assumes all tanks have the same fuel density!
 434         node->setDoubleValue("fuel-flow-gph", CM2GALS * t->getFuelFlow()
 435                              / airplane->getFuelDensity(0));
 436
 437         float tmp[3];
 438         t->getThrust(tmp);
 439         node->setDoubleValue("prop-thrust", Math::mag3(tmp) * KG2LBS / 9.8);
 440
 441         PropEngine* pe = t->getPropEngine();
 442         if(pe) {
 443             node->setDoubleValue("rpm", pe->getOmega() * RAD2RPM);
 444
 445             pe->getTorque(tmp);
 446             float power = Math::mag3(tmp) * pe->getOmega();
 447             float maxPower = pe->getPistonEngine()->getMaxPower();
 448
 449             node->setDoubleValue("max-hp", maxPower * W2HP);
 450             node->setDoubleValue("power-pct", 100 * power/maxPower);
 451         }
 452     }
 453 }