]> git.mxchange.org Git - flightgear.git/blob - src/FDM/JSBSim/FGPropeller.h
Restructuring some of the initialization code.
[flightgear.git] / 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 and Cp
66     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     @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGPropeller.h?rev=HEAD&content-type=text/vnd.viewcvs-markup">
85          Header File </a>
86     @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGPropeller.cpp?rev=HEAD&content-type=text/vnd.viewcvs-markup">
87          Source File </a>
88 */
89
90 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
91 CLASS DECLARATION
92 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
93
94 class FGPropeller : public FGThruster {
95
96 public:
97   /** Constructor for FGPropeller.
98       @param exec a pointer to the main executive object
99       @param AC_cfg a pointer to the main aircraft config file object */
100   FGPropeller(FGFDMExec* exec, FGConfigFile* AC_cfg);
101
102   /// Destructor for FGPropeller - deletes the FGTable objects
103   ~FGPropeller();
104
105   /** Sets the Revolutions Per Minute for the propeller. Normally the propeller
106       instance will calculate its own rotational velocity, given the Torque
107       produced by the engine and integrating over time using the standard
108       equation for rotational acceleration "a": a = Q/I , where Q is Torque and
109       I is moment of inertia for the propeller.
110       @param rpm the rotational velocity of the propeller */
111   void SetRPM(double rpm) {RPM = rpm;}
112
113   /// Returns true of this propeller is variable pitch
114   bool IsVPitch(void) {return MaxPitch != MinPitch;}
115
116   /** This commands the pitch of the blade to change to the value supplied.
117       This call is meant to be issued either from the cockpit or by the flight
118       control system (perhaps to maintain constant RPM for a constant-speed
119       propeller). This value will be limited to be within whatever is specified
120       in the config file for Max and Min pitch. It is also one of the lookup
121       indices to the power and thrust tables for variable-pitch propellers.
122       @param pitch the pitch of the blade in degrees. */
123   void SetPitch(double pitch) {Pitch = pitch;}
124
125   /// Sets the P-Factor constant
126   void SetPFactor(double pf) {P_Factor = pf;}
127
128   /** Sets the rotation sense of the propeller.
129       @param s this value should be +/- 1 ONLY. +1 indicates clockwise rotation as
130                viewed by someone standing behind the engine looking forward into
131                the direction of flight. */
132   void SetSense(double s) { Sense = s;}
133
134   /// Retrieves the pitch of the propeller in degrees.
135   double GetPitch(void)         { return Pitch;         }
136   
137   /// Retrieves the RPMs of the propeller
138   double GetRPM(void)           { return RPM;           }
139   
140   /// Retrieves the propeller moment of inertia
141   double GetIxx(void)           { return Ixx;           }
142   
143   /// Retrieves the Torque in foot-pounds (Don't you love the English system?)
144   double GetTorque(void)        { return vTorque(eX);    }
145   
146   /** Retrieves the power required (or "absorbed") by the propeller -
147       i.e. the power required to keep spinning the propeller at the current
148       velocity, air density,  and rotational rate. */
149   double GetPowerRequired(void);
150   
151   /** Calculates and returns the thrust produced by this propeller.
152       Given the excess power available from the engine (in foot-pounds), the thrust is
153       calculated, as well as the current RPM. The RPM is calculated by integrating
154       the torque provided by the engine over what the propeller "absorbs"
155       (essentially the "drag" of the propeller).
156       @param PowerAvailable this is the excess power provided by the engine to
157       accelerate the prop. It could be negative, dictating that the propeller
158       would be slowed.
159       @return the thrust in pounds */
160   double Calculate(double PowerAvailable);
161   FGColumnVector3 GetPFactor(void);
162
163 private:
164   int   numBlades;
165   double RPM;
166   double Ixx;
167   double Diameter;
168   double MaxPitch;
169   double MinPitch;
170   double MinRPM;
171   double MaxRPM;
172   double P_Factor;
173   double Sense;
174   double Pitch;
175   double ExcessTorque;
176   FGColumnVector3 vTorque;
177   FGTable *cThrust;
178   FGTable *cPower;
179   void Debug(int from);
180 };
181
182 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
183 #endif
184