src/FDM/JSBSim/FGEngine.h

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Header:       FGEngine.h
   4  Author:       Jon S. Berndt
   5  Date started: 01/21/99
   6
   7  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
   8
   9  This program is free software; you can redistribute it and/or modify it under
  10  the terms of the GNU General Public License as published by the Free Software
  11  Foundation; either version 2 of the License, or (at your option) any later
  12  version.
  13
  14  This program is distributed in the hope that it will be useful, but WITHOUT
  15  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  details.
  18
  19  You should have received a copy of the GNU General Public License along with
  20  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  21  Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23  Further information about the GNU General Public License can also be found on
  24  the world wide web at http://www.gnu.org.
  25
  26 FUNCTIONAL DESCRIPTION
  27 --------------------------------------------------------------------------------
  28
  29 Based on Flightgear code, which is based on LaRCSim. This class simulates
  30 a generic engine.
  31
  32 HISTORY
  33 --------------------------------------------------------------------------------
  34 01/21/99   JSB   Created
  35
  36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  37 SENTRY
  38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  39
  40 #ifndef FGENGINE_H
  41 #define FGENGINE_H
  42
  43 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  44 INCLUDES
  45 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  46
  47 #ifdef FGFS
  48 #  include <simgear/compiler.h>
  49 #  include STL_STRING
  50    SG_USING_STD(string);
  51 #  ifdef SG_HAVE_STD_INCLUDES
  52 #    include <vector>
  53 #  else
  54 #    include <vector.h>
  55 #  endif
  56 #else
  57 #  include <vector>
  58 #  include <string>
  59 #endif
  60
  61 #include "FGJSBBase.h"
  62 #include "FGThruster.h"
  63 #include "FGPropertyManager.h"
  64
  65 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  66 DEFINITIONS
  67 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  68
  69 #define ID_ENGINE "$Id$"
  70
  71 using std::string;
  72 using std::vector;
  73
  74 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  75 FORWARD DECLARATIONS
  76 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  77
  78 namespace JSBSim {
  79
  80 class FGFDMExec;
  81 class FGState;
  82 class FGAtmosphere;
  83 class FGFCS;
  84 class FGAircraft;
  85 class FGPropagate;
  86 class FGPropulsion;
  87 class FGAuxiliary;
  88 class FGOutput;
  89 class FGThruster;
  90 class FGConfigFile;
  91
  92 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  93 CLASS DOCUMENTATION
  94 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  95
  96 /** Base class for all engines.
  97     This base class contains methods and members common to all engines, such as
  98     logic to drain fuel from the appropriate tank, etc.
  99     @author Jon S. Berndt
 100     @version $Id$
 101 */
 102
 103 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 104 CLASS DECLARATION
 105 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 106
 107 class FGEngine : public FGJSBBase
 108 {
 109 public:
 110   FGEngine(FGFDMExec* exec);
 111   virtual ~FGEngine();
 112
 113   enum EngineType {etUnknown, etRocket, etPiston, etTurbine, etElectric};
 114
 115   EngineType      GetType(void) { return Type; }
 116   virtual string  GetName(void) { return Name; }
 117
 118   // Engine controls
 119   virtual double  GetThrottleMin(void) { return MinThrottle; }
 120   virtual double  GetThrottleMax(void) { return MaxThrottle; }
 121   virtual double  GetThrottle(void) { return Throttle; }
 122   virtual double  GetMixture(void) { return Mixture; }
 123   virtual bool    GetStarter(void) { return Starter; }
 124
 125   virtual double getFuelFlow_gph () const {return FuelFlow_gph;}
 126   virtual double getFuelFlow_pph () const {return FuelFlow_pph;}
 127   virtual double GetThrust(void) { return Thrust; }
 128   virtual bool   GetStarved(void) { return Starved; }
 129   virtual bool   GetRunning(void) { return Running; }
 130   virtual bool   GetCranking(void) { return Cranking; }
 131
 132   virtual void SetStarved(bool tt) { Starved = tt; }
 133   virtual void SetStarved(void)    { Starved = true; }
 134
 135   virtual void SetRunning(bool bb) { Running=bb; }
 136   virtual void SetName(string name) { Name = name; }
 137   virtual void AddFeedTank(int tkID);
 138
 139   virtual void SetStarter(bool s) { Starter = s; }
 140
 141   /** Calculates the thrust of the engine, and other engine functions.
 142       @return Thrust in pounds */
 143   virtual double Calculate(void) {return 0.0;}
 144
 145   /** Reduces the fuel in the active tanks by the amount required.
 146       This function should be called from within the
 147       derived class' Calculate() function before any other calculations are
 148       done. This base class method removes fuel from the fuel tanks as
 149       appropriate, and sets the starved flag if necessary. */
 150   virtual void ConsumeFuel(void);
 151
 152   /** The fuel need is calculated based on power levels and flow rate for that
 153       power level. It is also turned from a rate into an actual amount (pounds)
 154       by multiplying it by the delta T and the rate.
 155       @return Total fuel requirement for this engine in pounds. */
 156   virtual double CalcFuelNeed(void);
 157
 158   /** The oxidizer need is calculated based on power levels and flow rate for that
 159       power level. It is also turned from a rate into an actual amount (pounds)
 160       by multiplying it by the delta T and the rate.
 161       @return Total oxidizer requirement for this engine in pounds. */
 162   virtual double CalcOxidizerNeed(void);
 163
 164   /// Sets engine placement information
 165   virtual void SetPlacement(double x, double y, double z, double pitch, double yaw);
 166
 167   /// Sets the engine number
 168   virtual void SetEngineNumber(int nn) {EngineNumber = nn;}
 169
 170   virtual double GetPowerAvailable(void) {return 0.0;};
 171
 172   virtual bool GetTrimMode(void) {return TrimMode;}
 173   virtual void SetTrimMode(bool state) {TrimMode = state;}
 174
 175   virtual FGColumnVector3& GetBodyForces(void);
 176   virtual FGColumnVector3& GetMoments(void);
 177
 178   bool LoadThruster(FGConfigFile* AC_cfg);
 179   FGThruster* GetThruster(void) {return Thruster;}
 180
 181   virtual string GetEngineLabels(void) = 0;
 182   virtual string GetEngineValues(void) = 0;
 183
 184 protected:
 185   FGPropertyManager* PropertyManager;
 186   string Name;
 187   EngineType Type;
 188   double X, Y, Z;
 189   double EnginePitch;
 190   double EngineYaw;
 191   double SLFuelFlowMax;
 192   double SLOxiFlowMax;
 193   double MaxThrottle;
 194   double MinThrottle;
 195
 196   double Thrust;
 197   double Throttle;
 198   double Mixture;
 199   double FuelNeed;
 200   double OxidizerNeed;
 201   double PctPower;
 202   int   EngineNumber;
 203   bool  Starter;
 204   bool  Starved;
 205   bool  Running;
 206   bool  Cranking;
 207   bool  TrimMode;
 208
 209   double FuelFlow_gph;
 210   double FuelFlow_pph;
 211
 212   FGFDMExec*      FDMExec;
 213   FGState*        State;
 214   FGAtmosphere*   Atmosphere;
 215   FGFCS*          FCS;
 216   FGPropulsion*   Propulsion;
 217   FGAircraft*     Aircraft;
 218   FGPropagate*    Propagate;
 219   FGAuxiliary*    Auxiliary;
 220   FGOutput*       Output;
 221   FGThruster*     Thruster;
 222
 223   vector <int> SourceTanks;
 224   void Debug(int from);
 225 };
 226 }
 227 #include "FGState.h"
 228 #include "FGFDMExec.h"
 229 #include "FGAtmosphere.h"
 230 #include "FGFCS.h"
 231 #include "FGAircraft.h"
 232 #include "FGPropagate.h"
 233 #include "FGPropulsion.h"
 234 #include "FGAuxiliary.h"
 235 #include "FGOutput.h"
 236 #include "FGThruster.h"
 237 #include "FGConfigFile.h"
 238
 239 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 240 #endif
 241