src/FDM/JSBSim/models/FGLGear.h

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Header:       FGLGear.h
   4  Author:       Jon S. Berndt
   5  Date started: 11/18/99
   6
   7  ------------- Copyright (C) 1999  Jon S. Berndt (jon@jsbsim.org) -------------
   8
   9  This program is free software; you can redistribute it and/or modify it under
  10  the terms of the GNU Lesser General Public License as published by the Free Software
  11  Foundation; either version 2 of the License, or (at your option) any later
  12  version.
  13
  14  This program is distributed in the hope that it will be useful, but WITHOUT
  15  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
  17  details.
  18
  19  You should have received a copy of the GNU Lesser General Public License along with
  20  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  21  Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23  Further information about the GNU Lesser General Public License can also be found on
  24  the world wide web at http://www.gnu.org.
  25
  26 HISTORY
  27 --------------------------------------------------------------------------------
  28 11/18/99   JSB   Created
  29
  30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  31 SENTRY
  32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  33
  34 #ifndef FGLGEAR_H
  35 #define FGLGEAR_H
  36
  37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #include "models/propulsion/FGForce.h"
  42 #include "math/FGColumnVector3.h"
  43 #include <string>
  44
  45 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  46 DEFINITIONS
  47 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  48
  49 #define ID_LGEAR "$Id$"
  50
  51 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  52 FORWARD DECLARATIONS
  53 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  54
  55 namespace JSBSim {
  56
  57 class FGAircraft;
  58 class FGPropagate;
  59 class FGFCS;
  60 class FGState;
  61 class FGMassBalance;
  62 class FGAuxiliary;
  63 class FGTable;
  64 class Element;
  65
  66 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  67 CLASS DOCUMENTATION
  68 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  69
  70 /** Landing gear model.
  71     Calculates forces and moments due to landing gear reactions. This is done in
  72     several steps, and is dependent on what kind of gear is being modeled. Here
  73     are the parameters that can be specified in the config file for modeling
  74     landing gear:
  75     <p>
  76     <h3>Physical Characteristics</h3>
  77     <ol>
  78     <li>X, Y, Z location, in inches in structural coordinate frame</li>
  79     <li>Spring constant, in lbs/ft</li>
  80     <li>Damping coefficient, in lbs/ft/sec</li>
  81     <li>Dynamic Friction Coefficient</li>
  82     <li>Static Friction Coefficient</li>
  83     </ol></p><p>
  84     <h3>Operational Properties</h3>
  85     <ol>
  86     <li>Name</li>
  87     <li>Steerability attribute {one of STEERABLE | FIXED | CASTERED}</li>
  88     <li>Brake Group Membership {one of LEFT | CENTER | RIGHT | NOSE | TAIL | NONE}</li>
  89     <li>Max Steer Angle, in degrees</li>
  90     </ol></p>
  91     <p>
  92     <h3>Algorithm and Approach to Modeling</h3>
  93     <ol>
  94     <li>Find the location of the uncompressed landing gear relative to the CG of
  95     the aircraft. Remember, the structural coordinate frame that the aircraft is
  96     defined in is: X positive towards the tail, Y positive out the right side, Z
  97     positive upwards. The locations of the various parts are given in inches in
  98     the config file.</li>
  99     <li>The vector giving the location of the gear (relative to the cg) is
 100     rotated 180 degrees about the Y axis to put the coordinates in body frame (X
 101     positive forwards, Y positive out the right side, Z positive downwards, with
 102     the origin at the cg). The lengths are also now given in feet.</li>
 103     <li>The new gear location is now transformed to the local coordinate frame
 104     using the body-to-local matrix. (Mb2l).</li>
 105     <li>Knowing the location of the center of gravity relative to the ground
 106     (height above ground level or AGL) now enables gear deflection to be
 107     calculated. The gear compression value is the local frame gear Z location
 108     value minus the height AGL. [Currently, we make the assumption that the gear
 109     is oriented - and the deflection occurs in - the Z axis only. Additionally,
 110     the vector to the landing gear is currently not modified - which would
 111     (correctly) move the point of contact to the actual compressed-gear point of
 112     contact. Eventually, articulated gear may be modeled, but initially an
 113     effort must be made to model a generic system.] As an example, say the
 114     aircraft left main gear location (in local coordinates) is Z = 3 feet
 115     (positive) and the height AGL is 2 feet. This tells us that the gear is
 116     compressed 1 foot.</li>
 117     <li>If the gear is compressed, a Weight-On-Wheels (WOW) flag is set.</li>
 118     <li>With the compression length calculated, the compression velocity may now
 119     be calculated. This will be used to determine the damping force in the
 120     strut. The aircraft rotational rate is multiplied by the vector to the wheel
 121     to get a wheel velocity in body frame. That velocity vector is then
 122     transformed into the local coordinate frame.</li>
 123     <li>The aircraft cg velocity in the local frame is added to the
 124     just-calculated wheel velocity (due to rotation) to get a total wheel
 125     velocity in the local frame.</li>
 126     <li>The compression speed is the Z-component of the vector.</li>
 127     <li>With the wheel velocity vector no longer needed, it is normalized and
 128     multiplied by a -1 to reverse it. This will be used in the friction force
 129     calculation.</li>
 130     <li>Since the friction force takes place solely in the runway plane, the Z
 131     coordinate of the normalized wheel velocity vector is set to zero.</li>
 132     <li>The gear deflection force (the force on the aircraft acting along the
 133     local frame Z axis) is now calculated given the spring and damper
 134     coefficients, and the gear deflection speed and stroke length. Keep in mind
 135     that gear forces always act in the negative direction (in both local and
 136     body frames), and are not capable of generating a force in the positive
 137     sense (one that would attract the aircraft to the ground). So, the gear
 138     forces are always negative - they are limited to values of zero or less. The
 139     gear force is simply the negative of the sum of the spring compression
 140     length times the spring coefficient and the gear velocity times the damping
 141     coefficient.</li>
 142     <li>The lateral/directional force acting on the aircraft through the landing
 143
 144     gear (along the local frame X and Y axes) is calculated next. First, the
 145     friction coefficient is multiplied by the recently calculated Z-force. This
 146     is the friction force. It must be given direction in addition to magnitude.
 147     We want the components in the local frame X and Y axes. From step 9, above,
 148     the conditioned wheel velocity vector is taken and the X and Y parts are
 149     multiplied by the friction force to get the X and Y components of friction.
 150     </li>
 151     <li>The wheel force in local frame is next converted to body frame.</li>
 152     <li>The moment due to the gear force is calculated by multiplying r x F
 153     (radius to wheel crossed into the wheel force). Both of these operands are
 154     in body frame.</li>
 155     </ol>
 156
 157     <h3>Configuration File Format:</h3>
 158 @code
 159         <contact type="{BOGEY | STRUCTURE}" name="{string}">
 160             <location unit="{IN | M}">
 161                 <x> {number} </x>
 162                 <y> {number} </y>
 163                 <z> {number} </z>
 164             </location>
 165             <static_friction> {number} </static_friction>
 166             <dynamic_friction> {number} </dynamic_friction>
 167             <rolling_friction> {number} </rolling_friction>
 168             <spring_coeff unit="{LBS/FT | N/M}"> {number} </spring_coeff>
 169             <damping_coeff unit="{LBS/FT/SEC | N/M/SEC}"> {number} </damping_coeff>
 170             <damping_coeff_rebound unit="{LBS/FT/SEC | N/M/SEC}"> {number} </damping_coeff_rebound>
 171             <max_steer unit="DEG"> {number | 0 | 360} </max_steer>
 172             <brake_group> {NONE | LEFT | RIGHT | CENTER | NOSE | TAIL} </brake_group>
 173             <retractable>{0 | 1}</retractable>
 174             <table type="{CORNERING_COEFF}">
 175             </table>
 176             <relaxation_velocity>
 177                <rolling unit="{FT/SEC | KTS | M/S}"> {number} </rolling>
 178                <side unit="{FT/SEC | KTS | M/S}"> {number} </side>
 179             </relaxation_velocity>
 180             <force_lag_filter>
 181                <rolling> {number} </rolling>
 182                <side> {number} </side>
 183             </force_lag_filter>
 184             <wheel_slip_filter> {number} </wheel_slip_filter>
 185         </contact>
 186 @endcode
 187     @author Jon S. Berndt
 188     @version $Id$
 189     @see Richard E. McFarland, "A Standard Kinematic Model for Flight Simulation at
 190      NASA-Ames", NASA CR-2497, January 1975
 191     @see Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics",
 192      Wiley & Sons, 1979 ISBN 0-471-03032-5
 193     @see W. A. Ragsdale, "A Generic Landing Gear Dynamics Model for LASRS++",
 194      AIAA-2000-4303
 195 */
 196
 197 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 198 CLASS DECLARATION
 199 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 200
 201 class FGLGear : public FGForce
 202 {
 203 public:
 204   /// Brake grouping enumerators
 205   enum BrakeGroup {bgNone=0, bgLeft, bgRight, bgCenter, bgNose, bgTail };
 206   /// Steering group membership enumerators
 207   enum SteerType {stSteer, stFixed, stCaster};
 208   /// Contact point type
 209   enum ContactType {ctBOGEY, ctSTRUCTURE};
 210   /// Report type enumerators
 211   enum ReportType {erNone=0, erTakeoff, erLand};
 212   /// Damping types
 213   enum DampType {dtLinear=0, dtSquare};
 214   /** Constructor
 215       @param el a pointer to the XML element that contains the CONTACT info.
 216       @param Executive a pointer to the parent executive object
 217       @param number integer identifier for this instance of FGLGear
 218   */
 219   FGLGear(Element* el, FGFDMExec* Executive, int number);
 220   /// Destructor
 221   ~FGLGear();
 222
 223   /// The Force vector for this gear
 224   FGColumnVector3& GetBodyForces(void);
 225
 226   /// Gets the location of the gear in Body axes
 227   FGColumnVector3& GetBodyLocation(void) { return vWhlBodyVec; }
 228   double GetBodyLocation(int idx) const { return vWhlBodyVec(idx); }
 229
 230   FGColumnVector3& GetLocalGear(void) { return vLocalGear; }
 231   double GetLocalGear(int idx) const { return vLocalGear(idx); }
 232
 233   /// Gets the name of the gear
 234   string GetName(void) const {return name;          }
 235   /// Gets the Weight On Wheels flag value
 236   bool   GetWOW(void) const {return WOW;           }
 237   /// Gets the current compressed length of the gear in feet
 238   double  GetCompLen(void) const {return compressLength;}
 239   /// Gets the current gear compression velocity in ft/sec
 240   double  GetCompVel(void) const {return compressSpeed; }
 241   /// Gets the gear compression force in pounds
 242   double  GetCompForce(void) const {return StrutForce;   }
 243   double  GetBrakeFCoeff(void) const {return BrakeFCoeff;}
 244
 245   /// Gets the current normalized tire pressure
 246   double  GetTirePressure(void) const { return TirePressureNorm; }
 247   /// Sets the new normalized tire pressure
 248   void    SetTirePressure(double p) { TirePressureNorm = p; }
 249
 250   /// Sets the brake value in percent (0 - 100)
 251   void SetBrake(double bp) {brakePct = bp;}
 252
 253   /// Sets the weight-on-wheels flag.
 254   void SetWOW(bool wow) {WOW = wow;}
 255
 256   /** Set the console touchdown reporting feature
 257       @param flag true turns on touchdown reporting, false turns it off */
 258   void SetReport(bool flag) { ReportEnable = flag; }
 259   /** Get the console touchdown reporting feature
 260       @return true if reporting is turned on */
 261   bool GetReport(void) const  { return ReportEnable; }
 262   double GetSteerNorm(void) const    { return radtodeg/maxSteerAngle*SteerAngle; }
 263   double GetDefaultSteerAngle(double cmd) const { return cmd*maxSteerAngle; }
 264   double GetstaticFCoeff(void) const { return staticFCoeff; }
 265
 266   int GetBrakeGroup(void) const { return (int)eBrakeGrp; }
 267   int GetSteerType(void) const  { return (int)eSteerType; }
 268
 269   bool GetSteerable(void) const        { return eSteerType != stFixed; }
 270   bool GetRetractable(void) const      { return isRetractable;   }
 271   bool GetGearUnitUp(void) const       { return GearUp;          }
 272   bool GetGearUnitDown(void) const     { return GearDown;        }
 273   double GetWheelRollForce(void) {
 274     FGColumnVector3 vForce = mTGear.Transposed() * FGForce::GetBodyForces();
 275     return vForce(eX)*cos(SteerAngle) + vForce(eY)*sin(SteerAngle); }
 276   double GetWheelSideForce(void) {
 277     FGColumnVector3 vForce = mTGear.Transposed() * FGForce::GetBodyForces();
 278     return vForce(eY)*cos(SteerAngle) - vForce(eX)*sin(SteerAngle); }
 279   double GetWheelRollVel(void) const   { return vWhlVelVec(eX)*cos(SteerAngle)
 280                                               + vWhlVelVec(eY)*sin(SteerAngle);  }
 281   double GetWheelSideVel(void) const   { return vWhlVelVec(eY)*cos(SteerAngle)
 282                                               - vWhlVelVec(eX)*sin(SteerAngle);  }
 283   double GetWheelSlipAngle(void) const { return WheelSlip;       }
 284   double GetWheelVel(int axis) const   { return vWhlVelVec(axis);}
 285   bool IsBogey(void) const             { return (eContactType == ctBOGEY);}
 286   double GetGearUnitPos(void);
 287
 288   void bind(void);
 289
 290 private:
 291   int GearNumber;
 292   static const FGMatrix33 Tb2s;
 293   FGMatrix33 mTGear;
 294   FGColumnVector3 vGearOrient;
 295   FGColumnVector3 vWhlBodyVec;
 296   FGColumnVector3 vLocalGear;
 297   FGColumnVector3 vWhlVelVec, vLocalWhlVel;     // Velocity of this wheel
 298   FGColumnVector3 normal, cvel, vGroundNormal;
 299   FGLocation contact, gearLoc;
 300   FGTable *ForceY_Table;
 301   double dT;
 302   double SteerAngle;
 303   double kSpring;
 304   double bDamp;
 305   double bDampRebound;
 306   double compressLength;
 307   double compressSpeed;
 308   double staticFCoeff, dynamicFCoeff, rollingFCoeff;
 309   double Stiffness, Shape, Peak, Curvature; // Pacejka factors
 310   double brakePct;
 311   double BrakeFCoeff;
 312   double maxCompLen;
 313   double SinkRate;
 314   double GroundSpeed;
 315   double TakeoffDistanceTraveled;
 316   double TakeoffDistanceTraveled50ft;
 317   double LandingDistanceTraveled;
 318   double MaximumStrutForce, StrutForce;
 319   double MaximumStrutTravel;
 320   double FCoeff;
 321   double WheelSlip;
 322   double TirePressureNorm;
 323   double GearPos;
 324   bool   useFCSGearPos;
 325   bool WOW;
 326   bool lastWOW;
 327   bool FirstContact;
 328   bool StartedGroundRun;
 329   bool LandingReported;
 330   bool TakeoffReported;
 331   bool ReportEnable;
 332   bool isRetractable;
 333   bool GearUp, GearDown;
 334   bool Servicable;
 335   std::string name;
 336   std::string sSteerType;
 337   std::string sBrakeGroup;
 338   std::string sRetractable;
 339   std::string sContactType;
 340
 341   BrakeGroup  eBrakeGrp;
 342   ContactType eContactType;
 343   SteerType   eSteerType;
 344   DampType    eDampType;
 345   DampType    eDampTypeRebound;
 346   double  maxSteerAngle;
 347   double RFRV;  // Rolling force relaxation velocity
 348   double SFRV;  // Side force relaxation velocity
 349   double LongForceLagFilterCoeff; // Longitudinal Force Lag Filter Coefficient
 350   double LatForceLagFilterCoeff; // Lateral Force Lag Filter Coefficient
 351   double WheelSlipLagFilterCoeff; // Wheel slip angle lag filter coefficient
 352
 353   Filter LongForceFilter;
 354   Filter LatForceFilter;
 355   Filter WheelSlipFilter;
 356
 357   FGState*       State;
 358   FGAircraft*    Aircraft;
 359   FGPropagate*   Propagate;
 360   FGAuxiliary*   Auxiliary;
 361   FGFCS*         FCS;
 362   FGMassBalance* MassBalance;
 363
 364   void ComputeRetractionState(void);
 365   void ComputeBrakeForceCoefficient(void);
 366   void ComputeSteeringAngle(void);
 367   void ComputeSlipAngle(void);
 368   void ComputeSideForceCoefficient(void);
 369   void ComputeVerticalStrutForce(void);
 370   void ComputeGroundCoordSys(void);
 371   void CrashDetect(void);
 372   void InitializeReporting(void);
 373   void ResetReporting(void);
 374   void ReportTakeoffOrLanding(void);
 375   void Report(ReportType rt);
 376   void Debug(int from);
 377 };
 378 }
 379
 380 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 381
 382 #endif