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