Add preliminary operation modes for Booster engine

Author: peternewell

Source/Orts.Simulation/Simulation/Confirmer.cs

@@ -221,7 +221,7 @@ public Confirmer(Simulator simulator, double defaultDurationS)
                 , new string [] { GetString("Cylinder Cocks"), GetString("close"), null, GetString("open") }
                 , new string [] { GetString("Steam Booster Air Valve"), GetString("close"), null, GetString("open") }
                 , new string [] { GetString("Steam Booster Idle Valve"), GetString("idle"), null, GetString("run") }
-                , new string [] { GetString("Steam Booster Latch"), GetString("close"), null, GetString("open") }
+                , new string [] { GetString("Steam Booster Latch"), GetString("opened"), null, GetString("locked") }
                 , new string [] { GetString("Cylinder Compound"), GetString("close"), null, GetString("open") }
                 , new string [] { GetString("LargeEjector"), null, null, null, GetString("decrease"), GetString("increase") }
                 , new string [] { GetString("SmallEjector"), null, null, null, GetString("decrease"), GetString("increase") }

Source/Orts.Simulation/Simulation/RollingStocks/MSTSSteamLocomotive.cs

@@ -130,6 +130,9 @@ public class MSTSSteamLocomotive : MSTSLocomotive
         public bool SteamBoosterLatchOn = false;
         public bool SteamBoosterIdle = false;
         public bool SteamBoosterAirOpen = false;
+        public bool SteamBoosterRunMode = false;
+        public bool SteamBoosterIdleMode = false;
+        public bool SteamBoosterLatchedLocked = false;
 
         /// <summary>
         /// Grate limit of locomotive exceedeed?
@@ -1092,11 +1095,11 @@ public override void Initialize()
 
             if (MSTSNumCylinders < 0 && ZeroError(MSTSNumCylinders, "NumCylinders"))
                 MSTSNumCylinders = 0;
-            if (ZeroError(MSTSCylinderDiameterM, "CylinderDiammeter"))
+            if (ZeroError(MSTSCylinderDiameterM, "MSTSCylinderDiameter"))
                 MSTSCylinderDiameterM = 1;
-            if (ZeroError(MSTSCylinderStrokeM, "CylinderStroke"))
+            if (ZeroError(MSTSCylinderStrokeM, "MSTSCylinderStroke"))
                 MSTSCylinderStrokeM = 1;
-            if (ZeroError(DriverWheelRadiusM, "WheelRadius"))
+            if (ZeroError(DriverWheelRadiusM, "MSTSWheelRadius"))
                 DriverWheelRadiusM = Me.FromIn(30.0f); // Wheel radius of loco drive wheels can be anywhere from about 10" to 40"
             if (ZeroError(MaxBoilerPressurePSI, "MaxBoilerPressure"))
                 MaxBoilerPressurePSI = 1;
@@ -2175,19 +2178,54 @@ public override void Update(float elapsedClockSeconds)
 
             for (int i = 0; i < SteamEngines.Count; i++)
             {
-            //    Trace.TraceInformation("Booster - Air {0} Idle {1} Latch {2}", SteamBoosterAirOpen, SteamBoosterIdle, SteamBoosterLatchOn);
 
                 SteamEngines[i].IndicatedHorsePowerHP = (N.ToLbf(SteamEngines[i].TractiveForceN) * pS.TopH(Me.ToMi(absSpeedMpS))) / 375.0f;
 
                 if (SteamEngines[i].AuxiliarySteamEngineType != SteamEngine.AuxiliarySteamEngineTypes.Booster)
                 {
                     UpdateCylinders(elapsedClockSeconds, throttle, cutoff, absSpeedMpS, i);
                 }
-                else if (SteamBoosterAirOpen && SteamBoosterLatchOn)  // Booster Engine
+                else if (SteamEngines[i].AuxiliarySteamEngineType == SteamEngine.AuxiliarySteamEngineTypes.Booster)  // Booster Engine
                 {
                     var boosterthrottle = 0.0f;
                     var boostercutoff = SteamEngines[i].BoosterCutoff;
-                    UpdateCylinders(elapsedClockSeconds, boosterthrottle, boostercutoff, absSpeedMpS, i);
+
+                    // Confirm that Latch is on
+                    if (SteamBoosterLatchOn && cutoff > SteamEngines[i].BoosterThrottleCutoff)
+                    {
+                        SteamBoosterLatchedLocked = true;
+                    }
+                    else
+                    {
+                        SteamBoosterLatchedLocked = false;
+                    }
+
+                    // Identify operating mode for the Booster
+                    // Idle mode
+                    if (SteamBoosterAirOpen && !SteamBoosterIdle && SteamBoosterLatchedLocked)
+                    {
+                        SteamBoosterRunMode = false;
+                        SteamBoosterIdleMode = true;
+                        boosterthrottle = 0.2f;
+                    }
+                    // Run mode
+                    else if (SteamBoosterAirOpen && SteamBoosterIdle && SteamBoosterLatchedLocked)
+                    {
+                        SteamBoosterIdleMode = false;
+                        SteamBoosterRunMode = true;
+                        boosterthrottle = 1.0f;
+                    }
+                    else if (!SteamBoosterAirOpen || !SteamBoosterLatchedLocked)
+                    {
+                        SteamBoosterRunMode = false;
+                        SteamBoosterIdleMode = false;
+                        boosterthrottle = 0;
+                    }
+
+                    if (SteamBoosterRunMode || SteamBoosterIdleMode)
+                    {
+                        UpdateCylinders(elapsedClockSeconds, boosterthrottle, boostercutoff, absSpeedMpS, i);
+                    }
                 }
                 BoilerMassLB -= elapsedClockSeconds * SteamEngines[i].CylinderSteamUsageLBpS; //  Boiler mass will be reduced by cylinder steam usage
                 BoilerHeatBTU -= elapsedClockSeconds * SteamEngines[i].CylinderSteamUsageLBpS * (BoilerSteamHeatBTUpLB - BoilerWaterHeatBTUpLB); //  Boiler Heat will be reduced by heat required to replace the cylinder steam usage, ie create steam from hot water. 
@@ -2199,12 +2237,15 @@ public override void Update(float elapsedClockSeconds)
 
                 SteamEngines[i].TractiveForceN = 0;
 
-                if (SteamEngines[i].AuxiliarySteamEngineType != SteamEngine.AuxiliarySteamEngineTypes.Booster || (SteamBoosterAirOpen && SteamBoosterLatchOn))
-                UpdateTractiveForce(elapsedClockSeconds, 0, 0, 0, i);
+                if (SteamEngines[i].AuxiliarySteamEngineType == SteamEngine.AuxiliarySteamEngineTypes.Booster && (SteamBoosterIdleMode || SteamBoosterRunMode))
+                    UpdateTractiveForce(elapsedClockSeconds, 0, 0, 0, i);
+                else
+                {
+                    UpdateTractiveForce(elapsedClockSeconds, 0, 0, 0, i);
+                }
 
                 TractiveForceN += SteamEngines[i].TractiveForceN;
 
-
                 MotiveForceN += SteamEngines[i].AttachedAxle.CompensatedAxleForceN;
             }
 
@@ -3857,7 +3898,6 @@ private void UpdateCylinders(float elapsedClockSeconds, float throttle, float cu
 
             // Initialise values used in this module
 
-
 #if DEBUG_STEAM_CYLINDER_EVENTS
 
             // THIS CODE IS NOT FULLY OPERATIONAL AT THIS TIME
@@ -6641,7 +6681,7 @@ public override string GetDebugStatus()
                 }
             }
 
-            status.AppendFormat("{0}\t{1}\t{2}\t{3}\t{4}\t{5}\t{6}\t{7}\t{8}\n",
+            status.AppendFormat("{0}\t{1}\t{2}\t{3}\t{4}\t{5}\t{6}\t{7}\t{8}\t{9}\t{10}\t{11}\t{12}\n",
                 Simulator.Catalog.GetString("Status:"),
                 Simulator.Catalog.GetString("Safety"),
                 SafetyIsOn ? Simulator.Catalog.GetString("Open") : Simulator.Catalog.GetString("Closed"),
@@ -6650,7 +6690,11 @@ public override string GetDebugStatus()
                 Simulator.Catalog.GetString("Prime"),
                 BoilerIsPriming ? Simulator.Catalog.GetString("Yes") : Simulator.Catalog.GetString("No"),
                 Simulator.Catalog.GetString("Comp"),
-                CylinderCompoundOn ? Simulator.Catalog.GetString("Off") : Simulator.Catalog.GetString("On")
+                CylinderCompoundOn ? Simulator.Catalog.GetString("Off") : Simulator.Catalog.GetString("On"),
+                Simulator.Catalog.GetString("BoostIdle"),
+                SteamBoosterIdleMode ? Simulator.Catalog.GetString("On") : Simulator.Catalog.GetString("Off"),
+                Simulator.Catalog.GetString("BoostRun"),
+                SteamBoosterRunMode ? Simulator.Catalog.GetString("On") : Simulator.Catalog.GetString("Off")
                 );
 
 #if DEBUG_LOCO_STEAM_USAGE

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/SteamEngine.cs

@@ -338,7 +338,7 @@ public enum AuxiliarySteamEngineTypes
         public float BoosterCutoff;
 
         /// <summary>
-        /// Booster Throttle cutoff position
+        /// Booster Throttle cutoff position based upon the postion of the main engine reverser
         /// </summary>
         public float BoosterThrottleCutoff;
 
@@ -563,6 +563,7 @@ public enum SettingsFlags
             LPNumberCylindersF = 0x0004,
             LPCylindersDiameterF = 0x0005,
             LPCylinderStrokeF = 0x0006,
+            AttachedAxleIdF = 0x0007,
             BoosterCutoffF = 0x0009,
             BoosterThrottleCutoffF = 0x0009,
             BoosterGearRatioF = 0x0010,       
@@ -596,11 +597,27 @@ public bool IsInitialized
         {
             get
             {
-                if (initLevel == (SettingsFlags.NumberCylindersF | SettingsFlags.CylindersDiameterF | SettingsFlags.CylinderStrokeF | SettingsFlags.LPNumberCylindersF | SettingsFlags.LPCylindersDiameterF | SettingsFlags.LPCylinderStrokeF | SettingsFlags.BoosterCutoffF | SettingsFlags.BoosterThrottleCutoffF | SettingsFlags.BoosterGearRatioF))
-
-                    return true;
+                var initCheck = false;
+                if (AuxiliarySteamEngineType == AuxiliarySteamEngineTypes.Booster)
+                {
+                    // Checks to see if a Booster engine has been correctly configured
+                    if (initLevel == (SettingsFlags.NumberCylindersF | SettingsFlags.CylindersDiameterF | SettingsFlags.CylinderStrokeF | SettingsFlags.AttachedAxleIdF | SettingsFlags.BoosterCutoffF | SettingsFlags.BoosterGearRatioF | SettingsFlags.BoosterThrottleCutoffF))
+                    {
+                        initCheck = true;
+                    }
+                }
+                else if (AuxiliarySteamEngineType != AuxiliarySteamEngineTypes.Booster)
+                {
+                    // Checks to see if a non-booster engine has been correctly defined
+                    if (initLevel == (SettingsFlags.NumberCylindersF | SettingsFlags.CylindersDiameterF | SettingsFlags.CylinderStrokeF | SettingsFlags.AttachedAxleIdF))
+                    {
+                        initCheck = true;
+                    }
+                }
                 else
-                    return false;
+                    initCheck = false;
+
+                return initCheck;
             }
         }
 
@@ -610,7 +627,7 @@ public SteamEngine(MSTSSteamLocomotive locomotive)
             Locomotive = locomotive;
         }
 
-        public bool SteamEngineConfigured = false; // flag to indicate that the user has configured a diesel engine prime mover code block in the ENG file
+        public bool SteamEngineConfigured = false; // flag to indicate that the user has configured a steam engine prime mover code block in the ENG file
 
 
         /// <summary>
@@ -634,9 +651,9 @@ public virtual void Parse(STFReader stf)
                     case "lpcylinderstroke": LPCylindersStrokeM = stf.ReadFloatBlock(STFReader.UNITS.Distance, null); initLevel |= SettingsFlags.LPCylinderStrokeF; break;
                     case "lpcylinderdiameter": LPCylindersDiameterM = stf.ReadFloatBlock(STFReader.UNITS.Distance, null); initLevel |= SettingsFlags.LPCylindersDiameterF; break;
                     case "boostercutoff": BoosterCutoff = stf.ReadFloatBlock(STFReader.UNITS.None, null); initLevel |= SettingsFlags.BoosterCutoffF; break;
-                    case "boosterthrottlecutoff": BoosterThrottleCutoff = stf.ReadFloatBlock(STFReader.UNITS.None, null); initLevel |= SettingsFlags.BoosterCutoffF; break;
+                    case "boosterthrottlecutoff": BoosterThrottleCutoff = stf.ReadFloatBlock(STFReader.UNITS.None, null); initLevel |= SettingsFlags.BoosterThrottleCutoffF; break;
                     case "boostergearratio": BoosterGearRatio = stf.ReadFloatBlock(STFReader.UNITS.None, null); initLevel |= SettingsFlags.BoosterGearRatioF; break;
-                    case "attachedaxle": AttachedAxleId = stf.ReadIntBlock(null); break;
+                    case "attachedaxle": AttachedAxleId = stf.ReadIntBlock(null); initLevel |= SettingsFlags.AttachedAxleIdF; break;
 
                     case "auxiliarysteamenginetype":
                         stf.MustMatch("(");