src/FDM/JSBSim/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 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 General Public License for more
  17  details.
  18
  19  You should have received a copy of the GNU 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 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 <string>
  46 #include "FGConfigFile.h"
  47 #include "FGMatrix.h"
  48 #include "FGFDMExec.h"
  49
  50 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  51 DEFINITIONS
  52 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  53
  54 #define ID_LGEAR "$Id$"
  55
  56 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  57 FORWARD DECLARATIONS
  58 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  59
  60 class FGAircraft;
  61 class FGPosition;
  62 class FGRotation;
  63 class FGFCS;
  64 class FGState;
  65
  66 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  67 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
  68 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  69
  70 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  71 CLASS DOCUMENTATION
  72 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  73
  74 /** Landing gear model.
  75     Calculates forces and moments due to landing gear reactions. This is done in
  76     several steps, and is dependent on what kind of gear is being modeled. Here
  77     are the parameters that can be specified in the config file for modeling
  78     landing gear:
  79     <p>
  80     <b><u>Physical Characteristics</u></b><br>
  81     <ol>
  82     <li>X, Y, Z location, in inches in structural coordinate frame</li>
  83     <li>Spring constant, in lbs/ft</li>
  84     <li>Damping coefficient, in lbs/ft/sec</li>
  85     <li>Dynamic Friction Coefficient</li>
  86     <li>Static Friction Coefficient</li>
  87     </ol></p><p>
  88     <b><u>Operational Properties</b></u><br>
  89     <ol>
  90     <li>Name</li>
  91     <li>Steerability attribute {one of STEERABLE | FIXED | CASTERED}</li>
  92     <li>Brake Group Membership {one of LEFT | CENTER | RIGHT | NOSE | TAIL | NONE}</li>
  93     <li>Max Steer Angle, in degrees</li>
  94     </ol></p>
  95     <p>
  96     <b><u>Algorithm and Approach to Modeling</u></b><br>
  97     <ol>
  98     <li>Find the location of the uncompressed landing gear relative to the CG of
  99     the aircraft. Remember, the structural coordinate frame that the aircraft is
 100     defined in is: X positive towards the tail, Y positive out the right side, Z
 101     positive upwards. The locations of the various parts are given in inches in
 102     the config file.</li>
 103     <li>The vector giving the location of the gear (relative to the cg) is
 104     rotated 180 degrees about the Y axis to put the coordinates in body frame (X
 105     positive forwards, Y positive out the right side, Z positive downwards, with
 106     the origin at the cg). The lengths are also now given in feet.</li>
 107     <li>The new gear location is now transformed to the local coordinate frame
 108     using the body-to-local matrix. (Mb2l).</li>
 109     <li>Knowing the location of the center of gravity relative to the ground
 110     (height above ground level or AGL) now enables gear deflection to be
 111     calculated. The gear compression value is the local frame gear Z location
 112     value minus the height AGL. [Currently, we make the assumption that the gear
 113     is oriented - and the deflection occurs in - the Z axis only. Additionally,
 114     the vector to the landing gear is currently not modified - which would
 115     (correctly) move the point of contact to the actual compressed-gear point of
 116     contact. Eventually, articulated gear may be modeled, but initially an
 117     effort must be made to model a generic system.] As an example, say the
 118     aircraft left main gear location (in local coordinates) is Z = 3 feet
 119     (positive) and the height AGL is 2 feet. This tells us that the gear is
 120     compressed 1 foot.</li>
 121     <li>If the gear is compressed, a Weight-On-Wheels (WOW) flag is set.</li>
 122     <li>With the compression length calculated, the compression velocity may now
 123     be calculated. This will be used to determine the damping force in the
 124     strut. The aircraft rotational rate is multiplied by the vector to the wheel
 125     to get a wheel velocity in body frame. That velocity vector is then
 126     transformed into the local coordinate frame.</li>
 127     <li>The aircraft cg velocity in the local frame is added to the
 128     just-calculated wheel velocity (due to rotation) to get a total wheel
 129     velocity in the local frame.</li>
 130     <li>The compression speed is the Z-component of the vector.</li>
 131     <li>With the wheel velocity vector no longer needed, it is normalized and
 132     multiplied by a -1 to reverse it. This will be used in the friction force
 133     calculation.</li>
 134     <li>Since the friction force takes place solely in the runway plane, the Z
 135     coordinate of the normalized wheel velocity vector is set to zero.</li>
 136     <li>The gear deflection force (the force on the aircraft acting along the
 137     local frame Z axis) is now calculated given the spring and damper
 138     coefficients, and the gear deflection speed and stroke length. Keep in mind
 139     that gear forces always act in the negative direction (in both local and
 140     body frames), and are not capable of generating a force in the positive
 141     sense (one that would attract the aircraft to the ground). So, the gear
 142     forces are always negative - they are limited to values of zero or less. The
 143     gear force is simply the negative of the sum of the spring compression
 144     length times the spring coefficient and the gear velocity times the damping
 145     coefficient.</li>
 146     <li>The lateral/directional force acting on the aircraft through the landing
 147
 148     gear (along the local frame X and Y axes) is calculated next. First, the
 149     friction coefficient is multiplied by the recently calculated Z-force. This
 150     is the friction force. It must be given direction in addition to magnitude.
 151     We want the components in the local frame X and Y axes. From step 9, above,
 152     the conditioned wheel velocity vector is taken and the X and Y parts are
 153     multiplied by the friction force to get the X and Y components of friction.
 154     </li>
 155     <li>The wheel force in local frame is next converted to body frame.</li>
 156     <li>The moment due to the gear force is calculated by multiplying r x F
 157     (radius to wheel crossed into the wheel force). Both of these operands are
 158     in body frame.</li>
 159     </ol>
 160     @author Jon S. Berndt
 161     @version $Id$
 162     @see Richard E. McFarland, "A Standard Kinematic Model for Flight Simulation at
 163            NASA-Ames", NASA CR-2497, January 1975
 164     @see Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics",
 165            Wiley & Sons, 1979 ISBN 0-471-03032-5
 166     @see W. A. Ragsdale, "A Generic Landing Gear Dynamics Model for LASRS++",
 167      AIAA-2000-4303
 168 */
 169
 170 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 171 CLASS DECLARATION
 172 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 173
 174 class FGLGear
 175 {
 176 public:
 177   /// Brake grouping enumerators
 178   enum BrakeGroup {bgNone=0, bgLeft, bgRight, bgCenter, bgNose, bgTail };
 179   /// Steering group membership enumerators
 180   enum SteerType {stSteer, stFixed, stCaster};
 181   /** Constructor
 182       @param Executive a pointer to the parent executive object
 183       @param File a pointer to the config file instance */
 184   FGLGear(FGConfigFile* File, FGFDMExec* Executive);
 185   /** Constructor
 186       @param lgear a reference to an existing FGLGear object     */
 187   FGLGear(const FGLGear& lgear);
 188   /// Destructor
 189   ~FGLGear();
 190
 191
 192   /// The Force vector for this gear
 193   FGColumnVector Force(void);
 194   /// The Moment vector for this gear
 195   FGColumnVector Moment(void) {return vMoment;}
 196
 197   /// Gets the location of the gear in Body axes
 198   FGColumnVector GetBodyLocation(void) { return vWhlBodyVec; }
 199   float GetBodyLocation(int idx) { return vWhlBodyVec(idx); }
 200
 201   FGColumnVector GetLocalGear(void) { return vLocalGear; }
 202   float GetLocalGear(int idx) { return vLocalGear(idx); }
 203
 204   /// Gets the name of the gear
 205   inline string GetName(void)      {return name;          }
 206   /// Gets the Weight On Wheels flag value
 207   inline bool   GetWOW(void)       {return WOW;           }
 208   /// Gets the current compressed length of the gear in feet
 209   inline float  GetCompLen(void)   {return compressLength;}
 210   /// Gets the current gear compression velocity in ft/sec
 211   inline float  GetCompVel(void)   {return compressSpeed; }
 212   /// Gets the gear compression force in pounds
 213   inline float  GetCompForce(void) {return Force()(3);    }
 214
 215   /// Sets the brake value in percent (0 - 100)
 216   inline void SetBrake(double bp) {brakePct = bp;}
 217
 218   /** Set the console touchdown reporting feature
 219       @param flag true turns on touchdown reporting, false turns it off */
 220   inline void SetReport(bool flag) { ReportEnable = flag; }
 221   /** Get the console touchdown reporting feature
 222       @return true if reporting is turned on */
 223   inline bool GetReport(void)    { return ReportEnable; }
 224
 225 private:
 226   enum {eX=1, eY, eZ};
 227   FGColumnVector vXYZ;
 228   FGColumnVector vMoment;
 229   FGColumnVector vWhlBodyVec;
 230   FGColumnVector vLocalGear;
 231   float kSpring;
 232   float bDamp;
 233   float compressLength;
 234   float compressSpeed;
 235   float staticFCoeff, dynamicFCoeff, rollingFCoeff;
 236   float brakePct;
 237   float maxCompLen;
 238   double SinkRate;
 239   double GroundSpeed;
 240   double DistanceTraveled;
 241   double MaximumStrutForce;
 242   double MaximumStrutTravel;
 243   bool WOW;
 244   bool FirstContact;
 245   bool Reported;
 246   bool ReportEnable;
 247   string name;
 248   string sSteerType;
 249   string sBrakeGroup;
 250   BrakeGroup eBrakeGrp;
 251   SteerType  eSteerType;
 252   float  maxSteerAngle;
 253
 254   FGFDMExec*  Exec;
 255   FGState*    State;
 256   FGAircraft* Aircraft;
 257   FGPosition* Position;
 258   FGRotation* Rotation;
 259   FGFCS*      FCS;
 260
 261   void Report(void);
 262   void Debug(void);
 263 };
 264
 265 #include "FGAircraft.h"
 266 #include "FGPosition.h"
 267 #include "FGRotation.h"
 268 #include "FGFCS.h"
 269
 270 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 271
 272 #include "FGState.h"
 273
 274 #endif