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 "FGMassBalance.h"
  67 #include "FGAircraft.h"
  68 #include "FGPosition.h"
  69 #include "FGAuxiliary.h"
  70 #include "FGOutput.h"
  71
  72 static const char *IdSrc = "$Id$";
  73 static const char *IdHdr = ID_TRANSLATION;
  74
  75 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  76 CLASS IMPLEMENTATION
  77 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  78
  79
  80 FGTranslation::FGTranslation(FGFDMExec* fdmex) : FGModel(fdmex),
  81     vUVW(3),
  82     vUVWdot(3),
  83     vlastUVWdot(3),
  84     mVel(3,3),
  85     vAero(3)
  86 {
  87   Name = "FGTranslation";
  88   qbar = 0;
  89   Vt = 0.0;
  90   Mach = 0.0;
  91   alpha = beta = 0.0;
  92   adot = bdot = 0.0;
  93
  94   if (debug_lvl & 2) cout << "Instantiated: " << Name << endl;
  95 }
  96
  97 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  98
  99 FGTranslation::~FGTranslation()
 100 {
 101   if (debug_lvl & 2) cout << "Destroyed:    FGTranslation" << endl;
 102 }
 103
 104 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 105
 106 bool FGTranslation::Run(void)
 107 {
 108   float Tc = 0.5*State->Getdt()*rate;
 109
 110   if (!FGModel::Run()) {
 111
 112     mVel(1,1) =  0.0;
 113     mVel(1,2) = -vUVW(eW);
 114     mVel(1,3) =  vUVW(eV);
 115     mVel(2,1) =  vUVW(eW);
 116     mVel(2,2) =  0.0;
 117     mVel(2,3) = -vUVW(eU);
 118     mVel(3,1) = -vUVW(eV);
 119     mVel(3,2) =  vUVW(eU);
 120     mVel(3,3) =  0.0;
 121
 122     vUVWdot = mVel*Rotation->GetPQR() + Aircraft->GetBodyAccel();
 123
 124     vUVW += Tc * (vlastUVWdot + vUVWdot);
 125     vAero = vUVW + State->GetTl2b()*Atmosphere->GetWindNED();
 126
 127     Vt = vAero.Magnitude();
 128     if ( Vt > 1) {
 129       if (vAero(eW) != 0.0)
 130         alpha = vAero(eU)*vAero(eU) > 0.0 ? atan2(vAero(eW), vAero(eU)) : 0.0;
 131       if (vAero(eV) != 0.0)
 132         beta = vAero(eU)*vAero(eU)+vAero(eW)*vAero(eW) > 0.0 ? atan2(vAero(eV),
 133                sqrt(vAero(eU)*vAero(eU) + vAero(eW)*vAero(eW))) : 0.0;
 134
 135       // stolen, quite shamelessly, from LaRCsim
 136       float mUW = (vAero(eU)*vAero(eU) + vAero(eW)*vAero(eW));
 137       float signU=1;
 138       if (vAero(eU) != 0.0)
 139         signU = vAero(eU)/fabs(vAero(eU));
 140
 141       if ( (mUW == 0.0) || (Vt == 0.0) ) {
 142         adot = 0.0;
 143         bdot = 0.0;
 144       } else {
 145         adot = (vAero(eU)*vAero(eW) - vAero(eW)*vUVWdot(eU))/mUW;
 146         bdot = (signU*mUW*vUVWdot(eV) - vAero(eV)*(vAero(eU)*vUVWdot(eU)
 147                 + vAero(eW)*vUVWdot(eW)))/(Vt*Vt*sqrt(mUW));
 148       }
 149     } else {
 150       alpha = beta = adot = bdot = 0;
 151     }
 152
 153     qbar = 0.5*Atmosphere->GetDensity()*Vt*Vt;
 154     Mach = Vt / State->Geta();
 155
 156     vlastUVWdot = vUVWdot;
 157
 158     if (debug_lvl > 1) Debug();
 159
 160     return false;
 161   } else {
 162     return true;
 163   }
 164 }
 165
 166 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 167
 168 void FGTranslation::Debug(void)
 169 {
 170   if (debug_lvl & 16) { // Sanity check variables
 171     if (fabs(vUVW(eU)) > 1e6)
 172       cout << "FGTranslation::U velocity out of bounds: " << vUVW(eU) << endl;
 173     if (fabs(vUVW(eV)) > 1e6)
 174       cout << "FGTranslation::V velocity out of bounds: " << vUVW(eV) << endl;
 175     if (fabs(vUVW(eW)) > 1e6)
 176       cout << "FGTranslation::W velocity out of bounds: " << vUVW(eW) << endl;
 177     if (fabs(vUVWdot(eU)) > 1e4)
 178       cout << "FGTranslation::U acceleration out of bounds: " << vUVWdot(eU) << endl;
 179     if (fabs(vUVWdot(eV)) > 1e4)
 180       cout << "FGTranslation::V acceleration out of bounds: " << vUVWdot(eV) << endl;
 181     if (fabs(vUVWdot(eW)) > 1e4)
 182       cout << "FGTranslation::W acceleration out of bounds: " << vUVWdot(eW) << endl;
 183     if (Mach > 100 || Mach < 0.00)
 184       cout << "FGTranslation::Mach is out of bounds: " << Mach << endl;
 185     if (qbar > 1e6 || qbar < 0.00)
 186       cout << "FGTranslation::qbar is out of bounds: " << qbar << endl;
 187   }
 188 }
 189