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 (jsb@hal-pc.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 "FGPropagate.h"
  40 #include "FGState.h"
  41 #include "FGMassBalance.h"
  42
  43 namespace JSBSim {
  44
  45 static const char *IdSrc = "$Id$";
  46 static const char *IdHdr = ID_INERTIAL;
  47
  48 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  49 CLASS IMPLEMENTATION
  50 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  51
  52
  53 FGInertial::FGInertial(FGFDMExec* fgex) : FGModel(fgex)
  54 {
  55   Name = "FGInertial";
  56
  57   // Defaults
  58   RotationRate    = 0.00007292115;
  59   GM              = 14.07644180E15;     // WGS84 value
  60   RadiusReference = 20925650.00;        // Equatorial radius (WGS84)
  61   C2_0            = -4.84165371736E-04; // WGS84 value for the C2,0 coefficient
  62   J2              = 1.0826266836E-03;   // WGS84 value for J2
  63   a               = 20925646.3255;      // WGS84 semimajor axis length in feet
  64   b               = 20855486.5951;      // WGS84 semiminor axis length in feet
  65   earthPosAngle   = 0.0;
  66
  67   gAccelReference = GM/(RadiusReference*RadiusReference);
  68   gAccel          = GM/(RadiusReference*RadiusReference);
  69
  70   bind();
  71
  72   Debug(0);
  73 }
  74
  75 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  76
  77 FGInertial::~FGInertial(void)
  78 {
  79   Debug(1);
  80 }
  81
  82 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  83
  84 bool FGInertial::InitModel(void)
  85 {
  86   if (!FGModel::InitModel()) return false;
  87
  88   earthPosAngle   = 0.0;
  89
  90   return true;
  91 }
  92
  93 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  94
  95 bool FGInertial::Run(void)
  96 {
  97   // Fast return if we have nothing to do ...
  98   if (FGModel::Run()) return true;
  99   if (FDMExec->Holding()) return false;
 100
 101   // Gravitation accel
 102   double r = Propagate->GetRadius();
 103   gAccel = GetGAccel(r);
 104   earthPosAngle += State->Getdt()*RotationRate;
 105
 106   return false;
 107 }
 108
 109 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 110
 111 double FGInertial::GetGAccel(double r) const
 112 {
 113   return GM/(r*r);
 114 }
 115
 116 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 117
 118 void FGInertial::bind(void)
 119 {
 120   PropertyManager->Tie("position/epa-rad", this, &FGInertial::GetEarthPositionAngle);
 121 }
 122
 123 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 124 //    The bitmasked value choices are as follows:
 125 //    unset: In this case (the default) JSBSim would only print
 126 //       out the normally expected messages, essentially echoing
 127 //       the config files as they are read. If the environment
 128 //       variable is not set, debug_lvl is set to 1 internally
 129 //    0: This requests JSBSim not to output any messages
 130 //       whatsoever.
 131 //    1: This value explicity requests the normal JSBSim
 132 //       startup messages
 133 //    2: This value asks for a message to be printed out when
 134 //       a class is instantiated
 135 //    4: When this value is set, a message is displayed when a
 136 //       FGModel object executes its Run() method
 137 //    8: When this value is set, various runtime state variables
 138 //       are printed out periodically
 139 //    16: When set various parameters are sanity checked and
 140 //       a message is printed out when they go out of bounds
 141
 142 void FGInertial::Debug(int from)
 143 {
 144   if (debug_lvl <= 0) return;
 145
 146   if (debug_lvl & 1) { // Standard console startup message output
 147     if (from == 0) { // Constructor
 148
 149     }
 150   }
 151   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 152     if (from == 0) cout << "Instantiated: FGInertial" << endl;
 153     if (from == 1) cout << "Destroyed:    FGInertial" << endl;
 154   }
 155   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 156   }
 157   if (debug_lvl & 8 ) { // Runtime state variables
 158   }
 159   if (debug_lvl & 16) { // Sanity checking
 160   }
 161   if (debug_lvl & 64) {
 162     if (from == 0) { // Constructor
 163       cout << IdSrc << endl;
 164       cout << IdHdr << endl;
 165     }
 166   }
 167 }
 168 }