src/FDM/JSBSim/models/FGInertial.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGInertial.cpp
   4  Author:       Jon S. Berndt
   5  Date started: 09/13/00
   6  Purpose:      Encapsulates the inertial frame forces (coriolis and centrifugal)
   7
   8  ------------- Copyright (C) 2000  Jon S. Berndt (jon@jsbsim.org) -------------
   9
  10  This program is free software; you can redistribute it and/or modify it under
  11  the terms of the GNU Lesser General Public License as published by the Free Software
  12  Foundation; either version 2 of the License, or (at your option) any later
  13  version.
  14
  15  This program is distributed in the hope that it will be useful, but WITHOUT
  16  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
  18  details.
  19
  20  You should have received a copy of the GNU Lesser General Public License along with
  21  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  22  Place - Suite 330, Boston, MA  02111-1307, USA.
  23
  24  Further information about the GNU Lesser General Public License can also be found on
  25  the world wide web at http://www.gnu.org.
  26
  27 FUNCTIONAL DESCRIPTION
  28 --------------------------------------------------------------------------------
  29
  30 HISTORY
  31 --------------------------------------------------------------------------------
  32 09/13/00   JSB   Created
  33
  34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  35 INCLUDES
  36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  37
  38 #include "FGInertial.h"
  39 #include <FGFDMExec.h>
  40 #include "FGPropagate.h"
  41 #include "FGState.h"
  42 #include "FGMassBalance.h"
  43
  44 namespace JSBSim {
  45
  46 static const char *IdSrc = "$Id$";
  47 static const char *IdHdr = ID_INERTIAL;
  48
  49 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  50 CLASS IMPLEMENTATION
  51 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  52
  53
  54 FGInertial::FGInertial(FGFDMExec* fgex) : FGModel(fgex)
  55 {
  56   Name = "FGInertial";
  57
  58   // Earth defaults
  59   RotationRate    = 0.00007292115;
  60   GM              = 14.07644180E15;     // WGS84 value
  61   RadiusReference = 20925650.00;        // Equatorial radius (WGS84)
  62   C2_0            = -4.84165371736E-04; // WGS84 value for the C2,0 coefficient
  63   J2              = 1.0826266836E-03;   // WGS84 value for J2
  64   a               = 20925646.3255;      // WGS84 semimajor axis length in feet
  65   b               = 20855486.5951;      // WGS84 semiminor axis length in feet
  66   earthPosAngle   = 0.0;
  67
  68   // Lunar defaults
  69   /*
  70   RotationRate    = 0.0000026617;
  71   GM              = 1.7314079E14;         // Lunar GM
  72   RadiusReference = 5702559.05;           // Equatorial radius
  73   C2_0            = 0;                    // value for the C2,0 coefficient
  74   J2              = 2.033542482111609E-4; // value for J2
  75   a               = 5702559.05;           // semimajor axis length in feet
  76   b               = 5695439.63;           // semiminor axis length in feet
  77   earthPosAngle   = 0.0;
  78   */
  79
  80   gAccelReference = GM/(RadiusReference*RadiusReference);
  81   gAccel          = GM/(RadiusReference*RadiusReference);
  82
  83   bind();
  84
  85   Debug(0);
  86 }
  87
  88 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  89
  90 FGInertial::~FGInertial(void)
  91 {
  92   Debug(1);
  93 }
  94
  95 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  96
  97 bool FGInertial::InitModel(void)
  98 {
  99   if (!FGModel::InitModel()) return false;
 100
 101   earthPosAngle   = 0.0;
 102
 103   return true;
 104 }
 105
 106 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 107
 108 bool FGInertial::Run(void)
 109 {
 110   // Fast return if we have nothing to do ...
 111   if (FGModel::Run()) return true;
 112   if (FDMExec->Holding()) return false;
 113
 114   // Gravitation accel
 115   double r = Propagate->GetRadius();
 116   gAccel = GetGAccel(r);
 117   earthPosAngle += State->Getdt()*RotationRate;
 118
 119   return false;
 120 }
 121
 122 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 123
 124 double FGInertial::GetGAccel(double r) const
 125 {
 126   return GM/(r*r);
 127 }
 128
 129 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 130
 131 void FGInertial::bind(void)
 132 {
 133   PropertyManager->Tie("position/epa-rad", this, &FGInertial::GetEarthPositionAngle);
 134 }
 135
 136 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 137 //    The bitmasked value choices are as follows:
 138 //    unset: In this case (the default) JSBSim would only print
 139 //       out the normally expected messages, essentially echoing
 140 //       the config files as they are read. If the environment
 141 //       variable is not set, debug_lvl is set to 1 internally
 142 //    0: This requests JSBSim not to output any messages
 143 //       whatsoever.
 144 //    1: This value explicity requests the normal JSBSim
 145 //       startup messages
 146 //    2: This value asks for a message to be printed out when
 147 //       a class is instantiated
 148 //    4: When this value is set, a message is displayed when a
 149 //       FGModel object executes its Run() method
 150 //    8: When this value is set, various runtime state variables
 151 //       are printed out periodically
 152 //    16: When set various parameters are sanity checked and
 153 //       a message is printed out when they go out of bounds
 154
 155 void FGInertial::Debug(int from)
 156 {
 157   if (debug_lvl <= 0) return;
 158
 159   if (debug_lvl & 1) { // Standard console startup message output
 160     if (from == 0) { // Constructor
 161
 162     }
 163   }
 164   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 165     if (from == 0) cout << "Instantiated: FGInertial" << endl;
 166     if (from == 1) cout << "Destroyed:    FGInertial" << endl;
 167   }
 168   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 169   }
 170   if (debug_lvl & 8 ) { // Runtime state variables
 171   }
 172   if (debug_lvl & 16) { // Sanity checking
 173   }
 174   if (debug_lvl & 64) {
 175     if (from == 0) { // Constructor
 176       cout << IdSrc << endl;
 177       cout << IdHdr << endl;
 178     }
 179   }
 180 }
 181 }