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   delete ForceY_Table;
 264   Debug(1);
 265 }
 266
 267 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 268
 269 FGColumnVector3& FGLGear::Force(void)
 270 {
 271   double t = Exec->GetState()->Getsim_time();
 272   dT = State->Getdt()*Exec->GetGroundReactions()->GetRate();
 273
 274   vForce.InitMatrix();
 275   vMoment.InitMatrix();
 276
 277   if (isRetractable) ComputeRetractionState();
 278
 279   if (GearDown) {
 280
 281     vWhlBodyVec = MassBalance->StructuralToBody(vXYZ); // Get wheel in body frame
 282     vLocalGear = Propagate->GetTb2l() * vWhlBodyVec; // Get local frame wheel location
 283
 284     gearLoc = Propagate->GetLocation().LocalToLocation(vLocalGear);
 285     compressLength = -Exec->GetGroundCallback()->GetAGLevel(t, gearLoc, contact, normal, cvel);
 286
 287     // The compression length is measured in the Z-axis, only, at this time.
 288
 289     if (compressLength > 0.00) {
 290
 291       WOW = true;
 292
 293       // [The next equation should really use the vector to the contact patch of
 294       // the tire including the strut compression and not the original vWhlBodyVec.]
 295
 296       vWhlVelVec      =  Propagate->GetTb2l() * (Propagate->GetPQR() * vWhlBodyVec);
 297       vWhlVelVec     +=  Propagate->GetVel() - cvel;
 298       compressSpeed   =  vWhlVelVec(eZ);
 299
 300       InitializeReporting();
 301       ComputeBrakeForceCoefficient();
 302       ComputeSteeringAngle();
 303       ComputeSlipAngle();
 304       ComputeSideForceCoefficient();
 305       ComputeVerticalStrutForce();
 306
 307       // Compute the forces in the wheel ground plane.
 308
 309       double sign = RollingWhlVel>0?1.0:(RollingWhlVel<0?-1.0:0.0);
 310       RollingForce = ((1.0 - TirePressureNorm) * 30 + vLocalForce(eZ) * BrakeFCoeff) * sign;
 311       SideForce    = vLocalForce(eZ) * FCoeff;
 312
 313       // Transform these forces back to the local reference frame.
 314
 315       vLocalForce(eX) = RollingForce*CosWheel - SideForce*SinWheel;
 316       vLocalForce(eY) = SideForce*CosWheel    + RollingForce*SinWheel;
 317
 318       // Transform the forces back to the body frame and compute the moment.
 319
 320       vForce  = Propagate->GetTl2b() * vLocalForce;
 321
 322       // Lag and attenuate the XY-plane forces dependent on velocity. This code
 323       // uses a lag filter, C/(s + C) where "C" is the filter coefficient. When
 324       // "C" is chosen at the frame rate (in Hz), the jittering is significantly
 325       // reduced. This is because the jitter is present *at* the execution rate.
 326       // If a coefficient is set to something equal to or less than zero, the
 327       // filter is bypassed.
 328
 329       if (LongForceLagFilterCoeff > 0) vForce(eX) = LongForceFilter.execute(vForce(eX));
 330       if (LatForceLagFilterCoeff > 0)  vForce(eY) = LatForceFilter.execute(vForce(eY));
 331
 332       if ((fabs(RollingWhlVel) <= RFRV) && RFRV > 0) vForce(eX) *= fabs(RollingWhlVel)/RFRV;
 333       if ((fabs(SideWhlVel) <= SFRV) && SFRV > 0) vForce(eY) *= fabs(SideWhlVel)/SFRV;
 334
 335       // End section for attentuating gear jitter
 336
 337       vMoment = vWhlBodyVec * vForce;
 338
 339     } else { // Gear is NOT compressed
 340
 341       WOW = false;
 342       compressLength = 0.0;
 343
 344       // No wheel conditons
 345       RollingWhlVel = SideWhlVel = WheelSlip = 0.0;
 346
 347       // Return to neutral position between 1.0 and 0.8 gear pos.
 348       SteerAngle *= max(GetGearUnitPos()-0.8, 0.0)/0.2;
 349
 350       ResetReporting();
 351     }
 352   }
 353
 354   ReportTakeoffOrLanding();
 355
 356   // Require both WOW and LastWOW to be true before checking crash conditions
 357   // to allow the WOW flag to be used in terminating a scripted run.
 358   if (WOW && lastWOW) CrashDetect();
 359
 360   lastWOW = WOW;
 361
 362   return vForce;
 363 }
 364
 365 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 366
 367 void FGLGear::ComputeRetractionState(void)
 368 {
 369   double gearPos = GetGearUnitPos();
 370   if (gearPos < 0.01) {
 371     GearUp   = true;
 372     WOW      = false;
 373     GearDown = false;
 374   } else if (gearPos > 0.99) {
 375     GearDown = true;
 376     GearUp   = false;
 377   } else {
 378     GearUp   = false;
 379     GearDown = false;
 380   }
 381 }
 382
 383 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 384
 385 void FGLGear::ComputeSlipAngle(void)
 386 {
 387   // Transform the wheel velocities from the local axis system to the wheel axis system.
 388   RollingWhlVel = vWhlVelVec(eX)*CosWheel + vWhlVelVec(eY)*SinWheel;
 389   SideWhlVel    = vWhlVelVec(eY)*CosWheel - vWhlVelVec(eX)*SinWheel;
 390
 391   // Calculate tire slip angle.
 392   WheelSlip = atan2(SideWhlVel, fabs(RollingWhlVel))*radtodeg;
 393
 394   // Filter the wheel slip angle
 395   if (WheelSlipLagFilterCoeff > 0) WheelSlip = WheelSlipFilter.execute(WheelSlip);
 396 }
 397
 398 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 399 // Compute the steering angle in any case.
 400 // This will also make sure that animations will look right.
 401
 402 void FGLGear::ComputeSteeringAngle(void)
 403 {
 404   double casterLocalFrameAngleRad = 0.0;
 405   double casterAngle = 0.0;
 406
 407   switch (eSteerType) {
 408   case stSteer:
 409     SteerAngle = degtorad * FCS->GetSteerPosDeg(GearNumber);
 410     break;
 411   case stFixed:
 412     SteerAngle = 0.0;
 413     break;
 414   case stCaster:
 415     // This is not correct for castering gear. Should make steer angle parallel
 416     // to the actual velocity vector of the wheel, given aircraft velocity vector
 417     // and omega.
 418     SteerAngle = 0.0;
 419     casterLocalFrameAngleRad = acos(vWhlVelVec(eX)/vWhlVelVec.Magnitude());
 420     casterAngle = casterLocalFrameAngleRad - Propagate->GetEuler(ePsi);
 421     break;
 422   default:
 423     cerr << "Improper steering type membership detected for this gear." << endl;
 424     break;
 425   }
 426
 427   SinWheel      = sin(Propagate->GetEuler(ePsi) + SteerAngle);
 428   CosWheel      = cos(Propagate->GetEuler(ePsi) + SteerAngle);
 429 }
 430
 431 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 432 // Reset reporting functionality after takeoff
 433
 434 void FGLGear::ResetReporting(void)
 435 {
 436   if (Propagate->GetDistanceAGL() > 200.0) {
 437     FirstContact = false;
 438     StartedGroundRun = false;
 439     LandingReported = false;
 440     TakeoffReported = true;
 441     LandingDistanceTraveled = 0.0;
 442     MaximumStrutForce = MaximumStrutTravel = 0.0;
 443   }
 444 }
 445
 446 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 447
 448 void FGLGear::InitializeReporting(void)
 449 {
 450   // If this is the first time the wheel has made contact, remember some values
 451   // for later printout.
 452
 453   if (!FirstContact) {
 454     FirstContact  = true;
 455     SinkRate      =  compressSpeed;
 456     GroundSpeed   =  Propagate->GetVel().Magnitude();
 457     TakeoffReported = false;
 458   }
 459
 460   // If the takeoff run is starting, initialize.
 461
 462   if ((Propagate->GetVel().Magnitude() > 0.1) &&
 463       (FCS->GetBrake(bgLeft) == 0) &&
 464       (FCS->GetBrake(bgRight) == 0) &&
 465       (FCS->GetThrottlePos(0) > 0.90) && !StartedGroundRun)
 466   {
 467     TakeoffDistanceTraveled = 0;
 468     TakeoffDistanceTraveled50ft = 0;
 469     StartedGroundRun = true;
 470   }
 471 }
 472
 473 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 474 // Takeoff and landing reporting functionality
 475
 476 void FGLGear::ReportTakeoffOrLanding(void)
 477 {
 478   double deltaT = State->Getdt()*Exec->GetGroundReactions()->GetRate();
 479
 480   if (FirstContact)
 481     LandingDistanceTraveled += Auxiliary->GetVground()*deltaT;
 482
 483   if (StartedGroundRun) {
 484     TakeoffDistanceTraveled50ft += Auxiliary->GetVground()*deltaT;
 485     if (WOW) TakeoffDistanceTraveled += Auxiliary->GetVground()*deltaT;
 486   }
 487
 488   if ( ReportEnable
 489        && Auxiliary->GetVground() <= 0.05
 490        && !LandingReported
 491        && Exec->GetGroundReactions()->GetWOW())
 492   {
 493     if (debug_lvl > 0) Report(erLand);
 494   }
 495
 496   if ( ReportEnable
 497        && !TakeoffReported
 498        && (Propagate->GetDistanceAGL() - vLocalGear(eZ)) > 50.0
 499        && !Exec->GetGroundReactions()->GetWOW())
 500   {
 501     if (debug_lvl > 0) Report(erTakeoff);
 502   }
 503
 504   if (lastWOW != WOW) PutMessage("GEAR_CONTACT: " + name, WOW);
 505 }
 506
 507 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 508 // Crash detection logic (really out-of-bounds detection)
 509
 510 void FGLGear::CrashDetect(void)
 511 {
 512   if ( (compressLength > 500.0 ||
 513       vForce.Magnitude() > 100000000.0 ||
 514       vMoment.Magnitude() > 5000000000.0 ||
 515       SinkRate > 1.4666*30 ) && !State->IntegrationSuspended())
 516   {
 517     PutMessage("Crash Detected: Simulation FREEZE.");
 518     State->SuspendIntegration();
 519   }
 520 }
 521
 522 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 523 // The following needs work regarding friction coefficients and braking and
 524 // steering The BrakeFCoeff formula assumes that an anti-skid system is used.
 525 // It also assumes that we won't be turning and braking at the same time.
 526 // Will fix this later.
 527 // [JSB] The braking force coefficients include normal rolling coefficient +
 528 // a percentage of the static friction coefficient based on braking applied.
 529
 530 void FGLGear::ComputeBrakeForceCoefficient(void)
 531 {
 532   switch (eBrakeGrp) {
 533   case bgLeft:
 534     BrakeFCoeff =  ( rollingFCoeff*(1.0 - FCS->GetBrake(bgLeft)) +
 535                      staticFCoeff*FCS->GetBrake(bgLeft) );
 536     break;
 537   case bgRight:
 538     BrakeFCoeff =  ( rollingFCoeff*(1.0 - FCS->GetBrake(bgRight)) +
 539                      staticFCoeff*FCS->GetBrake(bgRight) );
 540     break;
 541   case bgCenter:
 542     BrakeFCoeff =  ( rollingFCoeff*(1.0 - FCS->GetBrake(bgCenter)) +
 543                      staticFCoeff*FCS->GetBrake(bgCenter) );
 544     break;
 545   case bgNose:
 546     BrakeFCoeff =  ( rollingFCoeff*(1.0 - FCS->GetBrake(bgCenter)) +
 547                      staticFCoeff*FCS->GetBrake(bgCenter) );
 548     break;
 549   case bgTail:
 550     BrakeFCoeff =  ( rollingFCoeff*(1.0 - FCS->GetBrake(bgCenter)) +
 551                      staticFCoeff*FCS->GetBrake(bgCenter) );
 552     break;
 553   case bgNone:
 554     BrakeFCoeff =  rollingFCoeff;
 555     break;
 556   default:
 557     cerr << "Improper brake group membership detected for this gear." << endl;
 558     break;
 559   }
 560 }
 561
 562 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 563 // Compute the sideforce coefficients using Pacejka's Magic Formula.
 564 //
 565 //   y(x) = D sin {C arctan [Bx - E(Bx - arctan Bx)]}
 566 //
 567 // Where: B = Stiffness Factor (0.06, here)
 568 //        C = Shape Factor (2.8, here)
 569 //        D = Peak Factor (0.8, here)
 570 //        E = Curvature Factor (1.03, here)
 571
 572 void FGLGear::ComputeSideForceCoefficient(void)
 573 {
 574   if (ForceY_Table) {
 575     FCoeff = ForceY_Table->GetValue(WheelSlip);
 576   } else {
 577     double StiffSlip = Stiffness*WheelSlip;
 578     FCoeff = Peak * sin(Shape*atan(StiffSlip - Curvature*(StiffSlip - atan(StiffSlip))));
 579   }
 580 }
 581
 582 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 583 // Compute the vertical force on the wheel using square-law damping (per comment
 584 // in paper AIAA-2000-4303 - see header prologue comments). We might consider
 585 // allowing for both square and linear damping force calculation. Also need to
 586 // possibly give a "rebound damping factor" that differs from the compression
 587 // case.
 588
 589 void FGLGear::ComputeVerticalStrutForce(void)
 590 {
 591   double springForce = 0;
 592   double dampForce = 0;
 593
 594   springForce = -compressLength * kSpring;
 595
 596   if (compressSpeed >= 0.0) {
 597
 598     if (eDampType == dtLinear)   dampForce = -compressSpeed * bDamp;
 599     else         dampForce = -compressSpeed * compressSpeed * bDamp;
 600
 601   } else {
 602
 603     if (eDampTypeRebound == dtLinear)
 604       dampForce   = -compressSpeed * bDampRebound;
 605     else
 606       dampForce   =  compressSpeed * compressSpeed * bDampRebound;
 607
 608   }
 609   vLocalForce(eZ) =  min(springForce + dampForce, (double)0.0);
 610
 611   // Remember these values for reporting
 612   MaximumStrutForce = max(MaximumStrutForce, fabs(vLocalForce(eZ)));
 613   MaximumStrutTravel = max(MaximumStrutTravel, fabs(compressLength));
 614 }
 615
 616 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 617
 618 double FGLGear::GetGearUnitPos(void)
 619 {
 620   // hack to provide backward compatibility to gear/gear-pos-norm property
 621   if( useFCSGearPos || FCS->GetGearPos() != 1.0 ) {
 622     useFCSGearPos = true;
 623     return FCS->GetGearPos();
 624   }
 625   return GearPos;
 626 }
 627
 628 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 629
 630 void FGLGear::bind(void)
 631 {
 632   string property_name;
 633   string base_property_name;
 634   base_property_name = CreateIndexedPropertyName("gear/unit", GearNumber);
 635   if (eContactType == ctBOGEY) {
 636     property_name = base_property_name + "/slip-angle-deg";
 637     Exec->GetPropertyManager()->Tie( property_name.c_str(), &WheelSlip );
 638     property_name = base_property_name + "/WOW";
 639     Exec->GetPropertyManager()->Tie( property_name.c_str(), &WOW );
 640     property_name = base_property_name + "/wheel-speed-fps";
 641     Exec->GetPropertyManager()->Tie( property_name.c_str(), &RollingWhlVel );
 642     property_name = base_property_name + "/z-position";
 643     Exec->GetPropertyManager()->Tie( property_name.c_str(), (FGLGear*)this,
 644                           &FGLGear::GetZPosition, &FGLGear::SetZPosition);
 645     property_name = base_property_name + "/compression-ft";
 646     Exec->GetPropertyManager()->Tie( property_name.c_str(), &compressLength );
 647     property_name = base_property_name + "/side_friction_coeff";
 648     Exec->GetPropertyManager()->Tie( property_name.c_str(), &FCoeff );
 649   }
 650
 651   if( isRetractable ) {
 652     property_name = base_property_name + "/pos-norm";
 653     Exec->GetPropertyManager()->Tie( property_name.c_str(), &GearPos );
 654   }
 655
 656 }
 657
 658 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 659
 660 void FGLGear::Report(ReportType repType)
 661 {
 662   if (fabs(TakeoffDistanceTraveled) < 0.001) return; // Don't print superfluous reports
 663
 664   switch(repType) {
 665   case erLand:
 666     cout << endl << "Touchdown report for " << name << endl;
 667     cout << "  Sink rate at contact:  " << SinkRate                << " fps,    "
 668                                 << SinkRate*0.3048          << " mps"     << endl;
 669     cout << "  Contact ground speed:  " << GroundSpeed*.5925       << " knots,  "
 670                                 << GroundSpeed*0.3048       << " mps"     << endl;
 671     cout << "  Maximum contact force: " << MaximumStrutForce       << " lbs,    "
 672                                 << MaximumStrutForce*4.448  << " Newtons" << endl;
 673     cout << "  Maximum strut travel:  " << MaximumStrutTravel*12.0 << " inches, "
 674                                 << MaximumStrutTravel*30.48 << " cm"      << endl;
 675     cout << "  Distance traveled:     " << LandingDistanceTraveled        << " ft,     "
 676                                 << LandingDistanceTraveled*0.3048  << " meters"  << endl;
 677     LandingReported = true;
 678     break;
 679   case erTakeoff:
 680     cout << endl << "Takeoff report for " << name << endl;
 681     cout << "  Distance traveled:                " << TakeoffDistanceTraveled
 682          << " ft,     " << TakeoffDistanceTraveled*0.3048  << " meters"  << endl;
 683     cout << "  Distance traveled (over 50'):     " << TakeoffDistanceTraveled50ft
 684          << " ft,     " << TakeoffDistanceTraveled50ft*0.3048 << " meters" << endl;
 685     TakeoffReported = true;
 686     break;
 687   }
 688 }
 689
 690 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 691 //    The bitmasked value choices are as follows:
 692 //    unset: In this case (the default) JSBSim would only print
 693 //       out the normally expected messages, essentially echoing
 694 //       the config files as they are read. If the environment
 695 //       variable is not set, debug_lvl is set to 1 internally
 696 //    0: This requests JSBSim not to output any messages
 697 //       whatsoever.
 698 //    1: This value explicity requests the normal JSBSim
 699 //       startup messages
 700 //    2: This value asks for a message to be printed out when
 701 //       a class is instantiated
 702 //    4: When this value is set, a message is displayed when a
 703 //       FGModel object executes its Run() method
 704 //    8: When this value is set, various runtime state variables
 705 //       are printed out periodically
 706 //    16: When set various parameters are sanity checked and
 707 //       a message is printed out when they go out of bounds
 708
 709 void FGLGear::Debug(int from)
 710 {
 711   if (debug_lvl <= 0) return;
 712
 713   if (debug_lvl & 1) { // Standard console startup message output
 714     if (from == 0) { // Constructor - loading and initialization
 715       cout << "    " << sContactType << " " << name          << endl;
 716       cout << "      Location: "         << vXYZ          << endl;
 717       cout << "      Spring Constant:  " << kSpring       << endl;
 718
 719       if (eDampType == dtLinear)
 720         cout << "      Damping Constant: " << bDamp << " (linear)" << endl;
 721       else
 722         cout << "      Damping Constant: " << bDamp << " (square law)" << endl;
 723
 724       if (eDampTypeRebound == dtLinear)
 725         cout << "      Rebound Damping Constant: " << bDampRebound << " (linear)" << endl;
 726       else
 727         cout << "      Rebound Damping Constant: " << bDampRebound << " (square law)" << endl;
 728
 729       cout << "      Dynamic Friction: " << dynamicFCoeff << endl;
 730       cout << "      Static Friction:  " << staticFCoeff  << endl;
 731       if (eContactType == ctBOGEY) {
 732         cout << "      Rolling Friction: " << rollingFCoeff << endl;
 733         cout << "      Steering Type:    " << sSteerType    << endl;
 734         cout << "      Grouping:         " << sBrakeGroup   << endl;
 735         cout << "      Max Steer Angle:  " << maxSteerAngle << endl;
 736         cout << "      Retractable:      " << isRetractable  << endl;
 737         cout << "      Relaxation Velocities:" << endl;
 738         cout << "        Rolling:          " << RFRV << endl;
 739         cout << "        Side:             " << SFRV << endl;
 740       }
 741     }
 742   }
 743   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 744     if (from == 0) cout << "Instantiated: FGLGear" << endl;
 745     if (from == 1) cout << "Destroyed:    FGLGear" << endl;
 746   }
 747   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 748   }
 749   if (debug_lvl & 8 ) { // Runtime state variables
 750   }
 751   if (debug_lvl & 16) { // Sanity checking
 752   }
 753   if (debug_lvl & 64) {
 754     if (from == 0) { // Constructor
 755       cout << IdSrc << endl;
 756       cout << IdHdr << endl;
 757     }
 758   }
 759 }
 760
 761 } // namespace JSBSim
 762