src/FDM/JSBSim/FGPosition.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGPosition.cpp
   4  Author:       Jon S. Berndt
   5  Date started: 01/05/99
   6  Purpose:      Integrate the EOM to determine instantaneous position
   7  Called by:    FGFDMExec
   8
   9  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
  10
  11  This program is free software; you can redistribute it and/or modify it under
  12  the terms of the GNU General Public License as published by the Free Software
  13  Foundation; either version 2 of the License, or (at your option) any later
  14  version.
  15
  16  This program is distributed in the hope that it will be useful, but WITHOUT
  17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  18  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  19  details.
  20
  21  You should have received a copy of the GNU General Public License along with
  22  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  23  Place - Suite 330, Boston, MA  02111-1307, USA.
  24
  25  Further information about the GNU General Public License can also be found on
  26  the world wide web at http://www.gnu.org.
  27
  28 FUNCTIONAL DESCRIPTION
  29 --------------------------------------------------------------------------------
  30 This class encapsulates the integration of rates and accelerations to get the
  31 current position of the aircraft.
  32
  33 HISTORY
  34 --------------------------------------------------------------------------------
  35 01/05/99   JSB   Created
  36
  37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 COMMENTS, REFERENCES,  and NOTES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  40 [1] Cooke, Zyda, Pratt, and McGhee, "NPSNET: Flight Simulation Dynamic Modeling
  41     Using Quaternions", Presence, Vol. 1, No. 4, pp. 404-420  Naval Postgraduate
  42     School, January 1994
  43 [2] D. M. Henderson, "Euler Angles, Quaternions, and Transformation Matrices",
  44     JSC 12960, July 1977
  45 [3] Richard E. McFarland, "A Standard Kinematic Model for Flight Simulation at
  46     NASA-Ames", NASA CR-2497, January 1975
  47 [4] Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics",
  48     Wiley & Sons, 1979 ISBN 0-471-03032-5
  49 [5] Bernard Etkin, "Dynamics of Flight, Stability and Control", Wiley & Sons,
  50     1982 ISBN 0-471-08936-2
  51
  52 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  53 INCLUDES
  54 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  55
  56 #ifdef FGFS
  57 #  include <simgear/compiler.h>
  58 #  ifdef SG_HAVE_STD_INCLUDES
  59 #    include <cmath>
  60 #    include <iomanip>
  61 #  else
  62 #    include <math.h>
  63 #    include <iomanip.h>
  64 #  endif
  65 #else
  66 #  if defined(sgi) && !defined(__GNUC__)
  67 #    include <math.h>
  68 #    include <iomanip.h>
  69 #  else
  70 #    include <cmath>
  71 #    include <iomanip>
  72 #  endif
  73 #endif
  74
  75 #include "FGPosition.h"
  76 #include "FGAtmosphere.h"
  77 #include "FGState.h"
  78 #include "FGFDMExec.h"
  79 #include "FGFCS.h"
  80 #include "FGAircraft.h"
  81 #include "FGMassBalance.h"
  82 #include "FGTranslation.h"
  83 #include "FGRotation.h"
  84 #include "FGAuxiliary.h"
  85 #include "FGOutput.h"
  86
  87 static const char *IdSrc = "$Id$";
  88 static const char *IdHdr = ID_POSITION;
  89
  90 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  91 CLASS IMPLEMENTATION
  92 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  93
  94 extern double globalTriNormal[3];
  95 extern double globalSceneryAltitude;
  96 extern double globalSeaLevelRadius;
  97
  98 FGPosition::FGPosition(FGFDMExec* fdmex) : FGModel(fdmex),
  99     vVel(3),
 100     vVelDot(3),
 101     vRunwayNormal(3)
 102 {
 103   Name = "FGPosition";
 104   LongitudeDot = LatitudeDot = RadiusDot = 0.0;
 105   lastLongitudeDot = lastLatitudeDot = lastRadiusDot = 0.0;
 106   Longitude = Latitude = 0.0;
 107   gamma = Vt = Vground = 0.0;
 108
 109   if (debug_lvl & 2) cout << "Instantiated: " << Name << endl;
 110 }
 111
 112 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 113
 114 FGPosition::~FGPosition()
 115 {
 116   if (debug_lvl & 2) cout << "Destroyed:    FGPosition" << endl;
 117 }
 118
 119 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 120
 121 bool FGPosition::InitModel(void)
 122 {
 123   FGModel::InitModel();
 124
 125   h = 3.0;                                 // Est. height of aircraft cg off runway
 126   SeaLevelRadius = Inertial->RefRadius();  // For initialization ONLY
 127   Radius         = SeaLevelRadius + h;
 128   RunwayRadius   = SeaLevelRadius;
 129   DistanceAGL    = Radius - RunwayRadius;  // Geocentric
 130   vRunwayNormal(3) = -1.0;                 // Initialized for standalone mode
 131   b = 1;
 132   return true;
 133 }
 134
 135 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 136 /*
 137 Purpose: Called on a schedule to perform Positioning algorithms
 138 Notes:   [TP] Make sure that -Vt <= hdot <= Vt, which, of course, should always
 139          be the case
 140          [JB] Run in standalone mode, SeaLevelRadius will be reference radius.
 141                In FGFS, SeaLevelRadius is stuffed from FGJSBSim in JSBSim.cxx each pass.
 142 */
 143
 144 bool FGPosition::Run(void) {
 145   double cosLat;
 146   double hdot_Vt;
 147   FGColumnVector3 vMac;
 148
 149   if (!FGModel::Run()) {
 150     GetState();
 151
 152     Vground = sqrt( vVel(eNorth)*vVel(eNorth) + vVel(eEast)*vVel(eEast) );
 153     psigt =  atan2(vVel(eEast), vVel(eNorth));
 154     if(psigt < 0.0)
 155       psigt += 2*M_PI;
 156
 157     invMass   = 1.0 / MassBalance->GetMass();
 158     Radius    = h + SeaLevelRadius;
 159     invRadius = 1.0 / Radius;
 160
 161     cosLat = cos(Latitude);
 162     if (cosLat != 0) LongitudeDot = vVel(eEast) / (Radius * cosLat);
 163
 164     LatitudeDot = vVel(eNorth) * invRadius;
 165     RadiusDot   = -vVel(eDown);
 166
 167     Longitude += 0.5*dt*rate*(LongitudeDot + lastLongitudeDot);
 168     Latitude  += 0.5*dt*rate*(LatitudeDot + lastLatitudeDot);
 169     Radius    += 0.5*dt*rate*(RadiusDot + lastRadiusDot);
 170
 171     h = Radius - SeaLevelRadius;           // Geocentric
 172
 173     DistanceAGL = Radius - RunwayRadius;   // Geocentric
 174
 175
 176     hoverbcg = DistanceAGL/b;
 177
 178     vMac=State->GetTb2l()*Aircraft->GetXYZrp();
 179
 180     vMac *= inchtoft;
 181     hoverbmac = (DistanceAGL + vMac(3))/b;
 182
 183     if (Vt > 0) {
 184       hdot_Vt = RadiusDot/Vt;
 185       if (fabs(hdot_Vt) <= 1) gamma = asin(hdot_Vt);
 186     } else {
 187       gamma = 0.0;
 188     }
 189
 190     lastLatitudeDot  = LatitudeDot;
 191     lastLongitudeDot = LongitudeDot;
 192     lastRadiusDot    = RadiusDot;
 193
 194     return false;
 195
 196   } else {
 197     return true;
 198   }
 199 }
 200
 201 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 202
 203 void FGPosition::GetState(void) {
 204   dt = State->Getdt();
 205
 206   Vt        = Translation->GetVt();
 207   vVel      = State->GetTb2l() * Translation->GetUVW();
 208   vVelDot   = State->GetTb2l() * Translation->GetUVWdot();
 209
 210   b = Aircraft->GetWingSpan();
 211 }
 212
 213 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 214
 215 void FGPosition::Seth(double tt) {
 216  h = tt;
 217  Radius    = h + SeaLevelRadius;
 218  DistanceAGL = Radius - RunwayRadius;   // Geocentric
 219  hoverbcg = DistanceAGL/b;
 220 }
 221
 222 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 223
 224 void FGPosition::SetDistanceAGL(double tt) {
 225   DistanceAGL=tt;
 226   Radius = RunwayRadius + DistanceAGL;
 227   h = Radius - SeaLevelRadius;
 228   hoverbcg = DistanceAGL/b;
 229 }
 230
 231 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 232
 233 void FGPosition::Debug(void)
 234 {
 235     //TODO: Add your source code here
 236 }
 237