Wag file axle configuration

Author: cesarBLG

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

@@ -451,7 +451,6 @@ public enum TractionMotorTypes
         public ILocomotivePowerSupply LocomotivePowerSupply => PowerSupply as ILocomotivePowerSupply;
         public ScriptedTrainControlSystem TrainControlSystem;
 
-        public Axles LocomotiveAxles;
         public IIRFilter CurrentFilter;
         public IIRFilter AdhesionFilter;
         public float SaveAdhesionFilter;
@@ -478,7 +477,6 @@ public MSTSLocomotive(Simulator simulator, string wagPath)
             MilepostUnitsMetric = Simulator.TRK.Tr_RouteFile.MilepostUnitsMetric;
             BrakeCutsPowerAtBrakeCylinderPressurePSI = 4.0f;
 
-            LocomotiveAxles = new Axles(this);
             LocomotiveAxles.Add(new Axle());
             CurrentFilter = new IIRFilter(IIRFilter.FilterTypes.Butterworth, 1, IIRFilter.HzToRad(0.5f), 0.001f);
             AdhesionFilter = new IIRFilter(IIRFilter.FilterTypes.Butterworth, 1, IIRFilter.HzToRad(1f), 0.001f);
@@ -1223,23 +1221,10 @@ public override void Copy(MSTSWagon copy)
             WaterScoopFillElevationM = locoCopy.WaterScoopFillElevationM;
             WaterScoopDepthM = locoCopy.WaterScoopDepthM;
             WaterScoopWidthM = locoCopy.WaterScoopWidthM;
-            MoveParamsToAxle();
             CruiseControl = locoCopy.CruiseControl?.Clone(this);
             MultiPositionControllers = locoCopy.CloneMPC(this);
         }
 
-        /// <summary>
-        /// We are moving parameters from locomotive to axle. 
-        /// </summary>
-        public void MoveParamsToAxle()
-        {
-            foreach (var axle in LocomotiveAxles)
-            {
-                axle.SlipWarningTresholdPercent = SlipWarningThresholdPercent;
-                axle.AdhesionK = AdhesionK;
-            }
-        }
-
         /// <summary>
         /// We are saving the game.  Save anything that we'll need to restore the 
         /// status later.
@@ -1288,7 +1273,6 @@ public override void Save(BinaryWriter outf)
             LocomotivePowerSupply?.Save(outf);
             TrainControlSystem.Save(outf);
 
-            LocomotiveAxles.Save(outf);
             CruiseControl?.Save(outf);
         }
 
@@ -1342,9 +1326,7 @@ public override void Restore(BinaryReader inf)
 
             LocomotivePowerSupply?.Restore(inf);
             TrainControlSystem.Restore(inf);
-                        
-            MoveParamsToAxle();
-            LocomotiveAxles.Restore(inf);
+
             CruiseControl?.Restore(inf);
         }
 
@@ -1426,7 +1408,6 @@ public override void Initialize()
             BrakemanBrakeController.Initialize();
             LocomotivePowerSupply?.Initialize();
             TrainControlSystem.Initialize();
-            LocomotiveAxles.Initialize();
             CruiseControl?.Initialize();
             foreach (MultiPositionController mpc in MultiPositionControllers)
             {
@@ -1485,6 +1466,18 @@ public override void Initialize()
                     Trace.TraceInformation("Number of Locomotive Drive Axles set to default value of {0}", LocoNumDrvAxles);
                 }
             }
+            //Compute axle inertia from parameters if possible
+            if (AxleInertiaKgm2 <= 0) // if no axleinertia value supplied in ENG file, calculate axleinertia value.
+            {
+                if (LocoNumDrvAxles > 0 && DriverWheelRadiusM > 0)
+                {
+                    float radiusSquared = DriverWheelRadiusM * DriverWheelRadiusM;
+                    float wheelMass = 500 * radiusSquared / (0.5f * 0.5f);
+                    AxleInertiaKgm2 = Math.Min(LocoNumDrvAxles * wheelMass * radiusSquared + 500, 40000);
+                }
+                else
+                    AxleInertiaKgm2 = 2000.0f;
+            }
             if (TractionMotorType == TractionMotorTypes.AC)
             {
                 foreach (var axle in LocomotiveAxles)
@@ -1494,7 +1487,6 @@ public override void Initialize()
                 }
             }
 
-
             // Calculate minimum speed to pickup water
             const float Aconst = 2;
             WaterScoopMinSpeedMpS = Me.FromFt((float)Math.Sqrt(Aconst * GravitationalAccelerationFtpSpS * Me.ToFt(WaterScoopFillElevationM)));
@@ -1742,9 +1734,8 @@ public List<MultiPositionController> CloneMPC(MSTSLocomotive locomotive)
 
         public override void InitializeMoving()
         {
-            base.InitializeMoving();
             AdhesionFilter.Reset(0.5f);
-            LocomotiveAxles.InitializeMoving();
+            base.InitializeMoving();
             AverageForceN = MaxForceN * Train.MUThrottlePercent / 100;
             float maxPowerW = MaxPowerW * Train.MUThrottlePercent * Train.MUThrottlePercent / 10000;
             if (AverageForceN * SpeedMpS > maxPowerW) AverageForceN = maxPowerW / SpeedMpS;
@@ -2761,34 +2752,6 @@ public virtual void AdvancedAdhesion(float elapsedClockSeconds)
                 return;
             }
 
-            if (EngineType == EngineTypes.Steam && SteamEngineType != MSTSSteamLocomotive.SteamEngineTypes.Geared)
-            {
-                // Managed in MSTSSteamLocomotive implementation of AdvancedAdhesion
-            }
-            else
-            {
-
-                //Compute axle inertia from parameters if possible
-                if (AxleInertiaKgm2 <= 0) // if no axleinertia value supplied in ENG file, calculate axleinertia value.
-                {
-                    if (LocoNumDrvAxles > 0 && DriverWheelRadiusM > 0)
-                    {
-                        float radiusSquared = DriverWheelRadiusM * DriverWheelRadiusM;
-                        float wheelMass = 500 * radiusSquared / (0.5f * 0.5f);
-                        AxleInertiaKgm2 = LocoNumDrvAxles * wheelMass * radiusSquared + 500;
-                    }
-                    else
-                        AxleInertiaKgm2 = 2000.0f;
-                }
-                foreach (var axle in LocomotiveAxles)
-                {
-                    //Limit the inertia to 40000 kgm2
-                    axle.InertiaKgm2 = Math.Min(AxleInertiaKgm2, 40000);
-                    axle.DampingNs = MassKG / 1000.0f;
-                    axle.FrictionN = MassKG / 1000.0f;
-                    axle.AxleWeightN = 9.81f * DrvWheelWeightKg/LocomotiveAxles.Count;;  //remains fixed for diesel/electric locomotives, but varies for steam locomotives
-                }
-            }
             foreach (var axle in LocomotiveAxles)
             {
                 axle.BrakeRetardForceN = BrakeRetardForceN/LocomotiveAxles.Count;

Source/Orts.Simulation/Simulation/RollingStocks/MSTSWagon.cs

@@ -43,6 +43,7 @@
 using Orts.Simulation.RollingStocks.SubSystems.Brakes.MSTS;
 using Orts.Simulation.RollingStocks.SubSystems.Controllers;
 using Orts.Simulation.RollingStocks.SubSystems.PowerSupplies;
+using Orts.Simulation.RollingStocks.SubSystems.PowerTransmissions;
 using ORTS.Common;
 using ORTS.Scripting.Api;
 using System;
@@ -148,13 +149,14 @@ public class MSTSWagon : TrainCar
         public float Curtius_KnifflerC = 0.161f;             //                                      speedMpS * 3.6 + B
         public float AdhesionK = 0.7f;   //slip characteristics slope
         public float AxleInertiaKgm2;    //axle inertia
-        public float AdhesionDriveWheelRadiusM;
         public float WheelSpeedMpS;
         public float WheelSpeedSlipMpS; // speed of wheel if locomotive is slipping
         public float SlipWarningThresholdPercent = 70;
         public MSTSNotchController WeightLoadController; // Used to control freight loading in freight cars
         public float AbsWheelSpeedMpS; // Math.Abs(WheelSpeedMpS) is used frequently in the subclasses, maybe it's more efficient to compute it once
 
+        public Axles LocomotiveAxles; // Only used at locomotives for efficiency
+
         // Colours for smoke and steam effects
         public Color ExhaustTransientColor = Color.Black;
         public Color ExhaustDecelColor = Color.WhiteSmoke;
@@ -347,6 +349,7 @@ public MSTSWagon(Simulator simulator, string wagFilePath)
         {
             Pantographs = new Pantographs(this);
             Doors = new Doors(this);
+            LocomotiveAxles = new Axles(this);
         }
 
         public void Load()
@@ -980,6 +983,7 @@ public override void Initialize()
             Pantographs.Initialize();
             Doors.Initialize();
             PassengerCarPowerSupply?.Initialize();
+            LocomotiveAxles.Initialize();
 
             base.Initialize();
 
@@ -1011,6 +1015,7 @@ public override void Initialize()
         public override void InitializeMoving()
         {
             PassengerCarPowerSupply?.InitializeMoving();
+            LocomotiveAxles.InitializeMoving();
 
             base.InitializeMoving();
         }
@@ -1382,15 +1387,8 @@ 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(wheelset(axle(ortsinertia":
-                    stf.MustMatch("(");
-                    AxleInertiaKgm2 = stf.ReadFloat(STFReader.UNITS.RotationalInertia, null);
-                    stf.SkipRestOfBlock();
-                    break;
-                case "wagon(ortsadhesion(wheelset(axle(ortsradius":
-                    stf.MustMatch("(");
-                    AdhesionDriveWheelRadiusM = stf.ReadFloat(STFReader.UNITS.Distance, null);
-                    stf.SkipRestOfBlock();
+                case "wagon(ortsadhesion(wheelset":
+                    LocomotiveAxles.Parse(lowercasetoken, stf);
                     break;
                 case "wagon(lights":
                     Lights = new LightCollection(stf);
@@ -1555,7 +1553,6 @@ public virtual void Copy(MSTSWagon copy)
             Curtius_KnifflerC = copy.Curtius_KnifflerC;
             AdhesionK = copy.AdhesionK;
             AxleInertiaKgm2 = copy.AxleInertiaKgm2;
-            AdhesionDriveWheelRadiusM = copy.AdhesionDriveWheelRadiusM;
             SlipWarningThresholdPercent = copy.SlipWarningThresholdPercent;
             Lights = copy.Lights;
             ExternalSoundPassThruPercent = copy.ExternalSoundPassThruPercent;
@@ -1618,6 +1615,20 @@ public virtual void Copy(MSTSWagon copy)
                 PowerSupply = new ScriptedPassengerCarPowerSupply(this);
                 PassengerCarPowerSupply.Copy(copy.PassengerCarPowerSupply);
             }
+            LocomotiveAxles.Copy(copy.LocomotiveAxles);
+            MoveParamsToAxle();
+        }
+
+        /// <summary>
+        /// We are moving parameters from locomotive to axle. 
+        /// </summary>
+        public void MoveParamsToAxle()
+        {
+            foreach (var axle in LocomotiveAxles)
+            {
+                axle.SlipWarningTresholdPercent = SlipWarningThresholdPercent;
+                axle.AdhesionK = AdhesionK;
+            }
         }
 
         protected void ParseWagonInside(STFReader stf)
@@ -1731,6 +1742,8 @@ public override void Save(BinaryWriter outf)
             outf.Write(DerailExpected);
             outf.Write(DerailElapsedTimeS);
 
+            LocomotiveAxles.Save(outf);
+
             base.Save(outf);
         }
 
@@ -1784,6 +1797,9 @@ public override void Restore(BinaryReader inf)
             DerailExpected = inf.ReadBoolean();
             DerailElapsedTimeS = inf.ReadSingle();
 
+            MoveParamsToAxle();
+            LocomotiveAxles.Restore(inf);
+
             base.Restore(inf);
         }
 

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerTransmissions/Axle.cs

@@ -22,6 +22,7 @@
 using System.Diagnostics;
 using Microsoft.Xna.Framework;
 using ORTS.Common;
+using Orts.Parsers.Msts;
 using Orts.Simulation.RollingStocks.SubSystems.PowerTransmissions;
 using SharpDX.Direct2D1;
 
@@ -179,6 +180,34 @@ public void Add(Axle axle)
         {
             AxleList.Add(axle);
         }
+
+        /// <summary>
+        /// Parses all the parameters within the ENG file
+        /// </summary>
+        /// <param name="stf">reference to the ENG file reader</param>
+        public void Parse(string lowercasetoken, STFReader stf)
+        {
+            switch (lowercasetoken)
+            {
+                case "wagon(ortsadhesion(wheelset":
+                    AxleList.Clear();
+                    stf.MustMatch("(");
+                    stf.ParseBlock(
+                        new[] {
+                            new STFReader.TokenProcessor(
+                                "axle",
+                                () => {
+                                    var axle = new Axle();
+                                    AxleList.Add(axle);
+                                    axle.Parse(stf);
+                                }
+                            )
+                        });
+                    if (AxleList.Count == 0)
+                        throw new InvalidDataException("Wheelset block with no axles");
+                    break;
+            }
+        }
         public void Copy(Axles other)
         {
             AxleList = new List<Axle>();
@@ -195,6 +224,13 @@ public void Initialize()
             ResetTime = Car.Simulator.GameTime;
             foreach (var axle in AxleList)
             {
+                if (Car is MSTSLocomotive locomotive)
+                {
+                    if (axle.InertiaKgm2 <= 0) axle.InertiaKgm2 = locomotive.AxleInertiaKgm2 / AxleList.Count;
+                    if (axle.AxleWeightN <= 0) axle.AxleWeightN = 9.81f * locomotive.DrvWheelWeightKg / AxleList.Count;  //remains fixed for diesel/electric locomotives, but varies for steam locomotives
+                    if (axle.DampingNs <= 0) axle.DampingNs = locomotive.MassKG / 1000.0f / AxleList.Count;
+                    if (axle.FrictionN <= 0) axle.FrictionN = locomotive.MassKG / 1000.0f / AxleList.Count;
+                }
                 axle.Initialize();
             }
         }
@@ -604,10 +640,33 @@ public void InitializeMoving()
             AxleSpeedMpS = TrainSpeedMpS;
             motor?.InitializeMoving();
         }
+        public void Parse(STFReader stf)
+        {
+            stf.MustMatch("(");
+            while (!stf.EndOfBlock())
+            {
+                switch (stf.ReadItem().ToLower())
+                {
+                    case "ortsradius":
+                        WheelRadiusM = stf.ReadFloatBlock(STFReader.UNITS.Distance, null);
+                        break;
+                    case "ortsinertia":
+                        InertiaKgm2 = stf.ReadFloatBlock(STFReader.UNITS.RotationalInertia, null);
+                        break;
+                    case "weight":
+                        AxleWeightN = 9.81f * stf.ReadFloatBlock(STFReader.UNITS.Mass, null);
+                        break;
+                    case "(":
+                        stf.SkipRestOfBlock();
+                        break;
+                }
+            }
+        }
         public void Copy(Axle other)
         {
-            // TODO
-            motor?.Copy(other.motor);
+            WheelRadiusM = other.WheelRadiusM;
+            InertiaKgm2 = other.InertiaKgm2;
+            AxleWeightN = other.AxleWeightN;
         }
 
         /// <summary>