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__)
  50 #    include <fstream.h>
  51 #  else
  52 #    include <fstream>
  53 #  endif
  54 #endif
  55
  56 #include "FGEngine.h"
  57 #include "FGTank.h"
  58
  59 static const char *IdSrc = "$Id$";
  60 static const char *IdHdr = ID_ENGINE;
  61
  62 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  63 CLASS IMPLEMENTATION
  64 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  65
  66
  67 FGEngine::FGEngine(FGFDMExec* exec) {
  68   FDMExec     = exec;
  69   State       = FDMExec->GetState();
  70   Atmosphere  = FDMExec->GetAtmosphere();
  71   FCS         = FDMExec->GetFCS();
  72   Propulsion  = FDMExec->GetPropulsion();
  73   Aircraft    = FDMExec->GetAircraft();
  74   Translation = FDMExec->GetTranslation();
  75   Rotation    = FDMExec->GetRotation();
  76   Position    = FDMExec->GetPosition();
  77   Auxiliary   = FDMExec->GetAuxiliary();
  78   Output      = FDMExec->GetOutput();
  79
  80   Mixture = 1.0;                // FIXME: get actual value
  81
  82   Thrust = PctPower = 0.0;
  83   Starved = Flameout = false;
  84   Running = false;
  85   Cranking = Starter = false;
  86
  87   if (debug_lvl & 2) cout << "Instantiated: FGEngine" << endl;
  88   TrimMode = false;
  89 }
  90
  91 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  92
  93 FGEngine::~FGEngine()
  94 {
  95   if (debug_lvl & 2) cout << "Destroyed:    FGEngine" << endl;
  96 }
  97
  98 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  99 // This base class function should be called from within the
 100 // derived class' Calculate() function before any other calculations are done.
 101 // This base class method removes fuel from the fuel tanks as appropriate,
 102 // and sets the starved flag if necessary.
 103
 104 void FGEngine::ConsumeFuel(void) {
 105   float Fshortage, Oshortage;
 106   FGTank* Tank;
 107
 108   if (TrimMode) return;
 109
 110   Fshortage = Oshortage = 0.0;
 111   for (unsigned int i=0; i<SourceTanks.size(); i++) {
 112     Tank = Propulsion->GetTank(i);
 113     if (Tank->GetType() == FGTank::ttFUEL) {
 114       Fshortage += Tank->Reduce(CalcFuelNeed()/Propulsion->GetnumSelectedFuelTanks());
 115     } else {
 116       Oshortage += Tank->Reduce(CalcOxidizerNeed()/Propulsion->GetnumSelectedOxiTanks());
 117     }
 118   }
 119
 120   if (Fshortage < 0.00 || Oshortage < 0.00) Starved = true;
 121   else Starved = false;
 122 }
 123
 124 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 125
 126 float FGEngine::CalcFuelNeed(void) {
 127   FuelNeed = SLFuelFlowMax*PctPower*State->Getdt()*Propulsion->GetRate();
 128   return FuelNeed;
 129 }
 130
 131 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 132
 133 float FGEngine::CalcOxidizerNeed(void) {
 134   OxidizerNeed = SLOxiFlowMax*PctPower*State->Getdt()*Propulsion->GetRate();
 135   return OxidizerNeed;
 136 }
 137
 138 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 139
 140 void FGEngine::SetPlacement(float x, float y, float z, float pitch, float yaw) {
 141   X = x;
 142   Y = y;
 143   Z = z;
 144   EnginePitch = pitch;
 145   EngineYaw = yaw;
 146 }
 147
 148 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 149
 150 void FGEngine::AddFeedTank(int tkID)
 151 {
 152   SourceTanks.push_back(tkID);
 153 }
 154
 155 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 156
 157 void FGEngine::Debug(void)
 158 {
 159     //TODO: Add your source code here
 160 }
 161