src/FDM/JSBSim/FGPropeller.h

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Header:       FGPropeller.h
   4  Author:       Jon S. Berndt
   5  Date started: 08/24/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 FGPROPELLER_H
  35 #define FGPROPELLER_H
  36
  37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #include "FGThruster.h"
  42 #include "FGTable.h"
  43
  44 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  45 DEFINITIONS
  46 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  47
  48 #define ID_PROPELLER "$Id$"
  49
  50 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  51 FORWARD DECLARATIONS
  52 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  53
  54 namespace JSBSim {
  55
  56 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  57 CLASS DOCUMENTATION
  58 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  59
  60 /** Propeller modeling class.
  61     FGPropeller models a propeller given the tabular data for Ct and Cp
  62     indexed by advance ratio "J". The data for the propeller is
  63     stored in a config file named "prop_name.xml". The propeller config file
  64     is referenced from the main aircraft config file in the "Propulsion" section.
  65     See the constructor for FGPropeller to see what is read in and what should
  66     be stored in the config file.<br>
  67     Several references were helpful, here:<ul>
  68     <li>Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics",
  69      Wiley & Sons, 1979 ISBN 0-471-03032-5</li>
  70     <li>Edwin Hartman, David Biermann, "The Aerodynamic Characteristics of
  71     Full Scale Propellers Having 2, 3, and 4 Blades of Clark Y and R.A.F. 6
  72     Airfoil Sections", NACA Report TN-640, 1938 (?)</li>
  73     <li>Various NACA Technical Notes and Reports</li>
  74     </ul>
  75     @author Jon S. Berndt
  76     @version $Id$
  77     @see FGEngine
  78     @see FGThruster
  79     @see FGTable
  80 */
  81
  82 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  83 CLASS DECLARATION
  84 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  85
  86 class FGPropeller : public FGThruster {
  87
  88 public:
  89   /** Constructor for FGPropeller.
  90       @param exec a pointer to the main executive object
  91       @param AC_cfg a pointer to the main aircraft config file object */
  92   FGPropeller(FGFDMExec* exec, FGConfigFile* AC_cfg, int num = 0);
  93
  94   /// Destructor for FGPropeller - deletes the FGTable objects
  95   ~FGPropeller();
  96
  97   /** Sets the Revolutions Per Minute for the propeller. Normally the propeller
  98       instance will calculate its own rotational velocity, given the Torque
  99       produced by the engine and integrating over time using the standard
 100       equation for rotational acceleration "a": a = Q/I , where Q is Torque and
 101       I is moment of inertia for the propeller.
 102       @param rpm the rotational velocity of the propeller */
 103   void SetRPM(double rpm) {RPM = rpm;}
 104
 105   /// Returns true of this propeller is variable pitch
 106   bool IsVPitch(void) {return MaxPitch != MinPitch;}
 107
 108   /** This commands the pitch of the blade to change to the value supplied.
 109       This call is meant to be issued either from the cockpit or by the flight
 110       control system (perhaps to maintain constant RPM for a constant-speed
 111       propeller). This value will be limited to be within whatever is specified
 112       in the config file for Max and Min pitch. It is also one of the lookup
 113       indices to the power and thrust tables for variable-pitch propellers.
 114       @param pitch the pitch of the blade in degrees. */
 115   void SetPitch(double pitch) {Pitch = pitch;}
 116
 117   void SetAdvance(double advance) {Advance = advance;}
 118
 119   /// Sets the P-Factor constant
 120   void SetPFactor(double pf) {P_Factor = pf;}
 121
 122   /** Sets the rotation sense of the propeller.
 123       @param s this value should be +/- 1 ONLY. +1 indicates clockwise rotation as
 124                viewed by someone standing behind the engine looking forward into
 125                the direction of flight. */
 126   void SetSense(double s) { Sense = s;}
 127
 128   double GetSense(void) {return Sense;}
 129   double GetPFactorValue(void) {return P_Factor;}
 130
 131   /// Retrieves the pitch of the propeller in degrees.
 132   double GetPitch(void)         { return Pitch;         }
 133
 134   /// Retrieves the RPMs of the propeller
 135   double GetRPM(void)           { return RPM;           }
 136
 137   /// Retrieves the propeller moment of inertia
 138   double GetIxx(void)           { return Ixx;           }
 139
 140   /// Retrieves the Torque in foot-pounds (Don't you love the English system?)
 141   double GetTorque(void)        { return vTorque(eX);    }
 142
 143   /** Retrieves the power required (or "absorbed") by the propeller -
 144       i.e. the power required to keep spinning the propeller at the current
 145       velocity, air density,  and rotational rate. */
 146   double GetPowerRequired(void);
 147
 148   /** Calculates and returns the thrust produced by this propeller.
 149       Given the excess power available from the engine (in foot-pounds), the thrust is
 150       calculated, as well as the current RPM. The RPM is calculated by integrating
 151       the torque provided by the engine over what the propeller "absorbs"
 152       (essentially the "drag" of the propeller).
 153       @param PowerAvailable this is the excess power provided by the engine to
 154       accelerate the prop. It could be negative, dictating that the propeller
 155       would be slowed.
 156       @return the thrust in pounds */
 157   double Calculate(double PowerAvailable);
 158   FGColumnVector3 GetPFactor(void);
 159   string GetThrusterLabels(int id, string delimeter);
 160   string GetThrusterValues(int id, string delimeter);
 161
 162 private:
 163   int   numBlades;
 164   double RPM;
 165   double Ixx;
 166   double Diameter;
 167   double MaxPitch;
 168   double MinPitch;
 169   double MinRPM;
 170   double MaxRPM;
 171   double P_Factor;
 172   double Sense;
 173   double Pitch;
 174   double Advance;
 175   double ExcessTorque;
 176   FGColumnVector3 vTorque;
 177   FGTable *cThrust;
 178   FGTable *cPower;
 179   void Debug(int from);
 180 };
 181 }
 182 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 183 #endif
 184