Add steam sander effects

Author: peternewell

Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs

@@ -927,6 +927,19 @@ public override void Parse(string lowercasetoken, STFReader stf)
                         STFException.TraceWarning(stf, "Skipped unknown engine type " + engineType);
                     }
                     break;
+                case "engine(sandingsystemtype":
+                    stf.MustMatch("(");
+                    var sandingType = stf.ReadString();
+                    try
+                    {
+                        SandingSystemType = (SandingSystemTypes)Enum.Parse(typeof(SandingSystemTypes), sandingType.First().ToString().ToUpper() + sandingType.Substring(1));
+                    }
+                    catch
+                    {
+                        STFException.TraceWarning(stf, "Skipped unknown engine type " + sandingType);
+                    }
+                    break;
+
                 case "engine(ortstractionmotortype":
                     stf.MustMatch("(");
                     string tractionMotorType = stf.ReadString().ToUpper();
@@ -1163,6 +1176,7 @@ public override void Copy(MSTSWagon copy)
             UnloadingSpeedMpS = locoCopy.UnloadingSpeedMpS;
             SlipControlSystem = locoCopy.SlipControlSystem;
             EngineType = locoCopy.EngineType;
+            SandingSystemType = locoCopy.SandingSystemType;
             TractionMotorType = locoCopy.TractionMotorType;
             TractiveForceCurves = locoCopy.TractiveForceCurves;
             MaxContinuousForceN = locoCopy.MaxContinuousForceN;
@@ -3217,11 +3231,19 @@ public void UpdateTrackSander(float elapsedClockSeconds)
                     }
                 }
 
-          // Calculate air consumption and change in main air reservoir pressure
-                float ActualAirConsumptionM3pS = pS.FrompM(TrackSanderAirComsumptionM3pS) * elapsedClockSeconds;
-                float SanderPressureDiffPSI = ActualAirConsumptionM3pS / Me3.ToFt3(MainResVolumeM3) ;
-                MainResPressurePSI -= SanderPressureDiffPSI;
-                MainResPressurePSI = MathHelper.Clamp(MainResPressurePSI, 0.001f, MaxMainResPressurePSI);
+                if (SandingSystemType == SandingSystemTypes.Steam)
+                {
+
+
+                }
+                else
+                {
+                    // Calculate air consumption and change in main air reservoir pressure
+                    float ActualAirConsumptionM3pS = pS.FrompM(TrackSanderAirComsumptionM3pS) * elapsedClockSeconds;
+                    float SanderPressureDiffPSI = ActualAirConsumptionM3pS / Me3.ToFt3(MainResVolumeM3);
+                    MainResPressurePSI -= SanderPressureDiffPSI;
+                    MainResPressurePSI = MathHelper.Clamp(MainResPressurePSI, 0.001f, MaxMainResPressurePSI);
+                }
             }
 
         }

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

@@ -411,6 +411,7 @@ public float TenderCoalMassKG              // Decreased by firing and increased
         float BoilerHeatTransferCoeffWpM2K = 45.0f; // Heat Transfer of locomotive boiler 45 Wm2K
         float TotalSteamUsageLBpS;                  // Running total for complete current steam usage
         float GeneratorSteamUsageLBpS = 1.0f;       // Generator Steam Usage
+        float SandingSteamUsageLBpS;       // Sanding Steam Usage
         float RadiationSteamLossLBpS = 2.5f;        // Steam loss due to radiation losses
         float BlowerBurnEffect;                     // Effect of Blower on burning rate
         float FlueTempDiffK;                        // Current difference in flue temp at current firing and steam usage rates.
@@ -685,6 +686,13 @@ public float TenderCoalMassKG              // Decreased by firing and increased
         public float Cylinders41SteamVolumeM3pS;
         public float Cylinders42SteamVolumeM3pS;
 
+        public float SanderSteamExhaustForwardVolumeM3pS;
+        public float SanderSteamExhaustReverseVolumeM3pS;
+        public float SanderSteamExhaustVelocityMpS;
+        public float SanderSteamExhaustParticleDurationS;
+
+        float SanderSteamConsumptionLbpS = 17; // Assume 1000lbs/hr steam consumption for the sander
+
         public float Cylinders2_11SteamVolumeM3pS;
         public float Cylinders2_12SteamVolumeM3pS;
         public float Cylinders2_21SteamVolumeM3pS;
@@ -3073,6 +3081,11 @@ private void UpdateFX(float elapsedClockSeconds)
 
             float SteamEffectsFactor = MathHelper.Clamp(BoilerPressurePSI / MaxBoilerPressurePSI, 0.1f, 1.0f);  // Factor to allow for drops in boiler pressure reducing steam effects
 
+            SanderSteamExhaustForwardVolumeM3pS = Sander && SandingSystemType == SandingSystemTypes.Steam && (Direction == Direction.Forward || Direction == Direction.N) ? (10.0f * SteamEffectsFactor) : 0.0f;
+            SanderSteamExhaustReverseVolumeM3pS = Sander && SandingSystemType == SandingSystemTypes.Steam && Direction == Direction.Reverse ? (10.0f * SteamEffectsFactor) : 0.0f;
+            SanderSteamExhaustParticleDurationS = 1.0f;
+            SanderSteamExhaustVelocityMpS = 100.0f;
+
             // Bernoulli formula for future reference - steam velocity = SQRT ( 2 * dynamic pressure (pascals) / fluid density)
             Cylinders1SteamVelocityMpS = 100.0f;
             Cylinders2SteamVelocityMpS = 100.0f;
@@ -6618,6 +6631,21 @@ private void UpdateAuxiliaries(float elapsedClockSeconds, float absSpeedMpS)
                 CylCockSteamUsageDisplayLBpS = 0.0f;
             }
 
+            // Calculate sanding steam Usage if turned on
+            // Assume steam sanding usage is 1000lbs/hr
+            if (Sander && SandingSystemType == SandingSystemTypes.Steam) 
+            {
+                SandingSteamUsageLBpS = SanderSteamConsumptionLbpS; 
+                BoilerMassLB -= elapsedClockSeconds * SandingSteamUsageLBpS; // Reduce boiler mass to reflect steam usage by generator  
+                BoilerHeatBTU -= elapsedClockSeconds * SandingSteamUsageLBpS * (BoilerSteamHeatBTUpLB - BoilerWaterHeatBTUpLB);  // Reduce boiler Heat to reflect steam usage by generator
+                BoilerHeatOutBTUpS += SandingSteamUsageLBpS * (BoilerSteamHeatBTUpLB - BoilerWaterHeatBTUpLB);  // Reduce boiler Heat to reflect steam usage by generator
+                TotalSteamUsageLBpS += SandingSteamUsageLBpS;
+            }
+            else
+            {
+                SandingSteamUsageLBpS = 0.0f; // No generator fitted to locomotive
+            }
+
             // Calculate Generator steam Usage if turned on
             // Assume generator kW = 350W for D50 Class locomotive
             if (GeneratorSteamEffects) // If Generator steam effects not present then assume no generator is fitted to locomotive
@@ -6633,6 +6661,7 @@ private void UpdateAuxiliaries(float elapsedClockSeconds, float absSpeedMpS)
             {
                 GeneratorSteamUsageLBpS = 0.0f; // No generator fitted to locomotive
             }
+
             if (StokerIsMechanical)
             {
                 StokerSteamUsageLBpS = pS.FrompH(MaxBoilerOutputLBpH) * (StokerMinUsage + (StokerMaxUsage - StokerMinUsage) * FuelFeedRateKGpS / MaxFiringRateKGpS);  // Caluculate current steam usage based on fuel feed rates

Source/Orts.Simulation/Simulation/RollingStocks/TrainCar.cs

@@ -657,6 +657,15 @@ public enum SteamEngineTypes
 
         public SteamEngineTypes SteamEngineType;
 
+        public enum SandingSystemTypes
+        {
+            Unknown,
+            Air,
+            Steam,
+        }
+
+        public SandingSystemTypes SandingSystemType;
+
         public enum WagonTypes
         {
             Unknown,

Source/RunActivity/Viewer3D/RollingStock/MSTSSteamLocomotiveViewer.cs

@@ -55,6 +55,8 @@ public class MSTSSteamLocomotiveViewer : MSTSLocomotiveViewer
         List<ParticleEmitterViewer> CylinderSteamExhaust4 = new List<ParticleEmitterViewer>();
         List<ParticleEmitterViewer> CylinderSteamExhaust2_1 = new List<ParticleEmitterViewer>();
         List<ParticleEmitterViewer> CylinderSteamExhaust2_2 = new List<ParticleEmitterViewer>();
+        List<ParticleEmitterViewer> SanderSteamExhaustForward = new List<ParticleEmitterViewer>();
+        List<ParticleEmitterViewer> SanderSteamExhaustReverse = new List<ParticleEmitterViewer>();
         List<ParticleEmitterViewer> BoosterCylinderSteamExhaust01 = new List<ParticleEmitterViewer>();
         List<ParticleEmitterViewer> BoosterCylinderSteamExhaust02 = new List<ParticleEmitterViewer>();
         List<ParticleEmitterViewer> BoosterCylinders11 = new List<ParticleEmitterViewer>();
@@ -127,6 +129,10 @@ public MSTSSteamLocomotiveViewer(Viewer viewer, MSTSSteamLocomotive car)
                     CylinderSteamExhaust2_1.AddRange(emitter.Value);
                 else if (emitter.Key.ToLowerInvariant() == "cylindersteamexhaust2_2fx")
                     CylinderSteamExhaust2_2.AddRange(emitter.Value);
+                else if (emitter.Key.ToLowerInvariant() == "sandersteamexhaustforwardfx")
+                    SanderSteamExhaustForward.AddRange(emitter.Value);
+                else if (emitter.Key.ToLowerInvariant() == "sandersteamexhaustreversefx")
+                    SanderSteamExhaustReverse.AddRange(emitter.Value);
                 else if (emitter.Key.ToLowerInvariant() == "boostercylinders11fx")
                     BoosterCylinders11.AddRange(emitter.Value);
                 else if (emitter.Key.ToLowerInvariant() == "boostercylinders12fx")
@@ -345,10 +351,15 @@ public override void PrepareFrame(RenderFrame frame, ElapsedTime elapsedTime)
             foreach (var drawer in CylinderSteamExhaust3)
                 drawer.SetOutput(car.CylinderSteamExhaustSteamVelocityMpS, car.CylinderSteamExhaust3SteamVolumeM3pS, car.CylinderSteamExhaustParticleDurationS);
 
+            foreach (var drawer in SanderSteamExhaustForward)
+                drawer.SetOutput(car.SanderSteamExhaustVelocityMpS, car.SanderSteamExhaustForwardVolumeM3pS, car.SanderSteamExhaustParticleDurationS);
+
+            foreach (var drawer in SanderSteamExhaustReverse)
+                drawer.SetOutput(car.SanderSteamExhaustVelocityMpS, car.SanderSteamExhaustReverseVolumeM3pS, car.SanderSteamExhaustParticleDurationS);
+
             foreach (var drawer in BoosterCylinderSteamExhaust01)
                 drawer.SetOutput(car.BoosterCylinderSteamExhaust01SteamVelocityMpS, car.BoosterCylinderSteamExhaust01SteamVolumeM3pS, car.BoosterCylinderCockParticleDurationS);
 
-
             foreach (var drawer in BoosterCylinderSteamExhaust02)
                 drawer.SetOutput(car.BoosterCylinderSteamExhaust02SteamVelocityMpS, car.BoosterCylinderSteamExhaust02SteamVolumeM3pS, car.BoosterCylinderCockParticleDurationS);