src/FDM/JSBSim/FGRotation.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGRotation.cpp
   4  Author:       Jon Berndt
   5  Date started: 12/02/98
   6  Purpose:      Integrates the rotational EOM
   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 integrates the rotational EOM.
  31
  32 HISTORY
  33 --------------------------------------------------------------------------------
  34 12/02/98   JSB   Created
  35
  36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  37 COMMENTS, REFERENCES,  and NOTES
  38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  39 [1] Cooke, Zyda, Pratt, and McGhee, "NPSNET: Flight Simulation Dynamic Modeling
  40     Using Quaternions", Presence, Vol. 1, No. 4, pp. 404-420  Naval Postgraduate
  41     School, January 1994
  42 [2] D. M. Henderson, "Euler Angles, Quaternions, and Transformation Matrices",
  43     JSC 12960, July 1977
  44 [3] Richard E. McFarland, "A Standard Kinematic Model for Flight Simulation at
  45     NASA-Ames", NASA CR-2497, January 1975
  46 [4] Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics",
  47     Wiley & Sons, 1979 ISBN 0-471-03032-5
  48 [5] Bernard Etkin, "Dynamics of Flight, Stability and Control", Wiley & Sons,
  49     1982 ISBN 0-471-08936-2
  50
  51   The order of rotations used in this class corresponds to a 3-2-1 sequence,
  52   or Y-P-R, or Z-Y-X, if you prefer.
  53
  54 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  55 INCLUDES
  56 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  57
  58 #include "FGRotation.h"
  59 #include "FGAtmosphere.h"
  60 #include "FGState.h"
  61 #include "FGFDMExec.h"
  62 #include "FGFCS.h"
  63 #include "FGAircraft.h"
  64 #include "FGMassBalance.h"
  65 #include "FGTranslation.h"
  66 #include "FGPosition.h"
  67 #include "FGAuxiliary.h"
  68 #include "FGOutput.h"
  69
  70 static const char *IdSrc = "$Id$";
  71 static const char *IdHdr = ID_ROTATION;
  72
  73 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  74 CLASS IMPLEMENTATION
  75 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  76
  77
  78 FGRotation::FGRotation(FGFDMExec* fdmex) : FGModel(fdmex)
  79 {
  80   Name = "FGRotation";
  81   cTht=cPhi=cPsi=1.0;
  82   sTht=sPhi=sPsi=0.0;
  83
  84   Debug(0);
  85 }
  86
  87 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  88
  89 FGRotation::~FGRotation()
  90 {
  91   Debug(1);
  92 }
  93
  94 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  95
  96 bool FGRotation::Run(void)
  97 {
  98   double L2, N1;
  99   double tTheta;
 100
 101   if (!FGModel::Run()) {
 102     GetState();
 103
 104     L2 = vMoments(eL) + Ixz*vPQR(eP)*vPQR(eQ) - (Izz-Iyy)*vPQR(eR)*vPQR(eQ);
 105     N1 = vMoments(eN) - (Iyy-Ixx)*vPQR(eP)*vPQR(eQ) - Ixz*vPQR(eR)*vPQR(eQ);
 106
 107     vPQRdot(eP) = (L2*Izz - N1*Ixz) / (Ixx*Izz - Ixz*Ixz);
 108     vPQRdot(eQ) = (vMoments(eM) - (Ixx-Izz)*vPQR(eP)*vPQR(eR) - Ixz*(vPQR(eP)*vPQR(eP) - vPQR(eR)*vPQR(eR)))/Iyy;
 109     vPQRdot(eR) = (N1*Ixx + L2*Ixz) / (Ixx*Izz - Ixz*Ixz);
 110
 111     vPQR += dt*rate*(vlastPQRdot + vPQRdot)/2.0;
 112     vAeroPQR = vPQR + Atmosphere->GetTurbPQR();
 113
 114     State->IntegrateQuat(vPQR, rate);
 115     State->CalcMatrices();
 116     vEuler = State->CalcEuler();
 117
 118     cTht = cos(vEuler(eTht));   sTht = sin(vEuler(eTht));
 119     cPhi = cos(vEuler(ePhi));   sPhi = sin(vEuler(ePhi));
 120     cPsi = cos(vEuler(ePsi));   sPsi = sin(vEuler(ePsi));
 121
 122     vEulerRates(eTht) = vPQR(2)*cPhi - vPQR(3)*sPhi;
 123     if (cTht != 0.0) {
 124       tTheta = sTht/cTht;       // what's cheaper: / or tan() ?
 125       vEulerRates(ePhi) = vPQR(1) + (vPQR(2)*sPhi + vPQR(3)*cPhi)*tTheta;
 126       vEulerRates(ePsi) = (vPQR(2)*sPhi + vPQR(3)*cPhi)/cTht;
 127     }
 128
 129     vlastPQRdot = vPQRdot;
 130
 131     if (debug_lvl > 1) Debug(2);
 132
 133     return false;
 134   } else {
 135     return true;
 136   }
 137 }
 138
 139 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 140
 141 void FGRotation::GetState(void)
 142 {
 143   dt = State->Getdt();
 144   vMoments = Aircraft->GetMoments();
 145
 146   Ixx = MassBalance->GetIxx();
 147   Iyy = MassBalance->GetIyy();
 148   Izz = MassBalance->GetIzz();
 149   Ixz = MassBalance->GetIxz();
 150 }
 151
 152 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 153 //    The bitmasked value choices are as follows:
 154 //    unset: In this case (the default) JSBSim would only print
 155 //       out the normally expected messages, essentially echoing
 156 //       the config files as they are read. If the environment
 157 //       variable is not set, debug_lvl is set to 1 internally
 158 //    0: This requests JSBSim not to output any messages
 159 //       whatsoever.
 160 //    1: This value explicity requests the normal JSBSim
 161 //       startup messages
 162 //    2: This value asks for a message to be printed out when
 163 //       a class is instantiated
 164 //    4: When this value is set, a message is displayed when a
 165 //       FGModel object executes its Run() method
 166 //    8: When this value is set, various runtime state variables
 167 //       are printed out periodically
 168 //    16: When set various parameters are sanity checked and
 169 //       a message is printed out when they go out of bounds
 170
 171 void FGRotation::Debug(int from)
 172 {
 173   if (debug_lvl <= 0) return;
 174
 175   if (debug_lvl & 1) { // Standard console startup message output
 176     if (from == 0) { // Constructor
 177
 178     }
 179   }
 180   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 181     if (from == 0) cout << "Instantiated: FGRotation" << endl;
 182     if (from == 1) cout << "Destroyed:    FGRotation" << endl;
 183   }
 184   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 185   }
 186   if (debug_lvl & 8 ) { // Runtime state variables
 187   }
 188   if (debug_lvl & 16) { // Sanity check variables
 189     if (from == 2) {
 190       if (fabs(vPQR(eP)) > 100)
 191         cout << "FGRotation::P (Roll Rate) out of bounds: " << vPQR(eP) << endl;
 192       if (fabs(vPQR(eQ)) > 100)
 193         cout << "FGRotation::Q (Pitch Rate) out of bounds: " << vPQR(eQ) << endl;
 194       if (fabs(vPQR(eR)) > 100)
 195         cout << "FGRotation::R (Yaw Rate) out of bounds: " << vPQR(eR) << endl;
 196     }
 197   }
 198   if (debug_lvl & 64) {
 199     if (from == 0) { // Constructor
 200       cout << IdSrc << endl;
 201       cout << IdHdr << endl;
 202     }
 203   }
 204 }
 205