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