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 (jsb@hal-pc.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 #ifdef FGFS
  42 #  include <simgear/compiler.h>
  43 #endif
  44
  45 #include <FGJSBBase.h>
  46 #include <FGFDMExec.h>
  47 #include <input_output/FGXMLElement.h>
  48 #include <math/FGColumnVector3.h>
  49 #include <math/FGTable.h>
  50 #include <string>
  51
  52 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  53 DEFINITIONS
  54 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  55
  56 #define ID_LGEAR "$Id$"
  57
  58 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  59 FORWARD DECLARATIONS
  60 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  61
  62 namespace JSBSim {
  63
  64 class FGAircraft;
  65 class FGPropagate;
  66 class FGFCS;
  67 class FGState;
  68 class FGMassBalance;
  69 class FGAuxiliary;
  70
  71 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  72 CLASS DOCUMENTATION
  73 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  74
  75 /** Landing gear model.
  76     Calculates forces and moments due to landing gear reactions. This is done in
  77     several steps, and is dependent on what kind of gear is being modeled. Here
  78     are the parameters that can be specified in the config file for modeling
  79     landing gear:
  80     <p>
  81     <b><u>Physical Characteristics</u></b><br>
  82     <ol>
  83     <li>X, Y, Z location, in inches in structural coordinate frame</li>
  84     <li>Spring constant, in lbs/ft</li>
  85     <li>Damping coefficient, in lbs/ft/sec</li>
  86     <li>Dynamic Friction Coefficient</li>
  87     <li>Static Friction Coefficient</li>
  88     </ol></p><p>
  89     <b><u>Operational Properties</b></u><br>
  90     <ol>
  91     <li>Name</li>
  92     <li>Steerability attribute {one of STEERABLE | FIXED | CASTERED}</li>
  93     <li>Brake Group Membership {one of LEFT | CENTER | RIGHT | NOSE | TAIL | NONE}</li>
  94     <li>Max Steer Angle, in degrees</li>
  95     </ol></p>
  96     <p>
  97     <b><u>Algorithm and Approach to Modeling</u></b><br>
  98     <ol>
  99     <li>Find the location of the uncompressed landing gear relative to the CG of
 100     the aircraft. Remember, the structural coordinate frame that the aircraft is
 101     defined in is: X positive towards the tail, Y positive out the right side, Z
 102     positive upwards. The locations of the various parts are given in inches in
 103     the config file.</li>
 104     <li>The vector giving the location of the gear (relative to the cg) is
 105     rotated 180 degrees about the Y axis to put the coordinates in body frame (X
 106     positive forwards, Y positive out the right side, Z positive downwards, with
 107     the origin at the cg). The lengths are also now given in feet.</li>
 108     <li>The new gear location is now transformed to the local coordinate frame
 109     using the body-to-local matrix. (Mb2l).</li>
 110     <li>Knowing the location of the center of gravity relative to the ground
 111     (height above ground level or AGL) now enables gear deflection to be
 112     calculated. The gear compression value is the local frame gear Z location
 113     value minus the height AGL. [Currently, we make the assumption that the gear
 114     is oriented - and the deflection occurs in - the Z axis only. Additionally,
 115     the vector to the landing gear is currently not modified - which would
 116     (correctly) move the point of contact to the actual compressed-gear point of
 117     contact. Eventually, articulated gear may be modeled, but initially an
 118     effort must be made to model a generic system.] As an example, say the
 119     aircraft left main gear location (in local coordinates) is Z = 3 feet
 120     (positive) and the height AGL is 2 feet. This tells us that the gear is
 121     compressed 1 foot.</li>
 122     <li>If the gear is compressed, a Weight-On-Wheels (WOW) flag is set.</li>
 123     <li>With the compression length calculated, the compression velocity may now
 124     be calculated. This will be used to determine the damping force in the
 125     strut. The aircraft rotational rate is multiplied by the vector to the wheel
 126     to get a wheel velocity in body frame. That velocity vector is then
 127     transformed into the local coordinate frame.</li>
 128     <li>The aircraft cg velocity in the local frame is added to the
 129     just-calculated wheel velocity (due to rotation) to get a total wheel
 130     velocity in the local frame.</li>
 131     <li>The compression speed is the Z-component of the vector.</li>
 132     <li>With the wheel velocity vector no longer needed, it is normalized and
 133     multiplied by a -1 to reverse it. This will be used in the friction force
 134     calculation.</li>
 135     <li>Since the friction force takes place solely in the runway plane, the Z
 136     coordinate of the normalized wheel velocity vector is set to zero.</li>
 137     <li>The gear deflection force (the force on the aircraft acting along the
 138     local frame Z axis) is now calculated given the spring and damper
 139     coefficients, and the gear deflection speed and stroke length. Keep in mind
 140     that gear forces always act in the negative direction (in both local and
 141     body frames), and are not capable of generating a force in the positive
 142     sense (one that would attract the aircraft to the ground). So, the gear
 143     forces are always negative - they are limited to values of zero or less. The
 144     gear force is simply the negative of the sum of the spring compression
 145     length times the spring coefficient and the gear velocity times the damping
 146     coefficient.</li>
 147     <li>The lateral/directional force acting on the aircraft through the landing
 148
 149     gear (along the local frame X and Y axes) is calculated next. First, the
 150     friction coefficient is multiplied by the recently calculated Z-force. This
 151     is the friction force. It must be given direction in addition to magnitude.
 152     We want the components in the local frame X and Y axes. From step 9, above,
 153     the conditioned wheel velocity vector is taken and the X and Y parts are
 154     multiplied by the friction force to get the X and Y components of friction.
 155     </li>
 156     <li>The wheel force in local frame is next converted to body frame.</li>
 157     <li>The moment due to the gear force is calculated by multiplying r x F
 158     (radius to wheel crossed into the wheel force). Both of these operands are
 159     in body frame.</li>
 160     </ol>
 161     @author Jon S. Berndt
 162     @version $Id$
 163     @see Richard E. McFarland, "A Standard Kinematic Model for Flight Simulation at
 164      NASA-Ames", NASA CR-2497, January 1975
 165     @see Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics",
 166      Wiley & Sons, 1979 ISBN 0-471-03032-5
 167     @see W. A. Ragsdale, "A Generic Landing Gear Dynamics Model for LASRS++",
 168      AIAA-2000-4303
 169 */
 170
 171 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 172 CLASS DECLARATION
 173 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 174
 175 class FGLGear : public FGJSBBase
 176 {
 177 public:
 178   /// Brake grouping enumerators
 179   enum BrakeGroup {bgNone=0, bgLeft, bgRight, bgCenter, bgNose, bgTail };
 180   /// Steering group membership enumerators
 181   enum SteerType {stSteer, stFixed, stCaster};
 182   /// Report type enumerators
 183   enum ReportType {erNone=0, erTakeoff, erLand};
 184   /** Constructor
 185       @param el a pointer to the XML element that contains the CONTACT info.
 186       @param Executive a pointer to the parent executive object
 187       @param File a pointer to the config file instance */
 188   FGLGear(Element* el, FGFDMExec* Executive, int number);
 189   /** Constructor
 190       @param lgear a reference to an existing FGLGear object     */
 191   FGLGear(const FGLGear& lgear);
 192   /// Destructor
 193   ~FGLGear();
 194
 195
 196   /// The Force vector for this gear
 197   FGColumnVector3& Force(void);
 198   /// The Moment vector for this gear
 199   FGColumnVector3& Moment(void) {return vMoment;}
 200
 201   /// Gets the location of the gear in Body axes
 202   FGColumnVector3& GetBodyLocation(void) { return vWhlBodyVec; }
 203   double GetBodyLocation(int idx) { return vWhlBodyVec(idx); }
 204
 205   FGColumnVector3& GetLocalGear(void) { return vLocalGear; }
 206   double GetLocalGear(int idx) { return vLocalGear(idx); }
 207
 208   /// Gets the name of the gear
 209   inline string GetName(void)      {return name;          }
 210   /// Gets the Weight On Wheels flag value
 211   inline bool   GetWOW(void)       {return WOW;           }
 212   /// Gets the current compressed length of the gear in feet
 213   inline double  GetCompLen(void)   {return compressLength;}
 214   /// Gets the current gear compression velocity in ft/sec
 215   inline double  GetCompVel(void)   {return compressSpeed; }
 216   /// Gets the gear compression force in pounds
 217   inline double  GetCompForce(void) {return Force()(3);    }
 218   inline double  GetBrakeFCoeff(void) {return BrakeFCoeff;}
 219
 220   /// Gets the current normalized tire pressure
 221   inline double  GetTirePressure(void) { return TirePressureNorm; }
 222   /// Sets the new normalized tire pressure
 223   inline void    SetTirePressure(double p) { TirePressureNorm = p; }
 224
 225   /// Sets the brake value in percent (0 - 100)
 226   inline void SetBrake(double bp) {brakePct = bp;}
 227
 228   /** Set the console touchdown reporting feature
 229       @param flag true turns on touchdown reporting, false turns it off */
 230   inline void SetReport(bool flag) { ReportEnable = flag; }
 231   /** Get the console touchdown reporting feature
 232       @return true if reporting is turned on */
 233   inline bool GetReport(void)    { return ReportEnable; }
 234   double GetSteerNorm(void) const { return radtodeg/maxSteerAngle*SteerAngle; }
 235   double GetDefaultSteerAngle(double cmd) const { return cmd*maxSteerAngle; }
 236   double GetstaticFCoeff(void) { return staticFCoeff; }
 237
 238   inline int GetBrakeGroup(void) { return (int)eBrakeGrp; }
 239   inline int GetSteerType(void)  { return (int)eSteerType; }
 240
 241   bool GetSteerable(void) const { return eSteerType != stFixed; }
 242   inline bool GetRetractable(void)         { return isRetractable;   }
 243   inline bool GetGearUnitUp(void)          { return GearUp;          }
 244   inline bool GetGearUnitDown(void)        { return GearDown;        }
 245   inline double GetWheelSideForce(void)    { return SideForce;       }
 246   inline double GetWheelRollForce(void)    { return RollingForce;    }
 247   inline double GetWheelSideVel(void)      { return SideWhlVel;      }
 248   inline double GetWheelRollVel(void)      { return RollingWhlVel;   }
 249   inline double GetBodyXForce(void)        { return vLocalForce(eX); }
 250   inline double GetBodyYForce(void)        { return vLocalForce(eY); }
 251   inline double GetWheelSlipAngle(void)    { return WheelSlip;       }
 252   double GetWheelVel(int axis)             { return vWhlVelVec(axis);}
 253
 254   bool IsBogey(void) {return (sContactType == string("BOGEY"));}
 255
 256   void bind(void);
 257   void unbind(void);
 258
 259 private:
 260   int GearNumber;
 261   FGColumnVector3 vXYZ;
 262   FGColumnVector3 vMoment;
 263   FGColumnVector3 vWhlBodyVec;
 264   FGColumnVector3 vLocalGear;
 265   FGColumnVector3 vForce;
 266   FGColumnVector3 last_vForce; // remove this
 267   FGColumnVector3 vLocalForce;
 268   FGColumnVector3 vWhlVelVec;     // Velocity of this wheel (Local)
 269   FGColumnVector3 prevOut, prevIn;
 270   FGTable *ForceY_Table;
 271   double dT;
 272   double SteerAngle;
 273   double kSpring;
 274   double bDamp;
 275   double bDampRebound;
 276   double compressLength;
 277   double compressSpeed;
 278   double staticFCoeff, dynamicFCoeff, rollingFCoeff;
 279   double brakePct;
 280   double BrakeFCoeff;
 281   double maxCompLen;
 282   double SinkRate;
 283   double GroundSpeed;
 284   double TakeoffDistanceTraveled;
 285   double TakeoffDistanceTraveled50ft;
 286   double LandingDistanceTraveled;
 287   double MaximumStrutForce;
 288   double MaximumStrutTravel;
 289   double SideWhlVel, RollingWhlVel;
 290   double RollingForce, SideForce, FCoeff;
 291   double WheelSlip;
 292   double prevSlipIn;
 293   double prevSlipOut;
 294   double TirePressureNorm;
 295   double SinWheel, CosWheel;
 296   bool WOW;
 297   bool lastWOW;
 298   bool FirstContact;
 299   bool StartedGroundRun;
 300   bool LandingReported;
 301   bool TakeoffReported;
 302   bool ReportEnable;
 303   bool isRetractable;
 304   bool GearUp, GearDown;
 305   bool Servicable;
 306   string name;
 307   string sSteerType;
 308   string sBrakeGroup;
 309   string sRetractable;
 310   string sContactType;
 311
 312   BrakeGroup eBrakeGrp;
 313   SteerType  eSteerType;
 314   double  maxSteerAngle;
 315   double RFRV;  // Rolling force relaxation velocity
 316   double SFRV;  // Side force relaxation velocity
 317   double LongForceLagFilterCoeff; // Longitudinal Force Lag Filter Coefficient
 318   double LatForceLagFilterCoeff; // Lateral Force Lag Filter Coefficient
 319   double WheelSlipLagFilterCoeff; // Wheel slip angle lag filter coefficient
 320
 321   FGFDMExec*     Exec;
 322   FGState*       State;
 323   FGAircraft*    Aircraft;
 324   FGPropagate*   Propagate;
 325   FGAuxiliary*   Auxiliary;
 326   FGFCS*         FCS;
 327   FGMassBalance* MassBalance;
 328
 329   void ComputeRetractionState(void);
 330   void ComputeBrakeForceCoefficient(void);
 331   void ComputeSteeringAngle(void);
 332   void ComputeSlipAngle(void);
 333   void ComputeSideForceCoefficient(void);
 334   void ComputeVerticalStrutForce(void);
 335   void CrashDetect(void);
 336   void InitializeReporting(void);
 337   void ResetReporting(void);
 338   void ReportTakeoffOrLanding(void);
 339   void Report(ReportType rt);
 340   void Debug(int from);
 341 };
 342 }
 343 #include "FGAircraft.h"
 344 #include "FGPropagate.h"
 345 #include "FGAuxiliary.h"
 346 #include "FGFCS.h"
 347 #include "FGMassBalance.h"
 348 #include "FGState.h"
 349
 350 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 351
 352 #endif