src/FDM/JSBSim/FGLGear.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGLGear.cpp
   4  Author:       Jon S. Berndt
   5                Norman H. Princen
   6  Date started: 11/18/99
   7  Purpose:      Encapsulates the landing gear elements
   8  Called by:    FGAircraft
   9
  10  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
  11
  12  This program is free software; you can redistribute it and/or modify it under
  13  the terms of the GNU General Public License as published by the Free Software
  14  Foundation; either version 2 of the License, or (at your option) any later
  15  version.
  16
  17  This program is distributed in the hope that it will be useful, but WITHOUT
  18  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  19  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  20  details.
  21
  22  You should have received a copy of the GNU General Public License along with
  23  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  24  Place - Suite 330, Boston, MA  02111-1307, USA.
  25
  26  Further information about the GNU General Public License can also be found on
  27  the world wide web at http://www.gnu.org.
  28
  29 FUNCTIONAL DESCRIPTION
  30 --------------------------------------------------------------------------------
  31
  32 HISTORY
  33 --------------------------------------------------------------------------------
  34 11/18/99   JSB   Created
  35 01/30/01   NHP   Extended gear model to properly simulate steering and braking
  36
  37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #include "FGLGear.h"
  42 #include <algorithm>
  43
  44 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  45 DEFINITIONS
  46 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  47
  48 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  49 GLOBAL DATA
  50 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  51
  52
  53 static const char *IdSrc = "$Id$";
  54 static const char *IdHdr = ID_LGEAR;
  55
  56 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  57 CLASS IMPLEMENTATION
  58 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  59
  60 FGLGear::FGLGear(FGConfigFile* AC_cfg, FGFDMExec* fdmex) : Exec(fdmex)
  61 {
  62   string tmp;
  63
  64   *AC_cfg >> tmp >> name >> vXYZ(1) >> vXYZ(2) >> vXYZ(3)
  65             >> kSpring >> bDamp>> dynamicFCoeff >> staticFCoeff
  66                   >> rollingFCoeff >> sSteerType >> sBrakeGroup
  67                      >> maxSteerAngle >> sRetractable;
  68
  69   if      (sBrakeGroup == "LEFT"  ) eBrakeGrp = bgLeft;
  70   else if (sBrakeGroup == "RIGHT" ) eBrakeGrp = bgRight;
  71   else if (sBrakeGroup == "CENTER") eBrakeGrp = bgCenter;
  72   else if (sBrakeGroup == "NOSE"  ) eBrakeGrp = bgNose;
  73   else if (sBrakeGroup == "TAIL"  ) eBrakeGrp = bgTail;
  74   else if (sBrakeGroup == "NONE"  ) eBrakeGrp = bgNone;
  75   else {
  76     cerr << "Improper braking group specification in config file: "
  77          << sBrakeGroup << " is undefined." << endl;
  78   }
  79
  80   if      (sSteerType == "STEERABLE") eSteerType = stSteer;
  81   else if (sSteerType == "FIXED"    ) eSteerType = stFixed;
  82   else if (sSteerType == "CASTERED" ) eSteerType = stCaster;
  83   else {
  84     cerr << "Improper steering type specification in config file: "
  85          << sSteerType << " is undefined." << endl;
  86   }
  87
  88   if ( sRetractable == "RETRACT" ) {
  89     isRetractable = true;
  90   } else  {
  91     isRetractable = false;
  92   }
  93
  94   GearUp = false;
  95   GearDown = true;
  96
  97 // Add some AI here to determine if gear is located properly according to its
  98 // brake group type ??
  99
 100   State       = Exec->GetState();
 101   Aircraft    = Exec->GetAircraft();
 102   Position    = Exec->GetPosition();
 103   Rotation    = Exec->GetRotation();
 104   FCS         = Exec->GetFCS();
 105   MassBalance = Exec->GetMassBalance();
 106
 107   WOW = lastWOW = false;
 108   ReportEnable = true;
 109   FirstContact = false;
 110   Reported = false;
 111   DistanceTraveled = 0.0;
 112   MaximumStrutForce = MaximumStrutTravel = 0.0;
 113   SinkRate = GroundSpeed = 0.0;
 114
 115   vWhlBodyVec     = (vXYZ - MassBalance->GetXYZcg()) / 12.0;
 116   vWhlBodyVec(eX) = -vWhlBodyVec(eX);
 117   vWhlBodyVec(eZ) = -vWhlBodyVec(eZ);
 118
 119   vLocalGear = State->GetTb2l() * vWhlBodyVec;
 120
 121   Debug(0);
 122 }
 123
 124 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 125
 126 FGLGear::FGLGear(const FGLGear& lgear)
 127 {
 128   State    = lgear.State;
 129   Aircraft = lgear.Aircraft;
 130   Position = lgear.Position;
 131   Rotation = lgear.Rotation;
 132   Exec     = lgear.Exec;
 133   FCS      = lgear.FCS;
 134   MassBalance = lgear.MassBalance;
 135
 136   vXYZ = lgear.vXYZ;
 137   vMoment = lgear.vMoment;
 138   vWhlBodyVec = lgear.vWhlBodyVec;
 139   vLocalGear = lgear.vLocalGear;
 140
 141   WOW                = lgear.WOW;
 142   lastWOW            = lgear.lastWOW;
 143   ReportEnable       = lgear.ReportEnable;
 144   FirstContact       = lgear.FirstContact;
 145   DistanceTraveled   = lgear.DistanceTraveled;
 146   MaximumStrutForce  = lgear.MaximumStrutForce;
 147   MaximumStrutTravel = lgear.MaximumStrutTravel;
 148
 149   kSpring         = lgear.kSpring;
 150   bDamp           = lgear.bDamp;
 151   compressLength  = lgear.compressLength;
 152   compressSpeed   = lgear.compressSpeed;
 153   staticFCoeff    = lgear.staticFCoeff;
 154   dynamicFCoeff   = lgear.dynamicFCoeff;
 155   rollingFCoeff   = lgear.rollingFCoeff;
 156   brakePct        = lgear.brakePct;
 157   maxCompLen      = lgear.maxCompLen;
 158   SinkRate        = lgear.SinkRate;
 159   GroundSpeed     = lgear.GroundSpeed;
 160   Reported        = lgear.Reported;
 161   name            = lgear.name;
 162   sSteerType      = lgear.sSteerType;
 163   sRetractable    = lgear.sRetractable;
 164   eSteerType      = lgear.eSteerType;
 165   sBrakeGroup     = lgear.sBrakeGroup;
 166   eBrakeGrp       = lgear.eBrakeGrp;
 167   maxSteerAngle   = lgear.maxSteerAngle;
 168   isRetractable   = lgear.isRetractable;
 169   GearUp          = lgear.GearUp;
 170   GearDown        = lgear.GearDown;
 171 }
 172
 173 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 174
 175 FGLGear::~FGLGear()
 176 {
 177   Debug(1);
 178 }
 179
 180 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 181
 182 FGColumnVector3& FGLGear::Force(void)
 183 {
 184   vForce.InitMatrix();
 185   vMoment.InitMatrix();
 186
 187   if (isRetractable) {
 188     if (FCS->GetGearPos() < 0.01) {
 189       GearUp   = true;
 190       GearDown = false;
 191      } else if (FCS->GetGearPos() > 0.99) {
 192       GearDown = true;
 193       GearUp   = false;
 194      } else {
 195       GearUp   = false;
 196       GearDown = false;
 197      }
 198   } else {
 199       GearUp   = false;
 200       GearDown = true;
 201   }
 202
 203   if (GearDown) {
 204     double SteerGain = 0;
 205     double SinWheel, CosWheel, SideWhlVel, RollingWhlVel;
 206     double RollingForce, SideForce, FCoeff;
 207     double WheelSlip;
 208
 209     vWhlBodyVec     = (vXYZ - MassBalance->GetXYZcg()) / 12.0;
 210     vWhlBodyVec(eX) = -vWhlBodyVec(eX);
 211     vWhlBodyVec(eZ) = -vWhlBodyVec(eZ);
 212
 213 // vWhlBodyVec now stores the vector from the cg to this wheel
 214
 215     vLocalGear = State->GetTb2l() * vWhlBodyVec;
 216
 217 // vLocalGear now stores the vector from the cg to the wheel in local coords.
 218
 219     compressLength = vLocalGear(eZ) - Position->GetDistanceAGL();
 220
 221 // The compression length is currently measured in the Z-axis, only, at this time.
 222 // It should be measured along the strut axis. If the local-frame gear position
 223 // "hangs down" below the CG greater than the altitude, then the compressLength
 224 // will be positive - i.e. the gear will have made contact.
 225
 226     if (compressLength > 0.00) {
 227
 228       WOW = true;// Weight-On-Wheels is true
 229
 230 // The next equation should really use the vector to the contact patch of the tire
 231 // including the strut compression and not vWhlBodyVec.  Will fix this later.
 232 // As it stands, now, the following equation takes the aircraft body-frame
 233 // rotational rate and calculates the cross-product with the vector from the CG
 234 // to the wheel, thus producing the instantaneous velocity vector of the tire
 235 // in Body coords. The frame is also converted to local coordinates. When the
 236 // aircraft local-frame velocity is added to this quantity, the total velocity of
 237 // the wheel in local frame is then known. Subsequently, the compression speed
 238 // (used for calculating damping force) is found by taking the Z-component of the
 239 // wheel velocity.
 240
 241       vWhlVelVec      =  State->GetTb2l() * (Rotation->GetPQR() * vWhlBodyVec);
 242
 243       vWhlVelVec     +=  Position->GetVel();
 244
 245       compressSpeed   =  vWhlVelVec(eZ);
 246
 247 // If this is the first time the wheel has made contact, remember some values
 248 // for later printout.
 249
 250       if (!FirstContact) {
 251         FirstContact  = true;
 252         SinkRate      =  compressSpeed;
 253         GroundSpeed   =  Position->GetVel().Magnitude();
 254       }
 255
 256 // The following needs work regarding friction coefficients and braking and
 257 // steering The BrakeFCoeff formula assumes that an anti-skid system is used.
 258 // It also assumes that we won't be turning and braking at the same time.
 259 // Will fix this later.
 260 // [JSB] The braking force coefficients include normal rolling coefficient +
 261 // a percentage of the static friction coefficient based on braking applied.
 262
 263       switch (eBrakeGrp) {
 264       case bgLeft:
 265         SteerGain = -0.10;
 266         BrakeFCoeff = rollingFCoeff*(1.0 - FCS->GetBrake(bgLeft)) +
 267                                               staticFCoeff*FCS->GetBrake(bgLeft);
 268         break;
 269       case bgRight:
 270         SteerGain = -0.10;
 271         BrakeFCoeff = rollingFCoeff*(1.0 - FCS->GetBrake(bgRight)) +
 272                                              staticFCoeff*FCS->GetBrake(bgRight);
 273         break;
 274       case bgCenter:
 275         SteerGain = -0.10;
 276         BrakeFCoeff = rollingFCoeff*(1.0 - FCS->GetBrake(bgCenter)) +
 277                                              staticFCoeff*FCS->GetBrake(bgCenter);
 278         break;
 279       case bgNose:
 280         SteerGain = 0.10;
 281         BrakeFCoeff = rollingFCoeff;
 282         break;
 283       case bgTail:
 284         SteerGain = -0.10;
 285         BrakeFCoeff = rollingFCoeff;
 286         break;
 287       case bgNone:
 288         SteerGain = -0.10;
 289         BrakeFCoeff = rollingFCoeff;
 290         break;
 291       default:
 292         cerr << "Improper brake group membership detected for this gear." << endl;
 293         break;
 294       }
 295
 296       switch (eSteerType) {
 297       case stSteer:
 298         SteerAngle = SteerGain*FCS->GetDrPos();
 299         break;
 300       case stFixed:
 301         SteerAngle = 0.0;
 302         break;
 303       case stCaster:
 304 // Note to Jon: This is not correct for castering gear.  I'll fix it later.
 305         SteerAngle = 0.0;
 306         break;
 307       default:
 308         cerr << "Improper steering type membership detected for this gear." << endl;
 309         break;
 310       }
 311
 312 // Transform the wheel velocities from the local axis system to the wheel axis system.
 313 // For now, steering angle is assumed to happen in the Local Z axis,
 314 // not the strut axis as it should be.  Will fix this later.
 315
 316       SinWheel      = sin(Rotation->Getpsi() + SteerAngle);
 317       CosWheel      = cos(Rotation->Getpsi() + SteerAngle);
 318       RollingWhlVel = vWhlVelVec(eX)*CosWheel + vWhlVelVec(eY)*SinWheel;
 319       SideWhlVel    = vWhlVelVec(eY)*CosWheel - vWhlVelVec(eX)*SinWheel;
 320
 321 // Calculate tire slip angle.
 322
 323       if (RollingWhlVel == 0.0 && SideWhlVel == 0.0) {
 324         WheelSlip = 0.0;
 325       } else {
 326         WheelSlip = radtodeg*atan2(SideWhlVel, RollingWhlVel);
 327       }
 328
 329 // The following code normalizes the wheel velocity vector, reverses it, and zeroes out
 330 // the z component of the velocity. The question is, should the Z axis velocity be zeroed
 331 // out first before the normalization takes place or not? Subsequent to that, the Wheel
 332 // Velocity vector now points as a unit vector backwards and parallel to the wheel
 333 // velocity vector. It acts AT the wheel.
 334
 335 // Note to Jon: I commented out this line because I wasn't sure we want to do this.
 336 //    vWhlVelVec      = -1.0 * vWhlVelVec.Normalize();
 337 //    vWhlVelVec(eZ)  =  0.00;
 338
 339 // Compute the sideforce coefficients using similar assumptions to LaRCSim for now.
 340 // Allow a maximum of 10 degrees tire slip angle before wheel slides.  At that point,
 341 // transition from static to dynamic friction.  There are more complicated formulations
 342 // of this that avoid the discrete jump.  Will fix this later.
 343
 344       if (fabs(WheelSlip) <= 10.0) {
 345         FCoeff = staticFCoeff*WheelSlip/10.0;
 346       } else {
 347         FCoeff = dynamicFCoeff*fabs(WheelSlip)/WheelSlip;
 348       }
 349
 350 // Compute the vertical force on the wheel using square-law damping (per comment
 351 // in paper AIAA-2000-4303 - see header prologue comments). We might consider
 352 // allowing for both square and linear damping force calculation. Also need to
 353 // possibly give a "rebound damping factor" that differs from the compression
 354 // case. NOTE: SQUARE LAW DAMPING NO GOOD!
 355
 356       vLocalForce(eZ) =  min(-compressLength * kSpring
 357                              - compressSpeed * bDamp, (double)0.0);
 358
 359       MaximumStrutForce = max(MaximumStrutForce, fabs(vLocalForce(eZ)));
 360       MaximumStrutTravel = max(MaximumStrutTravel, fabs(compressLength));
 361
 362 // Compute the forces in the wheel ground plane.
 363
 364       RollingForce = 0;
 365       if (fabs(RollingWhlVel) > 1E-3) {
 366         RollingForce = vLocalForce(eZ) * BrakeFCoeff * fabs(RollingWhlVel)/RollingWhlVel;
 367       }
 368       SideForce    = vLocalForce(eZ) * FCoeff;
 369
 370 // Transform these forces back to the local reference frame.
 371
 372       vLocalForce(eX) = RollingForce*CosWheel - SideForce*SinWheel;
 373       vLocalForce(eY) = SideForce*CosWheel    + RollingForce*SinWheel;
 374
 375 // Note to Jon: At this point the forces will be too big when the airplane is
 376 // stopped or rolling to a stop.  We need to make sure that the gear forces just
 377 // balance out the non-gear forces when the airplane is stopped.  That way the
 378 // airplane won't start to accelerate until the non-gear/ forces are larger than
 379 // the gear forces.  I think that the proper fix should go into FGAircraft::FMGear.
 380 // This routine would only compute the local strut forces and return them to
 381 // FMGear. All of the gear forces would get adjusted in FMGear using the total
 382 // non-gear forces. Then the gear moments would be calculated. If strange things
 383 // start happening to the airplane during testing as it rolls to a stop, then we
 384 // need to implement this change.  I ran out of time to do it now but have the
 385 // equations.
 386
 387 // Transform the forces back to the body frame and compute the moment.
 388
 389       vForce  = State->GetTl2b() * vLocalForce;
 390       vMoment = vWhlBodyVec * vForce;
 391
 392     } else {
 393
 394       WOW = false;
 395
 396       if (Position->GetDistanceAGL() > 200.0) {
 397         FirstContact = false;
 398         Reported = false;
 399         DistanceTraveled = 0.0;
 400         MaximumStrutForce = MaximumStrutTravel = 0.0;
 401       }
 402
 403       compressLength = 0.0; // reset compressLength to zero for data output validity
 404     }
 405
 406     if (FirstContact) {
 407       DistanceTraveled += Position->GetVel().Magnitude()*State->Getdt()*Aircraft->GetRate();
 408     }
 409
 410     if (ReportEnable && Position->GetVel().Magnitude() <= 0.05 && !Reported) {
 411       if (debug_lvl > 0) Report();
 412     }
 413
 414     if (lastWOW != WOW) {
 415       PutMessage("GEAR_CONTACT", WOW);
 416     }
 417
 418     lastWOW = WOW;
 419
 420 // Crash detection logic (really out-of-bounds detection)
 421
 422     if (compressLength > 500.0 ||
 423         vForce.Magnitude() > 100000000.0 ||
 424         vMoment.Magnitude() > 5000000000.0 ||
 425         SinkRate > 1.4666*30)
 426     {
 427       PutMessage("Crash Detected");
 428       Exec->Freeze();
 429     }
 430   }
 431   return vForce;
 432 }
 433
 434 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 435
 436 void FGLGear::Report(void)
 437 {
 438   cout << endl << "Touchdown report for " << name << endl;
 439   cout << "  Sink rate at contact:  " << SinkRate                << " fps,    "
 440                               << SinkRate*0.3408          << " mps"     << endl;
 441   cout << "  Contact ground speed:  " << GroundSpeed*.5925       << " knots,  "
 442                               << GroundSpeed*0.3408       << " mps"     << endl;
 443   cout << "  Maximum contact force: " << MaximumStrutForce       << " lbs,    "
 444                               << MaximumStrutForce*4.448  << " Newtons" << endl;
 445   cout << "  Maximum strut travel:  " << MaximumStrutTravel*12.0 << " inches, "
 446                               << MaximumStrutTravel*30.48 << " cm"      << endl;
 447   cout << "  Distance traveled:     " << DistanceTraveled        << " ft,     "
 448                               << DistanceTraveled*0.3408  << " meters"  << endl;
 449   Reported = true;
 450 }
 451
 452 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 453 //    The bitmasked value choices are as follows:
 454 //    unset: In this case (the default) JSBSim would only print
 455 //       out the normally expected messages, essentially echoing
 456 //       the config files as they are read. If the environment
 457 //       variable is not set, debug_lvl is set to 1 internally
 458 //    0: This requests JSBSim not to output any messages
 459 //       whatsoever.
 460 //    1: This value explicity requests the normal JSBSim
 461 //       startup messages
 462 //    2: This value asks for a message to be printed out when
 463 //       a class is instantiated
 464 //    4: When this value is set, a message is displayed when a
 465 //       FGModel object executes its Run() method
 466 //    8: When this value is set, various runtime state variables
 467 //       are printed out periodically
 468 //    16: When set various parameters are sanity checked and
 469 //       a message is printed out when they go out of bounds
 470
 471 void FGLGear::Debug(int from)
 472 {
 473   if (debug_lvl <= 0) return;
 474
 475   if (debug_lvl & 1) { // Standard console startup message output
 476     if (from == 0) { // Constructor
 477       cout << "    Name: "               << name          << endl;
 478       cout << "      Location: "         << vXYZ          << endl;
 479       cout << "      Spring Constant:  " << kSpring       << endl;
 480       cout << "      Damping Constant: " << bDamp         << endl;
 481       cout << "      Dynamic Friction: " << dynamicFCoeff << endl;
 482       cout << "      Static Friction:  " << staticFCoeff  << endl;
 483       cout << "      Rolling Friction: " << rollingFCoeff << endl;
 484       cout << "      Steering Type:    " << sSteerType    << endl;
 485       cout << "      Grouping:         " << sBrakeGroup   << endl;
 486       cout << "      Max Steer Angle:  " << maxSteerAngle << endl;
 487       cout << "      Retractable:      " << sRetractable  << endl;
 488     }
 489   }
 490   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 491     if (from == 0) cout << "Instantiated: FGLGear" << endl;
 492     if (from == 1) cout << "Destroyed:    FGLGear" << endl;
 493   }
 494   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 495   }
 496   if (debug_lvl & 8 ) { // Runtime state variables
 497   }
 498   if (debug_lvl & 16) { // Sanity checking
 499   }
 500   if (debug_lvl & 64) {
 501     if (from == 0) { // Constructor
 502       cout << IdSrc << endl;
 503       cout << IdHdr << endl;
 504     }
 505   }
 506 }
 507