Refactoring of slip control

cesarBLG · cesarBLG · commit 156a2be34f7d · 2022-04-12T09:57:57.000+02:00
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSDieselLocomotive.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSDieselLocomotive.cs
@@ -669,13 +669,25 @@ protected override void UpdateTractiveForce(float elapsedClockSeconds, float t,
                 // its impact. More modern locomotive have a more sophisticated system that eliminates slip in the majority (if not all circumstances).
                 // Simple adhesion control does not have any slip control feature built into it.
                 // TODO - a full review of slip/no slip control.
-                if (WheelSlip && AdvancedAdhesionModel)
+                if (ElectricMotorType == ElectricMotorTypes.AC)
                 {
-                    AbsTractionSpeedMpS = AbsWheelSpeedMpS;
+                    AbsTractionSpeedMpS = AbsSpeedMpS;
+                    if (AbsWheelSpeedMpS > 1.1 * MaxSpeedMpS)
+                    {
+                        AverageForceN = TractiveForceN = 0;
+                        return;
+                    }
                 }
                 else
                 {
-                    AbsTractionSpeedMpS = AbsSpeedMpS;
+                    if (WheelSlip && AdvancedAdhesionModel)
+                    {
+                        AbsTractionSpeedMpS = AbsWheelSpeedMpS;
+                    }
+                    else
+                    {
+                        AbsTractionSpeedMpS = AbsSpeedMpS;
+                    }
                 }
 
                 if (TractiveForceCurves == null)
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs
@@ -214,6 +214,12 @@ public float CurrentLocomotiveSteamHeatBoilerWaterCapacityL
         //float DebugTimer = 0.0f;
 
         // Adhesion parameters
+        public enum SlipControlType
+        {
+            None,
+            Full
+        }
+        public SlipControlType SlipControlSystem = SlipControlType.Full;
         float BaseFrictionCoefficientFactor;  // Factor used to adjust Curtius formula depending upon weather conditions
         public float SteamStaticWheelForce;
         public float SteamTangentialWheelForce;
@@ -426,6 +432,13 @@ public float OdometerM
         public float DynamicBrakeIntervention = -1;
         protected float PreviousDynamicBrakeIntervention = -1;
 
+        public enum ElectricMotorTypes
+        {
+            AC,
+            DC
+        }
+        public ElectricMotorTypes ElectricMotorType;
+
         public ILocomotivePowerSupply LocomotivePowerSupply => PowerSupply as ILocomotivePowerSupply;
         public ScriptedTrainControlSystem TrainControlSystem;
 
@@ -862,6 +875,18 @@ public override void Parse(string lowercasetoken, STFReader stf)
                 case "engine(dieselenginespeedofmaxtractiveeffort": MSTSSpeedOfMaxContinuousForceMpS = stf.ReadFloatBlock(STFReader.UNITS.Speed, null); break;
                 case "engine(maxvelocity": MaxSpeedMpS = stf.ReadFloatBlock(STFReader.UNITS.Speed, null); break;
                 case "engine(ortsunloadingspeed": UnloadingSpeedMpS = stf.ReadFloatBlock(STFReader.UNITS.Speed, null); break;
+                case "engine(ortsslipcontrolsystem":
+                    stf.MustMatch("(");
+                    string slipControlType = stf.ReadString().ToLowerInvariant();
+                    try
+                    {
+                        SlipControlSystem = (SlipControlType)Enum.Parse(typeof(SlipControlType), slipControlType.First().ToString().ToUpper() + slipControlType.Substring(1));
+                    }
+                    catch
+                    {
+                        STFException.TraceWarning(stf, "Skipped unknown slip control system " + slipControlType);
+                    }
+                    break;
                 case "engine(type":
                     stf.MustMatch("(");
                     var engineType = stf.ReadString();
@@ -874,6 +899,18 @@ public override void Parse(string lowercasetoken, STFReader stf)
                         STFException.TraceWarning(stf, "Skipped unknown engine type " + engineType);
                     }
                     break;
+                case "engine(ortselectricmotortype":
+                    stf.MustMatch("(");
+                    string electricMotorType = stf.ReadString().ToUpper();
+                    try
+                    {
+                        ElectricMotorType = (ElectricMotorTypes)Enum.Parse(typeof(ElectricMotorTypes), electricMotorType);
+                    }
+                    catch
+                    {
+                        STFException.TraceWarning(stf, "Skipped unknown electric motor type " + electricMotorType);
+                    }
+                    break;
 
                 case "engine(enginecontrollers(throttle": ThrottleController = new MSTSNotchController(stf); break;
                 case "engine(enginecontrollers(regulator": ThrottleController = new MSTSNotchController(stf); break;
@@ -1070,7 +1107,9 @@ public override void Copy(MSTSWagon copy)
             MaxCurrentA = locoCopy.MaxCurrentA;
             MaxSpeedMpS = locoCopy.MaxSpeedMpS;
             UnloadingSpeedMpS = locoCopy.UnloadingSpeedMpS;
+            SlipControlSystem = locoCopy.SlipControlSystem;
             EngineType = locoCopy.EngineType;
+            ElectricMotorType = locoCopy.ElectricMotorType;
             TractiveForceCurves = locoCopy.TractiveForceCurves;
             MaxContinuousForceN = locoCopy.MaxContinuousForceN;
             SpeedOfMaxContinuousForceMpS = locoCopy.SpeedOfMaxContinuousForceMpS;
@@ -1893,7 +1932,6 @@ public override void Update(float elapsedClockSeconds)
                             DynamicBrakeController.CurrentValue * 100);
                     }
 
-
                     // SimpleControlPhysics and if locomotive is a control car advanced adhesion will be "disabled".
                     if (Simulator.UseAdvancedAdhesion && !Simulator.Settings.SimpleControlPhysics && EngineType != EngineTypes.Control) 
                     {
@@ -2199,13 +2237,25 @@ protected virtual void UpdateTractiveForce(float elapsedClockSeconds, float t, f
                 // More modern locomotive have a more sophisticated system that eliminates slip in the majority (if not all circumstances).
                 // Simple adhesion control does not have any slip control feature built into it.
                 // TODO - a full review of slip/no slip control.
-                if (WheelSlip && AdvancedAdhesionModel)
+                if (ElectricMotorType == ElectricMotorTypes.AC)
                 {
-                    AbsTractionSpeedMpS = AbsWheelSpeedMpS;
+                    AbsTractionSpeedMpS = AbsSpeedMpS;
+                    if (AbsWheelSpeedMpS > 1.1 * MaxSpeedMpS)
+                    {
+                        AverageForceN = TractiveForceN = 0;
+                        return;
+                    }
                 }
                 else
                 {
-                    AbsTractionSpeedMpS = AbsSpeedMpS;
+                    if (WheelSlip && AdvancedAdhesionModel)
+                    {
+                        AbsTractionSpeedMpS = AbsWheelSpeedMpS;
+                    }
+                    else
+                    {
+                        AbsTractionSpeedMpS = AbsSpeedMpS;
+                    }
                 }
 
                 if (TractiveForceCurves == null)
@@ -2297,7 +2347,7 @@ public void ConfirmWheelslip(float elapsedClockSeconds)
                 if (AdvancedAdhesionModel)
                 {
                     // Wheelslip
-                    if (LocomotiveAxle.IsWheelSlip)
+                    if (WheelSlip)
                     {
                         if (WheelslipState != Wheelslip.Occurring)
                         {
@@ -2307,7 +2357,7 @@ public void ConfirmWheelslip(float elapsedClockSeconds)
                     }
                     else
                     {
-                        if (LocomotiveAxle.IsWheelSlipWarning)
+                        if (WheelSlipWarning)
                         {
                             if (WheelslipState != Wheelslip.Warning)
                             {
@@ -2590,7 +2640,7 @@ public void AdvancedAdhesion(float elapsedClockSeconds)
                 //LocomotiveAxle.AxleRevolutionsInt.MinStep = LocomotiveAxle.InertiaKgm2 / MaxPowerW / 5.0f;
                 LocomotiveAxle.AxleDiameterM = 2*DriverWheelRadiusM;
 
-                if (AntislipControl == AntislipControlType.Full)
+                if (SlipControlSystem == SlipControlType.Full)
                 {
                     // Simple slip control
                     // Motive force is reduced to the maximum adhesive force
@@ -2614,7 +2664,7 @@ public void AdvancedAdhesion(float elapsedClockSeconds)
                 if (elapsedClockSeconds > 0)
                 {
                     WheelSlip = LocomotiveAxle.IsWheelSlip;             //Get the wheelslip indicator
-                    WheelSlipWarning = LocomotiveAxle.IsWheelSlipWarning;
+                    WheelSlipWarning = LocomotiveAxle.IsWheelSlipWarning && SlipControlSystem != SlipControlType.Full;
                 }
                 WheelSpeedMpS = LocomotiveAxle.AxleSpeedMpS;
             }
@@ -5017,7 +5067,7 @@ public virtual float GetDataOf(CabViewControl cvc)
                                 if (activeloco.DieselEngines[0] != null)
                                 {
                                     if (activeloco.AdvancedAdhesionModel && Train.TrainType != Train.TRAINTYPE.AI_PLAYERHOSTING)
-                                        data = activeloco.LocomotiveAxle.IsWheelSlipWarning ? 1 : 0;
+                                        data = activeloco.WheelSlipWarning ? 1 : 0;
                                     else
                                         data = activeloco.WheelSlip ? 1 : 0;
 
@@ -5028,7 +5078,7 @@ public virtual float GetDataOf(CabViewControl cvc)
                         else
                         {
                             if (AdvancedAdhesionModel && Train.TrainType != Train.TRAINTYPE.AI_PLAYERHOSTING)
-                                data = LocomotiveAxle.IsWheelSlipWarning ? 1 : 0;
+                                data = WheelSlipWarning ? 1 : 0;
                             else
                                 data = WheelSlip ? 1 : 0;
                         }
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSWagon.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSWagon.cs
@@ -146,12 +146,6 @@ public class MSTSWagon : TrainCar
         public float Curtius_KnifflerB = 44.0f;              // (adhesion coeficient)       umax = ---------------------  + C
         public float Curtius_KnifflerC = 0.161f;             //                                      speedMpS * 3.6 + B
         public float AdhesionK = 0.7f;   //slip characteristics slope
-        public enum AntislipControlType
-        {
-            None,
-            Full
-        }
-        public AntislipControlType AntislipControl = AntislipControlType.None;
         public float AxleInertiaKgm2;    //axle inertia
         public float AdhesionDriveWheelRadiusM;
         public float WheelSpeedMpS;
@@ -1365,12 +1359,6 @@ public virtual void Parse(string lowercasetoken, STFReader stf)
                     SlipWarningThresholdPercent = stf.ReadFloat(STFReader.UNITS.None, 70.0f); if (SlipWarningThresholdPercent <= 0) SlipWarningThresholdPercent = 70.0f;
                     stf.SkipRestOfBlock();
                     break;
-                case "wagon(ortsadhesion(ortsantislip":
-                    string type = stf.ReadStringBlock("none").ToLowerInvariant();
-                    if (type == "full") AntislipControl = AntislipControlType.Full;
-                    else AntislipControl = AntislipControlType.None;
-                    stf.SkipRestOfBlock();
-                    break;
                 case "wagon(ortsadhesion(wheelset(axle(ortsinertia":
                     stf.MustMatch("(");
                     AxleInertiaKgm2 = stf.ReadFloat(STFReader.UNITS.RotationalInertia, null);
@@ -1573,7 +1561,6 @@ public virtual void Copy(MSTSWagon copy)
             Curtius_KnifflerC = copy.Curtius_KnifflerC;
             AdhesionK = copy.AdhesionK;
             AxleInertiaKgm2 = copy.AxleInertiaKgm2;
-            AntislipControl = copy.AntislipControl;
             AdhesionDriveWheelRadiusM = copy.AdhesionDriveWheelRadiusM;
             SlipWarningThresholdPercent = copy.SlipWarningThresholdPercent;
             Lights = copy.Lights;
