Automatic merge of T1.6-186-g21d9ada29 and 13 pull requests

- Pull request #1082 at b49a693: Allow variable water level in glass gauge
- Pull request #1057 at 85bde8e: Switchable brake system
- Pull request #1081 at a8127a1: Brake cuts power unification
- Pull request #1091 at 378be55: Automatic speed control
- Pull request #1122 at 73c47b4: Wagon Size and Centering Controls
- Pull request #1124 at e241a0d: Built-in PBL2 brake controller
- Pull request #1128 at b6c197f: Particle Emitter Overhaul
- Pull request #1158 at 2599bfe: Temporary fix for bug 2121985: F9 TCO out-of-range after resume
- Pull request #1169 at 906f204: Revise TrainCar.SetUpWheels to Better Handle Unusual Rolling Stock
- Pull request #1175 at d28315e: Make Data Logger interval configurable
- Pull request #1176 at 4cd961b: Remove Implicit Requirement for Engine Name to Come After "Engine ("
- Pull request #1178 at 015769e: Fix Diesel RPM Rate of Change
- Pull request #1183 at 41911f1: docs: Add code guidelines for translations

Author: openrails-bot

Source/Orts.Formats.Msts/CabViewFile.cs

@@ -140,6 +140,7 @@ public enum CABViewControlTypes
         WATER_INJECTOR1,
         WATER_INJECTOR2,
         SMALL_EJECTOR,
+        BACK_PR,
         STEAM_PR,
         STEAMCHEST_PR,
         TENDER_WATER,

Source/Orts.Simulation/Common/SteamTable.cs

@@ -1088,31 +1088,6 @@ public static Interpolator LiveSteamInjectorWaterFedForSteamUsedAtPressureInterp
               1.0f, 1.0f, 1.0f, 0.988f, 0.965f, 0.912f, 0.859f, 0.800f, 0.753f, 0.706f, 0.659f, 0.612f, 0.571f, 0.535f, 0.500f, 0.471f, 0.447f, 0.433f, 0.424f, 0.420f, 0.410f, 0.410f
         };
 
-        // Indicated HorsePower - 
-        static float[] IndicatedHorsepowerIHP = new float[]
-        {
-              0.0f, 200.0f, 500.0f, 1000.0f, 1250.0f, 1500.0f, 1750.0f, 2000.0f, 2500.0f, 3000.0f,
-              3500.0f, 4000.0f, 4500.0f, 5000.0f, 5500.0f, 6000.0f, 6500.0f, 7000.0f, 7500.0f
-        };
-
-        // BackPressure - Saturated locomotive -  Ref Principles of Locomotive Operation and Train Operation - Fig 73 - pg 178 - Assume atmospheric -
-        // extrapolated beyond 1800IHP with test results from PRR Test reports
-        // 
-        static float[] BackPressureSatPSI = new float[]
-        {
-              1.0f, 1.5f, 2.0f, 3.0f, 3.75f, 4.5f, 5.6f, 7.0f, 10.0f, 12.8f,
-              15.5f, 18.5f, 22.0f, 26.0f, 30.0f, 35.0f, 40.0f, 45.0f, 50.0f
-        };
-
-        // BackPressure - Superheated locomotive -  Ref Principles of Locomotive Operation and Train Operation - Fig 73 - pg 178 - Assume atmospheric
-        // extrapolated beyond 1800IHP with test results from PRR Test reports
-        // 
-        static float[] BackPressureSuperPSI = new float[]
-        {
-              0.0f, 0.25f, 0.5f, 1.0f, 1.5f, 2.0f,2.5f, 2.8f, 3.5f,4.5f,
-              6.0f, 7.5f, 10.0f, 14.0f, 18.0f, 25.0f, 30.0f , 35.0f, 40.0f
-        };
-
         // Indicator Diagram - Cylinder Events
 
         // Indicator Diagram Event - Exhaust Open - Perwall program - http://5at.co.uk/index.php/references-and-links/software.html
@@ -1145,19 +1120,6 @@ public static Interpolator SuperheatTempLimitInterpolatorXtoDegF()
             return new Interpolator(CutOffFractionTableX, SuperheatCondenstationLimitTableDegF);
         }
 
-        // Saturated Backpressure - Ref Principles of Locomotive Operation
-        public static Interpolator BackpressureSatIHPtoPSI()
-        {
-            return new Interpolator(IndicatedHorsepowerIHP, BackPressureSatPSI);
-        }
-
-        // Superheated Backpressure - Ref Principles of Locomotive Operation
-        public static Interpolator BackpressureSuperIHPtoPSI()
-        {
-            return new Interpolator(IndicatedHorsepowerIHP, BackPressureSuperPSI);
-        }
-
-
         // Saturated Speed factor - ie drop in TE as speed increases due to piston impacts - Ref American locomotive Company
         public static Interpolator SaturatedSpeedFactorSpeedDropFtpMintoX()
         {

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

@@ -294,6 +294,7 @@ public class MSTSSteamLocomotive : MSTSLocomotive
         float FuelFeedRateKGpS;
         float DesiredChange;     // Amount of change to increase fire mass, clamped to range 0.0 - 1.0
         public float CylinderSteamUsageLBpS;
+        public float CylinderSteamUsageLBpH;
         public float NewCylinderSteamUsageLBpS;
         public float BlowerSteamUsageLBpS;
         public float FuelOilHeatingSteamUsageLbpS;
@@ -405,7 +406,8 @@ public class MSTSSteamLocomotive : MSTSLocomotive
         float LPCylinderSweptVolumeFT3pFT;     // Volume of LP steam Cylinder
         float CylinderCondensationFactor;  // Cylinder compensation factor for condensation in cylinder due to cutoff
         float BlowerSteamUsageFactor;
-        Interpolator BackPressureIHPtoPSI;             // back pressure in cylinders given usage
+        Interpolator BackPressureIHPtoPSI;             // back pressure in cylinders given usage - this value needs to be deprerecated
+        Interpolator BackPressuretoSteamOutput;        // back pressure in cylinders given steam usage
         Interpolator CylinderSteamDensityPSItoLBpFT3;   // steam density in cylinders given pressure (could be super heated)
         Interpolator WaterDensityPSItoLBpFT3;   // water density given pressure
         Interpolator WaterHeatPSItoBTUpLB;      // total heat in water given pressure
@@ -1018,6 +1020,7 @@ public override void Parse(string lowercasetoken, STFReader stf)
                 case "engine(ortscylinderefficiencyrate": CylinderEfficiencyRate = stf.ReadFloatBlock(STFReader.UNITS.None, null); break;
                 case "engine(ortscylinderinitialpressuredrop": InitialPressureDropRatioRpMtoX = new Interpolator(stf); break;
                 case "engine(ortscylinderbackpressure": BackPressureIHPtoPSI = new Interpolator(stf); break;
+                case "engine(ortscylinderbackpressurevssteamoutput": BackPressuretoSteamOutput = new Interpolator(stf); break;
                 case "engine(ortsburnrate": NewBurnRateSteamToFuelLbspH = new Interpolator(stf); break;
                 case "engine(ortsboilerefficiency": BoilerEfficiencyGrateAreaLBpFT2toX = new Interpolator(stf); break;
                 case "engine(ortscylindereventexhaust": CylinderExhausttoCutoff = new Interpolator(stf); break;
@@ -1190,6 +1193,7 @@ public override void Copy(MSTSWagon copy)
             CylinderEfficiencyRate = locoCopy.CylinderEfficiencyRate;
             InitialPressureDropRatioRpMtoX = new Interpolator(locoCopy.InitialPressureDropRatioRpMtoX);
             BackPressureIHPtoPSI = new Interpolator(locoCopy.BackPressureIHPtoPSI);
+            BackPressuretoSteamOutput = new Interpolator(locoCopy.BackPressuretoSteamOutput);
             NewBurnRateSteamToFuelLbspH = new Interpolator(locoCopy.NewBurnRateSteamToFuelLbspH);
             BoilerEfficiency = locoCopy.BoilerEfficiency;
             SteamGearRatioLow = locoCopy.SteamGearRatioLow;
@@ -2101,22 +2105,31 @@ public override void Initialize()
             // Assign default steam table values if table not in ENG file 
             // Back pressure increases with the speed of the locomotive, as cylinder finds it harder to exhaust all the steam.
 
-            if (BackPressureIHPtoPSI == null)
+            if (BackPressureIHPtoPSI != null)
             {
-                if (HasSuperheater)
-                {
-                    BackPressureIHPtoPSI = SteamTable.BackpressureSuperIHPtoPSI();
-                    if (Simulator.Settings.VerboseConfigurationMessages)
-                        Trace.TraceInformation("BackPressureIHPtoAtmPSI (Superheated) - default information read from SteamTables");
-                }
-                else
-                {
-                    BackPressureIHPtoPSI = SteamTable.BackpressureSatIHPtoPSI();
-                    if (Simulator.Settings.VerboseConfigurationMessages)
-                        Trace.TraceInformation("BackPressureIHPtoAtmPSI (Saturated) - default information read from SteamTables");
-                }
+                if (Simulator.Settings.VerboseConfigurationMessages)
+                    Trace.TraceInformation("ORTSCylinderBackPressure read. This is an inaccurate and depreceated value. It is thereofre suggested that either the OR default value is used (leave the ORTSCylinderBackPressure out) or use ORTSCylinderBackPressureVsSteamoutput instead.");
             }
 
+            // if no user input provided then assign default values
+            if (BackPressuretoSteamOutput == null)
+            {
+                float tempMaxBackPressurePSI = 0.0002762f * pS.TopH(TheoreticalMaxSteamOutputLBpS);
+
+                // Create a new default back pressure table based upon default information
+                float[] TempSteamOutputRate = new float[]
+                    {
+                               0.0f, pS.TopH(TheoreticalMaxSteamOutputLBpS * 0.1f), pS.TopH(TheoreticalMaxSteamOutputLBpS * 0.2f), pS.TopH(TheoreticalMaxSteamOutputLBpS * 0.3f), pS.TopH(TheoreticalMaxSteamOutputLBpS * 0.4f), pS.TopH(TheoreticalMaxSteamOutputLBpS * 0.5f), pS.TopH(TheoreticalMaxSteamOutputLBpS * 0.6f), pS.TopH(TheoreticalMaxSteamOutputLBpS * 0.7f), pS.TopH(TheoreticalMaxSteamOutputLBpS * 0.8f), pS.TopH(TheoreticalMaxSteamOutputLBpS * 0.9f), pS.TopH(TheoreticalMaxSteamOutputLBpS * 1.0f), pS.TopH(TheoreticalMaxSteamOutputLBpS * 1.1f)
+                    };
+
+                float[] TempBackPressure = new float[]
+                    {
+                                0.0f, tempMaxBackPressurePSI* (float)Math.Pow(0.1f, 2.0f), tempMaxBackPressurePSI* (float)Math.Pow(0.2f, 2.0f), tempMaxBackPressurePSI* (float)Math.Pow(0.3f, 2.0f), tempMaxBackPressurePSI* (float)Math.Pow(0.4f, 2.0f), tempMaxBackPressurePSI* (float)Math.Pow(0.5f, 2.0f), tempMaxBackPressurePSI* (float)Math.Pow(0.6f, 2.0f), tempMaxBackPressurePSI* (float)Math.Pow(0.7f, 2.0f), tempMaxBackPressurePSI* (float)Math.Pow(0.8f, 2.0f), tempMaxBackPressurePSI* (float)Math.Pow(0.9f, 2.0f), tempMaxBackPressurePSI* (float)Math.Pow(1.0f, 2.0f), tempMaxBackPressurePSI* (float)Math.Pow(1.1f, 2.0f)
+                    };
+
+                BackPressuretoSteamOutput = new Interpolator(TempSteamOutputRate, TempBackPressure);
+            }
+        
             // Confirm Injector type
             if (Injector1Type == "Unknown" )
             {
@@ -2199,7 +2212,7 @@ public override void Initialize()
             }
 
             var RefFeedwaterTempF = 65.0f;
-            var maxExhaustPressure = BackPressureIHPtoPSI[maxIndicatedHorsePowerTemp];
+            var maxExhaustPressure = BackPressuretoSteamOutput[pS.TopH(TheoreticalMaxSteamOutputLBpS)];
 
             if (ActualInjector1NozzleSizeMM == 0)
             {
@@ -3073,6 +3086,7 @@ public override void Update(float elapsedClockSeconds)
                         // Steam Flow (lb/hr) = 24.24 x Press(BoilerPressure + Atmosphere(psi)) x ChokeDia^2 (in) - this needs to be multiplied by Num Cyls
                         SteamBoosterPressurePSI = (BoilerPressurePSI + OneAtmospherePSI) * BoosterPressureFactor;
                         SteamEngines[i].CylinderSteamUsageLBpS = pS.FrompH(SteamEngines[i].NumberCylinders * (24.24f * (SteamBoosterPressurePSI) * BoosterIdleChokeSizeIn * BoosterIdleChokeSizeIn));
+                        SteamEngines[i].CylinderSteamUsageLBpH = pS.TopH(SteamEngines[i].CylinderSteamUsageLBpS);
                         HuDBoosterSteamConsumptionLbpS = SteamEngines[i].CylinderSteamUsageLBpS;
 
                     }
@@ -5439,14 +5453,14 @@ private void UpdateCylinders(float elapsedClockSeconds, float throttle, float cu
                     // (d) - Exhaust (Back) Pressure (For LP equates to point m)
                     // LP Cylinder
                     // Cylinder back pressure will be decreased depending upon locomotive speed
-                    SteamEngines[numberofengine].LPPressure_d_AtmPSI = BackPressureIHPtoPSI[SteamEngines[numberofengine].IndicatedHorsePowerHP] + OneAtmospherePSI;
+                    SteamEngines[numberofengine].LPPressure_d_AtmPSI = BackPressuretoSteamOutput[SteamEngines[numberofengine].CylinderSteamUsageLBpH] + OneAtmospherePSI;
 
                     SteamEngines[numberofengine].LogLPBackPressurePSI = SteamEngines[numberofengine].LPPressure_d_AtmPSI - OneAtmospherePSI;  // Value for recording in log file
                     SteamEngines[numberofengine].LogLPBackPressurePSI = MathHelper.Clamp(SteamEngines[numberofengine].LogLPBackPressurePSI, 0.00f, SteamEngines[numberofengine].LogLPBackPressurePSI); // Clamp so that LP Back pressure does not go negative
 
                     // HP Cylinder
 
-                    SteamEngines[numberofengine].Pressure_d_AtmPSI = BackPressureIHPtoPSI[SteamEngines[numberofengine].IndicatedHorsePowerHP] + OneAtmospherePSI;
+                    SteamEngines[numberofengine].Pressure_d_AtmPSI = BackPressuretoSteamOutput[SteamEngines[numberofengine].CylinderSteamUsageLBpH] + OneAtmospherePSI;
 
                     SteamEngines[numberofengine].LogBackPressurePSI = SteamEngines[numberofengine].Pressure_d_AtmPSI - OneAtmospherePSI;  // Value for log file
                     SteamEngines[numberofengine].LogBackPressurePSI = MathHelper.Clamp(SteamEngines[numberofengine].LogBackPressurePSI, 0.00f, SteamEngines[numberofengine].LogBackPressurePSI); // Clamp so that Back pressure does not go negative
@@ -5729,7 +5743,7 @@ private void UpdateCylinders(float elapsedClockSeconds, float throttle, float cu
 
                     // (m) - LP exhaust pressure  
                     // LP Cylinder back pressure will be increased depending upon locomotive speed
-                    SteamEngines[numberofengine].LPCompPressure_m_AtmPSI = BackPressureIHPtoPSI[SteamEngines[numberofengine].IndicatedHorsePowerHP] + OneAtmospherePSI;
+                    SteamEngines[numberofengine].LPCompPressure_m_AtmPSI = BackPressuretoSteamOutput[SteamEngines[numberofengine].CylinderSteamUsageLBpH] + OneAtmospherePSI;
 
                     SteamEngines[numberofengine].LogLPBackPressurePSI = SteamEngines[numberofengine].LPCompPressure_m_AtmPSI - OneAtmospherePSI;  // Value for recording in log file
                     SteamEngines[numberofengine].LogLPBackPressurePSI = MathHelper.Clamp(SteamEngines[numberofengine].LogLPBackPressurePSI, 0.00f, SteamEngines[numberofengine].LogLPBackPressurePSI); // Clamp so that LP Back pressure does not go negative
@@ -6056,7 +6070,7 @@ private void UpdateCylinders(float elapsedClockSeconds, float throttle, float cu
 
 
                 // (d) - Back Pressure 
-                SteamEngines[numberofengine].Pressure_d_AtmPSI = BackPressureIHPtoPSI[SteamEngines[numberofengine].IndicatedHorsePowerHP] + OneAtmospherePSI;
+                SteamEngines[numberofengine].Pressure_d_AtmPSI = BackPressuretoSteamOutput[SteamEngines[numberofengine].CylinderSteamUsageLBpH] + OneAtmospherePSI;
 
                 if (throttle < 0.02f)
                 {
@@ -6376,6 +6390,7 @@ private void UpdateCylinders(float elapsedClockSeconds, float throttle, float cu
             // usage calculated as moving average to minimize chance of oscillation.
             // Decrease steam usage by SuperheaterUsage factor to model superheater - very crude model - to be improved upon
             SteamEngines[numberofengine].CylinderSteamUsageLBpS = (0.6f * SteamEngines[numberofengine].CylinderSteamUsageLBpS + 0.4f * CalculatedCylinderSteamUsageLBpS);
+            SteamEngines[numberofengine].CylinderSteamUsageLBpH = pS.TopH(SteamEngines[numberofengine].CylinderSteamUsageLBpS);
             MeanEffectivePressurePSI = SteamEngines[numberofengine].MeanEffectivePressurePSI; // for display purposes
 
             SteamReleasePressure_AtmPSI = SteamEngines[numberofengine].Pressure_c_AtmPSI; // for steam and smoke effects
@@ -7537,9 +7552,9 @@ private void UpdateWaterInjection(float elapsedClockSeconds)
                         }
                         else // Exhaust steam injector
                         {
-                            if (throttle > 0.01 && BackPressureIHPtoPSI[IndicatedHorsePowerHP] > 1)
+                            if (throttle > 0.01 && BackPressuretoSteamOutput[pS.TopH(CylinderSteamUsageLBpS)] > 1)
                             {
-                                Injector1CorrectedPressurePSI = BackPressureIHPtoPSI[IndicatedHorsePowerHP];
+                                Injector1CorrectedPressurePSI = BackPressuretoSteamOutput[pS.TopH(CylinderSteamUsageLBpS)];
                                 ActualInjector1FlowRateLBpS = Injector1Fraction * Injector1NozzleCorrectionFactor * pS.FrompH(ExhaustSteamInjectorMaximaWaterDeliveryLBatPSIandF.Get(tenderTemperatureF, Injector1CorrectedPressurePSI));
                                 Inj1MinimaFlowRateLBpS = Injector1Fraction * Injector1NozzleCorrectionFactor * pS.FrompH(ExhaustSteamInjectorMinimaWaterDeliveryLBatPSIandF.Get(tenderTemperatureF, Injector1CorrectedPressurePSI));
 
@@ -7635,9 +7650,9 @@ private void UpdateWaterInjection(float elapsedClockSeconds)
                         }
                         else // Exhaust steam injector
                         {
-                            if (throttle > 0.01 && BackPressureIHPtoPSI[IndicatedHorsePowerHP] > 1)
+                            if (throttle > 0.01 && BackPressuretoSteamOutput[pS.TopH(CylinderSteamUsageLBpS)] > 1)
                             {
-                                Injector2CorrectedPressurePSI = BackPressureIHPtoPSI[IndicatedHorsePowerHP];
+                                Injector2CorrectedPressurePSI = BackPressuretoSteamOutput[pS.TopH(CylinderSteamUsageLBpS)];
                                 ActualInjector2FlowRateLBpS = Injector2Fraction * Injector2NozzleCorrectionFactor * pS.FrompH(ExhaustSteamInjectorMaximaWaterDeliveryLBatPSIandF.Get(tenderTemperatureF, Injector2CorrectedPressurePSI));
                                 Inj2MinimaFlowRateLBpS = Injector2Fraction * Injector2NozzleCorrectionFactor * pS.FrompH(ExhaustSteamInjectorMinimaWaterDeliveryLBatPSIandF.Get(tenderTemperatureF, Injector2CorrectedPressurePSI));
 
@@ -8101,6 +8116,9 @@ public override float GetDataOf(CabViewControl cvc)
                 case CABViewControlTypes.STEAM_PR:
                     data = ConvertFromPSI(cvc, BoilerPressurePSI);
                     break;
+                case CABViewControlTypes.BACK_PR:
+                    data = ConvertFromPSI(cvc, -1 * BackPressuretoSteamOutput[CylinderSteamUsageLBpH]);
+                    break;
                 case CABViewControlTypes.STEAMCHEST_PR:
                     data = ConvertFromPSI(cvc, CabSteamChestPressurePSI);
                     break;

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

@@ -522,6 +522,11 @@ public enum AuxiliarySteamEngineTypes
         /// </summary>
         public float CylinderSteamUsageLBpS;
 
+        /// <summary>
+        /// Steam usage per steam engine per hour
+        /// </summary>
+        public float CylinderSteamUsageLBpH;
+
         /// <summary>
         /// Steam usage per steam engine steam cocks
         /// </summary>