]> git.mxchange.org Git - flightgear.git/blobdiff - src/FDM/JSBSim/FGPiston.cpp
Sync. with JSBSim CVS.
[flightgear.git] / src / FDM / JSBSim / FGPiston.cpp
index 58485a2e44bbef4e0d927a3b43e4065a5e285103..263591e48b7baeaab9843b5e9d1739a2a23ae316 100644 (file)
@@ -1,7 +1,8 @@
 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  Module:       FGPiston.cpp
- Author:       Jon S. Berndt
+ Author:       Jon S. Berndt, JSBSim framework
+               Dave Luff, Piston engine model
  Date started: 09/12/2000
  Purpose:      This module models a Piston engine
 
@@ -41,6 +42,8 @@ INCLUDES
 #include "FGPiston.h"
 #include "FGPropulsion.h"
 
+namespace JSBSim {
+
 static const char *IdSrc = "$Id$";
 static const char *IdHdr = ID_PISTON;
 
@@ -48,62 +51,30 @@ static const char *IdHdr = ID_PISTON;
 CLASS IMPLEMENTATION
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
-FGPiston::FGPiston(FGFDMExec* exec, FGConfigFile* Eng_cfg)
-  : FGEngine(exec),
-  //these must be initialized this way as they are declared const
-  CONVERT_CUBIC_INCHES_TO_METERS_CUBED(1.638706e-5),
+FGPiston::FGPiston(FGFDMExec* exec, FGConfigFile* Eng_cfg) : FGEngine(exec),
   R_air(287.3),
   rho_fuel(800),                 // estimate
   calorific_value_fuel(47.3e6),
   Cp_air(1005),
   Cp_fuel(1700)
 {
-  
   string token;
 
-  MinManifoldPressure_inHg=6.5;
-  MaxManifoldPressure_inHg=28.5;
-  Displacement=360;
-  MaxHP=200;
-  Cycles=2;
-  IdleRPM=600;
-  // Set constants
-  
-  
-  Name = Eng_cfg->GetValue("NAME");
-  Eng_cfg->GetNextConfigLine();
-  while (Eng_cfg->GetValue() != string("/FG_PISTON")) {
-    *Eng_cfg >> token;
-    if      (token == "MINMP") *Eng_cfg >> MinManifoldPressure_inHg;
-    else if (token == "MAXMP") *Eng_cfg >> MaxManifoldPressure_inHg;
-    else if (token == "DISPLACEMENT") *Eng_cfg >> Displacement;
-    else if (token == "MAXHP") *Eng_cfg >> MaxHP;
-    else if (token == "CYCLES") *Eng_cfg >> Cycles;
-    else if (token == "IDLERPM") *Eng_cfg >> IdleRPM;
-    else if (token == "MAXTHROTTLE") *Eng_cfg >> MaxThrottle;
-    else if (token == "MINTHROTTLE") *Eng_cfg >> MinThrottle;
-    else if (token == "SLFUELFLOWMAX") *Eng_cfg >> SLFuelFlowMax;
-    else cerr << "Unhandled token in Engine config file: " << token << endl;
-  }
-
-  if (debug_lvl > 0) {
-    cout << "\n    Engine Name: " << Name << endl;
-    cout << "      MinManifoldPressure: " << MinManifoldPressure_inHg << endl;
-    cout << "      MaxManifoldPressure: " << MaxManifoldPressure_inHg << endl;
-    cout << "      Displacement: " << Displacement << endl;
-    cout << "      MaxHP: " << MaxHP << endl;
-    cout << "      Cycles: " << Cycles << endl;
-    cout << "      IdleRPM: " << IdleRPM << endl;
-    cout << "      MaxThrottle: " << MaxThrottle << endl;
-    cout << "      MinThrottle: " << MinThrottle << endl;
-    cout << "      SLFuelFlowMax: " << SLFuelFlowMax << endl;
-  }
-
   Type = etPiston;
   crank_counter = 0;
-  EngineNumber = 0;    // FIXME: this should be the actual number
-  OilTemp_degK = 298;  // FIXME: should be initialized in FGEngine
+  EngineNumber = 0;
+  OilTemp_degK = 298;
+  MinManifoldPressure_inHg = 6.5;
+  MaxManifoldPressure_inHg = 28.5;
+  ManifoldPressure_inHg = Atmosphere->GetPressure() * psftoinhg; // psf to in Hg
+  CylinderHeadTemp_degK = 0.0;
+  Displacement = 360;
+  MaxHP = 200;
+  Cycles = 2;
+  IdleRPM = 600;
+  Magnetos = 0;
+  ExhaustGasTemp_degK = 0.0;
+  EGT_degC = 0.0;
 
   dt = State->Getdt();
 
@@ -125,11 +96,6 @@ FGPiston::FGPiston(FGFDMExec* exec, FGConfigFile* Eng_cfg)
   *Lookup_Combustion_Efficiency << 1.60 << 0.525;
   *Lookup_Combustion_Efficiency << 2.00 << 0.345;
 
-  cout << endl;
-  cout << "      Combustion Efficiency table:" << endl;
-  Lookup_Combustion_Efficiency->Print();
-  cout << endl;
-
   Power_Mixture_Correlation = new FGTable(13);
   *Power_Mixture_Correlation << (14.7/1.6) << 78.0;
   *Power_Mixture_Correlation << 10 <<  86.0;
@@ -145,28 +111,36 @@ FGPiston::FGPiston(FGFDMExec* exec, FGConfigFile* Eng_cfg)
   *Power_Mixture_Correlation << 20 <<  74.0;
   *Power_Mixture_Correlation << (14.7/0.6) << 58;
 
-  cout << endl;
-  cout << "      Power Mixture Correlation table:" << endl;
-  Power_Mixture_Correlation->Print();
-  cout << endl;
+  Name = Eng_cfg->GetValue("NAME");
+  Eng_cfg->GetNextConfigLine();
+  while (Eng_cfg->GetValue() != string("/FG_PISTON")) {
+    *Eng_cfg >> token;
+    if      (token == "MINMP") *Eng_cfg >> MinManifoldPressure_inHg;
+    else if (token == "MAXMP") *Eng_cfg >> MaxManifoldPressure_inHg;
+    else if (token == "DISPLACEMENT") *Eng_cfg >> Displacement;
+    else if (token == "MAXHP") *Eng_cfg >> MaxHP;
+    else if (token == "CYCLES") *Eng_cfg >> Cycles;
+    else if (token == "IDLERPM") *Eng_cfg >> IdleRPM;
+    else if (token == "MAXTHROTTLE") *Eng_cfg >> MaxThrottle;
+    else if (token == "MINTHROTTLE") *Eng_cfg >> MinThrottle;
+    else cerr << "Unhandled token in Engine config file: " << token << endl;
+  }
 
-  if (debug_lvl & 2) cout << "Instantiated: FGPiston" << endl;
+  Debug(0); // Call Debug() routine from constructor if needed
 }
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 FGPiston::~FGPiston()
 {
-  if (debug_lvl & 2) cout << "Destroyed:    FGPiston" << endl;
+  Debug(1); // Call Debug() routine from constructor if needed
 }
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 double FGPiston::Calculate(double PowerRequired)
 {
-
-        // FIXME: calculate from actual fuel flow
-  ConsumeFuel();
+  if (FuelFlow_gph > 0.0) ConsumeFuel();
 
   Throttle = FCS->GetThrottlePos(EngineNumber);
   Mixture = FCS->GetMixturePos(EngineNumber);
@@ -179,24 +153,28 @@ double FGPiston::Calculate(double PowerRequired)
   p_amb_sea_level = Atmosphere->GetPressureSL() * 48;
   T_amb = Atmosphere->GetTemperature() * (5.0 / 9.0);  // convert from Rankine to Kelvin
 
-  RPM = Propulsion->GetThruster(EngineNumber)->GetRPM();
-  //if (RPM < IdleRPM) RPM = IdleRPM;  // kludge
+  RPM = Propulsion->GetThruster(EngineNumber)->GetRPM() *
+        Propulsion->GetThruster(EngineNumber)->GetGearRatio();
     
   IAS = Auxiliary->GetVcalibratedKTS();
 
-  if (Mixture >= 0.5) {
     doEngineStartup();
     doManifoldPressure();
     doAirFlow();
     doFuelFlow();
-    doEnginePower();
+
+  //Now that the fuel flow is done check if the mixture is too lean to run the engine
+  //Assume lean limit at 22 AFR for now - thats a thi of 0.668
+  //This might be a bit generous, but since there's currently no audiable warning of impending
+  //cutout in the form of misfiring and/or rough running its probably reasonable for now.
+  if (equivalence_ratio < 0.668)
+    Running = false;
+
+  doEnginePower();
     doEGT();
     doCHT();
     doOilTemperature();
     doOilPressure();
-  } else {
-    HP = 0;
-  }
 
   PowerAvailable = (HP * hptoftlbssec) - PowerRequired;
   return PowerAvailable;
@@ -209,9 +187,6 @@ double FGPiston::Calculate(double PowerRequired)
 
 void FGPiston::doEngineStartup(void)
 {
-  // TODO: check magnetos, spark, starter, etc. and decide whether
-  // engine is running
-
   // Check parameters that may alter the operating state of the engine. 
   // (spark, fuel, starter motor etc)
   bool spark;
@@ -235,7 +210,7 @@ void FGPiston::doEngineStartup(void)
   if (Magnetos > 1)  Magneto_Right = true;
 
   // Assume we have fuel for now
-  fuel = true;
+  fuel = !Starved;
 
   // Check if we are turning the starter motor
   if (Cranking != Starter) {
@@ -245,49 +220,28 @@ void FGPiston::doEngineStartup(void)
     crank_counter = 0;
   }
 
-  //Check mode of engine operation
-  // ACK - unfortunately this hack doesn't work in JSBSim since the RPM is reset
-  // each iteration by the propeller :-(
-  if (Cranking) {
-    crank_counter++;
-    if (RPM <= 480) {
-      RPM += 100;
-      if (RPM > 480)
-        RPM = 480;
-    } else {
-      // consider making a horrible noise if the starter is engaged with
-      // the engine running
-    }
-    // TODO - find a better guess at cranking speed
-  }
+  if (Cranking) crank_counter++;  //Check mode of engine operation
   
-  // if ((!Running) && (spark) && (fuel) && (crank_counter > 120)) {
-
-  if ((!Running) && (spark) && (fuel)) {
-  // start the engine if revs high enough
-    if (RPM > 450) {
-      // For now just instantaneously start but later we should maybe crank for
-      // a bit
-      Running = true;
-      // RPM = 600;
+  if (!Running && spark && fuel) {  // start the engine if revs high enough
+    if (Cranking) {
+      if ((RPM > 450) && (crank_counter > 175)) // Add a little delay to startup
+        Running = true;                         // on the starter
+    } else {
+      if (RPM > 450)                            // This allows us to in-air start
+        Running = true;                         // when windmilling
     }
   }
 
-  if ( (Running) && ((!spark)||(!fuel)) ) {
-    // Cut the engine
-    // note that we only cut the power - the engine may continue to
-    // spin if the prop is in a moving airstream
-    Running = false;
-  }
+  // Cut the engine *power* - Note: the engine may continue to
+  // spin if the prop is in a moving airstream
 
-  // And finally a last check for stalling
+  if ( Running && (!spark || !fuel) ) Running = false;
+
+  // Check for stalling (RPM = 0).
   if (Running) { 
-    //Check if we have stalled the engine
     if (RPM == 0) {
       Running = false;
     } else if ((RPM <= 480) && (Cranking)) {
-      // Make sure the engine noise dosn't play if the engine won't
-           // start due to eg mixture lever pulled out.
       Running = false;
     }
   }
@@ -315,14 +269,21 @@ void FGPiston::doEngineStartup(void)
 
 void FGPiston::doManifoldPressure(void)
 {
-  ManifoldPressure_inHg = MinManifoldPressure_inHg +
-    (Throttle * (MaxManifoldPressure_inHg - MinManifoldPressure_inHg));
+  if (Running || Cranking) {
+    ManifoldPressure_inHg = MinManifoldPressure_inHg +
+            (Throttle * (MaxManifoldPressure_inHg - MinManifoldPressure_inHg));
+  } else {
+    ManifoldPressure_inHg = Atmosphere->GetPressure() * psftoinhg; // psf to in Hg
+  }  
 }
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 /**
  * Calculate the air flow through the engine.
  *
+ * At this point, ManifoldPressure_inHg still represents the sea-level
+ * MP, not adjusted for altitude.
+ *
  * Inputs: p_amb, R_air, T_amb, ManifoldPressure_inHg, Displacement,
  *   RPM, volumetric_efficiency
  *
@@ -333,7 +294,7 @@ void FGPiston::doAirFlow(void)
 {
   rho_air = p_amb / (R_air * T_amb);
   double rho_air_manifold = rho_air * ManifoldPressure_inHg / 29.6;
-  double displacement_SI = Displacement * CONVERT_CUBIC_INCHES_TO_METERS_CUBED;
+  double displacement_SI = Displacement * in3tom3;
   double swept_volume = (displacement_SI * (RPM/60)) / 2;
   double v_dot_air = swept_volume * volumetric_efficiency;
   m_dot_air = v_dot_air * rho_air_manifold;
@@ -353,16 +314,20 @@ void FGPiston::doFuelFlow(void)
   double thi_sea_level = 1.3 * Mixture;
   equivalence_ratio = thi_sea_level * p_amb_sea_level / p_amb;
   m_dot_fuel = m_dot_air / 14.7 * equivalence_ratio;
+  FuelFlow_gph = m_dot_fuel
+    * 3600                     // seconds to hours
+    * 2.2046                   // kg to lb
+    / 6.6;                     // lb to gal_us of kerosene
 }
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 /**
  * Calculate the power produced by the engine.
  *
- * <p>Currently, the JSBSim propellor model does not allow the
+ * Currently, the JSBSim propellor model does not allow the
  * engine to produce enough RPMs to get up to a high horsepower.
  * When tested with sufficient RPM, it has no trouble reaching
- * 200HP.</p>
+ * 200HP.
  *
  * Inputs: ManifoldPressure_inHg, p_amb, p_amb_sea_level, RPM, T_amb, 
  *   equivalence_ratio, Cycles, MaxHP
@@ -372,29 +337,38 @@ void FGPiston::doFuelFlow(void)
 
 void FGPiston::doEnginePower(void)
 {
-  double True_ManifoldPressure_inHg = ManifoldPressure_inHg * p_amb / p_amb_sea_level;
-  double ManXRPM = True_ManifoldPressure_inHg * RPM;
-        // FIXME: this needs to be generalized
-  Percentage_Power = (6e-9 * ManXRPM * ManXRPM) + (8e-4 * ManXRPM) - 1.0;
-  double T_amb_degF = (T_amb * 1.8) - 459.67;
-  double T_amb_sea_lev_degF = (288 * 1.8) - 459.67; 
-  Percentage_Power =
-    Percentage_Power + ((T_amb_sea_lev_degF - T_amb_degF) * 7 /120);
-  double Percentage_of_best_power_mixture_power =
-    Power_Mixture_Correlation->GetValue(14.7 / equivalence_ratio);
-  Percentage_Power =
-    Percentage_Power * Percentage_of_best_power_mixture_power / 100.0;
-  if (Percentage_Power < 0.0)
-    Percentage_Power = 0.0;
-  else if (Percentage_Power > 100.0)
-    Percentage_Power = 100.0;
-  HP = Percentage_Power * MaxHP / 100.0;
-
-  //Hack
-  if (!Running) {
+  ManifoldPressure_inHg *= p_amb / p_amb_sea_level;
+
+  if (Running) {       
+    double ManXRPM = ManifoldPressure_inHg * RPM;
+    double T_amb_degF = KelvinToFahrenheit(T_amb);
+    double T_amb_sea_lev_degF = KelvinToFahrenheit(288); 
+
+    // FIXME: this needs to be generalized
+    Percentage_Power = (6e-9 * ManXRPM * ManXRPM) + (8e-4 * ManXRPM) - 1.0;
+    Percentage_Power += ((T_amb_sea_lev_degF - T_amb_degF) * 7 /120);
+
+    double Percentage_of_best_power_mixture_power =
+      Power_Mixture_Correlation->GetValue(14.7 / equivalence_ratio);
+
+    Percentage_Power *= Percentage_of_best_power_mixture_power / 100.0;
+
+    if (Percentage_Power < 0.0) Percentage_Power = 0.0;
+    else if (Percentage_Power > 100.0) Percentage_Power = 100.0;
+    
+    HP = Percentage_Power * MaxHP / 100.0;
+
+  } else {
+
+    // Power output when the engine is not running
     if (Cranking) {
-      if (RPM < 480) {
-        HP = 3.0 + ((480 - RPM) / 10.0);
+      if (RPM < 10) {
+        HP = 3.0;   // This is a hack to prevent overshooting the idle rpm in
+                    // the first time step. It may possibly need to be changed
+                    // if the prop model is changed.
+      } else if (RPM < 480) {
+        HP = 3.0 + ((480 - RPM) / 10.0);  
+        // This is a guess - would be nice to find a proper starter moter torque curve
       } else {
         HP = 3.0;
       }
@@ -420,13 +394,24 @@ void FGPiston::doEnginePower(void)
 
 void FGPiston::doEGT(void)
 {
-  combustion_efficiency = Lookup_Combustion_Efficiency->GetValue(equivalence_ratio);
-  double enthalpy_exhaust = m_dot_fuel * calorific_value_fuel * 
-    combustion_efficiency * 0.33;
-  double heat_capacity_exhaust = (Cp_air * m_dot_air) + (Cp_fuel * m_dot_fuel);
-  double delta_T_exhaust = enthalpy_exhaust / heat_capacity_exhaust;
-  ExhaustGasTemp_degK = T_amb + delta_T_exhaust;
-  ExhaustGasTemp_degK *= 0.444 + ((0.544 - 0.444) * Percentage_Power / 100.0);
+  double delta_T_exhaust;
+  double enthalpy_exhaust;
+  double heat_capacity_exhaust;
+  double dEGTdt;
+
+  if ((Running) && (m_dot_air > 0.0)) {  // do the energy balance
+    combustion_efficiency = Lookup_Combustion_Efficiency->GetValue(equivalence_ratio);
+    enthalpy_exhaust = m_dot_fuel * calorific_value_fuel * 
+                              combustion_efficiency * 0.33;
+    heat_capacity_exhaust = (Cp_air * m_dot_air) + (Cp_fuel * m_dot_fuel);
+    delta_T_exhaust = enthalpy_exhaust / heat_capacity_exhaust;
+    ExhaustGasTemp_degK = T_amb + delta_T_exhaust;
+    ExhaustGasTemp_degK *= 0.444 + ((0.544 - 0.444) * Percentage_Power / 100.0);
+  } else {  // Drop towards ambient - guess an appropriate time constant for now
+    dEGTdt = (298.0 - ExhaustGasTemp_degK) / 100.0;
+    delta_T_exhaust = dEGTdt * dt;
+    ExhaustGasTemp_degK += delta_T_exhaust;
+  }
 }
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -462,7 +447,8 @@ void FGPiston::doCHT(void)
     
   double HeatCapacityCylinderHead = CpCylinderHead * MassCylinderHead;
     
-  CylinderHeadTemp_degK = dqdt_cylinder_head / HeatCapacityCylinderHead;
+  CylinderHeadTemp_degK +=
+    (dqdt_cylinder_head / HeatCapacityCylinderHead) * dt;
 }
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -510,8 +496,7 @@ void FGPiston::doOilPressure(void)
 {
   double Oil_Press_Relief_Valve = 60; // FIXME: may vary by engine
   double Oil_Press_RPM_Max = 1800;    // FIXME: may vary by engine
-  double Design_Oil_Temp = 85;        // FIXME: may vary by engine
-             // FIXME: WRONG!!! (85 degK???)
+  double Design_Oil_Temp = 358;              // degK; FIXME: may vary by engine
   double Oil_Viscosity_Index = 0.25;
 
   OilPressure_psi = (Oil_Press_Relief_Valve / Oil_Press_RPM_Max) * RPM;
@@ -524,9 +509,76 @@ void FGPiston::doOilPressure(void)
 }
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+//
+//    The bitmasked value choices are as follows:
+//    unset: In this case (the default) JSBSim would only print
+//       out the normally expected messages, essentially echoing
+//       the config files as they are read. If the environment
+//       variable is not set, debug_lvl is set to 1 internally
+//    0: This requests JSBSim not to output any messages
+//       whatsoever.
+//    1: This value explicity requests the normal JSBSim
+//       startup messages
+//    2: This value asks for a message to be printed out when
+//       a class is instantiated
+//    4: When this value is set, a message is displayed when a
+//       FGModel object executes its Run() method
+//    8: When this value is set, various runtime state variables
+//       are printed out periodically
+//    16: When set various parameters are sanity checked and
+//       a message is printed out when they go out of bounds
+
+void FGPiston::Debug(int from)
+{
+  if (debug_lvl <= 0) return;
+
+  if (debug_lvl & 1) { // Standard console startup message output
+    if (from == 0) { // Constructor
+
+      cout << "\n    Engine Name: "         << Name << endl;
+      cout << "      MinManifoldPressure: " << MinManifoldPressure_inHg << endl;
+      cout << "      MaxManifoldPressure: " << MaxManifoldPressure_inHg << endl;
+      cout << "      Displacement: "        << Displacement             << endl;
+      cout << "      MaxHP: "               << MaxHP                    << endl;
+      cout << "      Cycles: "              << Cycles                   << endl;
+      cout << "      IdleRPM: "             << IdleRPM                  << endl;
+      cout << "      MaxThrottle: "         << MaxThrottle              << endl;
+      cout << "      MinThrottle: "         << MinThrottle              << endl;
+
+      cout << endl;
+      cout << "      Combustion Efficiency table:" << endl;
+      Lookup_Combustion_Efficiency->Print();
+      cout << endl;
+
+      cout << endl;
+      cout << "      Power Mixture Correlation table:" << endl;
+      Power_Mixture_Correlation->Print();
+      cout << endl;
+
+    }
+  }
+  if (debug_lvl & 2 ) { // Instantiation/Destruction notification
+    if (from == 0) cout << "Instantiated: FGPiston" << endl;
+    if (from == 1) cout << "Destroyed:    FGPiston" << endl;
+  }
+  if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
+  }
+  if (debug_lvl & 8 ) { // Runtime state variables
+  }
+  if (debug_lvl & 16) { // Sanity checking
+  }
+  if (debug_lvl & 64) {
+    if (from == 0) { // Constructor
+      cout << IdSrc << endl;
+      cout << IdHdr << endl;
+    }
+  }
+}
 
-void FGPiston::Debug(void)
+double
+FGPiston::CalcFuelNeed(void)
 {
-  //TODO: Add your source code here
+  return FuelFlow_gph / 3600 * 6 * State->Getdt() * Propulsion->GetRate();
 }
 
+} // namespace JSBSim