src/FDM/JSBSim/FGRotation.h

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Header:       FGRotation.h
   4  Author:       Jon Berndt
   5  Date started: 12/02/98
   6
   7  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
   8
   9  This program is free software; you can redistribute it and/or modify it under
  10  the terms of the GNU General Public License as published by the Free Software
  11  Foundation; either version 2 of the License, or (at your option) any later
  12  version.
  13
  14  This program is distributed in the hope that it will be useful, but WITHOUT
  15  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  details.
  18
  19  You should have received a copy of the GNU General Public License along with
  20  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  21  Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23  Further information about the GNU General Public License can also be found on
  24  the world wide web at http://www.gnu.org.
  25
  26 HISTORY
  27 --------------------------------------------------------------------------------
  28 12/02/98   JSB   Created
  29
  30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  31 COMMENTS, REFERENCES,  and NOTES
  32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  33 [1] Cooke, Zyda, Pratt, and McGhee, "NPSNET: Flight Simulation Dynamic Modeling
  34     Using Quaternions", Presence, Vol. 1, No. 4, pp. 404-420  Naval Postgraduate
  35     School, January 1994
  36 [2] D. M. Henderson, "Euler Angles, Quaternions, and Transformation Matrices",
  37     JSC 12960, July 1977
  38 [3] Richard E. McFarland, "A Standard Kinematic Model for Flight Simulation at
  39     NASA-Ames", NASA CR-2497, January 1975
  40 [4] Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics",
  41     Wiley & Sons, 1979 ISBN 0-471-03032-5
  42 [5] Bernard Etkin, "Dynamics of Flight, Stability and Control", Wiley & Sons,
  43     1982 ISBN 0-471-08936-2
  44
  45   The order of rotations used in this class corresponds to a 3-2-1 sequence,
  46   or Y-P-R, or Z-Y-X, if you prefer.
  47
  48 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  49 SENTRY
  50 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  51
  52 #ifndef FGROTATION_H
  53 #define FGROTATION_H
  54
  55 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  56 INCLUDES
  57 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  58
  59 #ifdef FGFS
  60 #  include <simgear/compiler.h>
  61 #  ifdef FG_HAVE_STD_INCLUDES
  62 #    include <cmath>
  63 #  else
  64 #    include <math.h>
  65 #  endif
  66 #else
  67 #  include <cmath>
  68 #endif
  69
  70 #ifndef M_PI
  71 #  include <simgear/constants.h>
  72 #  define M_PI FG_PI
  73 #endif
  74
  75 #include "FGModel.h"
  76 #include "FGMatrix.h"
  77
  78 #define ID_ROTATION "$Id$"
  79
  80 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  81 CLASS DECLARATION
  82 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  83
  84 class FGRotation : public FGModel
  85 {
  86 public:
  87   FGRotation(FGFDMExec*);
  88   ~FGRotation();
  89
  90   bool Run(void);
  91
  92   inline FGColumnVector GetPQR(void) {return vPQR;}
  93   inline FGColumnVector GetPQRdot(void) {return vPQRdot;}
  94   inline FGColumnVector GetEuler(void) {return vEuler;}
  95   inline FGColumnVector GetEulerRates(void) { return vEulerRates; }
  96   inline void SetPQR(FGColumnVector tt) {vPQR = tt;}
  97   inline void SetEuler(FGColumnVector tt) {vEuler = tt;}
  98
  99   inline float Getphi(void) {return vEuler(1);}
 100   inline float Gettht(void) {return vEuler(2);}
 101   inline float Getpsi(void) {return vEuler(3);}
 102
 103   inline float GetCosphi(void) {return cPhi;}
 104   inline float GetCostht(void) {return cTht;}
 105   inline float GetCospsi(void) {return cPsi;}
 106
 107   inline float GetSinphi(void) {return sPhi;}
 108   inline float GetSintht(void) {return sTht;}
 109   inline float GetSinpsi(void) {return sPsi;}
 110
 111 private:
 112   FGColumnVector vPQR;
 113   FGColumnVector vPQRdot;
 114   FGColumnVector vMoments;
 115   FGColumnVector vEuler;
 116   FGColumnVector vEulerRates;
 117
 118   float cTht,sTht;
 119   float cPhi,sPhi;
 120   float cPsi,sPsi;
 121
 122   float Ixx, Iyy, Izz, Ixz;
 123   float dt;
 124
 125   void GetState(void);
 126
 127   void Debug(void);
 128 };
 129
 130 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 131 #endif
 132