-/*******************************************************************************
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Header: FGPropeller.h
Author: Jon S. Berndt
--------------------------------------------------------------------------------
08/24/00 JSB Created
-********************************************************************************
-COMMENTS, REFERENCES, and NOTES
-********************************************************************************
-
-********************************************************************************
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SENTRY
-*******************************************************************************/
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
#ifndef FGPROPELLER_H
#define FGPROPELLER_H
-/*******************************************************************************
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
INCLUDES
-*******************************************************************************/
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
#include "FGThruster.h"
-
-#define ID_PROPELLER "$Header$"
-
-/*******************************************************************************
+#include "FGTable.h"
+#include "FGTranslation.h"
+#include "FGRotation.h"
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+DEFINITIONS
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+#define ID_PROPELLER "$Id$"
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+FORWARD DECLARATIONS
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+CLASS DOCUMENTATION
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+/** Propeller modeling class.
+ FGPropeller models a propeller given the tabular data for Ct and Cp
+ indexed by advance ratio "J". The data for the propeller is
+ stored in a config file named "prop_name.xml". The propeller config file
+ is referenced from the main aircraft config file in the "Propulsion" section.
+ See the constructor for FGPropeller to see what is read in and what should
+ be stored in the config file.<br>
+ Several references were helpful, here:<ul>
+ <li>Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics",
+ Wiley & Sons, 1979 ISBN 0-471-03032-5</li>
+ <li>Edwin Hartman, David Biermann, "The Aerodynamic Characteristics of
+ Full Scale Propellers Having 2, 3, and 4 Blades of Clark Y and R.A.F. 6
+ Airfoil Sections", NACA Report TN-640, 1938 (?)</li>
+ <li>Various NACA Technical Notes and Reports</li>
+ <ul>
+ @author Jon S. Berndt
+ @version $Id$
+ @see FGEngine
+ @see FGThruster
+ @see FGTable
+ @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGPropeller.h?rev=HEAD&content-type=text/vnd.viewcvs-markup">
+ Header File </a>
+ @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGPropeller.cpp?rev=HEAD&content-type=text/vnd.viewcvs-markup">
+ Source File </a>
+*/
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DECLARATION
-*******************************************************************************/
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
class FGPropeller : public FGThruster {
public:
- FGPropeller(FGFDMExec *FDMExec);
- ~FGPropeller(void);
-
- void Calculate(void);
+ /** Constructor for FGPropeller.
+ @param exec a pointer to the main executive object
+ @param AC_cfg a pointer to the main aircraft config file object */
+ FGPropeller(FGFDMExec* exec, FGConfigFile* AC_cfg);
+
+ /// Destructor for FGPropeller - deletes the FGTable objects
+ ~FGPropeller();
+
+ /** Sets the Revolutions Per Minute for the propeller. Normally the propeller
+ instance will calculate its own rotational velocity, given the Torque
+ produced by the engine and integrating over time using the standard
+ equation for rotational acceleration "a": a = Q/I , where Q is Torque and
+ I is moment of inertia for the propeller.
+ @param rpm the rotational velocity of the propeller */
+ void SetRPM(double rpm) {RPM = rpm;}
+
+ /// Returns true of this propeller is variable pitch
+ bool IsVPitch(void) {return MaxPitch != MinPitch;}
+
+ /** This commands the pitch of the blade to change to the value supplied.
+ This call is meant to be issued either from the cockpit or by the flight
+ control system (perhaps to maintain constant RPM for a constant-speed
+ propeller). This value will be limited to be within whatever is specified
+ in the config file for Max and Min pitch. It is also one of the lookup
+ indices to the power and thrust tables for variable-pitch propellers.
+ @param pitch the pitch of the blade in degrees. */
+ void SetPitch(double pitch) {Pitch = pitch;}
+
+ /// Sets the P-Factor constant
+ void SetPFactor(double pf) {P_Factor = pf;}
+
+ /** Sets the rotation sense of the propeller.
+ @param s this value should be +/- 1 ONLY. +1 indicates clockwise rotation as
+ viewed by someone standing behind the engine looking forward into
+ the direction of flight. */
+ void SetSense(double s) { Sense = s;}
+
+ /// Retrieves the pitch of the propeller in degrees.
+ double GetPitch(void) { return Pitch; }
+
+ /// Retrieves the RPMs of the propeller
+ double GetRPM(void) { return RPM; }
+
+ /// Retrieves the propeller moment of inertia
+ double GetIxx(void) { return Ixx; }
+
+ /// Retrieves the Torque in foot-pounds (Don't you love the English system?)
+ double GetTorque(void) { return vTorque(eX); }
+
+ /** Retrieves the power required (or "absorbed") by the propeller -
+ i.e. the power required to keep spinning the propeller at the current
+ velocity, air density, and rotational rate. */
+ double GetPowerRequired(void);
+
+ /** Calculates and returns the thrust produced by this propeller.
+ Given the excess power available from the engine (in foot-pounds), the thrust is
+ calculated, as well as the current RPM. The RPM is calculated by integrating
+ the torque provided by the engine over what the propeller "absorbs"
+ (essentially the "drag" of the propeller).
+ @param PowerAvailable this is the excess power provided by the engine to
+ accelerate the prop. It could be negative, dictating that the propeller
+ would be slowed.
+ @return the thrust in pounds */
+ double Calculate(double PowerAvailable);
+ FGColumnVector3 GetPFactor(void);
+
+private:
+ int numBlades;
+ double RPM;
+ double Ixx;
+ double Diameter;
+ double MaxPitch;
+ double MinPitch;
+ double MinRPM;
+ double MaxRPM;
+ double P_Factor;
+ double Sense;
+ double Pitch;
+ double ExcessTorque;
+ FGColumnVector3 vTorque;
+ FGTable *cThrust;
+ FGTable *cPower;
+ void Debug(int from);
};
-/******************************************************************************/
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
#endif
+
projects / flightgear.git / blobdiff