]> git.mxchange.org Git - flightgear.git/blobdiff - src/FDM/JSBSim/FGEngine.cpp
Frederic Bouvier:
[flightgear.git] / src / FDM / JSBSim / FGEngine.cpp
index fe0aca43b4f50aad149af8fa625d96868fec80ec..1983708ef3cc4f34f7a627c3284102541cb0f33b 100644 (file)
@@ -1,39 +1,39 @@
 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
  Module:       FGEngine.cpp
  Author:       Jon Berndt
  Date started: 01/21/99
  Called by:    FGAircraft
+
  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
+
  This program is free software; you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
  Foundation; either version 2 of the License, or (at your option) any later
  version.
+
  This program is distributed in the hope that it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  details.
+
  You should have received a copy of the GNU General Public License along with
  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  Place - Suite 330, Boston, MA  02111-1307, USA.
+
  Further information about the GNU General Public License can also be found on
  the world wide web at http://www.gnu.org.
+
 FUNCTIONAL DESCRIPTION
 --------------------------------------------------------------------------------
 See header file.
+
 HISTORY
 --------------------------------------------------------------------------------
 01/21/99   JSB   Created
 09/03/99   JSB   Changed Rocket thrust equation to correct -= Thrust instead of
                  += Thrust (thanks to Tony Peden)
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 INCLUDES
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
@@ -46,7 +46,7 @@ INCLUDES
 #    include <fstream.h>
 #  endif
 #else
-#  if defined(sgi) && !defined(__GNUC__)
+#  if defined(sgi) && !defined(__GNUC__) && (_COMPILER_VERSION < 740)
 #    include <fstream.h>
 #  else
 #    include <fstream>
@@ -55,6 +55,10 @@ INCLUDES
 
 #include "FGEngine.h"
 #include "FGTank.h"
+#include "FGPropeller.h"
+#include "FGNozzle.h"
+
+namespace JSBSim {
 
 static const char *IdSrc = "$Id$";
 static const char *IdHdr = ID_ENGINE;
@@ -64,33 +68,46 @@ CLASS IMPLEMENTATION
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
 
-FGEngine::FGEngine(FGFDMExec* exec) {
-  FDMExec     = exec;
-  State       = FDMExec->GetState();
-  Atmosphere  = FDMExec->GetAtmosphere();
-  FCS         = FDMExec->GetFCS();
-  Propulsion  = FDMExec->GetPropulsion();
-  Aircraft    = FDMExec->GetAircraft();
-  Translation = FDMExec->GetTranslation();
-  Rotation    = FDMExec->GetRotation();
-  Position    = FDMExec->GetPosition();
-  Auxiliary   = FDMExec->GetAuxiliary();
-  Output      = FDMExec->GetOutput();
-
-  Mixture = 1.0;               // FIXME: get actual value\r
-  Thrust = PctPower = 0.0;
-  Starved = Flameout = false;
-  Running = true;
-
-  if (debug_lvl & 2) cout << "Instantiated: FGEngine" << endl;
+FGEngine::FGEngine(FGFDMExec* exec, int engine_number) : EngineNumber(engine_number)
+{
+  Name = "";
+  Type = etUnknown;
+  X = Y = Z = 0.0;
+  EnginePitch = EngineYaw = 0.0;
+  SLFuelFlowMax = SLOxiFlowMax = 0.0;
+  MaxThrottle = 1.0;
+  MinThrottle = 0.0;
+  Thrust = 0.0;
+  Throttle = 0.0;
+  Mixture = 1.0;
+  Starter = false;
+  FuelNeed = OxidizerNeed = 0.0;
+  Starved = Running = Cranking = false;
+  PctPower = 0.0;
   TrimMode = false;
+  FuelFlow_gph = 0.0;
+  FuelFlow_pph = 0.0;
+
+  FDMExec = exec;
+  State = FDMExec->GetState();
+  Atmosphere = FDMExec->GetAtmosphere();
+  FCS = FDMExec->GetFCS();
+  Propulsion = FDMExec->GetPropulsion();
+  Aircraft = FDMExec->GetAircraft();
+  Propagate = FDMExec->GetPropagate();
+  Auxiliary = FDMExec->GetAuxiliary();
+  Output = FDMExec->GetOutput();
+
+  PropertyManager = FDMExec->GetPropertyManager();
+
+  Debug(0);
 }
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 FGEngine::~FGEngine()
 {
-  if (debug_lvl & 2) cout << "Destroyed:    FGEngine" << endl;
+  Debug(1);
 }
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -99,19 +116,29 @@ FGEngine::~FGEngine()
 // This base class method removes fuel from the fuel tanks as appropriate,
 // and sets the starved flag if necessary.
 
-void FGEngine::ConsumeFuel(void) {
-  float Fshortage, Oshortage;
+void FGEngine::ConsumeFuel(void)
+{
+  double Fshortage, Oshortage, TanksWithFuel;
   FGTank* Tank;
 
   if (TrimMode) return;
+  Fshortage = Oshortage = TanksWithFuel = 0.0;
 
-  Fshortage = Oshortage = 0.0;
+  // count how many assigned tanks have fuel
   for (unsigned int i=0; i<SourceTanks.size(); i++) {
-    Tank = Propulsion->GetTank(i);
+    Tank = Propulsion->GetTank(SourceTanks[i]);
+    if (Tank->GetContents() > 0.0) {
+      ++TanksWithFuel;
+    }
+  }
+  if (!TanksWithFuel) return;
+
+  for (unsigned int i=0; i<SourceTanks.size(); i++) {
+    Tank = Propulsion->GetTank(SourceTanks[i]);
     if (Tank->GetType() == FGTank::ttFUEL) {
-      Fshortage += Tank->Reduce(CalcFuelNeed()/Propulsion->GetnumSelectedFuelTanks());
+       Fshortage += Tank->Drain(CalcFuelNeed()/TanksWithFuel);
     } else {
-      Oshortage += Tank->Reduce(CalcOxidizerNeed()/Propulsion->GetnumSelectedOxiTanks());
+       Oshortage += Tank->Drain(CalcOxidizerNeed()/TanksWithFuel);
     }
   }
 
@@ -121,21 +148,24 @@ void FGEngine::ConsumeFuel(void) {
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-float FGEngine::CalcFuelNeed(void) {
+double FGEngine::CalcFuelNeed(void)
+{
   FuelNeed = SLFuelFlowMax*PctPower*State->Getdt()*Propulsion->GetRate();
   return FuelNeed;
 }
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-float FGEngine::CalcOxidizerNeed(void) {
+double FGEngine::CalcOxidizerNeed(void)
+{
   OxidizerNeed = SLOxiFlowMax*PctPower*State->Getdt()*Propulsion->GetRate();
   return OxidizerNeed;
 }
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-void FGEngine::SetPlacement(float x, float y, float z, float pitch, float yaw) {
+void FGEngine::SetPlacement(double x, double y, double z, double pitch, double yaw)
+{
   X = x;
   Y = y;
   Z = z;
@@ -152,8 +182,143 @@ void FGEngine::AddFeedTank(int tkID)
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-void FGEngine::Debug(void)
+FGColumnVector3& FGEngine::GetBodyForces(void)
+{
+  return Thruster->GetBodyForces();
+}
+
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+FGColumnVector3& FGEngine::GetMoments(void)
+{
+  return Thruster->GetMoments();
+}
+
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+bool FGEngine::LoadThruster(FGConfigFile* AC_cfg)
 {
-    //TODO: Add your source code here
+  string token, fullpath, localpath;
+  string thrusterFileName, thrType, engineFileName;
+  FGConfigFile* Cfg_ptr = 0;
+  double xLoc, yLoc, zLoc, Pitch, Yaw;
+  double P_Factor = 0, Sense = 0.0;
+  string enginePath = FDMExec->GetEnginePath();
+  string aircraftPath = FDMExec->GetAircraftPath();
+  thrusterFileName = AC_cfg->GetValue("FILE");
+
+# ifndef macintosh
+      fullpath = enginePath + "/";
+      localpath = aircraftPath + "/"  + "/Engines/";
+# else
+      fullpath = enginePath + ";";
+      localpath = aircraftPath + ";" + ";Engines;";
+# endif
+
+  // Look in the Aircraft/Engines directory first
+  FGConfigFile Local_Thruster_cfg(localpath + thrusterFileName + ".xml");
+  FGConfigFile Thruster_cfg(fullpath + thrusterFileName + ".xml");
+
+  if (Local_Thruster_cfg.IsOpen()) {
+    Cfg_ptr = &Local_Thruster_cfg;
+    if (debug_lvl > 0) cout << "\n    Reading thruster from file: " << localpath
+                                      + thrusterFileName + ".xml"<< endl;
+  } else {
+    if (Thruster_cfg.IsOpen()) {
+      Cfg_ptr = &Thruster_cfg;
+      if (debug_lvl > 0) cout << "\n    Reading thruster from file: " << fullpath
+                                        + thrusterFileName + ".xml"<< endl;
+    }
+  }
+
+  if (Cfg_ptr) {
+    Cfg_ptr->GetNextConfigLine();
+    thrType = Cfg_ptr->GetValue();
+
+    if (thrType == "FG_PROPELLER") {
+      Thruster = new FGPropeller(FDMExec, Cfg_ptr);
+    } else if (thrType == "FG_NOZZLE") {
+      Thruster = new FGNozzle(FDMExec, Cfg_ptr);
+    } else if (thrType == "FG_DIRECT") {
+      Thruster = new FGThruster( FDMExec, Cfg_ptr);
+    }
+
+    AC_cfg->GetNextConfigLine();
+    while ((token = AC_cfg->GetValue()) != string("/AC_THRUSTER")) {
+      *AC_cfg >> token;
+      if (token == "XLOC") *AC_cfg >> xLoc;
+      else if (token == "YLOC") *AC_cfg >> yLoc;
+      else if (token == "ZLOC") *AC_cfg >> zLoc;
+      else if (token == "PITCH") *AC_cfg >> Pitch;
+      else if (token == "YAW") *AC_cfg >> Yaw;
+      else if (token == "P_FACTOR") *AC_cfg >> P_Factor;
+      else if (token == "SENSE")   *AC_cfg >> Sense;
+      else cerr << "Unknown identifier: " << token << " in engine file: "
+                << engineFileName << endl;
+    }
+
+    Thruster->SetLocation(xLoc, yLoc, zLoc);
+    Thruster->SetAnglesToBody(0, Pitch, Yaw);
+    if (thrType == "FG_PROPELLER" && P_Factor > 0.001) {
+      ((FGPropeller*)Thruster)->SetPFactor(P_Factor);
+      if (debug_lvl > 0) cout << "      P-Factor: " << P_Factor << endl;
+      ((FGPropeller*)Thruster)->SetSense(fabs(Sense)/Sense);
+      if (debug_lvl > 0) cout << "      Sense: " << Sense <<  endl;
+    }
+    Thruster->SetdeltaT(State->Getdt() * Propulsion->GetRate());
+    return true;
+  } else {
+
+    cerr << "Could not read thruster config file: " << fullpath
+              + thrusterFileName + ".xml" << endl;
+    return false;
+  }
+
 }
 
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+//    The bitmasked value choices are as follows:
+//    unset: In this case (the default) JSBSim would only print
+//       out the normally expected messages, essentially echoing
+//       the config files as they are read. If the environment
+//       variable is not set, debug_lvl is set to 1 internally
+//    0: This requests JSBSim not to output any messages
+//       whatsoever.
+//    1: This value explicity requests the normal JSBSim
+//       startup messages
+//    2: This value asks for a message to be printed out when
+//       a class is instantiated
+//    4: When this value is set, a message is displayed when a
+//       FGModel object executes its Run() method
+//    8: When this value is set, various runtime state variables
+//       are printed out periodically
+//    16: When set various parameters are sanity checked and
+//       a message is printed out when they go out of bounds
+
+void FGEngine::Debug(int from)
+{
+  if (debug_lvl <= 0) return;
+
+  if (debug_lvl & 1) { // Standard console startup message output
+    if (from == 0) { // Constructor
+
+    }
+  }
+  if (debug_lvl & 2 ) { // Instantiation/Destruction notification
+    if (from == 0) cout << "Instantiated: FGEngine" << endl;
+    if (from == 1) cout << "Destroyed:    FGEngine" << endl;
+  }
+  if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
+  }
+  if (debug_lvl & 8 ) { // Runtime state variables
+  }
+  if (debug_lvl & 16) { // Sanity checking
+  }
+  if (debug_lvl & 64) {
+    if (from == 0) { // Constructor
+      cout << IdSrc << endl;
+      cout << IdHdr << endl;
+    }
+  }
+}
+}