Merge pull request #857 from SteelFill/air-flow-meter

Adding Air Flow Meters

Author: cjakeman

Source/Documentation/Manual/appendices.rst

@@ -58,6 +58,11 @@ Voltage                 volt                        V
 Mass Flow                                           g/h
 \                                                   kg/h
 \                       lb/h                        lb/h        lb/h
+Volumetric Flow         m^3/s           air flow    m^3/s
+                                        meters
+\                                                   ft^3/min
+\                                                   L/min
+\                                                   L/s
 Speed                   m/s             other       m/s         m/s             meter per second
 \                                                   km/h
 \                                                   kph         kph             kilometer per hour

Source/Documentation/Manual/cabs.rst

@@ -679,6 +679,37 @@ An example of implementation of the above controls in a .cvf file follows::
 		)
 
 
+Air Flow Meter
+--------------
+
+.. index::
+   single:  ORTS_AIR_FLOW_METER
+
+This cabview control is used on some locomotives, particularly in North America, to show the
+volumetric flow rate of air moving from the main res to the brake pipe during release/recharge.
+Such an indication can be used to determine when brake pipe charging is complete,
+measure the amount of brake pipe leakage, and so on.
+The control will only function on locomotives with air brakes.
+
+Here is an example implementation of ORTS_AIR_FLOW_METER as an analog dial::
+
+
+		Dial (
+			Type ( ORTS_AIR_FLOW_METER DIAL )
+			Position ( 258 271 1 32 )
+			Graphic ( "white_needle.ace" )
+			Style ( NEEDLE )
+			ScaleRange ( 0 150 )
+			ScalePos ( 295 65 )
+			Units ( CUBIC_FT_MIN )
+			Pivot ( 24 )
+			DirIncrease ( 0 )
+		)
+
+Applicable user-defined units are CUBIC_FT_MIN, LITERS_S, LITERS_MIN, and CUBIC_M_S. Cubic meters per
+second will be used if no units are specified.
+
+
 Animated 2D Wipers
 ------------------
 

Source/Documentation/Manual/driving.rst

@@ -767,7 +767,9 @@ The following information is displayed in the basic display:
   Train brake HUD line has two Brake Reservoir pressure numbers: the first is 
   the Equalization Reservoir (EQ) and the second is the Brake Cylinder (BC) 
   pressure. The two BP numbers report the brake pressure in the lead engine 
-  and in the last car of the train. The unit of measure used for brake 
+  and in the last car of the train. Additionally, the brake flow is shown,
+  which measures the rate of air flowing into the brake pipe during release
+  and recharge. The unit of measure used for brake 
   pressure is defined by the option :ref:`Pressure unit <options-pressure>`.
 - Engine Brake = percentage of independent engine brake. Not fully 
   releasing the engine brake will affect train brake pressures.

Source/ORTS.Common/Conversions.cs

@@ -549,6 +549,9 @@ public static class FormatStrings
         public static string psi = Catalog.GetString("psi");
         public static string inhg = Catalog.GetString("inHg");
         public static string kgfpcm2 = Catalog.GetString("kgf/cm²");
+        public static string lps = Catalog.GetString("L/s");
+        public static string lpm = Catalog.GetString("L/min");
+        public static string cfm = Catalog.GetString("cfm");
         public static string kg = Catalog.GetString("kg");
         public static string t = Catalog.GetString("t");
         public static string tonUK = Catalog.GetString("t-uk");
@@ -814,6 +817,12 @@ public static string FormatPressure(float pressure, PressureUnit inputUnit, Pres
             return String.Format(CultureInfo.CurrentCulture, format, pressureOut);
         }
 
+        public static string FormatAirFlow(float flowM3pS, bool isMetric)
+        {
+            var flow = isMetric ? flowM3pS * 1000.0f : flowM3pS * 35.3147f * 60.0f;
+            return String.Format(CultureInfo.CurrentCulture, "{0:F0} {1}", flow, isMetric ? lps : cfm);
+        }
+
         /// <summary>
         /// Converts duration in floating-point seconds to whole hours, minutes and seconds (rounded down).
         /// </summary>

Source/Orts.Formats.Msts/CabViewFile.cs

@@ -196,6 +196,7 @@ public enum CABViewControlTypes
         ORTS_BAILOFF,
         ORTS_QUICKRELEASE,
         ORTS_OVERCHARGE,
+        ORTS_AIR_FLOW_METER,
         ORTS_BATTERY_SWITCH_COMMAND_SWITCH,
         ORTS_BATTERY_SWITCH_COMMAND_BUTTON_CLOSE,
         ORTS_BATTERY_SWITCH_COMMAND_BUTTON_OPEN,
@@ -328,6 +329,7 @@ public enum CABViewControlUnits
         KILO_LBS,
         METRES_PER_SEC,
         LITRES,
+        LITERS,
         GALLONS,
         INCHES_OF_MERCURY,
         MILI_AMPS,
@@ -338,7 +340,14 @@ public enum CABViewControlUnits
         METRES,
         MILES,
         FEET,
-        YARDS
+        YARDS,
+
+        CUBIC_FT_MIN,
+        LITRES_MIN,
+        LITERS_MIN,
+        LITRES_S,
+        LITERS_S,
+        CUBIC_M_S
     }
 
     public enum DiscreteStates

Source/Orts.Simulation/Simulation/RollingStocks/MSTSDieselLocomotive.cs

@@ -1159,11 +1159,11 @@ public string GetDpuStatus(bool dataDpu, CABViewControlUnits loadUnits = CABView
             status.AppendFormat((data < 0 ? "???" : " ") + "\t");
 
             // BP
-            var brakeInfoValue = brakeValue(Simulator.Catalog.GetString("BP"), Simulator.Catalog.GetString("EOT"));
+            var brakeInfoValue = brakeValue(Simulator.Catalog.GetString("BP"), Simulator.Catalog.GetString("Flow"));
+            status.AppendFormat("{0:F0}\t", brakeInfoValue);
+            // Air flow meter
+            brakeInfoValue = brakeValue(Simulator.Catalog.GetString("Flow"), Simulator.Catalog.GetString("EOT"));
             status.AppendFormat("{0:F0}\t", brakeInfoValue);
-
-            // Flow.
-            // TODO:The BP air flow that feeds the brake tube is not yet modeled in Open Rails.
 
             // Remote
             if (dataDpu)
@@ -1261,6 +1261,7 @@ private static void SetDPULabels(bool dpuFull, int numberOfEngines)
             labels.AppendFormat("{0}\t", Simulator.Catalog.GetString("Throttle"));
             labels.AppendFormat("{0}\t", Simulator.Catalog.GetString("Load"));
             labels.AppendFormat("{0}\t", Simulator.Catalog.GetString("BP"));
+            labels.AppendFormat("{0}\t", Simulator.Catalog.GetString("Flow"));
             if (!dpuFull)
             {
                 labels.AppendFormat("{0}", Simulator.Catalog.GetString("Remote"));

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

@@ -131,6 +131,7 @@ public enum SoundState
         public float MaxSpeedMpS = 1e3f;
         public float UnloadingSpeedMpS;
         public float MainResPressurePSI = 130;
+        public float BrakePipeFlowM3pS;
         public float MaximumMainReservoirPipePressurePSI;
         public bool CompressorIsOn;
         public bool CompressorIsMechanical = false;
@@ -146,6 +147,9 @@ public enum SoundState
         public bool OnLineCabRadio;
         public string OnLineCabRadioURL;
 
+        public float FilteredBrakePipeFlowM3pS;
+        public IIRFilter AFMFilter;
+
         // Water trough filling
         public bool HasWaterScoop = false; // indicates whether loco + tender have a water scoop or not
         public float ScoopMaxPickupSpeedMpS = 200.0f; // Maximum scoop pickup speed - used in steam locomotive viewer
@@ -417,7 +421,7 @@ public float OdometerM
         protected const float DefaultMainResVolume = 0.78f; // Value to be inserted if .eng parameters are corrected
         protected const float DefaultMaxMainResPressure = 140; // Max value to be inserted if .eng parameters are corrected
 
-public List<CabView> CabViewList = new List<CabView>();
+        public List<CabView> CabViewList = new List<CabView>();
         public CabView3D CabView3D;
 
         public MSTSNotchController SteamHeatController = new MSTSNotchController(0, 1, 0.1f);
@@ -482,6 +486,7 @@ public MSTSLocomotive(Simulator simulator, string wagPath)
             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);
+            AFMFilter = new IIRFilter(IIRFilter.FilterTypes.Butterworth, 1, IIRFilter.HzToRad(0.1f), 1.0f);
 
             TrainBrakeController = new ScriptedBrakeController(this);
             EngineBrakeController = new ScriptedBrakeController(this);
@@ -5418,6 +5423,32 @@ public virtual float GetDataOf(CabViewControl cvc)
                         data = (TrainBrakeController == null || !TrainBrakeController.OverchargeButtonPressed) ? 0 : 1;
                         break;
                     }
+                case CABViewControlTypes.ORTS_AIR_FLOW_METER:
+                    {
+                        switch (cvc.Units)
+                        {
+                            case CABViewControlUnits.CUBIC_FT_MIN:
+                                data = this.FilteredBrakePipeFlowM3pS * 35.3147f * 60.0f;
+                                break;
+
+                            case CABViewControlUnits.LITRES_S:
+                            case CABViewControlUnits.LITERS_S:
+                                data = this.FilteredBrakePipeFlowM3pS * 1000.0f;
+                                break;
+
+                            case CABViewControlUnits.LITRES_MIN:
+                            case CABViewControlUnits.LITERS_MIN:
+                                data = this.FilteredBrakePipeFlowM3pS * 1000.0f * 60.0f;
+                                break;
+
+                            case CABViewControlUnits.CUBIC_M_S:
+                            default:
+                                data = this.FilteredBrakePipeFlowM3pS;
+                                break;
+
+                        }
+                        break;
+                    }
                 case CABViewControlTypes.FRICTION_BRAKING:
                     {
                         data = (BrakeSystem == null) ? 0.0f : BrakeSystem.GetCylPressurePSI();
@@ -5541,7 +5572,6 @@ public virtual float GetDataOf(CabViewControl cvc)
 
                                 }
                             }
-
                         }
                         else
                         {