src/FDM/JSBSim/FGEngine.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGEngine.cpp
   4  Author:       Jon Berndt
   5  Date started: 01/21/99
   6  Called by:    FGAircraft
   7
   8  ------------- Copyright (C) 1999  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 See header file.
  30
  31 HISTORY
  32 --------------------------------------------------------------------------------
  33 01/21/99   JSB   Created
  34 09/03/99   JSB   Changed Rocket thrust equation to correct -= Thrust instead of
  35                  += Thrust (thanks to Tony Peden)
  36
  37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #ifdef FGFS
  42 #  include <simgear/compiler.h>
  43 #  ifdef SG_HAVE_STD_INCLUDES
  44 #    include <fstream>
  45 #  else
  46 #    include <fstream.h>
  47 #  endif
  48 #else
  49 #  if defined(sgi) && !defined(__GNUC__) && (_COMPILER_VERSION < 740)
  50 #    include <fstream.h>
  51 #  else
  52 #    include <fstream>
  53 #  endif
  54 #endif
  55
  56 #include "FGEngine.h"
  57 #include "FGTank.h"
  58 #include "FGPropeller.h"
  59 #include "FGNozzle.h"
  60
  61 namespace JSBSim {
  62
  63 static const char *IdSrc = "$Id$";
  64 static const char *IdHdr = ID_ENGINE;
  65
  66 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  67 CLASS IMPLEMENTATION
  68 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  69
  70
  71 FGEngine::FGEngine(FGFDMExec* exec, int engine_number) : EngineNumber(engine_number)
  72 {
  73   Name = "";
  74   Type = etUnknown;
  75   X = Y = Z = 0.0;
  76   EnginePitch = EngineYaw = 0.0;
  77   SLFuelFlowMax = SLOxiFlowMax = 0.0;
  78   MaxThrottle = 1.0;
  79   MinThrottle = 0.0;
  80   Thrust = 0.0;
  81   Throttle = 0.0;
  82   Mixture = 1.0;
  83   Starter = false;
  84   FuelNeed = OxidizerNeed = 0.0;
  85   Starved = Running = Cranking = false;
  86   PctPower = 0.0;
  87   TrimMode = false;
  88   FuelFlow_gph = 0.0;
  89   FuelFlow_pph = 0.0;
  90   FuelFreeze = false;
  91
  92   FDMExec = exec;
  93   State = FDMExec->GetState();
  94   Atmosphere = FDMExec->GetAtmosphere();
  95   FCS = FDMExec->GetFCS();
  96   Propulsion = FDMExec->GetPropulsion();
  97   Aircraft = FDMExec->GetAircraft();
  98   Propagate = FDMExec->GetPropagate();
  99   Auxiliary = FDMExec->GetAuxiliary();
 100   Output = FDMExec->GetOutput();
 101
 102   PropertyManager = FDMExec->GetPropertyManager();
 103
 104   char property_name[80];
 105   snprintf(property_name, 80, "propulsion/engine[%u]/thrust", EngineNumber);
 106   PropertyManager->Tie( property_name, &Thrust);
 107
 108   Debug(0);
 109 }
 110
 111 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 112
 113 FGEngine::~FGEngine()
 114 {
 115   if (Thruster) delete Thruster;
 116
 117   char property_name[80];
 118   snprintf(property_name, 80, "propulsion/engine[%u]/thrust", EngineNumber);
 119   PropertyManager->Untie( property_name);
 120
 121   Debug(1);
 122 }
 123
 124 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 125 // This base class function should be called from within the
 126 // derived class' Calculate() function before any other calculations are done.
 127 // This base class method removes fuel from the fuel tanks as appropriate,
 128 // and sets the starved flag if necessary.
 129
 130 void FGEngine::ConsumeFuel(void)
 131 {
 132   if (FuelFreeze) return;
 133   unsigned int i;
 134   double Fshortage, Oshortage, TanksWithFuel;
 135   FGTank* Tank;
 136
 137   if (TrimMode) return;
 138   Fshortage = Oshortage = TanksWithFuel = 0.0;
 139
 140   // count how many assigned tanks have fuel
 141   for (i=0; i<SourceTanks.size(); i++) {
 142     Tank = Propulsion->GetTank(SourceTanks[i]);
 143     if (Tank->GetContents() > 0.0) {
 144       ++TanksWithFuel;
 145     }
 146   }
 147   if (!TanksWithFuel) return;
 148
 149   for (i=0; i<SourceTanks.size(); i++) {
 150     Tank = Propulsion->GetTank(SourceTanks[i]);
 151     if (Tank->GetType() == FGTank::ttFUEL) {
 152        Fshortage += Tank->Drain(CalcFuelNeed()/TanksWithFuel);
 153     } else {
 154        Oshortage += Tank->Drain(CalcOxidizerNeed()/TanksWithFuel);
 155     }
 156   }
 157
 158   if (Fshortage < 0.00 || Oshortage < 0.00) Starved = true;
 159   else Starved = false;
 160 }
 161
 162 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 163
 164 double FGEngine::CalcFuelNeed(void)
 165 {
 166   FuelNeed = SLFuelFlowMax*PctPower*State->Getdt()*Propulsion->GetRate();
 167   return FuelNeed;
 168 }
 169
 170 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 171
 172 double FGEngine::CalcOxidizerNeed(void)
 173 {
 174   OxidizerNeed = SLOxiFlowMax*PctPower*State->Getdt()*Propulsion->GetRate();
 175   return OxidizerNeed;
 176 }
 177
 178 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 179
 180 void FGEngine::SetPlacement(double x, double y, double z, double pitch, double yaw)
 181 {
 182   X = x;
 183   Y = y;
 184   Z = z;
 185   EnginePitch = pitch;
 186   EngineYaw = yaw;
 187 }
 188
 189 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 190
 191 void FGEngine::AddFeedTank(int tkID)
 192 {
 193   SourceTanks.push_back(tkID);
 194 }
 195
 196 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 197
 198 FGColumnVector3& FGEngine::GetBodyForces(void)
 199 {
 200   return Thruster->GetBodyForces();
 201 }
 202
 203 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 204
 205 FGColumnVector3& FGEngine::GetMoments(void)
 206 {
 207   return Thruster->GetMoments();
 208 }
 209
 210 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 211
 212 bool FGEngine::LoadThruster(FGConfigFile* AC_cfg)
 213 {
 214   string token, fullpath, localpath;
 215   string thrusterFileName, thrType, engineFileName;
 216   FGConfigFile* Cfg_ptr = 0;
 217   double xLoc, yLoc, zLoc, Pitch, Yaw;
 218   double P_Factor = 0, Sense = 0.0;
 219   string enginePath = FDMExec->GetEnginePath();
 220   string aircraftPath = FDMExec->GetAircraftPath();
 221   thrusterFileName = AC_cfg->GetValue("FILE");
 222
 223 # ifndef macintosh
 224       fullpath = enginePath + "/";
 225       localpath = aircraftPath + "/"  + "/Engines/";
 226 # else
 227       fullpath = enginePath + ";";
 228       localpath = aircraftPath + ";" + ";Engines;";
 229 # endif
 230
 231   // Look in the Aircraft/Engines directory first
 232   FGConfigFile Local_Thruster_cfg(localpath + thrusterFileName + ".xml");
 233   FGConfigFile Thruster_cfg(fullpath + thrusterFileName + ".xml");
 234
 235   if (Local_Thruster_cfg.IsOpen()) {
 236     Cfg_ptr = &Local_Thruster_cfg;
 237     if (debug_lvl > 0) cout << "\n    Reading thruster from file: " << localpath
 238                                       + thrusterFileName + ".xml"<< endl;
 239   } else {
 240     if (Thruster_cfg.IsOpen()) {
 241       Cfg_ptr = &Thruster_cfg;
 242       if (debug_lvl > 0) cout << "\n    Reading thruster from file: " << fullpath
 243                                         + thrusterFileName + ".xml"<< endl;
 244     }
 245   }
 246
 247   if (Cfg_ptr) {
 248     Cfg_ptr->GetNextConfigLine();
 249     thrType = Cfg_ptr->GetValue();
 250
 251     if (thrType == "FG_PROPELLER") {
 252       Thruster = new FGPropeller(FDMExec, Cfg_ptr, EngineNumber);
 253     } else if (thrType == "FG_NOZZLE") {
 254       Thruster = new FGNozzle(FDMExec, Cfg_ptr, EngineNumber);
 255     } else if (thrType == "FG_DIRECT") {
 256       Thruster = new FGThruster( FDMExec, Cfg_ptr, EngineNumber);
 257     }
 258
 259     AC_cfg->GetNextConfigLine();
 260     while ((token = AC_cfg->GetValue()) != string("/AC_THRUSTER")) {
 261       *AC_cfg >> token;
 262       if (token == "XLOC") *AC_cfg >> xLoc;
 263       else if (token == "YLOC") *AC_cfg >> yLoc;
 264       else if (token == "ZLOC") *AC_cfg >> zLoc;
 265       else if (token == "PITCH") *AC_cfg >> Pitch;
 266       else if (token == "YAW") *AC_cfg >> Yaw;
 267       else if (token == "P_FACTOR") *AC_cfg >> P_Factor;
 268       else if (token == "SENSE")   *AC_cfg >> Sense;
 269       else cerr << "Unknown identifier: " << token << " in engine file: "
 270                 << engineFileName << endl;
 271     }
 272
 273     Thruster->SetLocation(xLoc, yLoc, zLoc);
 274     Thruster->SetAnglesToBody(0, Pitch, Yaw);
 275     if (thrType == "FG_PROPELLER" && P_Factor > 0.001) {
 276       ((FGPropeller*)Thruster)->SetPFactor(P_Factor);
 277       if (debug_lvl > 0) cout << "      P-Factor: " << P_Factor << endl;
 278       ((FGPropeller*)Thruster)->SetSense(fabs(Sense)/Sense);
 279       if (debug_lvl > 0) cout << "      Sense: " << Sense <<  endl;
 280     }
 281     Thruster->SetdeltaT(State->Getdt() * Propulsion->GetRate());
 282     return true;
 283   } else {
 284
 285     cerr << "Could not read thruster config file: " << fullpath
 286               + thrusterFileName + ".xml" << endl;
 287     return false;
 288   }
 289
 290 }
 291
 292 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 293 //    The bitmasked value choices are as follows:
 294 //    unset: In this case (the default) JSBSim would only print
 295 //       out the normally expected messages, essentially echoing
 296 //       the config files as they are read. If the environment
 297 //       variable is not set, debug_lvl is set to 1 internally
 298 //    0: This requests JSBSim not to output any messages
 299 //       whatsoever.
 300 //    1: This value explicity requests the normal JSBSim
 301 //       startup messages
 302 //    2: This value asks for a message to be printed out when
 303 //       a class is instantiated
 304 //    4: When this value is set, a message is displayed when a
 305 //       FGModel object executes its Run() method
 306 //    8: When this value is set, various runtime state variables
 307 //       are printed out periodically
 308 //    16: When set various parameters are sanity checked and
 309 //       a message is printed out when they go out of bounds
 310
 311 void FGEngine::Debug(int from)
 312 {
 313   if (debug_lvl <= 0) return;
 314
 315   if (debug_lvl & 1) { // Standard console startup message output
 316     if (from == 0) { // Constructor
 317
 318     }
 319   }
 320   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 321     if (from == 0) cout << "Instantiated: FGEngine" << endl;
 322     if (from == 1) cout << "Destroyed:    FGEngine" << endl;
 323   }
 324   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 325   }
 326   if (debug_lvl & 8 ) { // Runtime state variables
 327   }
 328   if (debug_lvl & 16) { // Sanity checking
 329   }
 330   if (debug_lvl & 64) {
 331     if (from == 0) { // Constructor
 332       cout << IdSrc << endl;
 333       cout << IdHdr << endl;
 334     }
 335   }
 336 }
 337 }