src/FDM/JSBSim/FGPiston.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGPiston.cpp
   4  Author:       Jon S. Berndt
   5  Date started: 09/12/2000
   6  Purpose:      This module models a Piston engine
   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 This class descends from the FGEngine class and models a Piston engine based on
  31 parameters given in the engine config file for this class
  32
  33 HISTORY
  34 --------------------------------------------------------------------------------
  35 09/12/2000  JSB  Created
  36
  37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #include "FGDefs.h"
  42 #include "FGPiston.h"
  43 #include "FGPropulsion.h"
  44
  45 static const char *IdSrc = "$Id$";
  46 static const char *IdHdr = ID_PISTON;
  47
  48 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  49 CLASS IMPLEMENTATION
  50 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  51
  52 FGPiston::FGPiston(FGFDMExec* exec, FGConfigFile* Eng_cfg)
  53   : FGEngine(exec),
  54     MinManifoldPressure_inHg(6.5),
  55     MaxManifoldPressure_inHg(28.5),
  56     Displacement(360),
  57     MaxHP(200),
  58     Cycles(2),
  59     IdleRPM(600),
  60     // Set constants
  61     CONVERT_CUBIC_INCHES_TO_METERS_CUBED(1.638706e-5),
  62     R_air(287.3),
  63     rho_fuel(800),                 // estimate
  64     calorific_value_fuel(47.3e6),
  65     Cp_air(1005),
  66     Cp_fuel(1700)
  67 {
  68   string token;
  69
  70   Name = Eng_cfg->GetValue("NAME");
  71   Eng_cfg->GetNextConfigLine();
  72   while (Eng_cfg->GetValue() != "/FG_PISTON") {
  73     *Eng_cfg >> token;
  74     if      (token == "MINMP") *Eng_cfg >> MinManifoldPressure_inHg;
  75     else if (token == "MAXMP") *Eng_cfg >> MaxManifoldPressure_inHg;
  76     else if (token == "DISPLACEMENT") *Eng_cfg >> Displacement;
  77     else if (token == "MAXHP") *Eng_cfg >> MaxHP;
  78     else if (token == "CYCLES") *Eng_cfg >> Cycles;
  79     else if (token == "IDLERPM") *Eng_cfg >> IdleRPM;
  80     else if (token == "MAXTHROTTLE") *Eng_cfg >> MaxThrottle;
  81     else if (token == "MINTHROTTLE") *Eng_cfg >> MinThrottle;
  82     else if (token == "SLFUELFLOWMAX") *Eng_cfg >> SLFuelFlowMax;
  83     else cerr << "Unhandled token in Engine config file: " << token << endl;
  84   }
  85
  86   if (debug_lvl > 0) {
  87     cout << "\n    Engine Name: " << Name << endl;
  88     cout << "      MinManifoldPressure: " << MinManifoldPressure_inHg << endl;
  89     cout << "      MaxManifoldPressure: " << MaxManifoldPressure_inHg << endl;
  90     cout << "      Displacement: " << Displacement << endl;
  91     cout << "      MaxHP: " << MaxHP << endl;
  92     cout << "      Cycles: " << Cycles << endl;
  93     cout << "      IdleRPM: " << IdleRPM << endl;
  94     cout << "      MaxThrottle: " << MaxThrottle << endl;
  95     cout << "      MinThrottle: " << MinThrottle << endl;
  96     cout << "      SLFuelFlowMax: " << SLFuelFlowMax << endl;
  97   }
  98
  99   Type = etPiston;
 100   EngineNumber = 0;    // FIXME: this should be the actual number
 101   OilTemp_degK = 298;  // FIXME: should be initialized in FGEngine
 102
 103   dt = State->Getdt();
 104
 105   // Initialisation
 106   volumetric_efficiency = 0.8;  // Actually f(speed, load) but this will get us running
 107
 108   // First column is thi, second is neta (combustion efficiency)
 109   Lookup_Combustion_Efficiency = new FGTable(12);
 110   *Lookup_Combustion_Efficiency << 0.00 << 0.980;
 111   *Lookup_Combustion_Efficiency << 0.90 << 0.980;
 112   *Lookup_Combustion_Efficiency << 1.00 << 0.970;
 113   *Lookup_Combustion_Efficiency << 1.05 << 0.950;
 114   *Lookup_Combustion_Efficiency << 1.10 << 0.900;
 115   *Lookup_Combustion_Efficiency << 1.15 << 0.850;
 116   *Lookup_Combustion_Efficiency << 1.20 << 0.790;
 117   *Lookup_Combustion_Efficiency << 1.30 << 0.700;
 118   *Lookup_Combustion_Efficiency << 1.40 << 0.630;
 119   *Lookup_Combustion_Efficiency << 1.50 << 0.570;
 120   *Lookup_Combustion_Efficiency << 1.60 << 0.525;
 121   *Lookup_Combustion_Efficiency << 2.00 << 0.345;
 122
 123   cout << endl;
 124   cout << "      Combustion Efficiency table:" << endl;
 125   Lookup_Combustion_Efficiency->Print();
 126   cout << endl;
 127
 128   Power_Mixture_Correlation = new FGTable(13);
 129   *Power_Mixture_Correlation << (14.7/1.6) << 78.0;
 130   *Power_Mixture_Correlation << 10 <<  86.0;
 131   *Power_Mixture_Correlation << 11 <<  93.5;
 132   *Power_Mixture_Correlation << 12 <<  98.0;
 133   *Power_Mixture_Correlation << 13 << 100.0;
 134   *Power_Mixture_Correlation << 14 <<  99.0;
 135   *Power_Mixture_Correlation << 15 <<  96.4;
 136   *Power_Mixture_Correlation << 16 <<  92.5;
 137   *Power_Mixture_Correlation << 17 <<  88.0;
 138   *Power_Mixture_Correlation << 18 <<  83.0;
 139   *Power_Mixture_Correlation << 19 <<  78.5;
 140   *Power_Mixture_Correlation << 20 <<  74.0;
 141   *Power_Mixture_Correlation << (14.7/0.6) << 58;
 142
 143   cout << endl;
 144   cout << "      Power Mixture Correlation table:" << endl;
 145   Power_Mixture_Correlation->Print();
 146   cout << endl;
 147
 148   if (debug_lvl & 2) cout << "Instantiated: FGPiston" << endl;
 149 }
 150
 151 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 152
 153 FGPiston::~FGPiston()
 154 {
 155   if (debug_lvl & 2) cout << "Destroyed:    FGPiston" << endl;
 156 }
 157
 158 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 159
 160 float FGPiston::Calculate(float PowerRequired)
 161 {
 162   float h,EngineMaxPower;
 163
 164         // FIXME: calculate from actual fuel flow
 165   ConsumeFuel();
 166
 167   Throttle = FCS->GetThrottlePos(EngineNumber);
 168   Mixture = FCS->GetMixturePos(EngineNumber);
 169
 170   //
 171   // Input values.
 172   //
 173
 174   p_amb = Atmosphere->GetPressure() * 48;              // convert from lbs/ft2 to Pa
 175   p_amb_sea_level = Atmosphere->GetPressureSL() * 48;
 176   T_amb = Atmosphere->GetTemperature() * (5.0 / 9.0);  // convert from Rankine to Kelvin
 177
 178   RPM = Propulsion->GetThruster(EngineNumber)->GetRPM();
 179   //if (RPM < IdleRPM) RPM = IdleRPM;  // kludge
 180
 181   IAS = Auxiliary->GetVcalibratedKTS();
 182
 183   if (Mixture >= 0.5) {
 184     doEngineStartup();
 185     doManifoldPressure();
 186     doAirFlow();
 187     doFuelFlow();
 188     doEnginePower();
 189     doEGT();
 190     doCHT();
 191     doOilTemperature();
 192     doOilPressure();
 193   } else {
 194     HP = 0;
 195   }
 196
 197   PowerAvailable = (HP * HPTOFTLBSSEC) - PowerRequired;
 198   return PowerAvailable;
 199 }
 200
 201 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 202 /**
 203  * Start or stop the engine.
 204  */
 205
 206 void FGPiston::doEngineStartup(void)
 207 {
 208   // TODO: check magnetos, spark, starter, etc. and decide whether
 209   // engine is running
 210
 211   // Check parameters that may alter the operating state of the engine.
 212   // (spark, fuel, starter motor etc)
 213   bool spark;
 214   bool fuel;
 215   static int crank_counter = 0;
 216
 217   // Check for spark
 218   Magneto_Left = false;
 219   Magneto_Right = false;
 220   // Magneto positions:
 221   // 0 -> off
 222   // 1 -> left only
 223   // 2 -> right only
 224   // 3 -> both
 225   if (Magnetos != 0) {
 226     spark = true;
 227   } else {
 228     spark = false;
 229   }  // neglects battery voltage, master on switch, etc for now.
 230
 231   if ((Magnetos == 1) || (Magnetos > 2)) Magneto_Left = true;
 232   if (Magnetos > 1)  Magneto_Right = true;
 233
 234   // Assume we have fuel for now
 235   fuel = true;
 236
 237   // Check if we are turning the starter motor
 238   if (Cranking != Starter) {
 239     // This check saves .../cranking from getting updated every loop - they
 240     // only update when changed.
 241     Cranking = Starter;
 242     crank_counter = 0;
 243   }
 244
 245   //Check mode of engine operation
 246   // ACK - unfortunately this hack doesn't work in JSBSim since the RPM is reset
 247   // each iteration by the propeller :-(
 248   if (Cranking) {
 249     crank_counter++;
 250     if (RPM <= 480) {
 251       RPM += 100;
 252       if (RPM > 480)
 253         RPM = 480;
 254     } else {
 255       // consider making a horrible noise if the starter is engaged with
 256       // the engine running
 257     }
 258     // TODO - find a better guess at cranking speed
 259   }
 260
 261   // if ((!Running) && (spark) && (fuel) && (crank_counter > 120)) {
 262
 263   if ((!Running) && (spark) && (fuel)) {
 264   // start the engine if revs high enough
 265     if (RPM > 450) {
 266       // For now just instantaneously start but later we should maybe crank for
 267       // a bit
 268       Running = true;
 269       // RPM = 600;
 270     }
 271   }
 272
 273   if ( (Running) && ((!spark)||(!fuel)) ) {
 274     // Cut the engine
 275     // note that we only cut the power - the engine may continue to
 276     // spin if the prop is in a moving airstream
 277     Running = false;
 278   }
 279
 280   // And finally a last check for stalling
 281   if (Running) {
 282     //Check if we have stalled the engine
 283     if (RPM == 0) {
 284       Running = false;
 285     } else if ((RPM <= 480) && (Cranking)) {
 286       // Make sure the engine noise dosn't play if the engine won't
 287             // start due to eg mixture lever pulled out.
 288       Running = false;
 289     }
 290   }
 291 }
 292
 293 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 294
 295 /**
 296  * Calculate the nominal manifold pressure in inches hg
 297  *
 298  * This function calculates nominal manifold pressure directly
 299  * from the throttle position, and does not adjust it for the
 300  * difference between the pressure at sea level and the pressure
 301  * at the current altitude (that adjustment takes place in
 302  * {@link #doEnginePower}).
 303  *
 304  * TODO: changes in MP should not be instantaneous -- introduce
 305  * a lag between throttle changes and MP changes, to allow pressure
 306  * to build up or disperse.
 307  *
 308  * Inputs: MinManifoldPressure_inHg, MaxManifoldPressure_inHg, Throttle
 309  *
 310  * Outputs: ManifoldPressure_inHg
 311  */
 312
 313 void FGPiston::doManifoldPressure(void)
 314 {
 315   ManifoldPressure_inHg = MinManifoldPressure_inHg +
 316     (Throttle * (MaxManifoldPressure_inHg - MinManifoldPressure_inHg));
 317 }
 318
 319 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 320 /**
 321  * Calculate the air flow through the engine.
 322  *
 323  * Inputs: p_amb, R_air, T_amb, ManifoldPressure_inHg, Displacement,
 324  *   RPM, volumetric_efficiency
 325  *
 326  * Outputs: rho_air, m_dot_air
 327  */
 328
 329 void FGPiston::doAirFlow(void)
 330 {
 331   rho_air = p_amb / (R_air * T_amb);
 332   float rho_air_manifold = rho_air * ManifoldPressure_inHg / 29.6;
 333   float displacement_SI = Displacement * CONVERT_CUBIC_INCHES_TO_METERS_CUBED;
 334   float swept_volume = (displacement_SI * (RPM/60)) / 2;
 335   float v_dot_air = swept_volume * volumetric_efficiency;
 336   m_dot_air = v_dot_air * rho_air_manifold;
 337 }
 338
 339 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 340 /**
 341  * Calculate the fuel flow into the engine.
 342  *
 343  * Inputs: Mixture, thi_sea_level, p_amb_sea_level, p_amb, m_dot_air
 344  *
 345  * Outputs: equivalence_ratio, m_dot_fuel
 346  */
 347
 348 void FGPiston::doFuelFlow(void)
 349 {
 350   float thi_sea_level = 1.3 * Mixture;
 351   equivalence_ratio = thi_sea_level * p_amb_sea_level / p_amb;
 352   m_dot_fuel = m_dot_air / 14.7 * equivalence_ratio;
 353 }
 354
 355 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 356 /**
 357  * Calculate the power produced by the engine.
 358  *
 359  * <p>Currently, the JSBSim propellor model does not allow the
 360  * engine to produce enough RPMs to get up to a high horsepower.
 361  * When tested with sufficient RPM, it has no trouble reaching
 362  * 200HP.</p>
 363  *
 364  * Inputs: ManifoldPressure_inHg, p_amb, p_amb_sea_level, RPM, T_amb,
 365  *   equivalence_ratio, Cycles, MaxHP
 366  *
 367  * Outputs: Percentage_Power, HP
 368  */
 369
 370 void FGPiston::doEnginePower(void)
 371 {
 372   float True_ManifoldPressure_inHg = ManifoldPressure_inHg * p_amb / p_amb_sea_level;
 373   float ManXRPM = True_ManifoldPressure_inHg * RPM;
 374         // FIXME: this needs to be generalized
 375   Percentage_Power = (6e-9 * ManXRPM * ManXRPM) + (8e-4 * ManXRPM) - 1.0;
 376   float T_amb_degF = (T_amb * 1.8) - 459.67;
 377   float T_amb_sea_lev_degF = (288 * 1.8) - 459.67;
 378   Percentage_Power =
 379     Percentage_Power + ((T_amb_sea_lev_degF - T_amb_degF) * 7 /120);
 380   float Percentage_of_best_power_mixture_power =
 381     Power_Mixture_Correlation->GetValue(14.7 / equivalence_ratio);
 382   Percentage_Power =
 383     Percentage_Power * Percentage_of_best_power_mixture_power / 100.0;
 384   if (Percentage_Power < 0.0)
 385     Percentage_Power = 0.0;
 386   else if (Percentage_Power > 100.0)
 387     Percentage_Power = 100.0;
 388   HP = Percentage_Power * MaxHP / 100.0;
 389
 390   //Hack
 391   if (!Running) {
 392     if (Cranking) {
 393       if (RPM < 480) {
 394         HP = 3.0 + ((480 - RPM) / 10.0);
 395       } else {
 396         HP = 3.0;
 397       }
 398     } else {
 399       // Quick hack until we port the FMEP stuff
 400       if (RPM > 0.0)
 401         HP = -1.5;
 402       else
 403         HP = 0.0;
 404     }
 405   }
 406 }
 407
 408 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 409 /**
 410  * Calculate the exhaust gas temperature.
 411  *
 412  * Inputs: equivalence_ratio, m_dot_fuel, calorific_value_fuel,
 413  *   Cp_air, m_dot_air, Cp_fuel, m_dot_fuel, T_amb, Percentage_Power
 414  *
 415  * Outputs: combustion_efficiency, ExhaustGasTemp_degK
 416  */
 417
 418 void FGPiston::doEGT(void)
 419 {
 420   combustion_efficiency = Lookup_Combustion_Efficiency->GetValue(equivalence_ratio);
 421   float enthalpy_exhaust = m_dot_fuel * calorific_value_fuel *
 422     combustion_efficiency * 0.33;
 423   float heat_capacity_exhaust = (Cp_air * m_dot_air) + (Cp_fuel * m_dot_fuel);
 424   float delta_T_exhaust = enthalpy_exhaust / heat_capacity_exhaust;
 425   ExhaustGasTemp_degK = T_amb + delta_T_exhaust;
 426   ExhaustGasTemp_degK *= 0.444 + ((0.544 - 0.444) * Percentage_Power / 100.0);
 427 }
 428
 429 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 430 /**
 431  * Calculate the cylinder head temperature.
 432  *
 433  * Inputs: T_amb, IAS, rho_air, m_dot_fuel, calorific_value_fuel,
 434  *   combustion_efficiency, RPM
 435  *
 436  * Outputs: CylinderHeadTemp_degK
 437  */
 438
 439 void FGPiston::doCHT(void)
 440 {
 441   float h1 = -95.0;
 442   float h2 = -3.95;
 443   float h3 = -0.05;
 444
 445   float arbitary_area = 1.0;
 446   float CpCylinderHead = 800.0;
 447   float MassCylinderHead = 8.0;
 448
 449   float temperature_difference = CylinderHeadTemp_degK - T_amb;
 450   float v_apparent = IAS * 0.5144444;
 451   float v_dot_cooling_air = arbitary_area * v_apparent;
 452   float m_dot_cooling_air = v_dot_cooling_air * rho_air;
 453   float dqdt_from_combustion =
 454     m_dot_fuel * calorific_value_fuel * combustion_efficiency * 0.33;
 455   float dqdt_forced = (h2 * m_dot_cooling_air * temperature_difference) +
 456     (h3 * RPM * temperature_difference);
 457   float dqdt_free = h1 * temperature_difference;
 458   float dqdt_cylinder_head = dqdt_from_combustion + dqdt_forced + dqdt_free;
 459
 460   float HeatCapacityCylinderHead = CpCylinderHead * MassCylinderHead;
 461
 462   CylinderHeadTemp_degK = dqdt_cylinder_head / HeatCapacityCylinderHead;
 463 }
 464
 465 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 466 /**
 467  * Calculate the oil temperature.
 468  *
 469  * Inputs: Percentage_Power, running flag.
 470  *
 471  * Outputs: OilTemp_degK
 472  */
 473
 474 void FGPiston::doOilTemperature(void)
 475 {
 476   float idle_percentage_power = 2.3;        // approximately
 477   float target_oil_temp;        // Steady state oil temp at the current engine conditions
 478   float time_constant;          // The time constant for the differential equation
 479
 480   if (Running) {
 481     target_oil_temp = 363;
 482     time_constant = 500;        // Time constant for engine-on idling.
 483     if (Percentage_Power > idle_percentage_power) {
 484       time_constant /= ((Percentage_Power / idle_percentage_power) / 10.0); // adjust for power
 485     }
 486   } else {
 487     target_oil_temp = 298;
 488     time_constant = 1000;  // Time constant for engine-off; reflects the fact
 489                            // that oil is no longer getting circulated
 490   }
 491
 492   float dOilTempdt = (target_oil_temp - OilTemp_degK) / time_constant;
 493
 494   OilTemp_degK += (dOilTempdt * dt);
 495 }
 496
 497 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 498 /**
 499  * Calculate the oil pressure.
 500  *
 501  * Inputs: RPM
 502  *
 503  * Outputs: OilPressure_psi
 504  */
 505
 506 void FGPiston::doOilPressure(void)
 507 {
 508   float Oil_Press_Relief_Valve = 60; // FIXME: may vary by engine
 509   float Oil_Press_RPM_Max = 1800;    // FIXME: may vary by engine
 510   float Design_Oil_Temp = 85;        // FIXME: may vary by engine
 511              // FIXME: WRONG!!! (85 degK???)
 512   float Oil_Viscosity_Index = 0.25;
 513
 514   OilPressure_psi = (Oil_Press_Relief_Valve / Oil_Press_RPM_Max) * RPM;
 515
 516   if (OilPressure_psi >= Oil_Press_Relief_Valve) {
 517     OilPressure_psi = Oil_Press_Relief_Valve;
 518   }
 519
 520   OilPressure_psi += (Design_Oil_Temp - OilTemp_degK) * Oil_Viscosity_Index;
 521 }
 522
 523 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 524
 525 void FGPiston::Debug(void)
 526 {
 527   //TODO: Add your source code here
 528 }
 529