src/FDM/JSBSim/models/FGMassBalance.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGMassBalance.cpp
   4  Author:       Jon S. Berndt
   5  Date started: 09/12/2000
   6  Purpose:      This module models weight and balance
   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 Lesser 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 Lesser General Public License for more
  18  details.
  19
  20  You should have received a copy of the GNU Lesser 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 Lesser 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 This class models the change in weight and balance of the aircraft due to fuel
  31 burnoff, etc.
  32
  33 HISTORY
  34 --------------------------------------------------------------------------------
  35 09/12/2000  JSB  Created
  36
  37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #include "FGMassBalance.h"
  42 #include "FGPropulsion.h"
  43 #include "FGBuoyantForces.h"
  44 #include <input_output/FGPropertyManager.h>
  45
  46 namespace JSBSim {
  47
  48 static const char *IdSrc = "$Id$";
  49 static const char *IdHdr = ID_MASSBALANCE;
  50
  51 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  52 CLASS IMPLEMENTATION
  53 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  54
  55
  56 FGMassBalance::FGMassBalance(FGFDMExec* fdmex) : FGModel(fdmex)
  57 {
  58   Name = "FGMassBalance";
  59   Weight = EmptyWeight = Mass = 0.0;
  60
  61   vbaseXYZcg.InitMatrix(0.0);
  62   baseJ.InitMatrix();
  63   mJ.InitMatrix();
  64   mJinv.InitMatrix();
  65   pmJ.InitMatrix();
  66
  67   bind();
  68
  69   Debug(0);
  70 }
  71
  72 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  73
  74 FGMassBalance::~FGMassBalance()
  75 {
  76   for (unsigned int i=0; i<PointMasses.size(); i++) delete PointMasses[i];
  77   PointMasses.clear();
  78
  79   Debug(1);
  80 }
  81
  82 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  83
  84 bool FGMassBalance::InitModel(void)
  85 {
  86   if (!FGModel::InitModel()) return false;
  87
  88   return true;
  89 }
  90
  91 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  92
  93 bool FGMassBalance::Load(Element* el)
  94 {
  95   Element *element;
  96   string element_name = "";
  97   double bixx, biyy, bizz, bixy, bixz, biyz;
  98
  99   bixx = biyy = bizz = bixy = bixz = biyz = 0.0;
 100   if (el->FindElement("ixx"))
 101     bixx = el->FindElementValueAsNumberConvertTo("ixx", "SLUG*FT2");
 102   if (el->FindElement("iyy"))
 103     biyy = el->FindElementValueAsNumberConvertTo("iyy", "SLUG*FT2");
 104   if (el->FindElement("izz"))
 105     bizz = el->FindElementValueAsNumberConvertTo("izz", "SLUG*FT2");
 106   if (el->FindElement("ixy"))
 107     bixy = el->FindElementValueAsNumberConvertTo("ixy", "SLUG*FT2");
 108   if (el->FindElement("ixz"))
 109     bixz = el->FindElementValueAsNumberConvertTo("ixz", "SLUG*FT2");
 110   if (el->FindElement("iyz"))
 111     biyz = el->FindElementValueAsNumberConvertTo("iyz", "SLUG*FT2");
 112   SetAircraftBaseInertias(FGMatrix33(  bixx,  -bixy,  bixz,
 113                                       -bixy,  biyy,  -biyz,
 114                                        bixz,  -biyz,  bizz ));
 115   EmptyWeight = el->FindElementValueAsNumberConvertTo("emptywt", "LBS");
 116
 117   element = el->FindElement("location");
 118   while (element) {
 119     element_name = element->GetAttributeValue("name");
 120     if (element_name == "CG") vbaseXYZcg = element->FindElementTripletConvertTo("IN");
 121     element = el->FindNextElement("location");
 122   }
 123
 124 // Find all POINTMASS elements that descend from this METRICS branch of the
 125 // config file.
 126
 127   element = el->FindElement("pointmass");
 128   while (element) {
 129     AddPointMass(element);
 130     element = el->FindNextElement("pointmass");
 131   }
 132
 133   Weight = EmptyWeight + Propulsion->GetTanksWeight() + GetTotalPointMassWeight()
 134     + BuoyantForces->GetGasMass()*slugtolb;
 135
 136   Mass = lbtoslug*Weight;
 137
 138   Debug(2);
 139   return true;
 140 }
 141
 142 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 143
 144 bool FGMassBalance::Run(void)
 145 {
 146   double denom, k1, k2, k3, k4, k5, k6;
 147   double Ixx, Iyy, Izz, Ixy, Ixz, Iyz;
 148
 149   if (FGModel::Run()) return true;
 150   if (FDMExec->Holding()) return false;
 151
 152   Weight = EmptyWeight + Propulsion->GetTanksWeight() + GetTotalPointMassWeight()
 153     + BuoyantForces->GetGasMass()*slugtolb;
 154
 155   Mass = lbtoslug*Weight;
 156
 157 // Calculate new CG
 158
 159   vXYZcg = (Propulsion->GetTanksMoment() + EmptyWeight*vbaseXYZcg
 160             + GetPointMassMoment()
 161             + BuoyantForces->GetGasMassMoment()) / Weight;
 162
 163 // Calculate new total moments of inertia
 164
 165   // At first it is the base configuration inertia matrix ...
 166   mJ = baseJ;
 167   // ... with the additional term originating from the parallel axis theorem.
 168   mJ += GetPointmassInertia( lbtoslug * EmptyWeight, vbaseXYZcg );
 169   // Then add the contributions from the additional pointmasses.
 170   mJ += CalculatePMInertias();
 171   mJ += Propulsion->CalculateTankInertias();
 172   mJ += BuoyantForces->GetGasMassInertia();
 173
 174   Ixx = mJ(1,1);
 175   Iyy = mJ(2,2);
 176   Izz = mJ(3,3);
 177   Ixy = -mJ(1,2);
 178   Ixz = -mJ(1,3);
 179   Iyz = -mJ(2,3);
 180
 181 // Calculate inertia matrix inverse (ref. Stevens and Lewis, "Flight Control & Simulation")
 182
 183   k1 = (Iyy*Izz - Iyz*Iyz);
 184   k2 = (Iyz*Ixz + Ixy*Izz);
 185   k3 = (Ixy*Iyz + Iyy*Ixz);
 186
 187   denom = 1.0/(Ixx*k1 - Ixy*k2 - Ixz*k3 );
 188   k1 = k1*denom;
 189   k2 = k2*denom;
 190   k3 = k3*denom;
 191   k4 = (Izz*Ixx - Ixz*Ixz)*denom;
 192   k5 = (Ixy*Ixz + Iyz*Ixx)*denom;
 193   k6 = (Ixx*Iyy - Ixy*Ixy)*denom;
 194
 195   mJinv.InitMatrix( k1, k2, k3,
 196                     k2, k4, k5,
 197                     k3, k5, k6 );
 198
 199   Debug(0);
 200
 201   return false;
 202 }
 203
 204 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 205
 206 void FGMassBalance::AddPointMass(Element* el)
 207 {
 208   Element* loc_element = el->FindElement("location");
 209   string pointmass_name = el->GetAttributeValue("name");
 210   if (!loc_element) {
 211     cerr << "Pointmass " << pointmass_name << " has no location." << endl;
 212     exit(-1);
 213   }
 214
 215   double w = el->FindElementValueAsNumberConvertTo("weight", "LBS");
 216   FGColumnVector3 vXYZ = loc_element->FindElementTripletConvertTo("IN");
 217
 218   PointMasses.push_back(new PointMass(w, vXYZ));
 219   PointMasses.back()->bind(PropertyManager, PointMasses.size()-1);
 220 }
 221
 222 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 223
 224 double FGMassBalance::GetTotalPointMassWeight(void)
 225 {
 226   double PM_total_weight = 0.0;
 227
 228   for (unsigned int i=0; i<PointMasses.size(); i++) {
 229     PM_total_weight += PointMasses[i]->Weight;
 230   }
 231   return PM_total_weight;
 232 }
 233
 234 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 235
 236 FGColumnVector3& FGMassBalance::GetPointMassMoment(void)
 237 {
 238   PointMassCG.InitMatrix();
 239
 240   for (unsigned int i=0; i<PointMasses.size(); i++) {
 241     PointMassCG += PointMasses[i]->Weight*PointMasses[i]->Location;
 242   }
 243   return PointMassCG;
 244 }
 245
 246 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 247
 248 FGMatrix33& FGMassBalance::CalculatePMInertias(void)
 249 {
 250   unsigned int size;
 251
 252   size = PointMasses.size();
 253   if (size == 0) return pmJ;
 254
 255   pmJ = FGMatrix33();
 256
 257   for (unsigned int i=0; i<size; i++)
 258     pmJ += GetPointmassInertia( lbtoslug * PointMasses[i]->Weight, PointMasses[i]->Location );
 259
 260   return pmJ;
 261 }
 262
 263 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 264
 265 FGColumnVector3 FGMassBalance::StructuralToBody(const FGColumnVector3& r) const
 266 {
 267   // Under the assumption that in the structural frame the:
 268   //
 269   // - X-axis is directed afterwards,
 270   // - Y-axis is directed towards the right,
 271   // - Z-axis is directed upwards,
 272   //
 273   // (as documented in http://jsbsim.sourceforge.net/JSBSimCoordinates.pdf)
 274   // we have to subtract first the center of gravity of the plane which
 275   // is also defined in the structural frame:
 276   //
 277   //   FGColumnVector3 cgOff = r - vXYZcg;
 278   //
 279   // Next, we do a change of units:
 280   //
 281   //   cgOff *= inchtoft;
 282   //
 283   // And then a 180 degree rotation is done about the Y axis so that the:
 284   //
 285   // - X-axis is directed forward,
 286   // - Y-axis is directed towards the right,
 287   // - Z-axis is directed downward.
 288   //
 289   // This is needed because the structural and body frames are 180 degrees apart.
 290
 291   return FGColumnVector3(inchtoft*(vXYZcg(1)-r(1)),
 292                          inchtoft*(r(2)-vXYZcg(2)),
 293                          inchtoft*(vXYZcg(3)-r(3)));
 294 }
 295
 296 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 297
 298 void FGMassBalance::bind(void)
 299 {
 300   typedef double (FGMassBalance::*PMF)(int) const;
 301   PropertyManager->Tie("inertia/mass-slugs", this,
 302                        &FGMassBalance::GetMass);
 303   PropertyManager->Tie("inertia/weight-lbs", this,
 304                        &FGMassBalance::GetWeight);
 305   PropertyManager->Tie("inertia/empty-weight-lbs", this,
 306     &FGMassBalance::GetWeight, &FGMassBalance::SetEmptyWeight);
 307   PropertyManager->Tie("inertia/cg-x-in", this,1,
 308                        (PMF)&FGMassBalance::GetXYZcg);
 309   PropertyManager->Tie("inertia/cg-y-in", this,2,
 310                        (PMF)&FGMassBalance::GetXYZcg);
 311   PropertyManager->Tie("inertia/cg-z-in", this,3,
 312                        (PMF)&FGMassBalance::GetXYZcg);
 313 }
 314
 315 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 316 //    The bitmasked value choices are as follows:
 317 //    unset: In this case (the default) JSBSim would only print
 318 //       out the normally expected messages, essentially echoing
 319 //       the config files as they are read. If the environment
 320 //       variable is not set, debug_lvl is set to 1 internally
 321 //    0: This requests JSBSim not to output any messages
 322 //       whatsoever.
 323 //    1: This value explicity requests the normal JSBSim
 324 //       startup messages
 325 //    2: This value asks for a message to be printed out when
 326 //       a class is instantiated
 327 //    4: When this value is set, a message is displayed when a
 328 //       FGModel object executes its Run() method
 329 //    8: When this value is set, various runtime state variables
 330 //       are printed out periodically
 331 //    16: When set various parameters are sanity checked and
 332 //       a message is printed out when they go out of bounds
 333
 334 void FGMassBalance::Debug(int from)
 335 {
 336   if (debug_lvl <= 0) return;
 337
 338   if (debug_lvl & 1) { // Standard console startup message output
 339     if (from == 2) { // Loading
 340       cout << endl << "  Mass and Balance:" << endl;
 341       cout << "    baseIxx: " << baseJ(1,1) << " slug-ft2" << endl;
 342       cout << "    baseIyy: " << baseJ(2,2) << " slug-ft2" << endl;
 343       cout << "    baseIzz: " << baseJ(3,3) << " slug-ft2" << endl;
 344       cout << "    baseIxy: " << baseJ(1,2) << " slug-ft2" << endl;
 345       cout << "    baseIxz: " << baseJ(1,3) << " slug-ft2" << endl;
 346       cout << "    baseIyz: " << baseJ(2,3) << " slug-ft2" << endl;
 347       cout << "    EmptyWeight: " << EmptyWeight << " lbm" << endl;
 348       cout << "    CG (x, y, z): " << vbaseXYZcg << endl;
 349       // ToDo: Need to add point mass outputs here
 350       for (unsigned int i=0; i<PointMasses.size(); i++) {
 351         cout << "    Point Mass Object: " << PointMasses[i]->Weight << " lbs. at "
 352                    << "X, Y, Z (in.): " << PointMasses[i]->Location(eX) << "  "
 353                    << PointMasses[i]->Location(eY) << "  "
 354                    << PointMasses[i]->Location(eZ) << endl;
 355       }
 356     }
 357   }
 358   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 359     if (from == 0) cout << "Instantiated: FGMassBalance" << endl;
 360     if (from == 1) cout << "Destroyed:    FGMassBalance" << endl;
 361   }
 362   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 363   }
 364   if (debug_lvl & 8 ) { // Runtime state variables
 365   }
 366   if (debug_lvl & 16) { // Sanity checking
 367     if (from == 2) {
 368       if (EmptyWeight <= 0.0 || EmptyWeight > 1e9)
 369         cout << "MassBalance::EmptyWeight out of bounds: " << EmptyWeight << endl;
 370       if (Weight <= 0.0 || Weight > 1e9)
 371         cout << "MassBalance::Weight out of bounds: " << Weight << endl;
 372       if (Mass <= 0.0 || Mass > 1e9)
 373         cout << "MassBalance::Mass out of bounds: " << Mass << endl;
 374     }
 375   }
 376   if (debug_lvl & 64) {
 377     if (from == 0) { // Constructor
 378       cout << IdSrc << endl;
 379       cout << IdHdr << endl;
 380     }
 381   }
 382 }
 383 }