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 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 General Public License for more
  18  details.
  19
  20  You should have received a copy of the GNU 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 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.00007272205217;
  59   GM              = 14.06252720E15;
  60   RadiusReference = 20925650.00;
  61   gAccelReference = GM/(RadiusReference*RadiusReference);
  62   gAccel          = GM/(RadiusReference*RadiusReference);
  63
  64   Debug(0);
  65 }
  66
  67 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  68
  69 FGInertial::~FGInertial(void)
  70 {
  71   Debug(1);
  72 }
  73
  74 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  75
  76 bool FGInertial::Run(void)
  77 {
  78   // Fast return if we have nothing to do ...
  79   if (FGModel::Run()) return true;
  80   if (FDMExec->Holding()) return false;
  81
  82   // Gravitation accel
  83   double r = Propagate->GetRadius();
  84   gAccel = GetGAccel(r);
  85
  86   return false;
  87 }
  88
  89 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  90 //    The bitmasked value choices are as follows:
  91 //    unset: In this case (the default) JSBSim would only print
  92 //       out the normally expected messages, essentially echoing
  93 //       the config files as they are read. If the environment
  94 //       variable is not set, debug_lvl is set to 1 internally
  95 //    0: This requests JSBSim not to output any messages
  96 //       whatsoever.
  97 //    1: This value explicity requests the normal JSBSim
  98 //       startup messages
  99 //    2: This value asks for a message to be printed out when
 100 //       a class is instantiated
 101 //    4: When this value is set, a message is displayed when a
 102 //       FGModel object executes its Run() method
 103 //    8: When this value is set, various runtime state variables
 104 //       are printed out periodically
 105 //    16: When set various parameters are sanity checked and
 106 //       a message is printed out when they go out of bounds
 107
 108 void FGInertial::Debug(int from)
 109 {
 110   if (debug_lvl <= 0) return;
 111
 112   if (debug_lvl & 1) { // Standard console startup message output
 113     if (from == 0) { // Constructor
 114
 115     }
 116   }
 117   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 118     if (from == 0) cout << "Instantiated: FGInertial" << endl;
 119     if (from == 1) cout << "Destroyed:    FGInertial" << endl;
 120   }
 121   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 122   }
 123   if (debug_lvl & 8 ) { // Runtime state variables
 124   }
 125   if (debug_lvl & 16) { // Sanity checking
 126   }
 127   if (debug_lvl & 64) {
 128     if (from == 0) { // Constructor
 129       cout << IdSrc << endl;
 130       cout << IdHdr << endl;
 131     }
 132   }
 133 }
 134 }