src/FDM/JSBSim/FGThruster.h

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Header:       FGThruster.h
   4  Author:       Jon S. Berndt
   5  Date started: 08/23/00
   6
   7  ------------- Copyright (C) 2000  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 HISTORY
  27 --------------------------------------------------------------------------------
  28 08/24/00  JSB  Created
  29
  30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  31 SENTRY
  32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  33
  34 #ifndef FGTHRUSTER_H
  35 #define FGTHRUSTER_H
  36
  37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #include "FGForce.h"
  42 #include "FGConfigFile.h"
  43 #include "FGPropertyManager.h"
  44 #include <string>
  45
  46 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  47 DEFINITIONS
  48 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  49
  50 #define ID_THRUSTER "$Id$"
  51
  52 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  53 FORWARD DECLARATIONS
  54 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  55
  56 namespace JSBSim {
  57
  58 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  59 CLASS DOCUMENTATION
  60 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  61
  62 /** Base class for specific thrusting devices such as propellers, nozzles, etc.
  63     @author Jon Berndt
  64     @version $Id$
  65     */
  66
  67 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  68 CLASS DECLARATION
  69 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  70
  71 class FGThruster : public FGForce {
  72
  73 public:
  74   /// Constructor
  75   FGThruster(FGFDMExec *FDMExec);
  76   FGThruster(FGFDMExec *FDMExec, FGConfigFile *Eng_cfg, int num );
  77   /// Destructor
  78   virtual ~FGThruster();
  79
  80   enum eType {ttNozzle, ttRotor, ttPropeller, ttDirect};
  81
  82   virtual double Calculate(double tt) {
  83        Thrust = tt; vFn(1) = Thrust;
  84        return 0.0;
  85   }
  86   void SetName(string name) {Name = name;}
  87   virtual void SetRPM(double rpm) {};
  88   virtual double GetPowerRequired(void) {return 0.0;}
  89   virtual void SetdeltaT(double dt) {deltaT = dt;}
  90   double GetThrust(void) {return Thrust;}
  91   eType GetType(void) {return Type;}
  92   string GetName(void) {return Name;}
  93   virtual double GetRPM(void) { return 0.0; };
  94   double GetGearRatio(void) {return GearRatio; }
  95   virtual string GetThrusterLabels(int id);
  96   virtual string GetThrusterValues(int id);
  97
  98   inline void SetThrustCoefficient(double ct) { ThrustCoeff = ct; }
  99
 100 protected:
 101   eType Type;
 102   string Name;
 103   double Thrust;
 104   double PowerRequired;
 105   double deltaT;
 106   double GearRatio;
 107   double ThrustCoeff;
 108   int EngineNum;
 109   FGPropertyManager* PropertyManager;
 110   virtual void Debug(int from);
 111 };
 112 }
 113 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 114 #endif
 115