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, int engine_number);
 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   virtual void SetFuelFreeze(bool f) { FuelFreeze = f; }
 139
 140   virtual void SetStarter(bool s) { Starter = s; }
 141
 142   /** Calculates the thrust of the engine, and other engine functions.
 143       @return Thrust in pounds */
 144   virtual double Calculate(void) {return 0.0;}
 145
 146   /** Reduces the fuel in the active tanks by the amount required.
 147       This function should be called from within the
 148       derived class' Calculate() function before any other calculations are
 149       done. This base class method removes fuel from the fuel tanks as
 150       appropriate, and sets the starved flag if necessary. */
 151   virtual void ConsumeFuel(void);
 152
 153   /** The fuel need is calculated based on power levels and flow rate for that
 154       power level. It is also turned from a rate into an actual amount (pounds)
 155       by multiplying it by the delta T and the rate.
 156       @return Total fuel requirement for this engine in pounds. */
 157   virtual double CalcFuelNeed(void);
 158
 159   /** The oxidizer need is calculated based on power levels and flow rate for that
 160       power level. It is also turned from a rate into an actual amount (pounds)
 161       by multiplying it by the delta T and the rate.
 162       @return Total oxidizer requirement for this engine in pounds. */
 163   virtual double CalcOxidizerNeed(void);
 164
 165   /// Sets engine placement information
 166   virtual void SetPlacement(double x, double y, double z, double pitch, double yaw);
 167
 168   virtual double GetPowerAvailable(void) {return 0.0;};
 169
 170   virtual bool GetTrimMode(void) {return TrimMode;}
 171   virtual void SetTrimMode(bool state) {TrimMode = state;}
 172
 173   virtual FGColumnVector3& GetBodyForces(void);
 174   virtual FGColumnVector3& GetMoments(void);
 175
 176   bool LoadThruster(FGConfigFile* AC_cfg);
 177   FGThruster* GetThruster(void) {return Thruster;}
 178
 179   virtual string GetEngineLabels(string delimeter) = 0;
 180   virtual string GetEngineValues(string delimeter) = 0;
 181
 182 protected:
 183   FGPropertyManager* PropertyManager;
 184   string Name;
 185   const int   EngineNumber;
 186   EngineType Type;
 187   double X, Y, Z;
 188   double EnginePitch;
 189   double EngineYaw;
 190   double SLFuelFlowMax;
 191   double SLOxiFlowMax;
 192   double MaxThrottle;
 193   double MinThrottle;
 194
 195   double Thrust;
 196   double Throttle;
 197   double Mixture;
 198   double FuelNeed;
 199   double OxidizerNeed;
 200   double PctPower;
 201   bool  Starter;
 202   bool  Starved;
 203   bool  Running;
 204   bool  Cranking;
 205   bool  TrimMode;
 206   bool  FuelFreeze;
 207
 208   double FuelFlow_gph;
 209   double FuelFlow_pph;
 210
 211   FGFDMExec*      FDMExec;
 212   FGState*        State;
 213   FGAtmosphere*   Atmosphere;
 214   FGFCS*          FCS;
 215   FGPropulsion*   Propulsion;
 216   FGAircraft*     Aircraft;
 217   FGPropagate*    Propagate;
 218   FGAuxiliary*    Auxiliary;
 219   FGOutput*       Output;
 220   FGThruster*     Thruster;
 221
 222   vector <int> SourceTanks;
 223   void Debug(int from);
 224 };
 225 }
 226 #include "FGState.h"
 227 #include "FGFDMExec.h"
 228 #include "FGAtmosphere.h"
 229 #include "FGFCS.h"
 230 #include "FGAircraft.h"
 231 #include "FGPropagate.h"
 232 #include "FGPropulsion.h"
 233 #include "FGAuxiliary.h"
 234 #include "FGOutput.h"
 235 #include "FGThruster.h"
 236 #include "FGConfigFile.h"
 237
 238 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 239 #endif
 240