style: Format physics wind code

twpol · twpol · commit 39abd77e61f1 · 2023-03-22T20:57:48.000Z
diff --git a/Source/Orts.Simulation/Simulation/Physics/Train.cs b/Source/Orts.Simulation/Simulation/Physics/Train.cs
@@ -2111,42 +2111,41 @@ public virtual void physicsUpdate(float elapsedClockSeconds)
         public void UpdateWindComponents()
         {
             // Gets wind direction and speed, and determines HUD display values for the train as a whole. 
-            //These will be representative of the train whilst it is on a straight track, but each wagon will vary when going around a curve.
+            // These will be representative of the train whilst it is on a straight track, but each wagon will vary when going around a curve.
             // Note both train and wind direction will be positive between 0 (north) and 180 (south) through east, and negative between 0 (north) and 180 (south) through west
             // Wind and train direction to be converted to an angle between 0 and 360 deg.
-                // Calculate Wind speed and direction, and train direction
-                // Update the value of the Wind Speed and Direction for the train
-                PhysicsWindDirectionDeg = MathHelper.ToDegrees(Simulator.Weather.WindDirectionRad);
-                PhysicsWindSpeedMpS = Simulator.Weather.WindSpeedMpS.Length();
-                float TrainSpeedMpS = Math.Abs(SpeedMpS);
-
-                // If a westerly direction (ie -ve) convert to an angle between 0 and 360
-                if (PhysicsWindDirectionDeg < 0)
-                    PhysicsWindDirectionDeg += 360;
-
-                if (PhysicsTrainLocoDirectionDeg < 0)
-                    PhysicsTrainLocoDirectionDeg += 360;
-
-                // calculate angle between train and eind direction
-                if (PhysicsWindDirectionDeg > PhysicsTrainLocoDirectionDeg)
-                    ResultantWindComponentDeg = PhysicsWindDirectionDeg - PhysicsTrainLocoDirectionDeg;
-                else if (PhysicsTrainLocoDirectionDeg > PhysicsWindDirectionDeg)
-                    ResultantWindComponentDeg = PhysicsTrainLocoDirectionDeg - PhysicsWindDirectionDeg;
-                else
-                    ResultantWindComponentDeg = 0.0f;
-
-                // Correct wind direction if it is greater then 360 deg, then correct to a value less then 360
-                if (Math.Abs(ResultantWindComponentDeg) > 360)
-                    ResultantWindComponentDeg = ResultantWindComponentDeg - 360.0f;
+            // Calculate Wind speed and direction, and train direction
+            // Update the value of the Wind Speed and Direction for the train
+            PhysicsWindDirectionDeg = MathHelper.ToDegrees(Simulator.Weather.WindDirectionRad);
+            PhysicsWindSpeedMpS = Simulator.Weather.WindSpeedMpS.Length();
+            var speedMpS = Math.Abs(SpeedMpS);
+
+            // If a westerly direction (ie -ve) convert to an angle between 0 and 360
+            if (PhysicsWindDirectionDeg < 0)
+                PhysicsWindDirectionDeg += 360;
+
+            if (PhysicsTrainLocoDirectionDeg < 0)
+                PhysicsTrainLocoDirectionDeg += 360;
+
+            // Calculate angle between train and wind direction
+            if (PhysicsWindDirectionDeg > PhysicsTrainLocoDirectionDeg)
+                ResultantWindComponentDeg = PhysicsWindDirectionDeg - PhysicsTrainLocoDirectionDeg;
+            else if (PhysicsTrainLocoDirectionDeg > PhysicsWindDirectionDeg)
+                ResultantWindComponentDeg = PhysicsTrainLocoDirectionDeg - PhysicsWindDirectionDeg;
+            else
+                ResultantWindComponentDeg = 0.0f;
 
-                // Wind angle should be kept between 0 and 180 the formulas do not cope with angles > 180. If angle > 180, denotes wind of "other" side of train
-                if (ResultantWindComponentDeg > 180)
-                    ResultantWindComponentDeg = 360 - ResultantWindComponentDeg;
+            // Correct wind direction if it is greater then 360 deg, then correct to a value less then 360
+            if (Math.Abs(ResultantWindComponentDeg) > 360)
+                ResultantWindComponentDeg = ResultantWindComponentDeg - 360.0f;
 
-                float WindAngleRad = MathHelper.ToRadians(ResultantWindComponentDeg);
+            // Wind angle should be kept between 0 and 180 the formulas do not cope with angles > 180. If angle > 180, denotes wind of "other" side of train
+            if (ResultantWindComponentDeg > 180)
+                ResultantWindComponentDeg = 360 - ResultantWindComponentDeg;
 
-                WindResultantSpeedMpS = (float)Math.Sqrt(TrainSpeedMpS * TrainSpeedMpS + PhysicsWindSpeedMpS * PhysicsWindSpeedMpS + 2.0f * TrainSpeedMpS * PhysicsWindSpeedMpS * (float)Math.Cos(WindAngleRad));
-            }
+            var windAngleRad = MathHelper.ToRadians(ResultantWindComponentDeg);
+            WindResultantSpeedMpS = (float)Math.Sqrt(speedMpS * speedMpS + PhysicsWindSpeedMpS * PhysicsWindSpeedMpS + 2.0f * speedMpS * PhysicsWindSpeedMpS * (float)Math.Cos(windAngleRad));
+        }
 
 
         //================================================================================================//
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSWagon.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSWagon.cs
@@ -127,11 +127,6 @@ public class MSTSWagon : TrainCar
         float TenderWagonMaxCoalMassKG;
         float TenderWagonMaxWaterMassKG;
 
-        // Wind Impacts
-        float WagonDirectionDeg;
-        float WagonResultantWindComponentDeg;
-        float WagonWindResultantSpeedMpS;
-
         protected float FrictionC1; // MSTS Friction parameters
         protected float FrictionE1; // MSTS Friction parameters
         protected float FrictionV2; // MSTS Friction parameters
@@ -2870,135 +2865,134 @@ private void UpdateWheelBearingTemperature(float elapsedClockSeconds)
         private void UpdateWindForce()
         {
             // Calculate compensation for  wind
-            // There are two components due to wind - 
+            // There are two components due to wind -
             // Drag, impact of wind on train, will increase resistance when head on, will decrease resistance when acting as a tailwind.
             // Lateral resistance - due to wheel flange being pushed against rail due to side wind.
             // Calculation based upon information provided in AREA 1942 Proceedings - https://archive.org/details/proceedingsofann431942amer - pg 56
 
-            if (!CarTunnelData.FrontPositionBeyondStartOfTunnel.HasValue && AbsSpeedMpS > 2.2352) // Only calculate wind resistance if option selected in options menu, and not in a tunnel, and speed is sufficient for wind effects (>5mph)
+            // Only calculate wind resistance if option selected in options menu, and not in a tunnel, and speed is sufficient for wind effects (>5mph)
+            if (!CarTunnelData.FrontPositionBeyondStartOfTunnel.HasValue && AbsSpeedMpS > 2.2352)
             {
-
                 // Wagon Direction
-                float direction = (float)Math.Atan2(WorldPosition.XNAMatrix.M13, WorldPosition.XNAMatrix.M11);
-                WagonDirectionDeg = MathHelper.ToDegrees((float)direction);
+                var directionRad = (float)Math.Atan2(WorldPosition.XNAMatrix.M13, WorldPosition.XNAMatrix.M11);
+                var directionDeg = MathHelper.ToDegrees(directionRad);
 
-                // If car is flipped, then the car's direction will be reversed by 180 compared to the rest of the train, and thus for calculation purposes only, 
+                // If car is flipped, then the car's direction will be reversed by 180 compared to the rest of the train, and thus for calculation purposes only,
                 // it is necessary to reverse the "assumed" direction of the car back again. This shouldn't impact the visual appearance of the car.
                 if (Flipped)
                 {
-                    WagonDirectionDeg += 180.0f; // Reverse direction of car
-                    if (WagonDirectionDeg > 360) // If this results in an angle greater then 360, then convert it back to an angle between 0 & 360.
-                    {
-                        WagonDirectionDeg -= 360;
-                    }
-                }                   
+                    // Reverse direction of car
+                    directionDeg += 180.0f;
+
+                    // If this results in an angle greater then 360, then convert it back to an angle between 0 & 360.
+                    if (directionDeg > 360)
+                        directionDeg -= 360;
+                }
 
                 // If a westerly direction (ie -ve) convert to an angle between 0 and 360
-                if (WagonDirectionDeg < 0)
-                    WagonDirectionDeg += 360;
+                if (directionDeg < 0)
+                    directionDeg += 360;
 
-                float TrainSpeedMpS = Math.Abs(SpeedMpS);
-                
                 // Find angle between wind and direction of train
-                if (Train.PhysicsWindDirectionDeg > WagonDirectionDeg)
-                    WagonResultantWindComponentDeg = Train.PhysicsWindDirectionDeg - WagonDirectionDeg;
-                else if (WagonDirectionDeg > Train.PhysicsWindDirectionDeg)
-                    WagonResultantWindComponentDeg = WagonDirectionDeg - Train.PhysicsWindDirectionDeg;
-                else
-                    WagonResultantWindComponentDeg = 0.0f;
+                var resultantWindComponentDeg = 0.0f;
+                if (Train.PhysicsWindDirectionDeg > directionDeg)
+                    resultantWindComponentDeg = Train.PhysicsWindDirectionDeg - directionDeg;
+                else if (directionDeg > Train.PhysicsWindDirectionDeg)
+                    resultantWindComponentDeg = directionDeg - Train.PhysicsWindDirectionDeg;
 
                 // Correct wind direction if it is greater then 360 deg, then correct to a value less then 360
-                if (Math.Abs(WagonResultantWindComponentDeg) > 360)
-                    WagonResultantWindComponentDeg = WagonResultantWindComponentDeg - 360.0f;
+                if (Math.Abs(resultantWindComponentDeg) > 360)
+                    resultantWindComponentDeg -= 360.0f;
 
                 // Wind angle should be kept between 0 and 180 the formulas do not cope with angles > 180. If angle > 180, denotes wind of "other" side of train
-                if (WagonResultantWindComponentDeg > 180)
-                    WagonResultantWindComponentDeg = 360 - WagonResultantWindComponentDeg;
+                if (resultantWindComponentDeg > 180)
+                    resultantWindComponentDeg = 360 - resultantWindComponentDeg;
 
-                float ResultantWindComponentRad = MathHelper.ToRadians(WagonResultantWindComponentDeg);
+                var resultantWindComponentRad = MathHelper.ToRadians(resultantWindComponentDeg);
 
                 // Find the resultand wind vector for the combination of wind and train speed
-                WagonWindResultantSpeedMpS = (float)Math.Sqrt(TrainSpeedMpS * TrainSpeedMpS + Train.PhysicsWindSpeedMpS * Train.PhysicsWindSpeedMpS + 2.0f * TrainSpeedMpS * Train.PhysicsWindSpeedMpS * (float)Math.Cos(ResultantWindComponentRad));
+                var windResultantSpeedMpS = (float)Math.Sqrt(AbsSpeedMpS * AbsSpeedMpS + Train.PhysicsWindSpeedMpS * Train.PhysicsWindSpeedMpS + 2.0f * AbsSpeedMpS * Train.PhysicsWindSpeedMpS * (float)Math.Cos(resultantWindComponentRad));
 
                 // Calculate Drag Resistance
-                // The drag resistance will be the difference between the STILL firction calculated using the standard Davies equation, 
+                // The drag resistance will be the difference between the STILL firction calculated using the standard Davies equation,
                 // and that produced using the wind resultant speed (combination of wind speed and train speed)
-                float TempStillDragResistanceForceN = AbsSpeedMpS * AbsSpeedMpS * DavisCNSSpMM;
-                float TempCombinedDragResistanceForceN = WagonWindResultantSpeedMpS * WagonWindResultantSpeedMpS * DavisCNSSpMM; // R3 of Davis formula taking into account wind
-                float WindDragResistanceForceN = 0.0f;
+                var tempStillDragResistanceForceN = AbsSpeedMpS * AbsSpeedMpS * DavisCNSSpMM;
+                var tempCombinedDragResistanceForceN = windResultantSpeedMpS * windResultantSpeedMpS * DavisCNSSpMM; // R3 of Davis formula taking into account wind
+                float windDragResistanceForceN;
 
                 // Find the difference between the Still and combined resistances
                 // This difference will be added or subtracted from the overall friction force depending upon the estimated wind direction.
-                // Wind typically headon to train - increase resistance - +ve differential
-                if (TempCombinedDragResistanceForceN > TempStillDragResistanceForceN)
+                if (tempCombinedDragResistanceForceN > tempStillDragResistanceForceN)
                 {
-                    WindDragResistanceForceN = TempCombinedDragResistanceForceN - TempStillDragResistanceForceN;
+                    // Wind typically headon to train - increase resistance - +ve differential
+                    windDragResistanceForceN = tempCombinedDragResistanceForceN - tempStillDragResistanceForceN;
                 }
-                else // wind typically following train - reduce resistance - -ve differential
+                else
                 {
-                    WindDragResistanceForceN = TempStillDragResistanceForceN - TempCombinedDragResistanceForceN;
-                    WindDragResistanceForceN *= -1.0f;  // Convert to negative number to allow subtraction from ForceN
+                    // Wind typically following train - reduce resistance - -ve differential
+                    windDragResistanceForceN = tempStillDragResistanceForceN - tempCombinedDragResistanceForceN;
+                    windDragResistanceForceN *= -1.0f;  // Convert to negative number to allow subtraction from ForceN
                 }
 
                 // Calculate Lateral Resistance
 
                 // Calculate lateral resistance due to wind
                 // Resistance is due to the wheel flanges being pushed further onto rails when a cross wind is experienced by a train
-                float A = Train.PhysicsWindSpeedMpS / AbsSpeedMpS;
-                float C = (float)Math.Sqrt((1 + (A * A) + 2.0f * A * Math.Cos(ResultantWindComponentRad)));
-                float WindConstant = 8.25f;
-                float TrainSpeedMpH = Me.ToMi(pS.TopH(AbsSpeedMpS));
-                float WindSpeedMpH = Me.ToMi(pS.TopH(Train.PhysicsWindSpeedMpS));
+                var a = Train.PhysicsWindSpeedMpS / AbsSpeedMpS;
+                var c = (float)Math.Sqrt((1 + (a * a) + 2.0f * a * Math.Cos(resultantWindComponentRad)));
+                var windConstant = 8.25f;
+                var speedMpH = Me.ToMi(pS.TopH(AbsSpeedMpS));
 
-                float WagonFrontalAreaFt2 = Me2.ToFt2(WagonFrontalAreaM2);
+                var wagonFrontalAreaFt2 = Me2.ToFt2(WagonFrontalAreaM2);
 
-                LateralWindForceN = N.FromLbf(WindConstant * A * (float)Math.Sin(ResultantWindComponentRad) * DavisDragConstant * WagonFrontalAreaFt2 * TrainSpeedMpH * TrainSpeedMpH * C);
+                LateralWindForceN = N.FromLbf(windConstant * a * (float)Math.Sin(resultantWindComponentRad) * DavisDragConstant * wagonFrontalAreaFt2 * speedMpH * speedMpH * c);
 
-                float LateralWindResistanceForceN = N.FromLbf(WindConstant * A * (float)Math.Sin(ResultantWindComponentRad) * DavisDragConstant * WagonFrontalAreaFt2 * TrainSpeedMpH * TrainSpeedMpH * C * Train.WagonCoefficientFriction);
+                var lateralWindResistanceForceN = N.FromLbf(windConstant * a * (float)Math.Sin(resultantWindComponentRad) * DavisDragConstant * wagonFrontalAreaFt2 * speedMpH * speedMpH * c * Train.WagonCoefficientFriction);
 
                 // if this car is a locomotive, but not the lead one then recalculate the resistance with lower C value as drag will not be as high on trailing locomotives
                 if (WagonType == WagonTypes.Engine && Train.LeadLocomotive != this)
                 {
-                    LateralWindResistanceForceN *= TrailLocoResistanceFactor;
+                    lateralWindResistanceForceN *= TrailLocoResistanceFactor;
                 }
 
                 // Test to identify whether a tender is attached to the leading engine, if not then the resistance should also be derated as for the locomotive
-                bool IsLeadTender = false;
+                var isLeadTender = false;
                 if (WagonType == WagonTypes.Tender)
                 {
-                    bool PrevCarLead = false;
+                    var prevCarLead = false;
                     foreach (var car in Train.Cars)
                     {
                         // If this car is a tender and the previous car is the lead locomotive then set the flag so that resistance will be reduced
-                        if (car == this && PrevCarLead)
+                        if (car == this && prevCarLead)
                         {
-                            IsLeadTender = true;
+                            isLeadTender = true;
                             break;  // If the tender has been identified then break out of the loop, otherwise keep going until whole train is done.
                         }
+
                         // Identify whether car is a lead locomotive or not. This is kept for when the next iteration (next car) is checked.
                         if (Train.LeadLocomotive == car)
                         {
-                            PrevCarLead = true;
+                            prevCarLead = true;
                         }
                         else
                         {
-                            PrevCarLead = false;
+                            prevCarLead = false;
                         }
                     }
 
                     // If tender is coupled to a trailing locomotive then reduce resistance
-                    if (!IsLeadTender)
+                    if (!isLeadTender)
                     {
-                        LateralWindResistanceForceN *= TrailLocoResistanceFactor;
+                        lateralWindResistanceForceN *= TrailLocoResistanceFactor;
                     }
                 }
-                WindForceN = LateralWindResistanceForceN + WindDragResistanceForceN;
+
+                WindForceN = lateralWindResistanceForceN + windDragResistanceForceN;
             }
             else
             {
                 WindForceN = 0.0f; // Set to zero if wind resistance is not to be calculated
             }
-
         }
 
         private void UpdateTenderLoad()
