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) : vXYZ(3),
  61                                                            vMoment(3),
  62                                                            vWhlBodyVec(3),
  63                                                            vForce(3),
  64                                                            vLocalForce(3),
  65                                                            vWhlVelVec(3),
  66                                                            Exec(fdmex)
  67 {
  68   string tmp;
  69   *AC_cfg >> tmp >> name >> vXYZ(1) >> vXYZ(2) >> vXYZ(3)
  70             >> kSpring >> bDamp>> dynamicFCoeff >> staticFCoeff
  71                   >> rollingFCoeff >> sSteerType >> sBrakeGroup >> maxSteerAngle;
  72
  73   if (debug_lvl > 0) {
  74     cout << "    Name: " << name << endl;
  75     cout << "      Location: " << vXYZ << endl;
  76     cout << "      Spring Constant:  " << kSpring << endl;
  77     cout << "      Damping Constant: " << bDamp << endl;
  78     cout << "      Dynamic Friction: " << dynamicFCoeff << endl;
  79     cout << "      Static Friction:  " << staticFCoeff << endl;
  80     cout << "      Rolling Friction: " << rollingFCoeff << endl;
  81     cout << "      Steering Type:    " << sSteerType << endl;
  82     cout << "      Grouping:         " << sBrakeGroup << endl;
  83     cout << "      Max Steer Angle:  " << maxSteerAngle << endl;
  84   }
  85
  86   if      (sBrakeGroup == "LEFT"  ) eBrakeGrp = bgLeft;
  87   else if (sBrakeGroup == "RIGHT" ) eBrakeGrp = bgRight;
  88   else if (sBrakeGroup == "CENTER") eBrakeGrp = bgCenter;
  89   else if (sBrakeGroup == "NOSE"  ) eBrakeGrp = bgNose;
  90   else if (sBrakeGroup == "TAIL"  ) eBrakeGrp = bgTail;
  91   else if (sBrakeGroup == "NONE"  ) eBrakeGrp = bgNone;
  92   else {
  93     cerr << "Improper braking group specification in config file: "
  94          << sBrakeGroup << " is undefined." << endl;
  95   }
  96
  97   if      (sSteerType == "STEERABLE") eSteerType = stSteer;
  98   else if (sSteerType == "FIXED"    ) eSteerType = stFixed;
  99   else if (sSteerType == "CASTERED" ) eSteerType = stCaster;
 100   else {
 101     cerr << "Improper steering type specification in config file: "
 102          << sSteerType << " is undefined." << endl;
 103   }
 104
 105 // Add some AI here to determine if gear is located properly according to its
 106 // brake group type ??
 107
 108   State       = Exec->GetState();
 109   Aircraft    = Exec->GetAircraft();
 110   Position    = Exec->GetPosition();
 111   Rotation    = Exec->GetRotation();
 112   FCS         = Exec->GetFCS();
 113   MassBalance = Exec->GetMassBalance();
 114
 115   WOW = false;
 116   ReportEnable = true;
 117   FirstContact = false;
 118   Reported = false;
 119   DistanceTraveled = 0.0;
 120   MaximumStrutForce = MaximumStrutTravel = 0.0;
 121   SinkRate = GroundSpeed = 0.0;
 122
 123   vWhlBodyVec     = (vXYZ - MassBalance->GetXYZcg()) / 12.0;
 124   vWhlBodyVec(eX) = -vWhlBodyVec(eX);
 125   vWhlBodyVec(eZ) = -vWhlBodyVec(eZ);
 126
 127   vLocalGear = State->GetTb2l() * vWhlBodyVec;
 128
 129   if (debug_lvl & 2) cout << "Instantiated: FGLGear" << endl;
 130 }
 131
 132 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 133
 134 FGLGear::FGLGear(const FGLGear& lgear)
 135 {
 136   State    = lgear.State;
 137   Aircraft = lgear.Aircraft;
 138   Position = lgear.Position;
 139   Rotation = lgear.Rotation;
 140   Exec     = lgear.Exec;
 141   FCS      = lgear.FCS;
 142   MassBalance = lgear.MassBalance;
 143
 144   vXYZ = lgear.vXYZ;
 145   vMoment = lgear.vMoment;
 146   vWhlBodyVec = lgear.vWhlBodyVec;
 147   vLocalGear = lgear.vLocalGear;
 148
 149   WOW                = lgear.WOW;
 150   ReportEnable       = lgear.ReportEnable;
 151   FirstContact       = lgear.FirstContact;
 152   DistanceTraveled   = lgear.DistanceTraveled;
 153   MaximumStrutForce  = lgear.MaximumStrutForce;
 154   MaximumStrutTravel = lgear.MaximumStrutTravel;
 155
 156   kSpring         = lgear.kSpring;
 157   bDamp           = lgear.bDamp;
 158   compressLength  = lgear.compressLength;
 159   compressSpeed   = lgear.compressSpeed;
 160   staticFCoeff    = lgear.staticFCoeff;
 161   dynamicFCoeff   = lgear.dynamicFCoeff;
 162   rollingFCoeff   = lgear.rollingFCoeff;
 163   brakePct        = lgear.brakePct;
 164   maxCompLen      = lgear.maxCompLen;
 165   SinkRate        = lgear.SinkRate;
 166   GroundSpeed     = lgear.GroundSpeed;
 167   Reported        = lgear.Reported;
 168   name            = lgear.name;
 169   sSteerType      = lgear.sSteerType;
 170   eSteerType      = lgear.eSteerType;
 171   sBrakeGroup     = lgear.sBrakeGroup;
 172   eBrakeGrp       = lgear.eBrakeGrp;
 173   maxSteerAngle   = lgear.maxSteerAngle;
 174 }
 175
 176 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 177
 178 FGLGear::~FGLGear()
 179 {
 180   if (debug_lvl & 2) cout << "Destroyed:    FGLGear" << endl;
 181 }
 182
 183 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 184
 185 FGColumnVector3& FGLGear::Force(void)
 186 {
 187   float SteerGain;
 188   float SinWheel, CosWheel, SideWhlVel, RollingWhlVel;
 189   float RudderPedal, RollingForce, SideForce, FCoeff;
 190   float WheelSlip;
 191
 192   vWhlBodyVec     = (vXYZ - MassBalance->GetXYZcg()) / 12.0;
 193   vWhlBodyVec(eX) = -vWhlBodyVec(eX);
 194   vWhlBodyVec(eZ) = -vWhlBodyVec(eZ);
 195
 196 // vWhlBodyVec now stores the vector from the cg to this wheel
 197
 198   vLocalGear = State->GetTb2l() * vWhlBodyVec;
 199
 200 // vLocalGear now stores the vector from the cg to the wheel in local coords.
 201
 202   compressLength = vLocalGear(eZ) - Position->GetDistanceAGL();
 203
 204 // The compression length is currently measured in the Z-axis, only, at this time.
 205 // It should be measured along the strut axis. If the local-frame gear position
 206 // "hangs down" below the CG greater than the altitude, then the compressLength
 207 // will be positive - i.e. the gear will have made contact.
 208
 209   if (compressLength > 0.00) {
 210
 211     WOW = true; // Weight-On-Wheels is true
 212
 213 // The next equation should really use the vector to the contact patch of the tire
 214 // including the strut compression and not vWhlBodyVec.  Will fix this later.
 215 // As it stands, now, the following equation takes the aircraft body-frame
 216 // rotational rate and calculates the cross-product with the vector from the CG
 217 // to the wheel, thus producing the instantaneous velocity vector of the tire
 218 // in Body coords. The frame is also converted to local coordinates. When the
 219 // aircraft local-frame velocity is added to this quantity, the total velocity of
 220 // the wheel in local frame is then known. Subsequently, the compression speed
 221 // (used for calculating damping force) is found by taking the Z-component of the
 222 // wheel velocity.
 223
 224     vWhlVelVec      =  State->GetTb2l() * (Rotation->GetPQR() * vWhlBodyVec);
 225
 226     vWhlVelVec     +=  Position->GetVel();
 227
 228     compressSpeed   =  vWhlVelVec(eZ);
 229
 230 // If this is the first time the wheel has made contact, remember some values
 231 // for later printout.
 232
 233     if (!FirstContact) {
 234       FirstContact  = true;
 235       SinkRate      =  compressSpeed;
 236       GroundSpeed   =  Position->GetVel().Magnitude();
 237     }
 238
 239 // The following needs work regarding friction coefficients and braking and
 240 // steering The BrakeFCoeff formula assumes that an anti-skid system is used.
 241 // It also assumes that we won't be turning and braking at the same time.
 242 // Will fix this later.
 243 // [JSB] The braking force coefficients include normal rolling coefficient +
 244 // a percentage of the static friction coefficient based on braking applied.
 245
 246     switch (eBrakeGrp) {
 247     case bgLeft:
 248       SteerGain = -0.10;
 249       BrakeFCoeff = rollingFCoeff*(1.0 - FCS->GetBrake(bgLeft)) +
 250                                             staticFCoeff*FCS->GetBrake(bgLeft);
 251       break;
 252     case bgRight:
 253       SteerGain = -0.10;
 254       BrakeFCoeff = rollingFCoeff*(1.0 - FCS->GetBrake(bgRight)) +
 255                                            staticFCoeff*FCS->GetBrake(bgRight);
 256       break;
 257     case bgCenter:
 258       SteerGain = -0.10;
 259       BrakeFCoeff = rollingFCoeff*(1.0 - FCS->GetBrake(bgCenter)) +
 260                                            staticFCoeff*FCS->GetBrake(bgCenter);
 261       break;
 262     case bgNose:
 263       SteerGain = 0.10;
 264       BrakeFCoeff = rollingFCoeff;
 265       break;
 266     case bgTail:
 267       SteerGain = -0.10;
 268       BrakeFCoeff = rollingFCoeff;
 269       break;
 270     case bgNone:
 271       SteerGain = -0.10;
 272       BrakeFCoeff = rollingFCoeff;
 273       break;
 274     default:
 275       cerr << "Improper brake group membership detected for this gear." << endl;
 276       break;
 277     }
 278
 279     switch (eSteerType) {
 280     case stSteer:
 281       SteerAngle = SteerGain*FCS->GetDrPos();
 282       break;
 283     case stFixed:
 284       SteerAngle = 0.0;
 285       break;
 286     case stCaster:
 287     // Note to Jon: This is not correct for castering gear.  I'll fix it later.
 288       SteerAngle = 0.0;
 289       break;
 290     default:
 291       cerr << "Improper steering type membership detected for this gear." << endl;
 292       break;
 293     }
 294
 295 // Transform the wheel velocities from the local axis system to the wheel axis system.
 296 // For now, steering angle is assumed to happen in the Local Z axis,
 297 // not the strut axis as it should be.  Will fix this later.
 298
 299     SinWheel      = sin(Rotation->Getpsi() + SteerAngle);
 300     CosWheel      = cos(Rotation->Getpsi() + SteerAngle);
 301     RollingWhlVel = vWhlVelVec(eX)*CosWheel + vWhlVelVec(eY)*SinWheel;
 302     SideWhlVel    = vWhlVelVec(eY)*CosWheel - vWhlVelVec(eX)*SinWheel;
 303
 304 // Calculate tire slip angle.
 305
 306     if (RollingWhlVel == 0.0 && SideWhlVel == 0.0) {
 307       WheelSlip = 0.0;
 308     } else {
 309       WheelSlip = radtodeg*atan2(SideWhlVel, RollingWhlVel);
 310     }
 311
 312 // The following code normalizes the wheel velocity vector, reverses it, and zeroes out
 313 // the z component of the velocity. The question is, should the Z axis velocity be zeroed
 314 // out first before the normalization takes place or not? Subsequent to that, the Wheel
 315 // Velocity vector now points as a unit vector backwards and parallel to the wheel
 316 // velocity vector. It acts AT the wheel.
 317
 318 // Note to Jon: I commented out this line because I wasn't sure we want to do this.
 319 //    vWhlVelVec      = -1.0 * vWhlVelVec.Normalize();
 320 //    vWhlVelVec(eZ)  =  0.00;
 321
 322 // Compute the sideforce coefficients using similar assumptions to LaRCSim for now.
 323 // Allow a maximum of 10 degrees tire slip angle before wheel slides.  At that point,
 324 // transition from static to dynamic friction.  There are more complicated formulations
 325 // of this that avoid the discrete jump.  Will fix this later.
 326
 327     if (fabs(WheelSlip) <= 10.0) {
 328       FCoeff = staticFCoeff*WheelSlip/10.0;
 329     } else {
 330       FCoeff = dynamicFCoeff*fabs(WheelSlip)/WheelSlip;
 331     }
 332
 333 // Compute the vertical force on the wheel using square-law damping (per comment
 334 // in paper AIAA-2000-4303 - see header prologue comments). We might consider
 335 // allowing for both square and linear damping force calculation. Also need to
 336 // possibly give a "rebound damping factor" that differs from the compression
 337 // case. NOTE: SQUARE LAW DAMPING NO GOOD!
 338
 339     vLocalForce(eZ) =  min(-compressLength * kSpring
 340                            - compressSpeed * bDamp, (float)0.0);
 341
 342     MaximumStrutForce = max(MaximumStrutForce, fabs(vLocalForce(eZ)));
 343     MaximumStrutTravel = max(MaximumStrutTravel, fabs(compressLength));
 344
 345 // Compute the forces in the wheel ground plane.
 346
 347     RollingForce = 0;
 348     if (fabs(RollingWhlVel) > 1E-3) {
 349       RollingForce = vLocalForce(eZ) * BrakeFCoeff * fabs(RollingWhlVel)/RollingWhlVel;
 350     }
 351     SideForce    = vLocalForce(eZ) * FCoeff;
 352
 353 // Transform these forces back to the local reference frame.
 354
 355     vLocalForce(eX) = RollingForce*CosWheel - SideForce*SinWheel;
 356     vLocalForce(eY) = SideForce*CosWheel    + RollingForce*SinWheel;
 357
 358 // Note to Jon: At this point the forces will be too big when the airplane is
 359 // stopped or rolling to a stop.  We need to make sure that the gear forces just
 360 // balance out the non-gear forces when the airplane is stopped.  That way the
 361 // airplane won't start to accelerate until the non-gear/ forces are larger than
 362 // the gear forces.  I think that the proper fix should go into FGAircraft::FMGear.
 363 // This routine would only compute the local strut forces and return them to
 364 // FMGear. All of the gear forces would get adjusted in FMGear using the total
 365 // non-gear forces. Then the gear moments would be calculated. If strange things
 366 // start happening to the airplane during testing as it rolls to a stop, then we
 367 // need to implement this change.  I ran out of time to do it now but have the
 368 // equations.
 369
 370 // Transform the forces back to the body frame and compute the moment.
 371
 372     vForce  = State->GetTl2b() * vLocalForce;
 373     vMoment = vWhlBodyVec * vForce;
 374
 375   } else {
 376
 377     WOW = false;
 378
 379     if (Position->GetDistanceAGL() > 200.0) {
 380       FirstContact = false;
 381       Reported = false;
 382       DistanceTraveled = 0.0;
 383       MaximumStrutForce = MaximumStrutTravel = 0.0;
 384     }
 385
 386     compressLength = 0.0; // reset compressLength to zero for data output validity
 387
 388     vForce.InitMatrix();
 389     vMoment.InitMatrix();
 390   }
 391
 392   if (FirstContact) {
 393     DistanceTraveled += Position->GetVel().Magnitude()*State->Getdt()*Aircraft->GetRate();
 394   }
 395
 396   if (ReportEnable && Position->GetVel().Magnitude() <= 0.05 && !Reported) {
 397     if (debug_lvl > 0) Report();
 398   }
 399
 400   return vForce;
 401 }
 402
 403 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 404
 405 void FGLGear::Report(void)
 406 {
 407   cout << endl << "Touchdown report for " << name << endl;
 408   cout << "  Sink rate at contact:  " << SinkRate                << " fps,    "
 409                               << SinkRate*0.3408          << " mps"     << endl;
 410   cout << "  Contact ground speed:  " << GroundSpeed*.5925       << " knots,  "
 411                               << GroundSpeed*0.3408       << " mps"     << endl;
 412   cout << "  Maximum contact force: " << MaximumStrutForce       << " lbs,    "
 413                               << MaximumStrutForce*4.448  << " Newtons" << endl;
 414   cout << "  Maximum strut travel:  " << MaximumStrutTravel*12.0 << " inches, "
 415                               << MaximumStrutTravel*30.48 << " cm"      << endl;
 416   cout << "  Distance traveled:     " << DistanceTraveled        << " ft,     "
 417                               << DistanceTraveled*0.3408  << " meters"  << endl;
 418   Reported = true;
 419 }
 420
 421 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 422
 423 void FGLGear::Debug(void)
 424 {
 425   // TODO: Add user code here
 426 }
 427