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 namespace JSBSim {
  43
  44 static const char *IdSrc = "$Id$";
  45 static const char *IdHdr = ID_INERTIAL;
  46
  47 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  48 CLASS IMPLEMENTATION
  49 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  50
  51
  52 FGInertial::FGInertial(FGFDMExec* fgex) : FGModel(fgex)
  53 {
  54   Name = "FGInertial";
  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   vRadius.InitMatrix();
  63   vCoriolis.InitMatrix();
  64   vCentrifugal.InitMatrix();
  65   vGravity.InitMatrix();
  66
  67   bind();
  68
  69   Debug(0);
  70 }
  71
  72 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  73
  74 FGInertial::~FGInertial(void)
  75 {
  76   unbind();
  77   Debug(1);
  78 }
  79
  80 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  81
  82 bool FGInertial::Run(void)
  83 {
  84   if (!FGModel::Run()) {
  85
  86     gAccel = GM / (Position->GetRadius()*Position->GetRadius());
  87
  88     vGravity(eDown) = gAccel;
  89
  90     // The following equation for vOmegaLocal terms shows the angular velocity
  91     // calculation _for_the_local_frame_ given the earth's rotation (first set)
  92     // at the current latitude, and also the component due to the aircraft
  93     // motion over the curved surface of the earth (second set).
  94
  95     vOmegaLocal(eX) = omega() * cos(Position->GetLatitude());
  96     vOmegaLocal(eY) = 0.0;
  97     vOmegaLocal(eZ) = omega() * -sin(Position->GetLatitude());
  98
  99     vOmegaLocal(eX) +=  Position->GetVe() / Position->GetRadius();
 100     vOmegaLocal(eY) += -Position->GetVn() / Position->GetRadius();
 101     vOmegaLocal(eZ) +=  0.00;
 102
 103     // Coriolis acceleration is normally written: -2w*dr/dt, but due to the axis
 104     // conventions used here the sign is reversed: 2w*dr/dt. The same is true for
 105     // Centrifugal acceleration.
 106
 107     vCoriolis(eEast) = 2.0*omega() * (Position->GetVd()*cos(Position->GetLatitude()) +
 108                                       Position->GetVn()*sin(Position->GetLatitude()));
 109
 110     vRadius(eDown) = Position->GetRadius();
 111     vCentrifugal(eDown) = -vOmegaLocal.Magnitude() * vOmegaLocal.Magnitude() * vRadius(eDown);
 112
 113     vForces = State->GetTl2b() * MassBalance->GetMass() * (vCoriolis + vCentrifugal + vGravity);
 114
 115     return false;
 116   } else {
 117     return true;
 118   }
 119 }
 120
 121 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 122
 123 bool FGInertial::LoadInertial(FGConfigFile* AC_cfg)
 124 {
 125   return true;
 126 }
 127
 128 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 129
 130 void FGInertial::bind(void)
 131 {
 132   typedef double (FGInertial::*PMF)(int) const;
 133   PropertyManager->Tie("forces/fbx-inertial-lbs", this,1,
 134                        (PMF)&FGInertial::GetForces);
 135   PropertyManager->Tie("forces/fby-inertial-lbs", this,2,
 136                        (PMF)&FGInertial::GetForces);
 137   PropertyManager->Tie("forces/fbz-inertial-lbs", this,3,
 138                        (PMF)&FGInertial::GetForces);
 139 }
 140
 141 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 142
 143 void FGInertial::unbind(void)
 144 {
 145   PropertyManager->Untie("forces/fbx-inertial-lbs");
 146   PropertyManager->Untie("forces/fby-inertial-lbs");
 147   PropertyManager->Untie("forces/fbz-inertial-lbs");
 148 }
 149
 150 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 151 //    The bitmasked value choices are as follows:
 152 //    unset: In this case (the default) JSBSim would only print
 153 //       out the normally expected messages, essentially echoing
 154 //       the config files as they are read. If the environment
 155 //       variable is not set, debug_lvl is set to 1 internally
 156 //    0: This requests JSBSim not to output any messages
 157 //       whatsoever.
 158 //    1: This value explicity requests the normal JSBSim
 159 //       startup messages
 160 //    2: This value asks for a message to be printed out when
 161 //       a class is instantiated
 162 //    4: When this value is set, a message is displayed when a
 163 //       FGModel object executes its Run() method
 164 //    8: When this value is set, various runtime state variables
 165 //       are printed out periodically
 166 //    16: When set various parameters are sanity checked and
 167 //       a message is printed out when they go out of bounds
 168
 169 void FGInertial::Debug(int from)
 170 {
 171   if (debug_lvl <= 0) return;
 172
 173   if (debug_lvl & 1) { // Standard console startup message output
 174     if (from == 0) { // Constructor
 175
 176     }
 177   }
 178   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 179     if (from == 0) cout << "Instantiated: FGInertial" << endl;
 180     if (from == 1) cout << "Destroyed:    FGInertial" << endl;
 181   }
 182   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 183   }
 184   if (debug_lvl & 8 ) { // Runtime state variables
 185   }
 186   if (debug_lvl & 16) { // Sanity checking
 187   }
 188   if (debug_lvl & 64) {
 189     if (from == 0) { // Constructor
 190       cout << IdSrc << endl;
 191       cout << IdHdr << endl;
 192     }
 193   }
 194 }
 195 }