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
  40 static const char *IdSrc = "$Id$";
  41 static const char *IdHdr = ID_PROPELLER;
  42
  43 extern short debug_lvl;
  44
  45 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  46 CLASS IMPLEMENTATION
  47 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  48
  49
  50 FGPropeller::FGPropeller(FGFDMExec* exec, FGConfigFile* Prop_cfg) : FGThruster(exec)
  51 {
  52   string token;
  53   int rows, cols;
  54
  55   MaxPitch = MinPitch = 0.0;
  56
  57   Name = Prop_cfg->GetValue("NAME");
  58   Prop_cfg->GetNextConfigLine();
  59   while (Prop_cfg->GetValue() != "/FG_PROPELLER") {
  60     *Prop_cfg >> token;
  61     if (token == "IXX") {
  62       *Prop_cfg >> Ixx;
  63     } else if (token == "DIAMETER") {
  64       *Prop_cfg >> Diameter;
  65       Diameter /= 12.0;
  66     } else if (token == "NUMBLADES") {
  67       *Prop_cfg >> numBlades;
  68     } else if (token == "MINPITCH") {
  69       *Prop_cfg >> MinPitch;
  70     } else if (token == "MAXPITCH") {
  71       *Prop_cfg >> MaxPitch;
  72     } else if (token == "EFFICIENCY") {
  73       *Prop_cfg >> rows >> cols;
  74       if (cols == 1) Efficiency = new FGTable(rows);
  75             else           Efficiency = new FGTable(rows, cols);
  76       *Efficiency << *Prop_cfg;
  77     } else if (token == "C_THRUST") {
  78       *Prop_cfg >> rows >> cols;
  79       if (cols == 1) cThrust = new FGTable(rows);
  80             else           cThrust = new FGTable(rows, cols);
  81       *cThrust << *Prop_cfg;
  82     } else if (token == "C_POWER") {
  83       *Prop_cfg >> rows >> cols;
  84       if (cols == 1) cPower = new FGTable(rows);
  85             else           cPower = new FGTable(rows, cols);
  86       *cPower << *Prop_cfg;
  87     } else if (token == "EOF") {
  88       cerr << "      End of file reached" <<  endl;
  89       break;
  90     } else {
  91       cerr << "Unhandled token in Propeller config file: " << token << endl;
  92     }
  93   }
  94
  95   if (debug_lvl > 0) {
  96     cout << "\n    Propeller Name: " << Name << endl;
  97     cout << "      IXX = " << Ixx << endl;
  98     cout << "      Diameter = " << Diameter << " ft." << endl;
  99     cout << "      Number of Blades  = " << numBlades << endl;
 100     cout << "      Minimum Pitch  = " << MinPitch << endl;
 101     cout << "      Maximum Pitch  = " << MaxPitch << endl;
 102     cout << "      Efficiency: " <<  endl;
 103     Efficiency->Print();
 104     cout << "      Thrust Coefficient: " <<  endl;
 105     cThrust->Print();
 106     cout << "      Power Coefficient: " <<  endl;
 107     cPower->Print();
 108   }
 109
 110   Type = ttPropeller;
 111   RPM = 0;
 112
 113   if (debug_lvl & 2) cout << "Instantiated: FGPropeller" << endl;
 114 }
 115
 116 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 117
 118 FGPropeller::~FGPropeller()
 119 {
 120   if (Efficiency) delete Efficiency;
 121   if (cThrust)    delete cThrust;
 122   if (cPower)     delete cPower;
 123   if (debug_lvl & 2) cout << "Destroyed:    FGPropeller" << endl;
 124 }
 125
 126 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 127 //
 128 // We must be getting the aerodynamic velocity here, NOT the inertial velocity.
 129 // We need the velocity with respect to the wind.
 130 //
 131 // Note that PowerAvailable is the excess power available after the drag of the
 132 // propeller has been subtracted. At equilibrium, PowerAvailable will be zero -
 133 // indicating that the propeller will not accelerate or decelerate.
 134 // Remembering that Torque * omega = Power, we can derive the torque on the
 135 // propeller and its acceleration to give a new RPM. The current RPM will be
 136 // used to calculate thrust.
 137 //
 138 // Because RPM could be zero, we need to be creative about what RPM is stated as.
 139
 140 float FGPropeller::Calculate(float PowerAvailable)
 141 {
 142   float J, C_Thrust, omega;
 143   float Vel = (fdmex->GetTranslation()->GetUVW())(1);
 144   float rho = fdmex->GetAtmosphere()->GetDensity();
 145   float RPS = RPM/60.0;
 146
 147   if (RPM > 0.10) {
 148     J = Vel / (Diameter * RPM / 60.0);
 149   } else {
 150     J = 0.0;
 151   }
 152
 153   if (MaxPitch == MinPitch) { // Fixed pitch prop
 154     C_Thrust = cThrust->GetValue(J);
 155   } else {                    // Variable pitch prop
 156     C_Thrust = cThrust->GetValue(J, Pitch);
 157   }
 158
 159   Thrust = C_Thrust*RPS*RPS*Diameter*Diameter*Diameter*Diameter*rho;
 160   vFn(1) = Thrust;
 161   omega = RPS*2.0*M_PI;
 162
 163   if (omega <= 5) omega = 1.0;
 164
 165   Torque = PowerAvailable / omega;
 166   RPM = (RPS + ((Torque / Ixx) / (2.0 * M_PI)) * deltaT) * 60.0;
 167   return Thrust; // return thrust in pounds
 168 }
 169
 170 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 171
 172 float FGPropeller::GetPowerRequired(void)
 173 {
 174   if (RPM <= 0.10) return 0.0; // If the prop ain't turnin', the fuel ain't burnin'.
 175
 176   float cPReq, RPS = RPM / 60.0;
 177
 178   float J = (fdmex->GetTranslation()->GetUVW())(1) / (Diameter * RPS);
 179   float rho = fdmex->GetAtmosphere()->GetDensity();
 180
 181   if (MaxPitch == MinPitch) { // Fixed pitch prop
 182     cPReq = cPower->GetValue(J);
 183   } else {                    // Variable pitch prop
 184     cPReq = cPower->GetValue(J, Pitch);
 185   }
 186
 187   PowerRequired = cPReq*RPS*RPS*RPS*Diameter*Diameter*Diameter*Diameter
 188                                                        *Diameter*rho;
 189   return PowerRequired;
 190 }
 191
 192 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 193
 194 void FGPropeller::Debug(void)
 195 {
 196     //TODO: Add your source code here
 197 }
 198