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 Lesser 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 Lesser General Public License for more
  17  details.
  18
  19  You should have received a copy of the GNU Lesser 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 Lesser 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
  65 <h3>reverser angle:</h3>
  66
  67     "Reverser angle" as used here is a way to manipulate the thrust vector,
  68     along the thrust axis ONLY, during run time.  This should not be confused
  69     with a thrust vectoring nozzle.  The angle is defined in radians, and is
  70     used thus:  Final_thrust = cosine( reverser_angle ) * unmodified_thrust.
  71     Therefore a reverser angle of 0 results in no change, and a reverser angle
  72     of 3.14 (pi) results in a completely reversed thrust vector.  An angle of
  73     1.57 (pi/2) results in no thrust at all.
  74
  75     @author Jon Berndt
  76     @version $Id$
  77     */
  78
  79 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  80 CLASS DECLARATION
  81 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  82
  83 class FGThruster : public FGForce {
  84
  85 public:
  86   /// Constructor
  87   FGThruster(FGFDMExec *FDMExec, Element *el, int num );
  88   /// Destructor
  89   virtual ~FGThruster();
  90
  91   enum eType {ttNozzle, ttRotor, ttPropeller, ttDirect};
  92
  93   virtual double Calculate(double tt) {
  94        Thrust = cos(ReverserAngle)*tt;
  95        vFn(1) = Thrust;
  96        return Thrust;
  97   }
  98   void SetName(string name) {Name = name;}
  99   virtual void SetRPM(double rpm) {};
 100   virtual double GetPowerRequired(void) {return 0.0;}
 101   virtual void SetdeltaT(double dt) {deltaT = dt;}
 102   double GetThrust(void) const {return Thrust;}
 103   eType GetType(void) {return Type;}
 104   string GetName(void) {return Name;}
 105   void SetReverserAngle(double angle) {ReverserAngle = angle;}
 106   double GetReverserAngle(void) const {return ReverserAngle;}
 107   virtual double GetRPM(void) const { return 0.0; };
 108   double GetGearRatio(void) {return GearRatio; }
 109   virtual string GetThrusterLabels(int id, string delimeter);
 110   virtual string GetThrusterValues(int id, string delimeter);
 111
 112 protected:
 113   eType Type;
 114   string Name;
 115   double Thrust;
 116   double PowerRequired;
 117   double deltaT;
 118   double GearRatio;
 119   double ThrustCoeff;
 120   double ReverserAngle;
 121   int EngineNum;
 122   FGPropertyManager* PropertyManager;
 123   virtual void Debug(int from);
 124 };
 125 }
 126 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 127 #endif
 128