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