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 #include "FGInertial.h"
  39 #include "FGPosition.h"
  40 #include "FGMassBalance.h"
  41
  42 static const char *IdSrc = "$Id$";
  43 static const char *IdHdr = ID_INERTIAL;
  44
  45 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  46 CLASS IMPLEMENTATION
  47 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  48
  49
  50 FGInertial::FGInertial(FGFDMExec* fgex) : FGModel(fgex)
  51 {
  52   Name = "FGInertial";
  53
  54   vRadius.InitMatrix();
  55
  56   // Defaults
  57   RotationRate    = 0.00007272205217;
  58   GM              = 14.06252720E15;
  59   RadiusReference = 20925650.00;
  60   gAccelReference = GM/(RadiusReference*RadiusReference);
  61   gAccel          = GM/(RadiusReference*RadiusReference);
  62
  63   Debug(0);
  64 }
  65
  66 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  67
  68 FGInertial::~FGInertial(void)
  69 {
  70   Debug(1);
  71 }
  72
  73 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  74
  75 bool FGInertial::Run(void)
  76 {
  77   double stht, ctht, sphi, cphi;
  78
  79   if (!FGModel::Run()) {
  80
  81     gAccel = GM / (Position->GetRadius()*Position->GetRadius());
  82
  83     stht = sin(Rotation->GetEuler(eTht));
  84     ctht = cos(Rotation->GetEuler(eTht));
  85     sphi = sin(Rotation->GetEuler(ePhi));
  86     cphi = cos(Rotation->GetEuler(ePhi));
  87
  88     vGravity(eX) = vForces(eX) = -gravity()*stht;
  89     vGravity(eY) = vForces(eY) =  gravity()*sphi*ctht;
  90     vGravity(eZ) = vForces(eZ) =  gravity()*cphi*ctht;
  91
  92     // The following equation for vOmegaLocal terms shows the angular velocity
  93     // calculation _for_the_local_frame_ given the earth's rotation (first set)
  94     // at the current latitude, and also the component due to the aircraft
  95     // motion over the curved surface of the earth (second set).
  96
  97     vOmegaLocal(eX) = omega() * cos(Position->GetLatitude());
  98     vOmegaLocal(eY) = 0.0;
  99     vOmegaLocal(eZ) = omega() * -sin(Position->GetLatitude());
 100
 101     vOmegaLocal(eX) +=  Position->GetVe() / Position->GetRadius();
 102     vOmegaLocal(eY) += -Position->GetVn() / Position->GetRadius();
 103     vOmegaLocal(eZ) +=  0.00;
 104
 105 //    vForces = State->GetTl2b()*(-2.0*vOmegaLocal * Position->GetVel());
 106
 107     vRadius(3) = Position->GetRadius();
 108     vForces += State->GetTl2b()*(vOmegaLocal * (vOmegaLocal * vRadius));
 109
 110     vForces *= MassBalance->GetMass(); // IMPORTANT !!!!!!!!!!!!!!!!!!!!!!!!!!!!
 111
 112     return false;
 113   } else {
 114     return true;
 115   }
 116 }
 117
 118 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 119
 120 bool FGInertial::LoadInertial(FGConfigFile* AC_cfg)
 121 {
 122   return true;
 123 }
 124
 125 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 126 //    The bitmasked value choices are as follows:
 127 //    unset: In this case (the default) JSBSim would only print
 128 //       out the normally expected messages, essentially echoing
 129 //       the config files as they are read. If the environment
 130 //       variable is not set, debug_lvl is set to 1 internally
 131 //    0: This requests JSBSim not to output any messages
 132 //       whatsoever.
 133 //    1: This value explicity requests the normal JSBSim
 134 //       startup messages
 135 //    2: This value asks for a message to be printed out when
 136 //       a class is instantiated
 137 //    4: When this value is set, a message is displayed when a
 138 //       FGModel object executes its Run() method
 139 //    8: When this value is set, various runtime state variables
 140 //       are printed out periodically
 141 //    16: When set various parameters are sanity checked and
 142 //       a message is printed out when they go out of bounds
 143
 144 void FGInertial::Debug(int from)
 145 {
 146   if (debug_lvl <= 0) return;
 147
 148   if (debug_lvl & 1) { // Standard console startup message output
 149     if (from == 0) { // Constructor
 150
 151     }
 152   }
 153   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 154     if (from == 0) cout << "Instantiated: FGInertial" << endl;
 155     if (from == 1) cout << "Destroyed:    FGInertial" << endl;
 156   }
 157   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 158   }
 159   if (debug_lvl & 8 ) { // Runtime state variables
 160   }
 161   if (debug_lvl & 16) { // Sanity checking
 162   }
 163   if (debug_lvl & 64) {
 164     if (from == 0) { // Constructor
 165       cout << IdSrc << endl;
 166       cout << IdHdr << endl;
 167     }
 168   }
 169 }
 170