src/FDM/JSBSim/models/FGInertial.h

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Header:       FGInertial.h
   4  Author:       Jon S. Berndt
   5  Date started: 09/13/00
   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 Lesser 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 Lesser General Public License for more
  17  details.
  18
  19  You should have received a copy of the GNU Lesser 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 Lesser General Public License can also be found on
  24  the world wide web at http://www.gnu.org.
  25
  26 HISTORY
  27 --------------------------------------------------------------------------------
  28 09/13/00   JSB   Created
  29
  30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  31 SENTRY
  32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  33
  34 #ifndef FGINERTIAL_H
  35 #define FGINERTIAL_H
  36
  37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #ifdef FGFS
  42 #  include <simgear/compiler.h>
  43 #  ifdef SG_HAVE_STD_INCLUDES
  44 #    include <vector>
  45 #  else
  46 #    include <vector.h>
  47 #  endif
  48 #else
  49 #  include <vector>
  50 #endif
  51
  52 #include "FGModel.h"
  53 #include <math/FGColumnVector3.h>
  54
  55 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  56 DEFINITIONS
  57 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  58
  59 #define ID_INERTIAL "$Id$"
  60
  61 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  62 FORWARD DECLARATIONS
  63 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  64
  65 namespace JSBSim {
  66
  67 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  68 CLASS DOCUMENTATION
  69 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  70
  71 /** Models inertial forces (e.g. centripetal and coriolis accelerations). Starting
  72     conversion to WGS84.
  73   */
  74
  75 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  76 CLASS DECLARATION
  77 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  78
  79 class FGInertial : public FGModel {
  80
  81 public:
  82   FGInertial(FGFDMExec*);
  83   ~FGInertial(void);
  84
  85   bool InitModel(void);
  86
  87   bool Run(void);
  88   double SLgravity(void) const {return gAccelReference;}
  89   double gravity(void) const {return gAccel;}
  90   double omega(void) const {return RotationRate;}
  91   double GetEarthPositionAngle(void) const { return earthPosAngle; }
  92   double GetEarthPositionAngleDeg(void) const { return earthPosAngle*radtodeg;}
  93   double GetGAccel(double r) const;
  94   double GetRefRadius(void) const {return RadiusReference;}
  95   double GetSemimajor(void) const {return a;}
  96   double GetSemiminor(void) const {return b;}
  97
  98 private:
  99   double gAccel;
 100   double gAccelReference;
 101   double RadiusReference;
 102   double RotationRate;
 103   double earthPosAngle;
 104   double GM;
 105   double C2_0; // WGS84 value for the C2,0 coefficient
 106   double J2;   // WGS84 value for J2
 107   double a;    // WGS84 semimajor axis length in feet
 108   double b;    // WGS84 semiminor axis length in feet
 109
 110   void bind(void);
 111   void Debug(int from);
 112 };
 113 }
 114 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 115 #endif