src/FDM/JSBSim/models/propulsion/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 (jon@jsbsim.org) -------------
   9
  10  This program is free software; you can redistribute it and/or modify it under
  11  the terms of the GNU Lesser 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 Lesser General Public License for more
  18  details.
  19
  20  You should have received a copy of the GNU Lesser 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 Lesser 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 <iostream>
  39 #include <sstream>
  40
  41 #include "FGPropeller.h"
  42 #include "input_output/FGXMLElement.h"
  43
  44 using namespace std;
  45
  46 namespace JSBSim {
  47
  48 static const char *IdSrc = "$Id: FGPropeller.cpp,v 1.41 2011/11/17 21:07:30 jentron Exp $";
  49 static const char *IdHdr = ID_PROPELLER;
  50
  51 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  52 CLASS IMPLEMENTATION
  53 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  54
  55 // This class currently makes certain assumptions when calculating torque and
  56 // p-factor. That is, that the axis of rotation is the X axis of the aircraft -
  57 // not just the X-axis of the engine/propeller. This may or may not work for a
  58 // helicopter.
  59
  60 FGPropeller::FGPropeller(FGFDMExec* exec, Element* prop_element, int num)
  61                        : FGThruster(exec, prop_element, num)
  62 {
  63   string token;
  64   Element *table_element, *local_element;
  65   string name="";
  66   FGPropertyManager* PropertyManager = exec->GetPropertyManager();
  67
  68   MaxPitch = MinPitch = P_Factor = Pitch = Advance = MinRPM = MaxRPM = 0.0;
  69   Sense = 1; // default clockwise rotation
  70   ReversePitch = 0.0;
  71   Reversed = false;
  72   Feathered = false;
  73   Reverse_coef = 0.0;
  74   GearRatio = 1.0;
  75   CtFactor = CpFactor = 1.0;
  76   ConstantSpeed = 0;
  77   cThrust = cPower = CtMach = CpMach = 0;
  78   Vinduced = 0.0;
  79
  80   if (prop_element->FindElement("ixx"))
  81     Ixx = prop_element->FindElementValueAsNumberConvertTo("ixx", "SLUG*FT2");
  82   if (prop_element->FindElement("diameter"))
  83     Diameter = prop_element->FindElementValueAsNumberConvertTo("diameter", "FT");
  84   if (prop_element->FindElement("numblades"))
  85     numBlades = (int)prop_element->FindElementValueAsNumber("numblades");
  86   if (prop_element->FindElement("gearratio"))
  87     GearRatio = prop_element->FindElementValueAsNumber("gearratio");
  88   if (prop_element->FindElement("minpitch"))
  89     MinPitch = prop_element->FindElementValueAsNumber("minpitch");
  90   if (prop_element->FindElement("maxpitch"))
  91     MaxPitch = prop_element->FindElementValueAsNumber("maxpitch");
  92   if (prop_element->FindElement("minrpm"))
  93     MinRPM = prop_element->FindElementValueAsNumber("minrpm");
  94   if (prop_element->FindElement("maxrpm")) {
  95     MaxRPM = prop_element->FindElementValueAsNumber("maxrpm");
  96     ConstantSpeed = 1;
  97     }
  98   if (prop_element->FindElement("constspeed"))
  99     ConstantSpeed = (int)prop_element->FindElementValueAsNumber("constspeed");
 100   if (prop_element->FindElement("reversepitch"))
 101     ReversePitch = prop_element->FindElementValueAsNumber("reversepitch");
 102   while((table_element = prop_element->FindNextElement("table")) != 0) {
 103     name = table_element->GetAttributeValue("name");
 104     try {
 105       if (name == "C_THRUST") {
 106         cThrust = new FGTable(PropertyManager, table_element);
 107       } else if (name == "C_POWER") {
 108         cPower = new FGTable(PropertyManager, table_element);
 109       } else if (name == "CT_MACH") {
 110         CtMach = new FGTable(PropertyManager, table_element);
 111       } else if (name == "CP_MACH") {
 112         CpMach = new FGTable(PropertyManager, table_element);
 113       } else {
 114         cerr << "Unknown table type: " << name << " in propeller definition." << endl;
 115       }
 116     } catch (std::string str) {
 117       throw("Error loading propeller table:" + name + ". " + str);
 118     }
 119   }
 120   if( (cPower == 0) || (cThrust == 0)){
 121       cerr << "Propeller configuration must contain C_THRUST and C_POWER tables!" << endl;
 122   }
 123
 124   local_element = prop_element->GetParent()->FindElement("sense");
 125   if (local_element) {
 126     double Sense = local_element->GetDataAsNumber();
 127     SetSense(Sense >= 0.0 ? 1.0 : -1.0);
 128   }
 129   local_element = prop_element->GetParent()->FindElement("p_factor");
 130   if (local_element) {
 131     P_Factor = local_element->GetDataAsNumber();
 132   }
 133   if (P_Factor < 0) {
 134     cerr << "P-Factor value in propeller configuration file must be greater than zero" << endl;
 135   }
 136   if (prop_element->FindElement("ct_factor"))
 137     SetCtFactor( prop_element->FindElementValueAsNumber("ct_factor") );
 138   if (prop_element->FindElement("cp_factor"))
 139     SetCpFactor( prop_element->FindElementValueAsNumber("cp_factor") );
 140
 141   Type = ttPropeller;
 142   RPM = 0;
 143   vTorque.InitMatrix();
 144   D4 = Diameter*Diameter*Diameter*Diameter;
 145   D5 = D4*Diameter;
 146   Pitch = MinPitch;
 147
 148   string property_name, base_property_name;
 149   base_property_name = CreateIndexedPropertyName("propulsion/engine", EngineNum);
 150   property_name = base_property_name + "/engine-rpm";
 151   PropertyManager->Tie( property_name.c_str(), this, &FGPropeller::GetEngineRPM );
 152   property_name = base_property_name + "/advance-ratio";
 153   PropertyManager->Tie( property_name.c_str(), &J );
 154   property_name = base_property_name + "/blade-angle";
 155   PropertyManager->Tie( property_name.c_str(), &Pitch );
 156   property_name = base_property_name + "/thrust-coefficient";
 157   PropertyManager->Tie( property_name.c_str(), this, &FGPropeller::GetThrustCoefficient );
 158   property_name = base_property_name + "/propeller-rpm";
 159   PropertyManager->Tie( property_name.c_str(), this, &FGPropeller::GetRPM );
 160   property_name = base_property_name + "/helical-tip-Mach";
 161   PropertyManager->Tie( property_name.c_str(), this, &FGPropeller::GetHelicalTipMach );
 162   property_name = base_property_name + "/constant-speed-mode";
 163   PropertyManager->Tie( property_name.c_str(), this, &FGPropeller::GetConstantSpeed,
 164                       &FGPropeller::SetConstantSpeed );
 165   property_name = base_property_name + "/prop-induced-velocity_fps";
 166   PropertyManager->Tie( property_name.c_str(), this, &FGPropeller::GetInducedVelocity,
 167                       &FGPropeller::SetInducedVelocity );
 168
 169   Debug(0);
 170 }
 171
 172 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 173
 174 FGPropeller::~FGPropeller()
 175 {
 176   delete cThrust;
 177   delete cPower;
 178   delete CtMach;
 179   delete CpMach;
 180
 181   Debug(1);
 182 }
 183
 184 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 185 //
 186 // We must be getting the aerodynamic velocity here, NOT the inertial velocity.
 187 // We need the velocity with respect to the wind.
 188 //
 189 // Remembering that Torque * omega = Power, we can derive the torque on the
 190 // propeller and its acceleration to give a new RPM. The current RPM will be
 191 // used to calculate thrust.
 192 //
 193 // Because RPM could be zero, we need to be creative about what RPM is stated as.
 194
 195 double FGPropeller::Calculate(double EnginePower)
 196 {
 197   double omega, PowerAvailable;
 198
 199   double Vel = in.AeroUVW(eU);
 200   double rho = in.Density;
 201   double RPS = RPM/60.0;
 202
 203   // Calculate helical tip Mach
 204   double Area = 0.25*Diameter*Diameter*M_PI;
 205   double Vtip = RPS * Diameter * M_PI;
 206   HelicalTipMach = sqrt(Vtip*Vtip + Vel*Vel) / in.Soundspeed;
 207
 208   PowerAvailable = EnginePower - GetPowerRequired();
 209
 210   if (RPS > 0.0) J = Vel / (Diameter * RPS); // Calculate J normally
 211   else           J = Vel / Diameter;
 212
 213   if (MaxPitch == MinPitch) {    // Fixed pitch prop
 214          ThrustCoeff = cThrust->GetValue(J);
 215   } else {                       // Variable pitch prop
 216          ThrustCoeff = cThrust->GetValue(J, Pitch);
 217   }
 218
 219   // Apply optional scaling factor to Ct (default value = 1)
 220   ThrustCoeff *= CtFactor;
 221
 222   // Apply optional Mach effects from CT_MACH table
 223   if (CtMach) ThrustCoeff *= CtMach->GetValue(HelicalTipMach);
 224
 225   if (P_Factor > 0.0001) {
 226 //    alpha = sin(fdmex->GetAuxiliary()->Getalpha() + FGThruster::GetPitch());
 227 //    beta  = sin(fdmex->GetAuxiliary()->Getbeta() + FGThruster::GetYaw());
 228 //    SetActingLocationY( GetLocationY() + P_Factor*alpha*Sense);
 229 //    SetActingLocationZ( GetLocationZ() + P_Factor*beta*Sense);
 230     SetActingLocationY( GetLocationY() + P_Factor*in.Alpha*Sense);
 231     SetActingLocationZ( GetLocationZ() + P_Factor*in.Beta*Sense);
 232   }
 233
 234   Thrust = ThrustCoeff*RPS*RPS*D4*rho;
 235
 236   // From B. W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics"
 237   // first edition, eqn. 6.15 (propeller analysis chapter).
 238   Vinduced = 0.5 * (-Vel + sqrt(Vel*Vel + 2.0*Thrust/(rho*Area)));
 239
 240   omega = RPS*2.0*M_PI;
 241
 242   vFn(1) = Thrust;
 243
 244   // The Ixx value and rotation speed given below are for rotation about the
 245   // natural axis of the engine. The transform takes place in the base class
 246   // FGForce::GetBodyForces() function.
 247
 248   vH(eX) = Ixx*omega*Sense;
 249   vH(eY) = 0.0;
 250   vH(eZ) = 0.0;
 251
 252   if (omega > 0.0) ExcessTorque = PowerAvailable / omega;
 253   else             ExcessTorque = PowerAvailable / 1.0;
 254
 255   RPM = (RPS + ((ExcessTorque / Ixx) / (2.0 * M_PI)) * deltaT) * 60.0;
 256
 257   if (RPM < 0.0) RPM = 0.0; // Engine won't turn backwards
 258
 259   // Transform Torque and momentum first, as PQR is used in this
 260   // equation and cannot be transformed itself.
 261   vMn = in.PQR*(Transform()*vH) + Transform()*vTorque;
 262
 263   return Thrust; // return thrust in pounds
 264 }
 265
 266 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 267
 268 double FGPropeller::GetPowerRequired(void)
 269 {
 270   double cPReq, J;
 271   double rho = in.Density;
 272   double Vel = in.AeroUVW(eU);
 273   double RPS = RPM / 60.0;
 274
 275   if (RPS != 0.0) J = Vel / (Diameter * RPS);
 276   else            J = Vel / Diameter;
 277
 278   if (MaxPitch == MinPitch) {   // Fixed pitch prop
 279     cPReq = cPower->GetValue(J);
 280
 281   } else {                      // Variable pitch prop
 282
 283     if (ConstantSpeed != 0) {   // Constant Speed Mode
 284
 285       // do normal calculation when propeller is neither feathered nor reversed
 286       // Note:  This method of feathering and reversing was added to support the
 287       //        turboprop model.  It's left here for backward compatablity, but
 288       //        now feathering and reversing should be done in Manual Pitch Mode.
 289       if (!Feathered) {
 290         if (!Reversed) {
 291
 292           double rpmReq = MinRPM + (MaxRPM - MinRPM) * Advance;
 293           double dRPM = rpmReq - RPM;
 294           // The pitch of a variable propeller cannot be changed when the RPMs are
 295           // too low - the oil pump does not work.
 296           if (RPM > 200) Pitch -= dRPM * deltaT;
 297           if (Pitch < MinPitch)       Pitch = MinPitch;
 298           else if (Pitch > MaxPitch)  Pitch = MaxPitch;
 299
 300         } else { // Reversed propeller
 301
 302           // when reversed calculate propeller pitch depending on throttle lever position
 303           // (beta range for taxing full reverse for braking)
 304           double PitchReq = MinPitch - ( MinPitch - ReversePitch ) * Reverse_coef;
 305           // The pitch of a variable propeller cannot be changed when the RPMs are
 306           // too low - the oil pump does not work.
 307           if (RPM > 200) Pitch += (PitchReq - Pitch) / 200;
 308           if (RPM > MaxRPM) {
 309             Pitch += (MaxRPM - RPM) / 50;
 310             if (Pitch < ReversePitch) Pitch = ReversePitch;
 311             else if (Pitch > MaxPitch)  Pitch = MaxPitch;
 312           }
 313         }
 314
 315       } else { // Feathered propeller
 316                // ToDo: Make feathered and reverse settings done via FGKinemat
 317         Pitch += (MaxPitch - Pitch) / 300; // just a guess (about 5 sec to fully feathered)
 318       }
 319
 320     } else { // Manual Pitch Mode, pitch is controlled externally
 321
 322     }
 323
 324     cPReq = cPower->GetValue(J, Pitch);
 325   }
 326
 327   // Apply optional scaling factor to Cp (default value = 1)
 328   cPReq *= CpFactor;
 329
 330   // Apply optional Mach effects from CP_MACH table
 331   if (CpMach) cPReq *= CpMach->GetValue(HelicalTipMach);
 332
 333   if (RPS > 0.1) {
 334     PowerRequired = cPReq*RPS*RPS*RPS*D5*rho;
 335     vTorque(eX) = -Sense*PowerRequired / (RPS*2.0*M_PI);
 336   } else {
 337      // For a stationary prop we have to estimate torque first.
 338      double CL = (90.0 - Pitch) / 20.0;
 339      if (CL > 1.5) CL = 1.5;
 340      double BladeArea = Diameter * Diameter / 32.0 * numBlades;
 341      vTorque(eX) = -Sense*BladeArea*Diameter*fabs(Vel)*Vel*rho*0.19*CL;
 342      PowerRequired = Sense*(vTorque(eX))*0.2*M_PI;
 343   }
 344
 345   return PowerRequired;
 346 }
 347
 348 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 349
 350 FGColumnVector3 FGPropeller::GetPFactor() const
 351 {
 352   double px=0.0, py, pz;
 353
 354   py = Thrust * Sense * (GetActingLocationY() - GetLocationY()) / 12.0;
 355   pz = Thrust * Sense * (GetActingLocationZ() - GetLocationZ()) / 12.0;
 356
 357   return FGColumnVector3(px, py, pz);
 358 }
 359
 360 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 361
 362 string FGPropeller::GetThrusterLabels(int id, const string& delimeter)
 363 {
 364   std::ostringstream buf;
 365
 366   buf << Name << " Torque (engine " << id << ")" << delimeter
 367       << Name << " PFactor Pitch (engine " << id << ")" << delimeter
 368       << Name << " PFactor Yaw (engine " << id << ")" << delimeter
 369       << Name << " Thrust (engine " << id << " in lbs)" << delimeter;
 370   if (IsVPitch())
 371     buf << Name << " Pitch (engine " << id << ")" << delimeter;
 372   buf << Name << " RPM (engine " << id << ")";
 373
 374   return buf.str();
 375 }
 376
 377 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 378
 379 string FGPropeller::GetThrusterValues(int id, const string& delimeter)
 380 {
 381   std::ostringstream buf;
 382
 383   FGColumnVector3 vPFactor = GetPFactor();
 384   buf << vTorque(eX) << delimeter
 385       << vPFactor(ePitch) << delimeter
 386       << vPFactor(eYaw) << delimeter
 387       << Thrust << delimeter;
 388   if (IsVPitch())
 389     buf << Pitch << delimeter;
 390   buf << RPM;
 391
 392   return buf.str();
 393 }
 394
 395 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 396 //    The bitmasked value choices are as follows:
 397 //    unset: In this case (the default) JSBSim would only print
 398 //       out the normally expected messages, essentially echoing
 399 //       the config files as they are read. If the environment
 400 //       variable is not set, debug_lvl is set to 1 internally
 401 //    0: This requests JSBSim not to output any messages
 402 //       whatsoever.
 403 //    1: This value explicity requests the normal JSBSim
 404 //       startup messages
 405 //    2: This value asks for a message to be printed out when
 406 //       a class is instantiated
 407 //    4: When this value is set, a message is displayed when a
 408 //       FGModel object executes its Run() method
 409 //    8: When this value is set, various runtime state variables
 410 //       are printed out periodically
 411 //    16: When set various parameters are sanity checked and
 412 //       a message is printed out when they go out of bounds
 413
 414 void FGPropeller::Debug(int from)
 415 {
 416   if (debug_lvl <= 0) return;
 417
 418   if (debug_lvl & 1) { // Standard console startup message output
 419     if (from == 0) { // Constructor
 420       cout << "\n    Propeller Name: " << Name << endl;
 421       cout << "      IXX = " << Ixx << endl;
 422       cout << "      Diameter = " << Diameter << " ft." << endl;
 423       cout << "      Number of Blades  = " << numBlades << endl;
 424       cout << "      Gear Ratio  = " << GearRatio << endl;
 425       cout << "      Minimum Pitch  = " << MinPitch << endl;
 426       cout << "      Maximum Pitch  = " << MaxPitch << endl;
 427       cout << "      Minimum RPM  = " << MinRPM << endl;
 428       cout << "      Maximum RPM  = " << MaxRPM << endl;
 429 // Tables are being printed elsewhere...
 430 //      cout << "      Thrust Coefficient: " <<  endl;
 431 //      cThrust->Print();
 432 //      cout << "      Power Coefficient: " <<  endl;
 433 //      cPower->Print();
 434 //      cout << "      Mach Thrust Coefficient: " <<  endl;
 435 //      if(CtMach)
 436 //      {
 437 //          CtMach->Print();
 438 //      } else {
 439 //          cout << "        NONE" <<  endl;
 440 //      }
 441 //      cout << "      Mach Power Coefficient: " <<  endl;
 442 //      if(CpMach)
 443 //      {
 444 //          CpMach->Print();
 445 //      } else {
 446 //          cout << "        NONE" <<  endl;
 447 //      }
 448     }
 449   }
 450   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 451     if (from == 0) cout << "Instantiated: FGPropeller" << endl;
 452     if (from == 1) cout << "Destroyed:    FGPropeller" << endl;
 453   }
 454   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 455   }
 456   if (debug_lvl & 8 ) { // Runtime state variables
 457   }
 458   if (debug_lvl & 16) { // Sanity checking
 459   }
 460   if (debug_lvl & 64) {
 461     if (from == 0) { // Constructor
 462       cout << IdSrc << endl;
 463       cout << IdHdr << endl;
 464     }
 465   }
 466 }
 467 }