Adding gradual anglecock opening, smoothed detection of emergency application, better emergency application behavior

Author: SteelFill

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/Brakes/BrakeSystem.cs

@@ -40,6 +40,7 @@ public abstract class BrakeSystem
         public float BrakePipeVolumeM3 = 1.4e-2f;      // volume of a single brake line
         public bool ControllerRunningLock = false;  // Stops Running controller from becoming active until BP = EQ Res, used in EQ vacuum brakes
         public float BrakeCylFraction;
+        public float AngleCockOpeningTime = 30.0f;  // Time taken to fully open a closed anglecock
 
         /// <summary>
         /// Front brake hoses connection status
@@ -49,10 +50,14 @@ public abstract class BrakeSystem
         /// Front angle cock opened/closed status
         /// </summary>
         public bool AngleCockAOpen = true;
+        public float AngleCockAOpenAmount = 1.0f; // 0 - anglecock fully closed, 1 - anglecock fully open, allows for partial opening
+        public float? AngleCockAOpenTime = null;   // Time elapsed since anglecock open command was sent
         /// <summary>
         /// Rear angle cock opened/closed status
         /// </summary>
         public bool AngleCockBOpen = true;
+        public float AngleCockBOpenAmount = 1.0f; // 0 - anglecock fully closed, 1 - anglecock fully open, allows for partial opening
+        public float? AngleCockBOpenTime = null;   // Time elapsed since anglecock open command was sent
         /// <summary>
         /// Auxiliary brake reservoir vent valve open/closed status
         /// </summary>

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/Brakes/MSTS/AirSinglePipe.cs

@@ -91,6 +91,9 @@ public class AirSinglePipe : MSTSBrakeSystem
         protected float prevBrakePipePressurePSI = 0f;
         protected float prevBrakePipePressurePSI_sound = 0f;
 
+        protected float BrakePipeChangePSIpS;
+        protected SmoothedData SmoothedBrakePipeChangePSIpS;
+
 
         /// <summary>
         /// EP brake holding valve. Needs to be closed (Lap) in case of brake application or holding.
@@ -114,6 +117,8 @@ public AirSinglePipe(TrainCar car)
             BrakePipeVolumeM3 = (0.032f * 0.032f * (float)Math.PI / 4f) * Math.Max ( 5.0f, (1 + car.CarLengthM)); // Using DN32 (1-1/4") pipe
             DebugType = "1P";
 
+            SmoothedBrakePipeChangePSIpS = new SmoothedData(0.25f);
+
             // Force graduated releasable brakes. Workaround for MSTS with bugs preventing to set eng/wag files correctly for this.
             if (Car.Simulator.Settings.GraduatedRelease) (Car as MSTSWagon).BrakeValve = MSTSWagon.BrakeValveType.Distributor;
 
@@ -205,7 +210,7 @@ public override string[] GetDebugStatus(Dictionary<BrakeSystemComponent, Pressur
                 string.Empty, // Spacer because the state above needs 2 columns.
                 (Car as MSTSWagon).HandBrakePresent ? string.Format("{0:F0}%", HandbrakePercent) : string.Empty,
                 FrontBrakeHoseConnected ? "I" : "T",
-                string.Format("A{0} B{1}", AngleCockAOpen ? "+" : "-", AngleCockBOpen ? "+" : "-"),
+                string.Format("A{0} B{1}", AngleCockAOpenAmount >= 1 ? "+" : AngleCockAOpenAmount <= 0 ? "-" : "/", AngleCockBOpenAmount >= 1 ? "+" : AngleCockBOpenAmount <= 0 ? "-" : "/"),
                 BleedOffValveOpen ? Simulator.Catalog.GetString("Open") : string.Empty,
             };
 
@@ -329,7 +334,9 @@ public override void Save(BinaryWriter outf)
             outf.Write((int)TripleValveState);
             outf.Write(FrontBrakeHoseConnected);
             outf.Write(AngleCockAOpen);
+            outf.Write(AngleCockAOpenAmount);
             outf.Write(AngleCockBOpen);
+            outf.Write(AngleCockBOpenAmount);
             outf.Write(BleedOffValveOpen);
             outf.Write((int)HoldingValve);
             outf.Write(UniformChargingActive);
@@ -352,7 +359,9 @@ public override void Restore(BinaryReader inf)
             TripleValveState = (ValveState)inf.ReadInt32();
             FrontBrakeHoseConnected = inf.ReadBoolean();
             AngleCockAOpen = inf.ReadBoolean();
+            AngleCockAOpenAmount = inf.ReadSingle();
             AngleCockBOpen = inf.ReadBoolean();
+            AngleCockBOpenAmount = inf.ReadSingle();
             BleedOffValveOpen = inf.ReadBoolean();
             HoldingValve = (ValveState)inf.ReadInt32();
             UniformChargingActive = inf.ReadBoolean();
@@ -380,6 +389,8 @@ public override void Initialize(bool handbrakeOn, float maxPressurePSI, float fu
             {
                 loco.MainResPressurePSI = loco.MaxMainResPressurePSI;
             }
+
+            SmoothedBrakePipeChangePSIpS.ForceSmoothValue(0);
         }
 
         public override void Initialize()
@@ -455,12 +466,15 @@ public void UpdateTripleValveState(float elapsedClockSeconds)
             var prevState = TripleValveState;
             var valveType = (Car as MSTSWagon).BrakeValve;
             bool disableGradient = !(Car.Train.LeadLocomotive is MSTSLocomotive) && Car.Train.TrainType != Orts.Simulation.Physics.Train.TRAINTYPE.STATIC;
+            // Small workaround to allow trains to more reliably go into emergency after uncoupling
+            bool emergencyTripped = (Car.Train.TrainType == Orts.Simulation.Physics.Train.TRAINTYPE.STATIC) ?
+                BrakeLine1PressurePSI <= EmergResPressurePSI * AuxCylVolumeRatio / (AuxCylVolumeRatio + 1) : Math.Max(-SmoothedBrakePipeChangePSIpS.SmoothedValue, 0) > EmergencyValveActuationRatePSIpS;
 
             if (valveType == MSTSWagon.BrakeValveType.Distributor)
             {
                 float applicationPSI = ControlResPressurePSI - BrakeLine1PressurePSI;
                 float targetPressurePSI = applicationPSI * AuxCylVolumeRatio;
-                if (!disableGradient && EmergencyValveActuationRatePSIpS > 0 && (prevBrakePipePressurePSI - BrakeLine1PressurePSI) > Math.Max(elapsedClockSeconds, 0.0001f) * EmergencyValveActuationRatePSIpS)
+                if (!disableGradient && EmergencyValveActuationRatePSIpS > 0 && emergencyTripped)
                 {
                     if (prevState == ValveState.Release) // If valve transitions from release to emergency, quick service activates
                     {
@@ -497,7 +511,7 @@ public void UpdateTripleValveState(float elapsedClockSeconds)
             }
             else if (valveType == MSTSWagon.BrakeValveType.TripleValve || valveType == MSTSWagon.BrakeValveType.DistributingValve)
             {
-                if (!disableGradient && EmergencyValveActuationRatePSIpS > 0 && (prevBrakePipePressurePSI - BrakeLine1PressurePSI) > Math.Max(elapsedClockSeconds, 0.0001f) * EmergencyValveActuationRatePSIpS)
+                if (!disableGradient && EmergencyValveActuationRatePSIpS > 0 && emergencyTripped)
                 {
                     if (prevState == ValveState.Release) // If valve transitions from release to emergency, quick service activates
                     {
@@ -547,11 +561,53 @@ public void UpdateTripleValveState(float elapsedClockSeconds)
             else EmergencyDumpStartTime = null;
         }
 
+        public void UpdateAngleCockState(bool AngleCockOpen, ref float AngleCockOpenAmount, ref float? AngleCockOpenTime)
+        {
+            float currentTime = (float)this.Car.Simulator.GameTime;
+
+            if (AngleCockOpen && AngleCockOpenAmount < 1.0f)
+            {
+                if (AngleCockOpenTime == null)
+                {
+                    AngleCockOpenTime = currentTime;
+                }
+                else if (currentTime - AngleCockOpenTime > AngleCockOpeningTime)
+                {
+                    // Finish opening anglecock at a faster rate once time has elapsed
+                    AngleCockOpenAmount = (currentTime - ((float)AngleCockOpenTime + AngleCockOpeningTime)) / 5 + 0.3f;
+
+                    if (AngleCockOpenAmount >= 1.0f)
+                    {
+                        AngleCockOpenAmount = 1.0f;
+                        AngleCockOpenTime = null;
+                    }
+                }
+                else
+                {
+                    // Gradually open anglecock toward 30% over 30 seconds
+                    AngleCockOpenAmount = 0.3f * (currentTime - (float)AngleCockOpenTime) / AngleCockOpeningTime;
+                }
+            }
+            else if (!AngleCockOpen && AngleCockOpenAmount > 0.0f)
+            {
+                AngleCockOpenAmount = 0.0f;
+                AngleCockOpenTime = null;
+            }
+        }
+
         public override void Update(float elapsedClockSeconds)
         {
             var valveType = (Car as MSTSWagon).BrakeValve;
             float threshold = valveType == MSTSWagon.BrakeValveType.Distributor ? Math.Max((ControlResPressurePSI - BrakeLine1PressurePSI) * AuxCylVolumeRatio, 0) : 0;
 
+            BrakePipeChangePSIpS = (BrakeLine1PressurePSI - prevBrakePipePressurePSI) / Math.Max(elapsedClockSeconds, 0.0001f);
+            SmoothedBrakePipeChangePSIpS.Update(Math.Max(elapsedClockSeconds, 0.0001f), BrakePipeChangePSIpS);
+
+            // Update anglecock opening. Anglecocks set to gradually open over 30 seconds, but close instantly.
+            // Gradual opening prevents undesired emergency applications
+            UpdateAngleCockState(AngleCockAOpen, ref AngleCockAOpenAmount, ref AngleCockAOpenTime);
+            UpdateAngleCockState(AngleCockBOpen, ref AngleCockBOpenAmount, ref AngleCockBOpenTime);
+
             if (BleedOffValveOpen)
             {
                 if (valveType == MSTSWagon.BrakeValveType.Distributor)
@@ -591,7 +647,6 @@ public override void Update(float elapsedClockSeconds)
             {
                 float dp = 0;
                 float dpPipe = 0;
-                float brakePipeChange = Math.Max(prevBrakePipePressurePSI - BrakeLine1PressurePSI, 0);
                 if (QuickServiceActive) // Quick service: Brake pipe pressure is locally reduced to speed up initial reduction
                 {
                     if (QuickServiceVentRatePSIpS > 0)
@@ -608,7 +663,8 @@ public override void Update(float elapsedClockSeconds)
                 {
                     if (AcceleratedApplicationFactor > 0) // Accelerated application: Air is vented from the brake pipe to speed up service applications
                     {
-                        dpPipe = Math.Min(brakePipeChange * AcceleratedApplicationFactor, elapsedClockSeconds * AcceleratedApplicationLimitPSIpS); // Amount of air vented is proportional to pressure reduction from external sources
+                        // Amount of air vented is proportional to pressure reduction from external sources
+                        dpPipe = MathHelper.Clamp(-SmoothedBrakePipeChangePSIpS.SmoothedValue * AcceleratedApplicationFactor, 0, AcceleratedApplicationLimitPSIpS) * elapsedClockSeconds;
                     }
                     dp = elapsedClockSeconds * MaxApplicationRatePSIpS;
                 }
@@ -1116,7 +1172,8 @@ protected static void PropagateBrakeLinePressures(float elapsedClockSeconds, Tra
                 int nSteps = (int)(elapsedClockSeconds / brakePipeTimeFactorS + 1);
                 float trainPipeTimeVariationS = elapsedClockSeconds / nSteps;
                 float trainPipeLeakLossPSI = lead == null ? 0.0f : (trainPipeTimeVariationS * lead.TrainBrakePipeLeakPSIorInHgpS);
-                float serviceTimeFactor = lead != null ? lead.TrainBrakeController != null && lead.TrainBrakeController.EmergencyBraking ? lead.BrakeEmergencyTimeFactorPSIpS : lead.BrakeServiceTimeFactorPSIpS : 0;
+                float serviceTimeFactor = lead != null && lead.TrainBrakeController != null ? lead.BrakeServiceTimeFactorPSIpS : 0.001f;
+                float emergencyTimeFactor = lead != null && lead.TrainBrakeController != null ? lead.BrakeEmergencyTimeFactorPSIpS : 0.001f;
                 for (int i = 0; i < nSteps; i++)
                 {
                     if (lead != null)
@@ -1127,7 +1184,17 @@ protected static void PropagateBrakeLinePressures(float elapsedClockSeconds, Tra
                             lead.BrakeSystem.BrakeLine1PressurePSI -= trainPipeLeakLossPSI;
                         }
 
-                        if (lead.TrainBrakeController.TrainBrakeControllerState != ControllerState.Neutral)
+                        // Emergency brake - vent brake pipe to 0 psi regardless of equalizing res pressure
+                        if (lead.TrainBrakeController.EmergencyBraking)
+                        {
+                            float emergencyVariationFactor = Math.Min(trainPipeTimeVariationS / emergencyTimeFactor, 0.95f);
+                            float pressureDiffPSI = emergencyVariationFactor * lead.BrakeSystem.BrakeLine1PressurePSI;
+
+                            if (lead.BrakeSystem.BrakeLine1PressurePSI - pressureDiffPSI < 0)
+                                pressureDiffPSI = lead.BrakeSystem.BrakeLine1PressurePSI;
+                            lead.BrakeSystem.BrakeLine1PressurePSI -= pressureDiffPSI;
+                        }
+                        else if (lead.TrainBrakeController.TrainBrakeControllerState != ControllerState.Neutral)
                         {
                             // Charge train brake pipe - adjust main reservoir pressure, and lead brake pressure line to maintain brake pipe equal to equalising resevoir pressure - release brakes
                             if (lead.BrakeSystem.BrakeLine1PressurePSI < train.EqualReservoirPressurePSIorInHg)
@@ -1203,6 +1270,13 @@ protected static void PropagateBrakeLinePressures(float elapsedClockSeconds, Tra
                                 // The sign in the equation determines the direction of air flow.
                                 float trainPipePressureDiffPropagationPSI = pressureDiffPSI * Math.Min(trainPipeTimeVariationS / brakePipeTimeFactorS, 1);
 
+                                // Flow is restricted when either anglecock is not opened fully
+                                if (car.BrakeSystem.AngleCockAOpenAmount < 1 || prevCar.BrakeSystem.AngleCockBOpenAmount < 1)
+                                {
+                                    trainPipePressureDiffPropagationPSI *= MathHelper.Min((float)Math.Pow(car.BrakeSystem.AngleCockAOpenAmount * prevCar.BrakeSystem.AngleCockBOpenAmount, 2), 1.0f);
+
+                                }
+
                                 // Air flows from high pressure to low pressure, until pressure is equal in both cars.
                                 // Brake pipe volumes of both cars are taken into account, so pressure increase/decrease is proportional to relative volumes.
                                 // If TrainPipePressureDiffPropagationPSI equals to p1-p0 the equalization is achieved in one step.
@@ -1221,11 +1295,25 @@ protected static void PropagateBrakeLinePressures(float elapsedClockSeconds, Tra
                         // Empty the brake pipe if the brake hose is not connected and angle cocks are open
                         if (!car.BrakeSystem.FrontBrakeHoseConnected && car.BrakeSystem.AngleCockAOpen)
                         {
-                            car.BrakeSystem.BrakeLine1PressurePSI = Math.Max(car.BrakeSystem.BrakeLine1PressurePSI * (1 - trainPipeTimeVariationS / brakePipeTimeFactorS), 0);
+                            float dp = car.BrakeSystem.BrakeLine1PressurePSI * trainPipeTimeVariationS / brakePipeTimeFactorS;
+
+                            if (car.BrakeSystem.AngleCockAOpenAmount < 1)
+                                dp *= MathHelper.Clamp((float)Math.Pow(car.BrakeSystem.AngleCockAOpenAmount, 2), 0.0f, 1.0f);
+
+                            if (car.BrakeSystem.BrakeLine1PressurePSI - dp < 0)
+                                dp = car.BrakeSystem.BrakeLine1PressurePSI;
+                            car.BrakeSystem.BrakeLine1PressurePSI -= dp;
                         }
                         if ((nextCar == null || !nextCar.BrakeSystem.FrontBrakeHoseConnected) && car.BrakeSystem.AngleCockBOpen)
                         {
-                            car.BrakeSystem.BrakeLine1PressurePSI = Math.Max(car.BrakeSystem.BrakeLine1PressurePSI * (1 - trainPipeTimeVariationS / brakePipeTimeFactorS), 0);
+                            float dp = car.BrakeSystem.BrakeLine1PressurePSI * trainPipeTimeVariationS / brakePipeTimeFactorS;
+
+                            if (car.BrakeSystem.AngleCockBOpenAmount < 1)
+                                dp *= MathHelper.Clamp((float)Math.Pow(car.BrakeSystem.AngleCockBOpenAmount, 2), 0.0f, 1.0f);
+
+                            if (car.BrakeSystem.BrakeLine1PressurePSI - dp < 0)
+                                dp = car.BrakeSystem.BrakeLine1PressurePSI;
+                            car.BrakeSystem.BrakeLine1PressurePSI -= dp;
                         }
                     }
 #if DEBUG_TRAIN_PIPE_LEAK