Automatic merge of T1.5.1-770-g1f196a3249 and 14 pull requests

openrails-bot · openrails-bot · commit 310cfbd5c44d · 2023-12-18T05:52:55.000Z
- Pull request #570 at 3539862: Experimental glTF 2.0 support with PBR lighting - Pull request #839 at d00beb9: First phase of https://blueprints.launchpad.net/or/+spec/additional-cruise-control-parameters - Pull request #875 at 43bf33e: Bug fix for https://bugs.launchpad.net/or/+bug/2036346 Player train switching doesn't work with 3D cabs - Pull request #876 at f92de76: docs: add source for documents previously on website to source Documentation folder - Pull request #882 at a055bca: Blueprint/train car operations UI window - Pull request #885 at d9ce84b: feat: Add notifications to Menu - Pull request #886 at 6c0785b: Scene viewer extension to TrackViewer - Pull request #892 at 1f5ba4c: Signal Function OPP_SIG_ID_TRAINPATH - Pull request #893 at bf8876b: Signal errors - Pull request #894 at 5ff1e73: Correct Decrease Colour - Pull request #896 at 5866028: First implementation of https://blueprints.launchpad.net/or/+spec/specific-sounds-for-ai-trains - Pull request #897 at 0a9d939: feat: Improved system information collection - Pull request #898 at e271395: Extra line with all the arguments for debugging purposes in logfile - Pull request #899 at cca2bd5: Duplex steam engines - Booster Engine addition
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSControlTrailerCar.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSControlTrailerCar.cs
@@ -225,7 +225,7 @@ public override string GetStatus()
         /// <summary>
         /// This function updates periodically the locomotive's motive force.
         /// </summary>
-        protected override void UpdateTractiveForce(float elapsedClockSeconds, float t, float AbsSpeedMpS, float AbsWheelSpeedMpS, int numberofengine)
+        protected override void UpdateTractiveForce(float elapsedClockSeconds, float t, float AbsSpeedMpS, float AbsWheelSpeedMpS)
         {
         }
 
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSDieselLocomotive.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSDieselLocomotive.cs
@@ -624,7 +624,7 @@ protected override void UpdateControllers(float elapsedClockSeconds)
         /// <summary>
         /// This function updates periodically the locomotive's motive force.
         /// </summary>
-        protected override void UpdateTractiveForce(float elapsedClockSeconds, float t, float AbsSpeedMpS, float AbsWheelSpeedMpS, int numberofengine)
+        protected override void UpdateTractiveForce(float elapsedClockSeconds, float t, float AbsSpeedMpS, float AbsWheelSpeedMpS)
         {
             // This section calculates the motive force of the locomotive as follows:
             // Basic configuration (no TF table) - uses P = F /speed  relationship - requires power and force parameters to be set in the ENG file. 
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs
@@ -2013,7 +2013,7 @@ public override void Update(float elapsedClockSeconds)
             // TODO  this is a wild simplification for electric and diesel electric
             if (EngineType == EngineTypes.Diesel || EngineType == EngineTypes.Electric)
             {
-                UpdateTractiveForce(elapsedClockSeconds, ThrottlePercent / 100f, AbsSpeedMpS, AbsWheelSpeedMpS, 0);
+            UpdateTractiveForce(elapsedClockSeconds, ThrottlePercent / 100f, AbsSpeedMpS, AbsWheelSpeedMpS);
             }
 
             foreach (MultiPositionController mpc in MultiPositionControllers)
@@ -2335,7 +2335,7 @@ protected virtual void UpdateControllers(float elapsedClockSeconds)
         /// <summary>
         /// This function updates periodically the locomotive's motive force.
         /// </summary>
-        protected virtual void UpdateTractiveForce(float elapsedClockSeconds, float t, float AbsSpeedMpS, float AbsWheelSpeedMpS, int numberofengine)
+        protected virtual void UpdateTractiveForce(float elapsedClockSeconds, float t, float AbsSpeedMpS, float AbsWheelSpeedMpS)
         {
             // Method to set force and power info
             // An alternative method in the steam locomotive will override this and input force and power info for it.
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSSteamLocomotive.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSSteamLocomotive.cs
@@ -2203,8 +2203,6 @@ public override void Update(float elapsedClockSeconds)
             UpdateAuxiliaries(elapsedClockSeconds, absSpeedMpS);
             UpdateSuperHeat();
 
-            TractiveForceN = 0; // reset tractiveforceN in preparation to calculating a new value
-            MotiveForceN = 0;
             CylinderSteamUsageLBpS = 0;
             CylCockSteamUsageLBpS = 0;
             MeanEffectivePressurePSI = 0;
@@ -2310,41 +2308,11 @@ public override void Update(float elapsedClockSeconds)
                     tractiveforcethrottle = throttle;
                 }
 
-                UpdateTractiveForce(elapsedClockSeconds, tractiveforcethrottle, 0, 0, i);
-
-                TractiveForceN += SteamEngines[i].TractiveForceN;
-
-                MotiveForceN += SteamEngines[i].AttachedAxle.CompensatedAxleForceN;
-            }
+                UpdateSteamTractiveForce(elapsedClockSeconds, tractiveforcethrottle, 0, 0, i);
 
-            // Find the maximum TE for debug i.e. @ start and full throttle
-            if (absSpeedMpS < 1.0)
-            {
-                if (Math.Abs(TractiveForceN) > absStartTractiveEffortN && Math.Abs(TractiveForceN) < MaxForceN)
-                {
-                    absStartTractiveEffortN = Math.Abs(TractiveForceN); // update to new maximum TE
-                }
             }
 
-            DisplayTractiveForceN = TractiveForceN;
-
-            MotiveForceSmoothN.Update(elapsedClockSeconds, MotiveForceN);
-            MotiveForceSmoothedN = MotiveForceSmoothN.SmoothedValue;
-            if (float.IsNaN(MotiveForceN))
-                MotiveForceN = 0;
-
-            DrawBarPullLbsF = N.ToLbf(Math.Abs(MotiveForceSmoothedN) - LocoTenderFrictionForceN); // Locomotive drawbar pull is equal to motive force of locomotive (+ tender) - friction forces of locomotive (+ tender)
-            DrawBarPullLbsF = MathHelper.Clamp(DrawBarPullLbsF, 0, DrawBarPullLbsF); // clamp value so it doesn't go negative
-
-            DrawbarHorsePowerHP = (DrawBarPullLbsF * MpS.ToMpH(absSpeedMpS)) / 375.0f;  // TE in this instance is a maximum, and not at the wheel???
-            DrawbarHorsePowerHP = MathHelper.Clamp(DrawbarHorsePowerHP, 0, DrawbarHorsePowerHP); // clamp value so it doesn't go negative
-
-
-            // Calculate IHP
-            // IHP = (MEP x CylStroke(ft) x cylArea(sq in) x No Strokes (/min)) / 33000) - this is per cylinder
-
-            IndicatedHorsePowerHP = (N.ToLbf(MotiveForceSmoothedN) * pS.TopH(Me.ToMi(absSpeedMpS))) / 375.0f;
-            IndicatedHorsePowerHP = MathHelper.Clamp(IndicatedHorsePowerHP, 0, IndicatedHorsePowerHP);
+            UpdateTractiveForce(elapsedClockSeconds, ThrottlePercent / 100f, AbsSpeedMpS, AbsWheelSpeedMpS);
 
             #endregion
 
@@ -5130,21 +5098,20 @@ private void UpdateCylinders(float elapsedClockSeconds, float throttle, float cu
             SteamReleasePressure_AtmPSI = SteamEngines[numberofengine].Pressure_c_AtmPSI; // for steam and smoke effects
 
         }
-        protected override void UpdateTractiveForce(float elapsedClockSeconds, float locomotivethrottle, float AbsSpeedMpS, float AbsWheelSpeedMpS, int numberofengine)
-        {
-            // Pass force and power information to MSTSLocomotive file by overriding corresponding method there
 
-            // Set Max Power equal to max IHP
-            MaxPowerW = W.FromHp(SteamEngines[numberofengine].MaxIndicatedHorsePowerHP);
 
-            // Set maximum force for the locomotive
-            MaxForceN = N.FromLbf(SteamEngines[numberofengine].MaxTractiveEffortLbf * CylinderEfficiencyRate);
-
-            // Set Max Velocity of locomotive
-            MaxSpeedMpS = Me.FromMi(pS.FrompH(MaxLocoSpeedMpH)); // Note this is not the true max velocity of the locomotive, but  the speed at which max HP is reached
+        /// <summary>
+        /// Calculate the tractive forces for each steam engine
+        /// </summary>
+        private void UpdateSteamTractiveForce(float elapsedClockSeconds, float locomotivethrottle, float AbsSpeedMpS, float AbsWheelSpeedMpS, int numberofengine)
+        {
 
             #region - Steam Adhesion Model Input for Steam Locomotives
 
+            // Caculate the current piston speed - purely for display purposes at the moment 
+            // Piston Speed (Ft p Min) = (Stroke length x 2) x (Ft in Mile x Train Speed (mph) / ( Circum of Drv Wheel x 60))
+            SteamEngines[numberofengine].PistonSpeedFtpMin = Me.ToFt(pS.TopM(SteamEngines[numberofengine].CylindersStrokeM * 2.0f * DrvWheelRevRpS)) * SteamGearRatio;
+
             // Based upon information presented on pg 276 of "Locomotive Operation - A Technical and Practical Analysis" by G. R. Henderson -
             // https://archive.org/details/locomotiveoperat00hend/page/276/mode/2up
             // At its simplest slip occurs when the wheel tangential force exceeds the static frictional force
@@ -5459,11 +5426,7 @@ protected override void UpdateTractiveForce(float elapsedClockSeconds, float loc
             else // Adjust tractive force if  "simple" friction is used, or is a geared steam locomotive
             {
                 // This section updates the force calculations and maintains them at the current values.
-
-                // Caculate the current piston speed - purely for display purposes at the moment 
-                // Piston Speed (Ft p Min) = (Stroke length x 2) x (Ft in Mile x Train Speed (mph) / ( Circum of Drv Wheel x 60))
-                PistonSpeedFtpMin = Me.ToFt(pS.TopM(SteamEngines[numberofengine].CylindersStrokeM * 2.0f * DrvWheelRevRpS)) * SteamGearRatio;
-
+                
                 if (SteamEngineType == SteamEngineTypes.Compound)
                 {
                     // Calculate tractive effort if set for compounding - tractive effort in each cylinder will need to be calculated
@@ -5482,21 +5445,20 @@ protected override void UpdateTractiveForce(float elapsedClockSeconds, float loc
                     // Calculate IHP
                     // IHP = (MEP x Speed (mph)) / 375.0) - this is per cylinder
 
-                    HPIndicatedHorsePowerHP = (HPTractiveEffortLbsF * pS.TopH(Me.ToMi(absSpeedMpS))) / 375.0f;
-                    LPIndicatedHorsePowerHP = (LPTractiveEffortLbsF * pS.TopH(Me.ToMi(absSpeedMpS))) / 375.0f;
+                    SteamEngines[numberofengine].HPIndicatedHorsePowerHP = (HPTractiveEffortLbsF * pS.TopH(Me.ToMi(absSpeedMpS))) / 375.0f;
+                    SteamEngines[numberofengine].LPIndicatedHorsePowerHP = (LPTractiveEffortLbsF * pS.TopH(Me.ToMi(absSpeedMpS))) / 375.0f;
 
                     float WheelRevs = pS.TopM(DrvWheelRevRpS);
-                    IndicatedHorsePowerHP += HPIndicatedHorsePowerHP + LPIndicatedHorsePowerHP;
-                    IndicatedHorsePowerHP = MathHelper.Clamp(IndicatedHorsePowerHP, 0, IndicatedHorsePowerHP);
+
                 }
                 else // if simple or geared locomotive calculate tractive effort
                 {
 
                     // If the steam piston is exceeding the maximum design piston rate then decrease efficiency of mep
-                    if (SteamEngineType == SteamEngineTypes.Geared && PistonSpeedFtpMin > MaxSteamGearPistonRateFtpM)
+                    if (SteamEngineType == SteamEngineTypes.Geared && SteamEngines[numberofengine].PistonSpeedFtpMin > MaxSteamGearPistonRateFtpM)
                     {
                         // use straight line curve to decay mep to zero by 2 x piston speed
-                        float pistonforcedecay = 1.0f - (1.0f / MaxSteamGearPistonRateFtpM) * (PistonSpeedFtpMin - MaxSteamGearPistonRateFtpM);
+                        float pistonforcedecay = 1.0f - (1.0f / MaxSteamGearPistonRateFtpM) * (SteamEngines[numberofengine].PistonSpeedFtpMin - MaxSteamGearPistonRateFtpM);
                         pistonforcedecay = MathHelper.Clamp(pistonforcedecay, 0.0f, 1.0f);  // Clamp decay within bounds
 
                         SteamEngines[numberofengine].MeanEffectivePressurePSI *= pistonforcedecay; // Decrease mep once piston critical speed is exceeded
@@ -5575,22 +5537,88 @@ protected override void UpdateTractiveForce(float elapsedClockSeconds, float loc
                 IsCritTELimit = false; // Reset flag if limiting TE
             }
 
-            ApplyDirectionToTractiveForce(ref SteamEngines[numberofengine].TractiveForceN);
+            SteamEngines[numberofengine].AttachedAxle.DriveForceN = SteamEngines[numberofengine].TractiveForceN;
+        }
+
+        /// <summary>
+        /// Update the tractive force for the complete steam locomotive
+        /// </summary>
+        protected override void UpdateTractiveForce(float elapsedClockSeconds, float locomotivethrottle, float AbsSpeedMpS, float AbsWheelSpeedMpS)
+        {
+            TractiveForceN = 0; // reset tractiveforceN in preparation to calculating a new value
+            MotiveForceN = 0;
+            IndicatedHorsePowerHP = 0;
+            PistonSpeedFtpMin = 0;
+
+            // Update tractive effort across all steam engines
+            for (int i = 0; i < SteamEngines.Count; i++)
+            {
+                TractiveForceN += SteamEngines[i].TractiveForceN;
+
+                MotiveForceN += SteamEngines[i].AttachedAxle.CompensatedAxleForceN;
+
+                // Set Max Power equal to max IHP
+                MaxPowerW = W.FromHp(SteamEngines[i].MaxIndicatedHorsePowerHP);
+
+                // Set maximum force for the locomotive
+                MaxForceN = N.FromLbf(SteamEngines[i].MaxTractiveEffortLbf * CylinderEfficiencyRate);
+
+                if (SteamEngineType == SteamEngineTypes.Compound)
+                {
+                    IndicatedHorsePowerHP += HPIndicatedHorsePowerHP + LPIndicatedHorsePowerHP;
+                    IndicatedHorsePowerHP = MathHelper.Clamp(IndicatedHorsePowerHP, 0, IndicatedHorsePowerHP);
+                }
+                else
+                {
+                    IndicatedHorsePowerHP += SteamEngines[i].IndicatedHorsePowerHP;
+                }
+
+                //TODO - identify the maximum value for display?? 
+                PistonSpeedFtpMin = SteamEngines[0].PistonSpeedFtpMin;
+
+            }
+
+            ApplyDirectionToTractiveForce(ref TractiveForceN);
+
+            // Find the maximum TE for debug i.e. @ start and full throttle
+            if (absSpeedMpS < 1.0)
+            {
+                if (Math.Abs(TractiveForceN) > absStartTractiveEffortN && Math.Abs(TractiveForceN) < MaxForceN)
+                {
+                    absStartTractiveEffortN = Math.Abs(TractiveForceN); // update to new maximum TE
+                }
+            }
+
+            DisplayTractiveForceN = TractiveForceN;
+
+            MotiveForceSmoothN.Update(elapsedClockSeconds, MotiveForceN);
+            MotiveForceSmoothedN = MotiveForceSmoothN.SmoothedValue;
+            if (float.IsNaN(MotiveForceN))
+                MotiveForceN = 0;
+
+            DrawBarPullLbsF = N.ToLbf(Math.Abs(MotiveForceSmoothedN) - LocoTenderFrictionForceN); // Locomotive drawbar pull is equal to motive force of locomotive (+ tender) - friction forces of locomotive (+ tender)
+            DrawBarPullLbsF = MathHelper.Clamp(DrawBarPullLbsF, 0, DrawBarPullLbsF); // clamp value so it doesn't go negative
+
+            DrawbarHorsePowerHP = (DrawBarPullLbsF * MpS.ToMpH(absSpeedMpS)) / 375.0f;  // TE in this instance is a maximum, and not at the wheel???
+            DrawbarHorsePowerHP = MathHelper.Clamp(DrawbarHorsePowerHP, 0, DrawbarHorsePowerHP); // clamp value so it doesn't go negative
+
+            // Set Max Velocity of locomotive
+            MaxSpeedMpS = Me.FromMi(pS.FrompH(MaxLocoSpeedMpH)); // Note this is not the true max velocity of the locomotive, but  the speed at which max HP is reached
+
+
 
             // Set tractive force to zero if throttle is closed
             if (locomotivethrottle < 0.001)
             {
-                SteamEngines[numberofengine].TractiveForceN = 0;
+                TractiveForceN = 0;
             }
 
-
-            SteamEngines[numberofengine].AttachedAxle.DriveForceN = SteamEngines[numberofengine].TractiveForceN;
         }
 
-        /// <summary>
-        /// Normalise crank angle so that it is a value between 0 and 360 starting at the real crank angle difference
-        /// </summary>
-        private float NormalisedCrankAngle(int cylinderNumber)
+            /// <summary>
+            /// Normalise crank angle so that it is a value between 0 and 360 starting at the real crank angle difference
+            /// </summary>
+            private float NormalisedCrankAngle(int cylinderNumber)
         {
             float normalisedCrankAngleRad = (float)MathHelper.WrapAngle((float)LocomotiveAxles[0].AxlePositionRad + WheelCrankAngleDiffRad[cylinderNumber]);
 
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/SteamEngine.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/SteamEngine.cs
@@ -543,10 +543,25 @@ public enum AuxiliarySteamEngineTypes
         public float CylCockSteamUsageLBpS;
 
         /// <summary>
-        /// Indicated Horse Power
+        /// Indicated HP Horse Power for Compound
+        /// </summary>
+        public float HPIndicatedHorsePowerHP;
+
+        /// <summary>
+        /// Indicated LP Horse Power for Compound
+        /// </summary>
+        public float LPIndicatedHorsePowerHP;
+
+        /// <summary>
+        /// Indicated Horse Power for single expansion
         /// </summary>
         public float IndicatedHorsePowerHP;
 
+        /// <summary>
+        /// Speed of Piston
+        /// </summary>
+        public float PistonSpeedFtpMin;
+
         /// <summary>
         /// Calculated Factor of Adhesion
         /// </summary>

Original file line number	Diff line number	Diff line change
`@@ -225,7 +225,7 @@ public override string GetStatus()`
`225`	`225`	`/// <summary>`
`226`	`226`	`/// This function updates periodically the locomotive's motive force.`
`227`	`227`	`/// </summary>`
`228`		`- protected override void UpdateTractiveForce(float elapsedClockSeconds, float t, float AbsSpeedMpS, float AbsWheelSpeedMpS, int numberofengine)`
	`228`	`+ protected override void UpdateTractiveForce(float elapsedClockSeconds, float t, float AbsSpeedMpS, float AbsWheelSpeedMpS)`
`229`	`229`	`{`
`230`	`230`	`}`
`231`	`231`
Original file line number	Diff line number	Diff line change
`@@ -624,7 +624,7 @@ protected override void UpdateControllers(float elapsedClockSeconds)`
`624`	`624`	`/// <summary>`
`625`	`625`	`/// This function updates periodically the locomotive's motive force.`
`626`	`626`	`/// </summary>`
`627`		`- protected override void UpdateTractiveForce(float elapsedClockSeconds, float t, float AbsSpeedMpS, float AbsWheelSpeedMpS, int numberofengine)`
	`627`	`+ protected override void UpdateTractiveForce(float elapsedClockSeconds, float t, float AbsSpeedMpS, float AbsWheelSpeedMpS)`
`628`	`628`	`{`
`629`	`629`	`// This section calculates the motive force of the locomotive as follows:`
`630`	`630`	`// Basic configuration (no TF table) - uses P = F /speed relationship - requires power and force parameters to be set in the ENG file.`
Original file line number	Diff line number	Diff line change
`@@ -2013,7 +2013,7 @@ public override void Update(float elapsedClockSeconds)`
`2013`	`2013`	`// TODO this is a wild simplification for electric and diesel electric`
`2014`	`2014`	`if (EngineType == EngineTypes.Diesel \|\| EngineType == EngineTypes.Electric)`
`2015`	`2015`	`{`
`2016`		`- UpdateTractiveForce(elapsedClockSeconds, ThrottlePercent / 100f, AbsSpeedMpS, AbsWheelSpeedMpS, 0);`
	`2016`	`+ UpdateTractiveForce(elapsedClockSeconds, ThrottlePercent / 100f, AbsSpeedMpS, AbsWheelSpeedMpS);`
`2017`	`2017`	`}`
`2018`	`2018`
`2019`	`2019`	`foreach (MultiPositionController mpc in MultiPositionControllers)`
`@@ -2335,7 +2335,7 @@ protected virtual void UpdateControllers(float elapsedClockSeconds)`
`2335`	`2335`	`/// <summary>`
`2336`	`2336`	`/// This function updates periodically the locomotive's motive force.`
`2337`	`2337`	`/// </summary>`
`2338`		`- protected virtual void UpdateTractiveForce(float elapsedClockSeconds, float t, float AbsSpeedMpS, float AbsWheelSpeedMpS, int numberofengine)`
	`2338`	`+ protected virtual void UpdateTractiveForce(float elapsedClockSeconds, float t, float AbsSpeedMpS, float AbsWheelSpeedMpS)`
`2339`	`2339`	`{`
`2340`	`2340`	`// Method to set force and power info`
`2341`	`2341`	`// An alternative method in the steam locomotive will override this and input force and power info for it.`