src/FDM/JSBSim/FGSimTurbine.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGSimTurbine.cpp
   4  Author:       David Culp
   5  Date started: 03/11/2003
   6  Purpose:      This module models a turbine engine.
   7
   8  ------------- Copyright (C) 2003  David Culp (davidculp2@comcast.net) ---------
   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 This class descends from the FGEngine class and models a Turbine engine based
  31 on parameters given in the engine config file for this class
  32
  33 HISTORY
  34 --------------------------------------------------------------------------------
  35 03/11/2003  DPC  Created
  36 09/08/2003  DPC  Changed Calculate() and added engine phases
  37
  38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  39 INCLUDES
  40 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  41
  42 #include <vector>
  43 #include "FGSimTurbine.h"
  44
  45 namespace JSBSim {
  46
  47 static const char *IdSrc = "$Id$";
  48 static const char *IdHdr = ID_SIMTURBINE;
  49
  50 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  51 CLASS IMPLEMENTATION
  52 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  53
  54
  55 FGSimTurbine::FGSimTurbine(FGFDMExec* exec, FGConfigFile* cfg) : FGEngine(exec)
  56 {
  57   SetDefaults();
  58   FGEngine::Type=etSimTurbine;
  59   Load(cfg);
  60   Debug(0);
  61 }
  62
  63 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  64
  65 FGSimTurbine::~FGSimTurbine()
  66 {
  67   Debug(1);
  68 }
  69
  70 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  71 // The main purpose of Calculate() is to determine what phase the engine should
  72 // be in, then call the corresponding function.
  73
  74 double FGSimTurbine::Calculate(double dummy)
  75 {
  76   TAT = (Auxiliary->GetTotalTemperature() - 491.69) * 0.5555556;
  77   dt = State->Getdt() * Propulsion->GetRate();
  78   ThrottleCmd = FCS->GetThrottleCmd(EngineNumber);
  79
  80   // When trimming is finished check if user wants engine OFF or RUNNING
  81   if ((phase == tpTrim) && (dt > 0)) {
  82     if (Running && !Starved) {
  83       phase = tpRun;
  84       N2 = IdleN2;
  85       N1 = IdleN1;
  86       OilTemp_degK = TAT + 10;
  87       Cutoff = false;
  88       }
  89     else {
  90       phase = tpOff;
  91       Cutoff = true;
  92       EGT_degC = TAT;
  93       }
  94     }
  95
  96   if (!Running && Cutoff && Starter) {
  97      if (phase == tpOff) phase = tpSpinUp;
  98      }
  99   if (!Running && !Cutoff && (N2 > 15.0)) phase = tpStart;
 100   if (Cutoff && (phase != tpSpinUp)) phase = tpOff;
 101   if (dt == 0) phase = tpTrim;
 102   if (Starved) phase = tpOff;
 103   if (Stalled) phase = tpStall;
 104   if (Seized) phase = tpSeize;
 105
 106   switch (phase) {
 107     case tpOff:    Thrust = Off(); break;
 108     case tpRun:    Thrust = Run(); break;
 109     case tpSpinUp: Thrust = SpinUp(); break;
 110     case tpStart:  Thrust = Start(); break;
 111     case tpStall:  Thrust = Stall(); break;
 112     case tpSeize:  Thrust = Seize(); break;
 113     case tpTrim:   Thrust = Trim(); break;
 114     default: Thrust = Off();
 115   }
 116
 117   return Thrust;
 118 }
 119
 120 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 121
 122 double FGSimTurbine::Off(void)
 123 {
 124     double qbar = Translation->Getqbar();
 125     Running = false;
 126     FuelFlow_pph = Seek(&FuelFlow_pph, 0, 1000.0, 10000.0);
 127     N1 = Seek(&N1, qbar/10.0, N1/2.0, N1/2.0);
 128     N2 = Seek(&N2, qbar/15.0, N2/2.0, N2/2.0);
 129     EGT_degC = Seek(&EGT_degC, TAT, 11.7, 7.3);
 130     OilTemp_degK = Seek(&OilTemp_degK, TAT + 273.0, 0.2, 0.2);
 131     OilPressure_psi = N2 * 0.62;
 132     NozzlePosition = Seek(&NozzlePosition, 1.0, 0.8, 0.8);
 133     EPR = Seek(&EPR, 1.0, 0.2, 0.2);
 134     return 0.0;
 135 }
 136
 137 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 138
 139 double FGSimTurbine::Run(void)
 140 {
 141     double idlethrust, milthrust, thrust;
 142     double N2norm;   // 0.0 = idle N2, 1.0 = maximum N2
 143     idlethrust = MilThrust * ThrustTables[0]->TotalValue();
 144     milthrust = (MilThrust - idlethrust) * ThrustTables[1]->TotalValue();
 145
 146     Running = true;
 147     Starter = false;
 148
 149     N2 = Seek(&N2, IdleN2 + ThrottleCmd * N2_factor, delay, delay * 3.0);
 150     N1 = Seek(&N1, IdleN1 + ThrottleCmd * N1_factor, delay, delay * 2.4);
 151     N2norm = (N2 - IdleN2) / N2_factor;
 152     thrust = idlethrust + (milthrust * N2norm * N2norm);
 153     thrust = thrust * (1.0 - BleedDemand);
 154     EGT_degC = TAT + 363.1 + ThrottleCmd * 357.1;
 155     OilPressure_psi = N2 * 0.62;
 156     OilTemp_degK = Seek(&OilTemp_degK, 366.0, 1.2, 0.1);
 157     EPR = 1.0 + thrust/MilThrust;
 158     if (!Augmentation) {
 159       FuelFlow_pph = Seek(&FuelFlow_pph, thrust * TSFC, 1000.0, 100000);
 160       if (FuelFlow_pph < IdleFF) FuelFlow_pph = IdleFF;
 161       NozzlePosition = Seek(&NozzlePosition, 1.0 - N2norm, 0.8, 0.8);
 162     }
 163     if (Reversed) thrust = thrust * -0.2;
 164
 165     if (AugMethod == 1) {
 166       if ((ThrottleCmd > 0.99) && (N2 > 97.0)) {Augmentation = true;}
 167         else {Augmentation = false;}
 168       }
 169
 170     if ((Augmented == 1) && Augmentation) {
 171       thrust = MaxThrust * ThrustTables[2]->TotalValue();
 172       FuelFlow_pph = Seek(&FuelFlow_pph, thrust * ATSFC, 5000.0, 10000.0);
 173       NozzlePosition = Seek(&NozzlePosition, 1.0, 0.8, 0.8);
 174       }
 175
 176     if ((Injected == 1) && Injection)
 177       thrust = thrust * ThrustTables[3]->TotalValue();
 178
 179     ConsumeFuel();
 180     if (Cutoff) phase = tpOff;
 181     if (Starved) phase = tpOff;
 182     return thrust;
 183 }
 184
 185 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 186
 187 double FGSimTurbine::SpinUp(void)
 188 {
 189     Running = false;
 190     FuelFlow_pph = 0.0;
 191     N2 = Seek(&N2, 25.18, 3.0, N2/2.0);
 192     N1 = Seek(&N1, 5.21, 1.0, N1/2.0);
 193     EGT_degC = Seek(&EGT_degC, TAT, 11.7, 7.3);
 194     OilPressure_psi = N2 * 0.62;
 195     OilTemp_degK = Seek(&OilTemp_degK, TAT + 273.0, 0.2, 0.2);
 196     EPR = 1.0;
 197     NozzlePosition = 1.0;
 198     return 0.0;
 199 }
 200
 201 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 202
 203 double FGSimTurbine::Start(void)
 204 {
 205     if ((N2 > 15.0) && !Starved) {       // minimum 15% N2 needed for start
 206       Cranking = true;                   // provided for sound effects signal
 207       if (N2 < IdleN2) {
 208         N2 = Seek(&N2, IdleN2, 2.0, N2/2.0);
 209         N1 = Seek(&N1, IdleN1, 1.4, N1/2.0);
 210         EGT_degC = Seek(&EGT_degC, TAT + 363.1, 21.3, 7.3);
 211         FuelFlow_pph = Seek(&FuelFlow_pph, IdleFF, 103.7, 103.7);
 212         OilPressure_psi = N2 * 0.62;
 213         }
 214       else {
 215         phase = tpRun;
 216         Running = true;
 217         Starter = false;
 218         Cranking = false;
 219         }
 220       }
 221     else {                 // no start if N2 < 15%
 222       phase = tpOff;
 223       Starter = false;
 224       }
 225     return 0.0;
 226 }
 227
 228 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 229
 230 double FGSimTurbine::Stall(void)
 231 {
 232     double qbar = Translation->Getqbar();
 233     EGT_degC = TAT + 903.14;
 234     FuelFlow_pph = IdleFF;
 235     N1 = Seek(&N1, qbar/10.0, 0, N1/10.0);
 236     N2 = Seek(&N2, qbar/15.0, 0, N2/10.0);
 237     if (ThrottleCmd == 0) phase = tpRun;        // clear the stall with throttle
 238     return 0.0;
 239 }
 240
 241 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 242
 243 double FGSimTurbine::Seize(void)
 244 {
 245     double qbar = Translation->Getqbar();
 246     N2 = 0.0;
 247     N1 = Seek(&N1, qbar/20.0, 0, N1/15.0);
 248     FuelFlow_pph = IdleFF;
 249     OilPressure_psi = 0.0;
 250     OilTemp_degK = Seek(&OilTemp_degK, TAT + 273.0, 0, 0.2);
 251     Running = false;
 252     return 0.0;
 253 }
 254
 255 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 256
 257 double FGSimTurbine::Trim(void)
 258 {
 259     double idlethrust, milthrust, thrust;
 260     idlethrust = MilThrust * ThrustTables[0]->TotalValue();
 261     milthrust = (MilThrust - idlethrust) * ThrustTables[1]->TotalValue();
 262     thrust = idlethrust + (milthrust * ThrottleCmd * ThrottleCmd);
 263     return thrust;
 264 }
 265
 266 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 267
 268 double FGSimTurbine::CalcFuelNeed(void)
 269 {
 270   return FuelFlow_pph /3600 * State->Getdt() * Propulsion->GetRate();
 271 }
 272
 273 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 274
 275 double FGSimTurbine::GetPowerAvailable(void) {
 276   if( ThrottleCmd <= 0.77 )
 277     return 64.94*ThrottleCmd;
 278   else
 279     return 217.38*ThrottleCmd - 117.38;
 280 }
 281
 282 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 283
 284 double FGSimTurbine::Seek(double *var, double target, double accel, double decel) {
 285   double v = *var;
 286   if (v > target) {
 287     v -= dt * decel;
 288     if (v < target) v = target;
 289   } else if (v < target) {
 290     v += dt * accel;
 291     if (v > target) v = target;
 292   }
 293   return v;
 294 }
 295
 296 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 297
 298 void FGSimTurbine::SetDefaults(void)
 299 {
 300   Name = "None_Defined";
 301   MilThrust = 10000.0;
 302   MaxThrust = 10000.0;
 303   BypassRatio = 0.0;
 304   TSFC = 0.8;
 305   ATSFC = 1.7;
 306   IdleN1 = 30.0;
 307   IdleN2 = 60.0;
 308   MaxN1 = 100.0;
 309   MaxN2 = 100.0;
 310   Augmented = 0;
 311   AugMethod = 0;
 312   Injected = 0;
 313   BleedDemand = 0.0;
 314   ThrottleCmd = 0.0;
 315   InletPosition = 1.0;
 316   NozzlePosition = 1.0;
 317   Augmentation = false;
 318   Injection = false;
 319   Reversed = false;
 320   phase = tpOff;
 321   Stalled = false;
 322   Seized = false;
 323   Overtemp = false;
 324   Fire = false;
 325 }
 326
 327 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 328
 329 bool FGSimTurbine::Load(FGConfigFile *Eng_cfg)
 330 {
 331   int i;
 332   string token;
 333   Name = Eng_cfg->GetValue("NAME");
 334   cout << Name << endl;
 335   Eng_cfg->GetNextConfigLine();
 336   *Eng_cfg >> token >> MilThrust;
 337   *Eng_cfg >> token >> MaxThrust;
 338   *Eng_cfg >> token >> BypassRatio;
 339   *Eng_cfg >> token >> TSFC;
 340   *Eng_cfg >> token >> ATSFC;
 341   *Eng_cfg >> token >> IdleN1;
 342   *Eng_cfg >> token >> IdleN2;
 343   *Eng_cfg >> token >> MaxN1;
 344   *Eng_cfg >> token >> MaxN2;
 345   *Eng_cfg >> token >> Augmented;
 346   *Eng_cfg >> token >> AugMethod;
 347   *Eng_cfg >> token >> Injected;
 348   i=0;
 349   while( Eng_cfg->GetValue() != string("/FG_SIMTURBINE") && i < 10){
 350     ThrustTables.push_back( new FGCoefficient(FDMExec) );
 351     ThrustTables.back()->Load(Eng_cfg);
 352     i++;
 353   }
 354
 355   // pre-calculations and initializations
 356   delay= 60.0 / (BypassRatio + 3.0);
 357   N1_factor = MaxN1 - IdleN1;
 358   N2_factor = MaxN2 - IdleN2;
 359   OilTemp_degK = (Auxiliary->GetTotalTemperature() - 491.69) * 0.5555556 + 273.0;
 360   IdleFF = pow(MilThrust, 0.2) * 107.0;  // just an estimate
 361   return true;
 362 }
 363
 364
 365 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 366 //    The bitmasked value choices are as follows:
 367 //    unset: In this case (the default) JSBSim would only print
 368 //       out the normally expected messages, essentially echoing
 369 //       the config files as they are read. If the environment
 370 //       variable is not set, debug_lvl is set to 1 internally
 371 //    0: This requests JSBSim not to output any messages
 372 //       whatsoever.
 373 //    1: This value explicity requests the normal JSBSim
 374 //       startup messages
 375 //    2: This value asks for a message to be printed out when
 376 //       a class is instantiated
 377 //    4: When this value is set, a message is displayed when a
 378 //       FGModel object executes its Run() method
 379 //    8: When this value is set, various runtime state variables
 380 //       are printed out periodically
 381 //    16: When set various parameters are sanity checked and
 382 //       a message is printed out when they go out of bounds
 383
 384 void FGSimTurbine::Debug(int from)
 385 {
 386   if (debug_lvl <= 0) return;
 387
 388   if (debug_lvl & 1) { // Standard console startup message output
 389     if (from == 0) { // Constructor
 390
 391     }
 392   }
 393   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 394     if (from == 0) cout << "Instantiated: FGSimTurbine" << endl;
 395     if (from == 1) cout << "Destroyed:    FGSimTurbine" << endl;
 396   }
 397   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 398   }
 399   if (debug_lvl & 8 ) { // Runtime state variables
 400   }
 401   if (debug_lvl & 16) { // Sanity checking
 402   }
 403   if (debug_lvl & 64) {
 404     if (from == 0) { // Constructor
 405       cout << IdSrc << endl;
 406       cout << IdHdr << endl;
 407     }
 408   }
 409 }
 410 }