src/FDM/JSBSim/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 #ifdef HAVE_CONFIG_H
  39 #  include <config.h>
  40 #endif
  41
  42 #include "FGInertial.h"
  43 #include "FGPropagate.h"
  44 #include "FGState.h"
  45 #include "FGMassBalance.h"
  46
  47 namespace JSBSim {
  48
  49 static const char *IdSrc = "$Id$";
  50 static const char *IdHdr = ID_INERTIAL;
  51
  52 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  53 CLASS IMPLEMENTATION
  54 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  55
  56
  57 FGInertial::FGInertial(FGFDMExec* fgex) : FGModel(fgex)
  58 {
  59   Name = "FGInertial";
  60
  61   // Defaults
  62   RotationRate    = 0.00007272205217;
  63   GM              = 14.06252720E15;
  64   RadiusReference = 20925650.00;
  65   gAccelReference = GM/(RadiusReference*RadiusReference);
  66   gAccel          = GM/(RadiusReference*RadiusReference);
  67
  68   Debug(0);
  69 }
  70
  71 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  72
  73 FGInertial::~FGInertial(void)
  74 {
  75   Debug(1);
  76 }
  77
  78 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  79
  80 bool FGInertial::Run(void)
  81 {
  82   // Fast return if we have nothing to do ...
  83   if (FGModel::Run()) return true;
  84
  85   // Gravitation accel
  86   double r = Propagate->GetRadius();
  87   gAccel = GetGAccel(r);
  88
  89   return false;
  90 }
  91
  92 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  93
  94 bool FGInertial::LoadInertial(FGConfigFile* AC_cfg)
  95 {
  96   return true;
  97 }
  98
  99 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 100
 101 //    The bitmasked value choices are as follows:
 102 //    unset: In this case (the default) JSBSim would only print
 103 //       out the normally expected messages, essentially echoing
 104 //       the config files as they are read. If the environment
 105 //       variable is not set, debug_lvl is set to 1 internally
 106 //    0: This requests JSBSim not to output any messages
 107 //       whatsoever.
 108 //    1: This value explicity requests the normal JSBSim
 109 //       startup messages
 110 //    2: This value asks for a message to be printed out when
 111 //       a class is instantiated
 112 //    4: When this value is set, a message is displayed when a
 113 //       FGModel object executes its Run() method
 114 //    8: When this value is set, various runtime state variables
 115 //       are printed out periodically
 116 //    16: When set various parameters are sanity checked and
 117 //       a message is printed out when they go out of bounds
 118
 119 void FGInertial::Debug(int from)
 120 {
 121   if (debug_lvl <= 0) return;
 122
 123   if (debug_lvl & 1) { // Standard console startup message output
 124     if (from == 0) { // Constructor
 125
 126     }
 127   }
 128   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 129     if (from == 0) cout << "Instantiated: FGInertial" << endl;
 130     if (from == 1) cout << "Destroyed:    FGInertial" << endl;
 131   }
 132   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 133   }
 134   if (debug_lvl & 8 ) { // Runtime state variables
 135   }
 136   if (debug_lvl & 16) { // Sanity checking
 137   }
 138   if (debug_lvl & 64) {
 139     if (from == 0) { // Constructor
 140       cout << IdSrc << endl;
 141       cout << IdHdr << endl;
 142     }
 143   }
 144 }
 145 }