src/FDM/JSBSim/FGTranslation.cpp

   1 /*******************************************************************************
   2
   3  Module:       FGTranslation.cpp
   4  Author:       Jon Berndt
   5  Date started: 12/02/98
   6  Purpose:      Integrates the translational EOM
   7  Called by:    FDMExec
   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 integrates the translational EOM.
  31
  32 HISTORY
  33 --------------------------------------------------------------------------------
  34 12/02/98   JSB   Created
  35  7/23/99   TP    Added data member and modified Run and PutState to calcuate
  36                                Mach number
  37
  38 ********************************************************************************
  39 COMMENTS, REFERENCES,  and NOTES
  40 ********************************************************************************
  41 [1] Cooke, Zyda, Pratt, and McGhee, "NPSNET: Flight Simulation Dynamic Modeling
  42     Using Quaternions", Presence, Vol. 1, No. 4, pp. 404-420  Naval Postgraduate
  43     School, January 1994
  44 [2] D. M. Henderson, "Euler Angles, Quaternions, and Transformation Matrices",
  45     JSC 12960, July 1977
  46 [3] Richard E. McFarland, "A Standard Kinematic Model for Flight Simulation at
  47     NASA-Ames", NASA CR-2497, January 1975
  48 [4] Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics",
  49     Wiley & Sons, 1979 ISBN 0-471-03032-5
  50 [5] Bernard Etkin, "Dynamics of Flight, Stability and Control", Wiley & Sons,
  51     1982 ISBN 0-471-08936-2
  52
  53   The order of rotations used in this class corresponds to a 3-2-1 sequence,
  54   or Y-P-R, or Z-Y-X, if you prefer.
  55
  56 ********************************************************************************
  57 INCLUDES
  58 *******************************************************************************/
  59
  60 #include "FGTranslation.h"
  61 #include "FGRotation.h"
  62 #include "FGAtmosphere.h"
  63 #include "FGState.h"
  64 #include "FGFDMExec.h"
  65 #include "FGFCS.h"
  66 #include "FGAircraft.h"
  67 #include "FGPosition.h"
  68 #include "FGAuxiliary.h"
  69 #include "FGOutput.h"
  70
  71 static const char *IdSrc = "$Header$";
  72 static const char *IdHdr = ID_TRANSLATION;
  73
  74 /*******************************************************************************
  75 ************************************ CODE **************************************
  76 *******************************************************************************/
  77
  78
  79 FGTranslation::FGTranslation(FGFDMExec* fdmex) : FGModel(fdmex),
  80     vUVW(3),
  81     vWindUVW(3),
  82     vUVWdot(3),
  83     vNcg(3),
  84     vPQR(3),
  85     vForces(3),
  86     vEuler(3)
  87 {
  88   Name = "FGTranslation";
  89   qbar = 0;
  90   Vt = 0.0;
  91   Mach = 0.0;
  92   alpha = beta = 0.0;
  93   adot = bdot = 0.0;
  94   rho = 0.002378;
  95 }
  96
  97 /******************************************************************************/
  98
  99 FGTranslation::~FGTranslation(void) {}
 100
 101 /******************************************************************************/
 102
 103 bool FGTranslation::Run(void) {
 104   static FGColumnVector vlastUVWdot(3);
 105   static FGMatrix       mVel(3,3);
 106
 107   if (!FGModel::Run()) {
 108
 109     GetState();
 110
 111     mVel(1,1) =  0.0;
 112     mVel(1,2) = -vUVW(eW);
 113     mVel(1,3) =  vUVW(eV);
 114     mVel(2,1) =  vUVW(eW);
 115     mVel(2,2) =  0.0;
 116     mVel(2,3) = -vUVW(eU);
 117     mVel(3,1) = -vUVW(eV);
 118     mVel(3,2) =  vUVW(eU);
 119     mVel(3,3) =  0.0;
 120
 121     vUVWdot = mVel*vPQR + vForces/Mass;
 122
 123     vNcg=vUVWdot*INVGRAVITY;
 124
 125     vUVW += 0.5*dt*rate*(vlastUVWdot + vUVWdot) + vWindUVW;
 126
 127     Vt = vUVW.Magnitude();
 128
 129     if (vUVW(eW) != 0.0)
 130       alpha = vUVW(eU)*vUVW(eU) > 0.0 ? atan2(vUVW(eW), vUVW(eU)) : 0.0;
 131     if (vUVW(eV) != 0.0)
 132       beta = vUVW(eU)*vUVW(eU)+vUVW(eW)*vUVW(eW) > 0.0 ? atan2(vUVW(eV),
 133              sqrt(vUVW(eU)*vUVW(eU) + vUVW(eW)*vUVW(eW))) : 0.0;
 134
 135
 136
 137           // stolen, quite shamelessly, from LaRCsim
 138     float mUW = (vUVW(eU)*vUVW(eU) + vUVW(eW)*vUVW(eW));
 139     float signU=1;
 140     if (vUVW(eU) != 0.0)
 141                   signU = vUVW(eU)/fabs(vUVW(eU));
 142
 143           if( (mUW == 0.0) || (Vt == 0.0) ) {
 144                   adot = 0.0;
 145                   bdot = 0.0;
 146           } else {
 147                   adot = (vUVW(eU)*vUVWdot(eW) - vUVW(eW)*vUVWdot(eU))/mUW;
 148                   bdot = (signU*mUW*vUVWdot(eV) - vUVW(eV)*(vUVW(eU)*vUVWdot(eU)
 149               + vUVW(eW)*vUVWdot(eW)))/(Vt*Vt*sqrt(mUW));
 150           }
 151     //
 152
 153     qbar = 0.5*rho*Vt*Vt;
 154
 155     Mach = Vt / State->Geta();
 156
 157     vlastUVWdot = vUVWdot;
 158
 159   } else {}
 160
 161   return false;
 162 }
 163
 164 /******************************************************************************/
 165
 166 void FGTranslation::GetState(void) {
 167   dt = State->Getdt();
 168
 169   vPQR = Rotation->GetPQR();
 170   vForces = Aircraft->GetForces();
 171
 172   Mass = Aircraft->GetMass();
 173   rho = Atmosphere->GetDensity();
 174
 175   vEuler = Rotation->GetEuler();
 176
 177   vWindUVW = Atmosphere->GetWindUVW();
 178 }
 179