src/FDM/JSBSim/FGPropeller.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGPropeller.cpp
   4  Author:       Jon S. Berndt
   5  Date started: 08/24/00
   6  Purpose:      Encapsulates the propeller object
   7
   8  ------------- Copyright (C) 2000  Jon S. Berndt (jsb@hal-pc.org) -------------
   9
  10  This program is free software; you can redistribute it and/or modify it under
  11  the terms of the GNU General Public License as published by the Free Software
  12  Foundation; either version 2 of the License, or (at your option) any later
  13  version.
  14
  15  This program is distributed in the hope that it will be useful, but WITHOUT
  16  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18  details.
  19
  20  You should have received a copy of the GNU General Public License along with
  21  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  22  Place - Suite 330, Boston, MA  02111-1307, USA.
  23
  24  Further information about the GNU General Public License can also be found on
  25  the world wide web at http://www.gnu.org.
  26
  27 FUNCTIONAL DESCRIPTION
  28 --------------------------------------------------------------------------------
  29
  30 HISTORY
  31 --------------------------------------------------------------------------------
  32 08/24/00  JSB  Created
  33
  34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  35 INCLUDES
  36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  37
  38 #include "FGPropeller.h"
  39 #include "FGTranslation.h"
  40 #include "FGRotation.h"
  41 #include "FGFCS.h"
  42 #include "FGAtmosphere.h"
  43
  44 namespace JSBSim {
  45
  46 static const char *IdSrc = "$Id$";
  47 static const char *IdHdr = ID_PROPELLER;
  48
  49 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  50 CLASS IMPLEMENTATION
  51 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  52
  53 // This class currently makes certain assumptions when calculating torque and
  54 // p-factor. That is, that the axis of rotation is the X axis of the aircraft -
  55 // not just the X-axis of the engine/propeller. This may or may not work for a
  56 // helicopter.
  57
  58 FGPropeller::FGPropeller(FGFDMExec* exec, FGConfigFile* Prop_cfg) : FGThruster(exec)
  59 {
  60   string token;
  61   int rows, cols;
  62
  63   MaxPitch = MinPitch = P_Factor = Sense = Pitch = 0.0;
  64   GearRatio = 1.0;
  65
  66   Name = Prop_cfg->GetValue("NAME");
  67   Prop_cfg->GetNextConfigLine();
  68   while (Prop_cfg->GetValue() != string("/FG_PROPELLER")) {
  69     *Prop_cfg >> token;
  70     if (token == "IXX") {
  71       *Prop_cfg >> Ixx;
  72     } else if (token == "DIAMETER") {
  73       *Prop_cfg >> Diameter;
  74       Diameter /= 12.0;
  75     } else if (token == "NUMBLADES") {
  76       *Prop_cfg >> numBlades;
  77     } else if (token == "GEARRATIO") {
  78       *Prop_cfg >> GearRatio;
  79     } else if (token == "MINPITCH") {
  80       *Prop_cfg >> MinPitch;
  81     } else if (token == "MAXPITCH") {
  82       *Prop_cfg >> MaxPitch;
  83     } else if (token == "MINRPM") {
  84       *Prop_cfg >> MinRPM;
  85     } else if (token == "MAXRPM") {
  86       *Prop_cfg >> MaxRPM;
  87     } else if (token == "C_THRUST") {
  88       *Prop_cfg >> rows >> cols;
  89       if (cols == 1) cThrust = new FGTable(rows);
  90       else           cThrust = new FGTable(rows, cols);
  91       *cThrust << *Prop_cfg;
  92     } else if (token == "C_POWER") {
  93       *Prop_cfg >> rows >> cols;
  94       if (cols == 1) cPower = new FGTable(rows);
  95       else           cPower = new FGTable(rows, cols);
  96       *cPower << *Prop_cfg;
  97     } else if (token == "EOF") {
  98       cerr << "      End of file reached" <<  endl;
  99       break;
 100     } else {
 101       cerr << "Unhandled token in Propeller config file: " << token << endl;
 102     }
 103   }
 104
 105   Type = ttPropeller;
 106   RPM = 0;
 107   vTorque.InitMatrix();
 108
 109   Debug(0);
 110 }
 111
 112 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 113
 114 FGPropeller::~FGPropeller()
 115 {
 116   if (cThrust)    delete cThrust;
 117   if (cPower)     delete cPower;
 118   Debug(1);
 119 }
 120
 121 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 122 //
 123 // We must be getting the aerodynamic velocity here, NOT the inertial velocity.
 124 // We need the velocity with respect to the wind.
 125 //
 126 // Note that PowerAvailable is the excess power available after the drag of the
 127 // propeller has been subtracted. At equilibrium, PowerAvailable will be zero -
 128 // indicating that the propeller will not accelerate or decelerate.
 129 // Remembering that Torque * omega = Power, we can derive the torque on the
 130 // propeller and its acceleration to give a new RPM. The current RPM will be
 131 // used to calculate thrust.
 132 //
 133 // Because RPM could be zero, we need to be creative about what RPM is stated as.
 134
 135 double FGPropeller::Calculate(double PowerAvailable)
 136 {
 137   double J, C_Thrust, omega;
 138   double Vel = fdmex->GetTranslation()->GetAeroUVW(eU);
 139   double rho = fdmex->GetAtmosphere()->GetDensity();
 140   double RPS = RPM/60.0;
 141   double alpha, beta;
 142
 143   if (RPM > 0.10) {
 144     J = Vel / (Diameter * RPS);
 145   } else {
 146     J = 0.0;
 147   }
 148
 149   if (MaxPitch == MinPitch) { // Fixed pitch prop
 150     C_Thrust = cThrust->GetValue(J);
 151   } else {                    // Variable pitch prop
 152     C_Thrust = cThrust->GetValue(J, Pitch);
 153   }
 154
 155   if (P_Factor > 0.0001) {
 156     alpha = fdmex->GetTranslation()->Getalpha();
 157     beta  = fdmex->GetTranslation()->Getbeta();
 158     SetActingLocationY( GetLocationY() + P_Factor*alpha*Sense);
 159     SetActingLocationZ( GetLocationZ() + P_Factor*beta*Sense);
 160   } else if (P_Factor < 0.000) {
 161     cerr << "P-Factor value in config file must be greater than zero" << endl;
 162   }
 163
 164   Thrust = C_Thrust*RPS*RPS*Diameter*Diameter*Diameter*Diameter*rho;
 165   omega = RPS*2.0*M_PI;
 166
 167   // Check for windmilling.
 168   double radius = Diameter * 0.375; // 75% of radius
 169   double windmill_cutoff = tan(Pitch * 1.745329E-2) * omega * radius;
 170   if (Vel > windmill_cutoff)
 171     Thrust = -Thrust;
 172
 173   vFn(1) = Thrust;
 174
 175   // The Ixx value and rotation speed given below are for rotation about the
 176   // natural axis of the engine. The transform takes place in the base class
 177   // FGForce::GetBodyForces() function.
 178
 179   vH(eX) = Ixx*omega*Sense;
 180   vH(eY) = 0.0;
 181   vH(eZ) = 0.0;
 182
 183   if (omega <= 5) omega = 1.0;
 184
 185   ExcessTorque = PowerAvailable / omega * GearRatio;
 186   RPM = (RPS + ((ExcessTorque / Ixx) / (2.0 * M_PI)) * deltaT) * 60.0;
 187
 188                                 // The friction from the engine should
 189                                 // stop it somewhere; I chose an
 190                                 // arbitrary point.
 191   if (RPM < 5.0)
 192     RPM = 0;
 193
 194   vMn = fdmex->GetRotation()->GetPQR()*vH + vTorque*Sense;
 195
 196   return Thrust; // return thrust in pounds
 197 }
 198
 199 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 200
 201 double FGPropeller::GetPowerRequired(void)
 202 {
 203   if (RPM <= 0.10) return 0.0; // If the prop ain't turnin', the fuel ain't burnin'.
 204
 205   double cPReq, RPS = RPM / 60.0;
 206
 207   double J = fdmex->GetTranslation()->GetAeroUVW(eU) / (Diameter * RPS);
 208   double rho = fdmex->GetAtmosphere()->GetDensity();
 209
 210   if (MaxPitch == MinPitch) { // Fixed pitch prop
 211     Pitch = MinPitch;
 212     cPReq = cPower->GetValue(J);
 213   } else {                    // Variable pitch prop
 214     double advance = fdmex->GetFCS()->GetPropAdvance(ThrusterNumber);
 215
 216     if (MaxRPM != MinRPM) {   // fixed-speed prop
 217       double rpmReq = MinRPM + (MaxRPM - MinRPM) * advance;
 218       double dRPM = rpmReq - RPM;
 219
 220       Pitch -= dRPM / 10;
 221
 222       if (Pitch < MinPitch)       Pitch = MinPitch;
 223       else if (Pitch > MaxPitch)  Pitch = MaxPitch;
 224
 225     } else {
 226       Pitch = MinPitch + (MaxPitch - MinPitch) * advance;
 227     }
 228     cPReq = cPower->GetValue(J, Pitch);
 229   }
 230
 231   PowerRequired = cPReq*RPS*RPS*RPS*Diameter*Diameter*Diameter*Diameter
 232                                                        *Diameter*rho;
 233   vTorque(eX) = -Sense*PowerRequired / (RPS*2.0*M_PI);
 234
 235   return PowerRequired;
 236 }
 237
 238 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 239
 240 FGColumnVector3 FGPropeller::GetPFactor()
 241 {
 242   double px=0.0, py, pz;
 243
 244   py = Thrust * Sense * (GetActingLocationY() - GetLocationY()) / 12.0;
 245   pz = Thrust * Sense * (GetActingLocationZ() - GetLocationZ()) / 12.0;
 246
 247   return FGColumnVector3(px, py, pz);
 248 }
 249
 250 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 251 //    The bitmasked value choices are as follows:
 252 //    unset: In this case (the default) JSBSim would only print
 253 //       out the normally expected messages, essentially echoing
 254 //       the config files as they are read. If the environment
 255 //       variable is not set, debug_lvl is set to 1 internally
 256 //    0: This requests JSBSim not to output any messages
 257 //       whatsoever.
 258 //    1: This value explicity requests the normal JSBSim
 259 //       startup messages
 260 //    2: This value asks for a message to be printed out when
 261 //       a class is instantiated
 262 //    4: When this value is set, a message is displayed when a
 263 //       FGModel object executes its Run() method
 264 //    8: When this value is set, various runtime state variables
 265 //       are printed out periodically
 266 //    16: When set various parameters are sanity checked and
 267 //       a message is printed out when they go out of bounds
 268
 269 void FGPropeller::Debug(int from)
 270 {
 271   if (debug_lvl <= 0) return;
 272
 273   if (debug_lvl & 1) { // Standard console startup message output
 274     if (from == 0) { // Constructor
 275       cout << "\n    Propeller Name: " << Name << endl;
 276       cout << "      IXX = " << Ixx << endl;
 277       cout << "      Diameter = " << Diameter << " ft." << endl;
 278       cout << "      Number of Blades  = " << numBlades << endl;
 279       cout << "      Minimum Pitch  = " << MinPitch << endl;
 280       cout << "      Maximum Pitch  = " << MaxPitch << endl;
 281       cout << "      Thrust Coefficient: " <<  endl;
 282       cThrust->Print();
 283       cout << "      Power Coefficient: " <<  endl;
 284       cPower->Print();
 285     }
 286   }
 287   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 288     if (from == 0) cout << "Instantiated: FGPropeller" << endl;
 289     if (from == 1) cout << "Destroyed:    FGPropeller" << endl;
 290   }
 291   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 292   }
 293   if (debug_lvl & 8 ) { // Runtime state variables
 294   }
 295   if (debug_lvl & 16) { // Sanity checking
 296   }
 297   if (debug_lvl & 64) {
 298     if (from == 0) { // Constructor
 299       cout << IdSrc << endl;
 300       cout << IdHdr << endl;
 301     }
 302   }
 303 }
 304 }