src/FDM/JSBSim/models/propulsion/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 <input_output/FGXMLElement.h>
  43 #include <input_output/FGPropertyManager.h>
  44 #include <math/FGColumnVector3.h>
  45 #include <string>
  46
  47 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  48 DEFINITIONS
  49 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  50
  51 #define ID_THRUSTER "$Id$"
  52
  53 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  54 FORWARD DECLARATIONS
  55 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  56
  57 namespace JSBSim {
  58
  59 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  60 CLASS DOCUMENTATION
  61 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  62
  63 /** Base class for specific thrusting devices such as propellers, nozzles, etc.
  64     @author Jon Berndt
  65     @version $Id$
  66     */
  67
  68 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  69 CLASS DECLARATION
  70 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  71
  72 class FGThruster : public FGForce {
  73
  74 public:
  75   /// Constructor
  76   FGThruster(FGFDMExec *FDMExec);
  77   FGThruster(FGFDMExec *FDMExec, Element *el, int num );
  78   /// Destructor
  79   virtual ~FGThruster();
  80
  81   enum eType {ttNozzle, ttRotor, ttPropeller, ttDirect};
  82
  83   virtual double Calculate(double tt) {
  84        Thrust = tt; vFn(1) = Thrust;
  85        return Thrust;
  86   }
  87   void SetName(string name) {Name = name;}
  88   virtual void SetRPM(double rpm) {};
  89   virtual double GetPowerRequired(void) {return 0.0;}
  90   virtual void SetdeltaT(double dt) {deltaT = dt;}
  91   double GetThrust(void) {return Thrust;}
  92   eType GetType(void) {return Type;}
  93   string GetName(void) {return Name;}
  94   virtual double GetRPM(void) { return 0.0; };
  95   double GetGearRatio(void) {return GearRatio; }
  96   virtual string GetThrusterLabels(int id, string delimeter);
  97   virtual string GetThrusterValues(int id, string delimeter);
  98
  99 protected:
 100   eType Type;
 101   string Name;
 102   double Thrust;
 103   double PowerRequired;
 104   double deltaT;
 105   double GearRatio;
 106   double ThrustCoeff;
 107   int EngineNum;
 108   FGPropertyManager* PropertyManager;
 109   virtual void Debug(int from);
 110 };
 111 }
 112 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 113 #endif
 114