src/FDM/JSBSim/models/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 Lesser 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 Lesser General Public License for more
  20  details.
  21
  22  You should have received a copy of the GNU Lesser 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 Lesser 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
  43 namespace JSBSim {
  44
  45 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  46 DEFINITIONS
  47 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  48
  49 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  50 GLOBAL DATA
  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(Element* el, FGFDMExec* fdmex, int number) :
  61   GearNumber(number),
  62   Exec(fdmex)
  63 {
  64   Element *force_table=0;
  65   Element *dampCoeff=0;
  66   Element *dampCoeffRebound=0;
  67   string force_type="";
  68
  69   kSpring = bDamp = bDampRebound = dynamicFCoeff = staticFCoeff = rollingFCoeff = maxSteerAngle = 0;
  70   sSteerType = sBrakeGroup = sSteerType = "";
  71   isRetractable = 0;
  72   eDampType = dtLinear;
  73   eDampTypeRebound = dtLinear;
  74
  75   name = el->GetAttributeValue("name");
  76   sContactType = el->GetAttributeValue("type");
  77   if (sContactType == "BOGEY") {
  78     eContactType = ctBOGEY;
  79   } else if (sContactType == "STRUCTURE") {
  80     eContactType = ctSTRUCTURE;
  81   } else {
  82     eContactType = ctUNKNOWN;
  83   }
  84
  85   if (el->FindElement("spring_coeff"))
  86     kSpring = el->FindElementValueAsNumberConvertTo("spring_coeff", "LBS/FT");
  87   if (el->FindElement("damping_coeff")) {
  88     dampCoeff = el->FindElement("damping_coeff");
  89     if (dampCoeff->GetAttributeValue("type") == "SQUARE") {
  90       eDampType = dtSquare;
  91       bDamp   = el->FindElementValueAsNumberConvertTo("damping_coeff", "LBS/FT2/SEC2");
  92     } else {
  93       bDamp   = el->FindElementValueAsNumberConvertTo("damping_coeff", "LBS/FT/SEC");
  94     }
  95   }
  96
  97   if (el->FindElement("damping_coeff_rebound")) {
  98     dampCoeffRebound = el->FindElement("damping_coeff_rebound");
  99     if (dampCoeffRebound->GetAttributeValue("type") == "SQUARE") {
 100       eDampTypeRebound = dtSquare;
 101       bDampRebound   = el->FindElementValueAsNumberConvertTo("damping_coeff_rebound", "LBS/FT2/SEC2");
 102     } else {
 103       bDampRebound   = el->FindElementValueAsNumberConvertTo("damping_coeff_rebound", "LBS/FT/SEC");
 104     }
 105   } else {
 106     bDampRebound   = bDamp;
 107     eDampTypeRebound = eDampType;
 108   }
 109
 110   if (el->FindElement("dynamic_friction"))
 111     dynamicFCoeff = el->FindElementValueAsNumber("dynamic_friction");
 112   if (el->FindElement("static_friction"))
 113     staticFCoeff = el->FindElementValueAsNumber("static_friction");
 114   if (el->FindElement("rolling_friction"))
 115     rollingFCoeff = el->FindElementValueAsNumber("rolling_friction");
 116   if (el->FindElement("max_steer"))
 117     maxSteerAngle = el->FindElementValueAsNumberConvertTo("max_steer", "DEG");
 118   if (el->FindElement("retractable"))
 119     isRetractable = ((unsigned int)el->FindElementValueAsNumber("retractable"))>0.0?true:false;
 120
 121   ForceY_Table = 0;
 122   force_table = el->FindElement("table");
 123   while (force_table) {
 124     force_type = force_table->GetAttributeValue("type");
 125     if (force_type == "CORNERING_COEFF") {
 126       ForceY_Table = new FGTable(Exec->GetPropertyManager(), force_table);
 127     } else {
 128       cerr << "Undefined force table for " << name << " contact point" << endl;
 129     }
 130     force_table = el->FindNextElement("table");
 131   }
 132
 133   sBrakeGroup = el->FindElementValue("brake_group");
 134
 135   if (maxSteerAngle == 360) sSteerType = "CASTERED";
 136   else if (maxSteerAngle == 0.0) sSteerType = "FIXED";
 137   else sSteerType = "STEERABLE";
 138
 139   Element* element = el->FindElement("location");
 140   if (element) vXYZ = element->FindElementTripletConvertTo("IN");
 141   else {cerr << "No location given for contact " << name << endl; exit(-1);}
 142
 143   if      (sBrakeGroup == "LEFT"  ) eBrakeGrp = bgLeft;
 144   else if (sBrakeGroup == "RIGHT" ) eBrakeGrp = bgRight;
 145   else if (sBrakeGroup == "CENTER") eBrakeGrp = bgCenter;
 146   else if (sBrakeGroup == "NOSE"  ) eBrakeGrp = bgNose;
 147   else if (sBrakeGroup == "TAIL"  ) eBrakeGrp = bgTail;
 148   else if (sBrakeGroup == "NONE"  ) eBrakeGrp = bgNone;
 149   else if (sBrakeGroup.empty()    ) {eBrakeGrp = bgNone;
 150                                      sBrakeGroup = "NONE (defaulted)";}
 151   else {
 152     cerr << "Improper braking group specification in config file: "
 153          << sBrakeGroup << " is undefined." << endl;
 154   }
 155
 156   if      (sSteerType == "STEERABLE") eSteerType = stSteer;
 157   else if (sSteerType == "FIXED"    ) eSteerType = stFixed;
 158   else if (sSteerType == "CASTERED" ) eSteerType = stCaster;
 159   else if (sSteerType.empty()       ) {eSteerType = stFixed;
 160                                        sSteerType = "FIXED (defaulted)";}
 161   else {
 162     cerr << "Improper steering type specification in config file: "
 163          << sSteerType << " is undefined." << endl;
 164   }
 165
 166   RFRV = 0.7;  // Rolling force relaxation velocity, default value
 167   SFRV = 0.7;  // Side force relaxation velocity, default value
 168
 169   Element* relax_vel = el->FindElement("relaxation_velocity");
 170   if (relax_vel) {
 171     if (relax_vel->FindElement("rolling")) {
 172       RFRV = relax_vel->FindElementValueAsNumberConvertTo("rolling", "FT/SEC");
 173     }
 174     if (relax_vel->FindElement("side")) {
 175       SFRV = relax_vel->FindElementValueAsNumberConvertTo("side", "FT/SEC");
 176     }
 177   }
 178
 179   State = Exec->GetState();
 180   LongForceLagFilterCoeff = 1/State->Getdt(); // default longitudinal force filter coefficient
 181   LatForceLagFilterCoeff  = 1/State->Getdt(); // default lateral force filter coefficient
 182
 183   Element* force_lag_filter_elem = el->FindElement("force_lag_filter");
 184   if (force_lag_filter_elem) {
 185     if (force_lag_filter_elem->FindElement("rolling")) {
 186       LongForceLagFilterCoeff = force_lag_filter_elem->FindElementValueAsNumber("rolling");
 187     }
 188     if (force_lag_filter_elem->FindElement("side")) {
 189       LatForceLagFilterCoeff = force_lag_filter_elem->FindElementValueAsNumber("side");
 190     }
 191   }
 192
 193   LongForceFilter = Filter(LongForceLagFilterCoeff, State->Getdt());
 194   LatForceFilter = Filter(LatForceLagFilterCoeff, State->Getdt());
 195
 196   WheelSlipLagFilterCoeff = 1/State->Getdt();
 197
 198   Element *wheel_slip_angle_lag_elem = el->FindElement("wheel_slip_filter");
 199   if (wheel_slip_angle_lag_elem) {
 200     WheelSlipLagFilterCoeff = wheel_slip_angle_lag_elem->GetDataAsNumber();
 201   }
 202
 203   WheelSlipFilter = Filter(WheelSlipLagFilterCoeff, State->Getdt());
 204
 205   GearUp = false;
 206   GearDown = true;
 207   GearPos  = 1.0;
 208   useFCSGearPos = false;
 209   Servicable = true;
 210
 211 // Add some AI here to determine if gear is located properly according to its
 212 // brake group type ??
 213
 214   State       = Exec->GetState();
 215   Aircraft    = Exec->GetAircraft();
 216   Propagate   = Exec->GetPropagate();
 217   Auxiliary   = Exec->GetAuxiliary();
 218   FCS         = Exec->GetFCS();
 219   MassBalance = Exec->GetMassBalance();
 220
 221   WOW = lastWOW = false;
 222   ReportEnable = true;
 223   FirstContact = false;
 224   StartedGroundRun = false;
 225   TakeoffReported = LandingReported = false;
 226   LandingDistanceTraveled = TakeoffDistanceTraveled = TakeoffDistanceTraveled50ft = 0.0;
 227   MaximumStrutForce = MaximumStrutTravel = 0.0;
 228   SideForce = RollingForce = 0.0;
 229   SinkRate = GroundSpeed = 0.0;
 230
 231   vWhlBodyVec = MassBalance->StructuralToBody(vXYZ);
 232
 233   vLocalGear = Propagate->GetTb2l() * vWhlBodyVec;
 234
 235   compressLength  = 0.0;
 236   compressSpeed   = 0.0;
 237   brakePct        = 0.0;
 238   maxCompLen      = 0.0;
 239
 240   WheelSlip = 0.0;
 241   TirePressureNorm = 1.0;
 242
 243   SideWhlVel    = 0.0;
 244   RollingWhlVel = 0.0;
 245
 246   SinWheel = 0.0;
 247   CosWheel = 0.0;
 248
 249   // Set Pacejka terms
 250
 251   Stiffness = 0.06;
 252   Shape = 2.8;
 253   Peak = staticFCoeff;
 254   Curvature = 1.03;
 255
 256   Debug(0);
 257 }
 258
 259 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 260
 261 FGLGear::~FGLGear()
 262 {
 263   Debug(1);
 264 }
 265
 266 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 267
 268 FGColumnVector3& FGLGear::Force(void)
 269 {
 270   double t = Exec->GetState()->Getsim_time();
 271   dT = State->Getdt()*Exec->GetGroundReactions()->GetRate();
 272
 273   vForce.InitMatrix();
 274   vMoment.InitMatrix();
 275
 276   if (isRetractable) ComputeRetractionState();
 277
 278   if (GearDown) {
 279
 280     vWhlBodyVec = MassBalance->StructuralToBody(vXYZ); // Get wheel in body frame
 281     vLocalGear = Propagate->GetTb2l() * vWhlBodyVec; // Get local frame wheel location
 282
 283     gearLoc = Propagate->GetLocation().LocalToLocation(vLocalGear);
 284     compressLength = -Exec->GetGroundCallback()->GetAGLevel(t, gearLoc, contact, normal, cvel);
 285
 286     // The compression length is measured in the Z-axis, only, at this time.
 287
 288     if (compressLength > 0.00) {
 289
 290       WOW = true;
 291
 292       // [The next equation should really use the vector to the contact patch of
 293       // the tire including the strut compression and not the original vWhlBodyVec.]
 294
 295       vWhlVelVec      =  Propagate->GetTb2l() * (Propagate->GetPQR() * vWhlBodyVec);
 296       vWhlVelVec     +=  Propagate->GetVel() - cvel;
 297       compressSpeed   =  vWhlVelVec(eZ);
 298
 299       InitializeReporting();
 300       ComputeBrakeForceCoefficient();
 301       ComputeSteeringAngle();
 302       ComputeSlipAngle();
 303       ComputeSideForceCoefficient();
 304       ComputeVerticalStrutForce();
 305
 306       // Compute the forces in the wheel ground plane.
 307
 308       double sign = RollingWhlVel>0?1.0:(RollingWhlVel<0?-1.0:0.0);
 309       RollingForce = ((1.0 - TirePressureNorm) * 30 + vLocalForce(eZ) * BrakeFCoeff) * sign;
 310       SideForce    = vLocalForce(eZ) * FCoeff;
 311
 312       // Transform these forces back to the local reference frame.
 313
 314       vLocalForce(eX) = RollingForce*CosWheel - SideForce*SinWheel;
 315       vLocalForce(eY) = SideForce*CosWheel    + RollingForce*SinWheel;
 316
 317       // Transform the forces back to the body frame and compute the moment.
 318
 319       vForce  = Propagate->GetTl2b() * vLocalForce;
 320
 321       // Lag and attenuate the XY-plane forces dependent on velocity. This code
 322       // uses a lag filter, C/(s + C) where "C" is the filter coefficient. When
 323       // "C" is chosen at the frame rate (in Hz), the jittering is significantly
 324       // reduced. This is because the jitter is present *at* the execution rate.
 325       // If a coefficient is set to something equal to or less than zero, the
 326       // filter is bypassed.
 327
 328       if (LongForceLagFilterCoeff > 0) vForce(eX) = LongForceFilter.execute(vForce(eX));
 329       if (LatForceLagFilterCoeff > 0)  vForce(eY) = LatForceFilter.execute(vForce(eY));
 330
 331       if ((fabs(RollingWhlVel) <= RFRV) && RFRV > 0) vForce(eX) *= fabs(RollingWhlVel)/RFRV;
 332       if ((fabs(SideWhlVel) <= SFRV) && SFRV > 0) vForce(eY) *= fabs(SideWhlVel)/SFRV;
 333
 334       // End section for attentuating gear jitter
 335
 336       vMoment = vWhlBodyVec * vForce;
 337
 338     } else { // Gear is NOT compressed
 339
 340       WOW = false;
 341       compressLength = 0.0;
 342
 343       // Return to neutral position between 1.0 and 0.8 gear pos.
 344       SteerAngle *= max(GetGearUnitPos()-0.8, 0.0)/0.2;
 345
 346       ResetReporting();
 347     }
 348   }
 349
 350   ReportTakeoffOrLanding();
 351
 352   // Require both WOW and LastWOW to be true before checking crash conditions
 353   // to allow the WOW flag to be used in terminating a scripted run.
 354   if (WOW && lastWOW) CrashDetect();
 355
 356   lastWOW = WOW;
 357
 358   return vForce;
 359 }
 360
 361 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 362
 363 void FGLGear::ComputeRetractionState(void)
 364 {
 365   double gearPos = GetGearUnitPos();
 366   if (gearPos < 0.01) {
 367     GearUp   = true;
 368     WOW      = false;
 369     GearDown = false;
 370   } else if (gearPos > 0.99) {
 371     GearDown = true;
 372     GearUp   = false;
 373   } else {
 374     GearUp   = false;
 375     GearDown = false;
 376   }
 377 }
 378
 379 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 380
 381 void FGLGear::ComputeSlipAngle(void)
 382 {
 383   // Transform the wheel velocities from the local axis system to the wheel axis system.
 384   RollingWhlVel = vWhlVelVec(eX)*CosWheel + vWhlVelVec(eY)*SinWheel;
 385   SideWhlVel    = vWhlVelVec(eY)*CosWheel - vWhlVelVec(eX)*SinWheel;
 386
 387   // Calculate tire slip angle.
 388   WheelSlip = atan2(SideWhlVel, fabs(RollingWhlVel))*radtodeg;
 389
 390   // Filter the wheel slip angle
 391   if (WheelSlipLagFilterCoeff > 0) WheelSlip = WheelSlipFilter.execute(WheelSlip);
 392 }
 393
 394 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 395 // Compute the steering angle in any case.
 396 // This will also make sure that animations will look right.
 397
 398 void FGLGear::ComputeSteeringAngle(void)
 399 {
 400   double casterLocalFrameAngleRad = 0.0;
 401   double casterAngle = 0.0;
 402
 403   switch (eSteerType) {
 404   case stSteer:
 405     SteerAngle = degtorad * FCS->GetSteerPosDeg(GearNumber);
 406     break;
 407   case stFixed:
 408     SteerAngle = 0.0;
 409     break;
 410   case stCaster:
 411     // This is not correct for castering gear. Should make steer angle parallel
 412     // to the actual velocity vector of the wheel, given aircraft velocity vector
 413     // and omega.
 414     SteerAngle = 0.0;
 415     casterLocalFrameAngleRad = acos(vWhlVelVec(eX)/vWhlVelVec.Magnitude());
 416     casterAngle = casterLocalFrameAngleRad - Propagate->GetEuler(ePsi);
 417     break;
 418   default:
 419     cerr << "Improper steering type membership detected for this gear." << endl;
 420     break;
 421   }
 422
 423   SinWheel      = sin(Propagate->GetEuler(ePsi) + SteerAngle);
 424   CosWheel      = cos(Propagate->GetEuler(ePsi) + SteerAngle);
 425 }
 426
 427 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 428 // Reset reporting functionality after takeoff
 429
 430 void FGLGear::ResetReporting(void)
 431 {
 432   if (Propagate->GetDistanceAGL() > 200.0) {
 433     FirstContact = false;
 434     StartedGroundRun = false;
 435     LandingReported = false;
 436     TakeoffReported = true;
 437     LandingDistanceTraveled = 0.0;
 438     MaximumStrutForce = MaximumStrutTravel = 0.0;
 439   }
 440 }
 441
 442 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 443
 444 void FGLGear::InitializeReporting(void)
 445 {
 446   // If this is the first time the wheel has made contact, remember some values
 447   // for later printout.
 448
 449   if (!FirstContact) {
 450     FirstContact  = true;
 451     SinkRate      =  compressSpeed;
 452     GroundSpeed   =  Propagate->GetVel().Magnitude();
 453     TakeoffReported = false;
 454   }
 455
 456   // If the takeoff run is starting, initialize.
 457
 458   if ((Propagate->GetVel().Magnitude() > 0.1) &&
 459       (FCS->GetBrake(bgLeft) == 0) &&
 460       (FCS->GetBrake(bgRight) == 0) &&
 461       (FCS->GetThrottlePos(0) > 0.90) && !StartedGroundRun)
 462   {
 463     TakeoffDistanceTraveled = 0;
 464     TakeoffDistanceTraveled50ft = 0;
 465     StartedGroundRun = true;
 466   }
 467 }
 468
 469 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 470 // Takeoff and landing reporting functionality
 471
 472 void FGLGear::ReportTakeoffOrLanding(void)
 473 {
 474   double deltaT = State->Getdt()*Exec->GetGroundReactions()->GetRate();
 475
 476   if (FirstContact)
 477     LandingDistanceTraveled += Auxiliary->GetVground()*deltaT;
 478
 479   if (StartedGroundRun) {
 480     TakeoffDistanceTraveled50ft += Auxiliary->GetVground()*deltaT;
 481     if (WOW) TakeoffDistanceTraveled += Auxiliary->GetVground()*deltaT;
 482   }
 483
 484   if ( ReportEnable
 485        && Auxiliary->GetVground() <= 0.05
 486        && !LandingReported
 487        && Exec->GetGroundReactions()->GetWOW())
 488   {
 489     if (debug_lvl > 0) Report(erLand);
 490   }
 491
 492   if ( ReportEnable
 493        && !TakeoffReported
 494        && (Propagate->GetDistanceAGL() - vLocalGear(eZ)) > 50.0
 495        && !Exec->GetGroundReactions()->GetWOW())
 496   {
 497     if (debug_lvl > 0) Report(erTakeoff);
 498   }
 499
 500   if (lastWOW != WOW) PutMessage("GEAR_CONTACT: " + name, WOW);
 501 }
 502
 503 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 504 // Crash detection logic (really out-of-bounds detection)
 505
 506 void FGLGear::CrashDetect(void)
 507 {
 508   if ( (compressLength > 500.0 ||
 509       vForce.Magnitude() > 100000000.0 ||
 510       vMoment.Magnitude() > 5000000000.0 ||
 511       SinkRate > 1.4666*30 ) && !State->IntegrationSuspended())
 512   {
 513     PutMessage("Crash Detected: Simulation FREEZE.");
 514     State->SuspendIntegration();
 515   }
 516 }
 517
 518 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 519 // The following needs work regarding friction coefficients and braking and
 520 // steering The BrakeFCoeff formula assumes that an anti-skid system is used.
 521 // It also assumes that we won't be turning and braking at the same time.
 522 // Will fix this later.
 523 // [JSB] The braking force coefficients include normal rolling coefficient +
 524 // a percentage of the static friction coefficient based on braking applied.
 525
 526 void FGLGear::ComputeBrakeForceCoefficient(void)
 527 {
 528   switch (eBrakeGrp) {
 529   case bgLeft:
 530     BrakeFCoeff =  ( rollingFCoeff*(1.0 - FCS->GetBrake(bgLeft)) +
 531                      staticFCoeff*FCS->GetBrake(bgLeft) );
 532     break;
 533   case bgRight:
 534     BrakeFCoeff =  ( rollingFCoeff*(1.0 - FCS->GetBrake(bgRight)) +
 535                      staticFCoeff*FCS->GetBrake(bgRight) );
 536     break;
 537   case bgCenter:
 538     BrakeFCoeff =  ( rollingFCoeff*(1.0 - FCS->GetBrake(bgCenter)) +
 539                      staticFCoeff*FCS->GetBrake(bgCenter) );
 540     break;
 541   case bgNose:
 542     BrakeFCoeff =  ( rollingFCoeff*(1.0 - FCS->GetBrake(bgCenter)) +
 543                      staticFCoeff*FCS->GetBrake(bgCenter) );
 544     break;
 545   case bgTail:
 546     BrakeFCoeff =  ( rollingFCoeff*(1.0 - FCS->GetBrake(bgCenter)) +
 547                      staticFCoeff*FCS->GetBrake(bgCenter) );
 548     break;
 549   case bgNone:
 550     BrakeFCoeff =  rollingFCoeff;
 551     break;
 552   default:
 553     cerr << "Improper brake group membership detected for this gear." << endl;
 554     break;
 555   }
 556 }
 557
 558 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 559 // Compute the sideforce coefficients using Pacejka's Magic Formula.
 560 //
 561 //   y(x) = D sin {C arctan [Bx - E(Bx - arctan Bx)]}
 562 //
 563 // Where: B = Stiffness Factor (0.06, here)
 564 //        C = Shape Factor (2.8, here)
 565 //        D = Peak Factor (0.8, here)
 566 //        E = Curvature Factor (1.03, here)
 567
 568 void FGLGear::ComputeSideForceCoefficient(void)
 569 {
 570   if (ForceY_Table) {
 571     FCoeff = ForceY_Table->GetValue(WheelSlip);
 572   } else {
 573     double StiffSlip = Stiffness*WheelSlip;
 574     FCoeff = Peak * sin(Shape*atan(StiffSlip - Curvature*(StiffSlip - atan(StiffSlip))));
 575   }
 576 }
 577
 578 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 579 // Compute the vertical force on the wheel using square-law damping (per comment
 580 // in paper AIAA-2000-4303 - see header prologue comments). We might consider
 581 // allowing for both square and linear damping force calculation. Also need to
 582 // possibly give a "rebound damping factor" that differs from the compression
 583 // case.
 584
 585 void FGLGear::ComputeVerticalStrutForce(void)
 586 {
 587   double springForce = 0;
 588   double dampForce = 0;
 589
 590   springForce = -compressLength * kSpring;
 591
 592   if (compressSpeed >= 0.0) {
 593
 594     if (eDampType == dtLinear)   dampForce = -compressSpeed * bDamp;
 595     else         dampForce = -compressSpeed * compressSpeed * bDamp;
 596
 597   } else {
 598
 599     if (eDampTypeRebound == dtLinear)
 600       dampForce   = -compressSpeed * bDampRebound;
 601     else
 602       dampForce   =  compressSpeed * compressSpeed * bDampRebound;
 603
 604   }
 605   vLocalForce(eZ) =  min(springForce + dampForce, (double)0.0);
 606
 607   // Remember these values for reporting
 608   MaximumStrutForce = max(MaximumStrutForce, fabs(vLocalForce(eZ)));
 609   MaximumStrutTravel = max(MaximumStrutTravel, fabs(compressLength));
 610 }
 611
 612 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 613
 614 double FGLGear::GetGearUnitPos(void)
 615 {
 616   // hack to provide backward compatibility to gear/gear-pos-norm property
 617   if( useFCSGearPos || FCS->GetGearPos() != 1.0 ) {
 618     useFCSGearPos = true;
 619     return FCS->GetGearPos();
 620   }
 621   return GearPos;
 622 }
 623
 624 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 625
 626 void FGLGear::bind(void)
 627 {
 628   string property_name;
 629   string base_property_name;
 630   base_property_name = CreateIndexedPropertyName("gear/unit", GearNumber);
 631   if (eContactType == ctBOGEY) {
 632     property_name = base_property_name + "/slip-angle-deg";
 633     Exec->GetPropertyManager()->Tie( property_name.c_str(), &WheelSlip );
 634     property_name = base_property_name + "/WOW";
 635     Exec->GetPropertyManager()->Tie( property_name.c_str(), &WOW );
 636     property_name = base_property_name + "/wheel-speed-fps";
 637     Exec->GetPropertyManager()->Tie( property_name.c_str(), &RollingWhlVel );
 638     property_name = base_property_name + "/z-position";
 639     Exec->GetPropertyManager()->Tie( property_name.c_str(), (FGLGear*)this,
 640                           &FGLGear::GetZPosition, &FGLGear::SetZPosition);
 641     property_name = base_property_name + "/compression-ft";
 642     Exec->GetPropertyManager()->Tie( property_name.c_str(), &compressLength );
 643     property_name = base_property_name + "/side_friction_coeff";
 644     Exec->GetPropertyManager()->Tie( property_name.c_str(), &FCoeff );
 645   }
 646
 647   if( isRetractable ) {
 648     property_name = base_property_name + "/pos-norm";
 649     Exec->GetPropertyManager()->Tie( property_name.c_str(), &GearPos );
 650   }
 651
 652 }
 653
 654 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 655
 656 void FGLGear::Report(ReportType repType)
 657 {
 658   if (fabs(TakeoffDistanceTraveled) < 0.001) return; // Don't print superfluous reports
 659
 660   switch(repType) {
 661   case erLand:
 662     cout << endl << "Touchdown report for " << name << endl;
 663     cout << "  Sink rate at contact:  " << SinkRate                << " fps,    "
 664                                 << SinkRate*0.3048          << " mps"     << endl;
 665     cout << "  Contact ground speed:  " << GroundSpeed*.5925       << " knots,  "
 666                                 << GroundSpeed*0.3048       << " mps"     << endl;
 667     cout << "  Maximum contact force: " << MaximumStrutForce       << " lbs,    "
 668                                 << MaximumStrutForce*4.448  << " Newtons" << endl;
 669     cout << "  Maximum strut travel:  " << MaximumStrutTravel*12.0 << " inches, "
 670                                 << MaximumStrutTravel*30.48 << " cm"      << endl;
 671     cout << "  Distance traveled:     " << LandingDistanceTraveled        << " ft,     "
 672                                 << LandingDistanceTraveled*0.3048  << " meters"  << endl;
 673     LandingReported = true;
 674     break;
 675   case erTakeoff:
 676     cout << endl << "Takeoff report for " << name << endl;
 677     cout << "  Distance traveled:                " << TakeoffDistanceTraveled
 678          << " ft,     " << TakeoffDistanceTraveled*0.3048  << " meters"  << endl;
 679     cout << "  Distance traveled (over 50'):     " << TakeoffDistanceTraveled50ft
 680          << " ft,     " << TakeoffDistanceTraveled50ft*0.3048 << " meters" << endl;
 681     TakeoffReported = true;
 682     break;
 683   }
 684 }
 685
 686 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 687 //    The bitmasked value choices are as follows:
 688 //    unset: In this case (the default) JSBSim would only print
 689 //       out the normally expected messages, essentially echoing
 690 //       the config files as they are read. If the environment
 691 //       variable is not set, debug_lvl is set to 1 internally
 692 //    0: This requests JSBSim not to output any messages
 693 //       whatsoever.
 694 //    1: This value explicity requests the normal JSBSim
 695 //       startup messages
 696 //    2: This value asks for a message to be printed out when
 697 //       a class is instantiated
 698 //    4: When this value is set, a message is displayed when a
 699 //       FGModel object executes its Run() method
 700 //    8: When this value is set, various runtime state variables
 701 //       are printed out periodically
 702 //    16: When set various parameters are sanity checked and
 703 //       a message is printed out when they go out of bounds
 704
 705 void FGLGear::Debug(int from)
 706 {
 707   if (debug_lvl <= 0) return;
 708
 709   if (debug_lvl & 1) { // Standard console startup message output
 710     if (from == 0) { // Constructor - loading and initialization
 711       cout << "    " << sContactType << " " << name          << endl;
 712       cout << "      Location: "         << vXYZ          << endl;
 713       cout << "      Spring Constant:  " << kSpring       << endl;
 714
 715       if (eDampType == dtLinear)
 716         cout << "      Damping Constant: " << bDamp << " (linear)" << endl;
 717       else
 718         cout << "      Damping Constant: " << bDamp << " (square law)" << endl;
 719
 720       if (eDampTypeRebound == dtLinear)
 721         cout << "      Rebound Damping Constant: " << bDampRebound << " (linear)" << endl;
 722       else
 723         cout << "      Rebound Damping Constant: " << bDampRebound << " (square law)" << endl;
 724
 725       cout << "      Dynamic Friction: " << dynamicFCoeff << endl;
 726       cout << "      Static Friction:  " << staticFCoeff  << endl;
 727       if (eContactType == ctBOGEY) {
 728         cout << "      Rolling Friction: " << rollingFCoeff << endl;
 729         cout << "      Steering Type:    " << sSteerType    << endl;
 730         cout << "      Grouping:         " << sBrakeGroup   << endl;
 731         cout << "      Max Steer Angle:  " << maxSteerAngle << endl;
 732         cout << "      Retractable:      " << isRetractable  << endl;
 733         cout << "      Relaxation Velocities:" << endl;
 734         cout << "        Rolling:          " << RFRV << endl;
 735         cout << "        Side:             " << SFRV << endl;
 736       }
 737     }
 738   }
 739   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 740     if (from == 0) cout << "Instantiated: FGLGear" << endl;
 741     if (from == 1) cout << "Destroyed:    FGLGear" << endl;
 742   }
 743   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 744   }
 745   if (debug_lvl & 8 ) { // Runtime state variables
 746   }
 747   if (debug_lvl & 16) { // Sanity checking
 748   }
 749   if (debug_lvl & 64) {
 750     if (from == 0) { // Constructor
 751       cout << IdSrc << endl;
 752       cout << IdHdr << endl;
 753     }
 754   }
 755 }
 756
 757 } // namespace JSBSim
 758