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 #include "FGPropertyManager.h"
  70
  71
  72 static const char *IdSrc = "$Id$";
  73 static const char *IdHdr = ID_ROTATION;
  74
  75 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  76 CLASS IMPLEMENTATION
  77 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  78
  79
  80 FGRotation::FGRotation(FGFDMExec* fdmex) : FGModel(fdmex)
  81 {
  82   Name = "FGRotation";
  83   cTht=cPhi=cPsi=1.0;
  84   sTht=sPhi=sPsi=0.0;
  85
  86   bind();
  87
  88   Debug(0);
  89 }
  90
  91 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  92
  93 FGRotation::~FGRotation()
  94 {
  95   unbind();
  96   Debug(1);
  97 }
  98
  99 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 100
 101 bool FGRotation::Run(void)
 102 {
 103   double L2, N1;
 104   double tTheta;
 105
 106   if (!FGModel::Run()) {
 107     GetState();
 108
 109     L2 = vMoments(eL) + Ixz*vPQR(eP)*vPQR(eQ) - (Izz-Iyy)*vPQR(eR)*vPQR(eQ);
 110     N1 = vMoments(eN) - (Iyy-Ixx)*vPQR(eP)*vPQR(eQ) - Ixz*vPQR(eR)*vPQR(eQ);
 111
 112     vPQRdot(eP) = (L2*Izz - N1*Ixz) / (Ixx*Izz - Ixz*Ixz);
 113     vPQRdot(eQ) = (vMoments(eM) - (Ixx-Izz)*vPQR(eP)*vPQR(eR) - Ixz*(vPQR(eP)*vPQR(eP) - vPQR(eR)*vPQR(eR)))/Iyy;
 114     vPQRdot(eR) = (N1*Ixx + L2*Ixz) / (Ixx*Izz - Ixz*Ixz);
 115
 116     vPQR += dt*rate*(vlastPQRdot + vPQRdot)/2.0;
 117     vAeroPQR = vPQR + Atmosphere->GetTurbPQR();
 118
 119     State->IntegrateQuat(vPQR, rate);
 120     State->CalcMatrices();
 121     vEuler = State->CalcEuler();
 122
 123     cTht = cos(vEuler(eTht));   sTht = sin(vEuler(eTht));
 124     cPhi = cos(vEuler(ePhi));   sPhi = sin(vEuler(ePhi));
 125     cPsi = cos(vEuler(ePsi));   sPsi = sin(vEuler(ePsi));
 126
 127     vEulerRates(eTht) = vPQR(2)*cPhi - vPQR(3)*sPhi;
 128     if (cTht != 0.0) {
 129       tTheta = sTht/cTht;       // what's cheaper: / or tan() ?
 130       vEulerRates(ePhi) = vPQR(1) + (vPQR(2)*sPhi + vPQR(3)*cPhi)*tTheta;
 131       vEulerRates(ePsi) = (vPQR(2)*sPhi + vPQR(3)*cPhi)/cTht;
 132     }
 133
 134     vlastPQRdot = vPQRdot;
 135
 136     if (debug_lvl > 1) Debug(2);
 137
 138     return false;
 139   } else {
 140     return true;
 141   }
 142 }
 143
 144 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 145
 146 void FGRotation::GetState(void)
 147 {
 148   dt = State->Getdt();
 149   vMoments = Aircraft->GetMoments();
 150
 151   Ixx = MassBalance->GetIxx();
 152   Iyy = MassBalance->GetIyy();
 153   Izz = MassBalance->GetIzz();
 154   Ixz = MassBalance->GetIxz();
 155 }
 156
 157 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 158
 159 void FGRotation::bind(void)
 160 {
 161   typedef double (FGRotation::*PMF)(int) const;
 162   PropertyManager->Tie("velocities/p-rad_sec", this,1,
 163                        (PMF)&FGRotation::GetPQR);
 164   PropertyManager->Tie("velocities/q-rad_sec", this,2,
 165                        (PMF)&FGRotation::GetPQR);
 166   PropertyManager->Tie("velocities/r-rad_sec", this,3,
 167                        (PMF)&FGRotation::GetPQR);
 168   PropertyManager->Tie("velocities/p-aero-rad_sec", this,1,
 169                        (PMF)&FGRotation::GetAeroPQR);
 170   PropertyManager->Tie("velocities/q-aero-rad_sec", this,2,
 171                        (PMF)&FGRotation::GetAeroPQR);
 172   PropertyManager->Tie("velocities/r-aero-rad_sec", this,3,
 173                        (PMF)&FGRotation::GetAeroPQR);
 174   PropertyManager->Tie("accelerations/pdot-rad_sec", this,1,
 175                        (PMF)&FGRotation::GetPQRdot);
 176   PropertyManager->Tie("accelerations/qdot-rad_sec", this,2,
 177                        (PMF)&FGRotation::GetPQRdot);
 178   PropertyManager->Tie("accelerations/rdot-rad_sec", this,3,
 179                        (PMF)&FGRotation::GetPQRdot);
 180   PropertyManager->Tie("attitude/roll-rad", this,1,
 181                        (PMF)&FGRotation::GetEuler);
 182   PropertyManager->Tie("attitude/pitch-rad", this,2,
 183                        (PMF)&FGRotation::GetEuler);
 184   PropertyManager->Tie("attitude/heading-true-rad", this,3,
 185                        (PMF)&FGRotation::GetEuler);
 186   PropertyManager->Tie("velocities/phidot-rad_sec", this,1,
 187                        (PMF)&FGRotation::GetEulerRates);
 188   PropertyManager->Tie("velocities/thetadot-rad_sec", this,2,
 189                        (PMF)&FGRotation::GetEulerRates);
 190   PropertyManager->Tie("velocities/psidot-rad_sec", this,3,
 191                        (PMF)&FGRotation::GetEulerRates);
 192   PropertyManager->Tie("attitude/phi-rad", this,
 193                        &FGRotation::Getphi);
 194   PropertyManager->Tie("attitude/theta-rad", this,
 195                        &FGRotation::Gettht);
 196   PropertyManager->Tie("attitude/psi-true-rad", this,
 197                        &FGRotation::Getpsi);
 198 }
 199
 200 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 201
 202 void FGRotation::unbind(void)
 203 {
 204   PropertyManager->Untie("velocities/p-rad_sec");
 205   PropertyManager->Untie("velocities/q-rad_sec");
 206   PropertyManager->Untie("velocities/r-rad_sec");
 207   PropertyManager->Untie("velocities/p-aero-rad_sec");
 208   PropertyManager->Untie("velocities/q-aero-rad_sec");
 209   PropertyManager->Untie("velocities/r-aero-rad_sec");
 210   PropertyManager->Untie("accelerations/pdot-rad_sec");
 211   PropertyManager->Untie("accelerations/qdot-rad_sec");
 212   PropertyManager->Untie("accelerations/rdot-rad_sec");
 213   PropertyManager->Untie("attitude/roll-rad");
 214   PropertyManager->Untie("attitude/pitch-rad");
 215   PropertyManager->Untie("attitude/heading-true-rad");
 216   PropertyManager->Untie("velocities/phidot-rad_sec");
 217   PropertyManager->Untie("velocities/thetadot-rad_sec");
 218   PropertyManager->Untie("velocities/psidot-rad_sec");
 219   PropertyManager->Untie("attitude/phi-rad");
 220   PropertyManager->Untie("attitude/theta-rad");
 221   PropertyManager->Untie("attitude/psi-true-rad");
 222 }
 223
 224 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 225 //    The bitmasked value choices are as follows:
 226 //    unset: In this case (the default) JSBSim would only print
 227 //       out the normally expected messages, essentially echoing
 228 //       the config files as they are read. If the environment
 229 //       variable is not set, debug_lvl is set to 1 internally
 230 //    0: This requests JSBSim not to output any messages
 231 //       whatsoever.
 232 //    1: This value explicity requests the normal JSBSim
 233 //       startup messages
 234 //    2: This value asks for a message to be printed out when
 235 //       a class is instantiated
 236 //    4: When this value is set, a message is displayed when a
 237 //       FGModel object executes its Run() method
 238 //    8: When this value is set, various runtime state variables
 239 //       are printed out periodically
 240 //    16: When set various parameters are sanity checked and
 241 //       a message is printed out when they go out of bounds
 242
 243 void FGRotation::Debug(int from)
 244 {
 245   if (debug_lvl <= 0) return;
 246
 247   if (debug_lvl & 1) { // Standard console startup message output
 248     if (from == 0) { // Constructor
 249
 250     }
 251   }
 252   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 253     if (from == 0) cout << "Instantiated: FGRotation" << endl;
 254     if (from == 1) cout << "Destroyed:    FGRotation" << endl;
 255   }
 256   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 257   }
 258   if (debug_lvl & 8 ) { // Runtime state variables
 259   }
 260   if (debug_lvl & 16) { // Sanity check variables
 261     if (from == 2) {
 262       if (fabs(vPQR(eP)) > 100)
 263         cout << "FGRotation::P (Roll Rate) out of bounds: " << vPQR(eP) << endl;
 264       if (fabs(vPQR(eQ)) > 100)
 265         cout << "FGRotation::Q (Pitch Rate) out of bounds: " << vPQR(eQ) << endl;
 266       if (fabs(vPQR(eR)) > 100)
 267         cout << "FGRotation::R (Yaw Rate) out of bounds: " << vPQR(eR) << endl;
 268     }
 269   }
 270   if (debug_lvl & 64) {
 271     if (from == 0) { // Constructor
 272       cout << IdSrc << endl;
 273       cout << IdHdr << endl;
 274     }
 275   }
 276 }
 277