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 float 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
 148   if (!FGModel::Run()) {
 149     GetState();
 150
 151     Vground = sqrt( vVel(eNorth)*vVel(eNorth) + vVel(eEast)*vVel(eEast) );
 152     psigt =  atan2(vVel(eEast), vVel(eNorth));
 153     if(psigt < 0.0)
 154       psigt += 2*M_PI;
 155
 156     invMass   = 1.0 / MassBalance->GetMass();
 157     Radius    = h + SeaLevelRadius;
 158     invRadius = 1.0 / Radius;
 159
 160     cosLat = cos(Latitude);
 161     if (cosLat != 0) LongitudeDot = vVel(eEast) / (Radius * cosLat);
 162
 163     LatitudeDot = vVel(eNorth) * invRadius;
 164     RadiusDot   = -vVel(eDown);
 165
 166     Longitude += 0.5*dt*rate*(LongitudeDot + lastLongitudeDot);
 167     Latitude  += 0.5*dt*rate*(LatitudeDot + lastLatitudeDot);
 168     Radius    += 0.5*dt*rate*(RadiusDot + lastRadiusDot);
 169
 170     h = Radius - SeaLevelRadius;           // Geocentric
 171
 172     DistanceAGL = Radius - RunwayRadius;   // Geocentric
 173
 174     hoverb = DistanceAGL/b;
 175
 176     if (Vt > 0) {
 177       hdot_Vt = RadiusDot/Vt;
 178       if (fabs(hdot_Vt) <= 1) gamma = asin(hdot_Vt);
 179     } else {
 180       gamma = 0.0;
 181     }
 182
 183     lastLatitudeDot  = LatitudeDot;
 184     lastLongitudeDot = LongitudeDot;
 185     lastRadiusDot    = RadiusDot;
 186
 187     return false;
 188
 189   } else {
 190     return true;
 191   }
 192 }
 193
 194 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 195
 196 void FGPosition::GetState(void) {
 197   dt = State->Getdt();
 198
 199   Vt        = Translation->GetVt();
 200   vVel      = State->GetTb2l() * Translation->GetUVW();
 201   vVelDot   = State->GetTb2l() * Translation->GetUVWdot();
 202
 203   b = Aircraft->GetWingSpan();
 204 }
 205
 206 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 207
 208 void FGPosition::Seth(double tt) {
 209  h = tt;
 210  Radius    = h + SeaLevelRadius;
 211  DistanceAGL = Radius - RunwayRadius;   // Geocentric
 212  hoverb = DistanceAGL/b;
 213 }
 214
 215 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 216
 217 void FGPosition::SetDistanceAGL(double tt) {
 218   DistanceAGL=tt;
 219   Radius = RunwayRadius + DistanceAGL;
 220   h = Radius - SeaLevelRadius;
 221   hoverb = DistanceAGL/b;
 222 }
 223
 224 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 225
 226 void FGPosition::Debug(void)
 227 {
 228     //TODO: Add your source code here
 229 }
 230