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 #include "FGState.h"
  50
  51 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  52 DEFINITIONS
  53 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  54
  55 #define ID_LGEAR "$Id$"
  56
  57 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  58 FORWARD DECLARATIONS
  59 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  60
  61 class FGAircraft;
  62 class FGPosition;
  63 class FGRotation;
  64 class FGFCS;
  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 */
 167
 168 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 169 CLASS DECLARATION
 170 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 171
 172 class FGLGear
 173 {
 174 public:
 175   /// Brake grouping enumerators
 176   enum BrakeGroup {bgNone=0, bgLeft, bgRight, bgCenter, bgNose, bgTail };
 177   /// Steering group membership enumerators
 178   enum SteerType {stSteer, stFixed, stCaster};
 179   /** Constructor
 180       @param Executive a pointer to the parent executive object
 181       @param File a pointer to the config file instance */
 182   FGLGear(FGConfigFile* File, FGFDMExec* Executive);
 183   /** Constructor
 184       @param lgear a reference to an existing FGLGear object     */
 185   FGLGear(const FGLGear& lgear);
 186   /// Destructor
 187   ~FGLGear();
 188
 189
 190   /// The Force vector for this gear
 191   FGColumnVector Force(void);
 192   /// The Moment vector for this gear
 193   FGColumnVector Moment(void) {return vMoment;}
 194
 195   /// Gets the location of the gear in Body axes
 196   FGColumnVector GetBodyLocation(void) { return vWhlBodyVec; }
 197
 198   FGColumnVector GetLocalGear(void) { return vLocalGear; }
 199
 200   /// Gets the name of the gear
 201   inline string GetName(void)      {return name;          }
 202   /// Gets the Weight On Wheels flag value
 203   inline bool   GetWOW(void)       {return WOW;           }
 204   /// Gets the current compressed length of the gear in feet
 205   inline float  GetCompLen(void)   {return compressLength;}
 206   /// Gets the current gear compression velocity in ft/sec
 207   inline float  GetCompVel(void)   {return compressSpeed; }
 208   /// Gets the gear compression force in pounds
 209   inline float  GetCompForce(void) {return Force()(3);    }
 210
 211   /// Sets the brake value in percent (0 - 100)
 212   inline void SetBrake(double bp) {brakePct = bp;}
 213
 214   /** Set the console touchdown reporting feature
 215       @param flag true turns on touchdown reporting, false turns it off */
 216   inline void SetReport(bool flag) { ReportEnable = flag; }
 217   /** Get the console touchdown reporting feature
 218       @return true if reporting is turned on */
 219   inline bool GetReport(void)    { return ReportEnable; }
 220
 221 private:
 222   enum {eX=1, eY, eZ};
 223   FGColumnVector vXYZ;
 224   FGColumnVector vMoment;
 225   FGColumnVector vWhlBodyVec;
 226   FGColumnVector vLocalGear;
 227   float kSpring;
 228   float bDamp;
 229   float compressLength;
 230   float compressSpeed;
 231   float staticFCoeff, dynamicFCoeff, rollingFCoeff;
 232   float brakePct;
 233   float maxCompLen;
 234   double SinkRate;
 235   double GroundSpeed;
 236   double DistanceTraveled;
 237   double MaximumStrutForce;
 238   double MaximumStrutTravel;
 239   bool WOW;
 240   bool FirstContact;
 241   bool Reported;
 242   bool ReportEnable;
 243   string name;
 244   string sSteerType;
 245   string sBrakeGroup;
 246   BrakeGroup eBrakeGrp;
 247   SteerType  eSteerType;
 248   float  maxSteerAngle;
 249
 250   FGFDMExec*  Exec;
 251   FGState*    State;
 252   FGAircraft* Aircraft;
 253   FGPosition* Position;
 254   FGRotation* Rotation;
 255   FGFCS*      FCS;
 256
 257   void Report(void);
 258   void Debug(void);
 259 };
 260
 261 #include "FGAircraft.h"
 262 #include "FGPosition.h"
 263 #include "FGRotation.h"
 264 #include "FGFCS.h"
 265
 266 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 267 #endif