Improve battery voltage handling

Author: cesarBLG

Source/Documentation/Manual/physics.rst

@@ -5021,8 +5021,11 @@ It is possible for the battery switch to be switched on at the start of the simu
 To activate this behaviour, you can add the optional parameter ``ORTSBattery( DefaultOn ( 1 ) )``
 
 The voltage and energetic capacity of the battery can be indicated using the ``Voltage`` and ``MaxCapacity``
-parameters. Optionally, it is possible to define a realistic capacity-voltage curve such that voltage becomes
-lower when the battery is discharged, using ``ChargeVoltageCurve``.
+parameters. The performance of the battery charger, which is powered by the power converters, can be
+adjusted using the ``ChargerPower`` and ``ChargerVoltage`` parameters.
+
+Optionally, it is possible to define a capacity-voltage curve such that voltage becomes
+lower when the battery is discharged, using ``ChargeVoltageCurve``. Battery discharge is not implemented yet.
 
 Example::
 
@@ -5039,6 +5042,8 @@ Example::
           30kWh   72V
           50kWh   80V
         )
+        ChargerVoltage ( 80V )
+        ChargerPower ( 10kW )
       )
     )
 

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/Battery.cs

@@ -1,7 +1,8 @@
-
+
 using Microsoft.CodeAnalysis.VisualBasic.Syntax;
 using Microsoft.Xna.Framework;
 using Orts.Common;
+using Orts.Formats.Msts;
 using Orts.Parsers.Msts;
 using ORTS.Scripting.Api;
 using System;
@@ -15,16 +16,35 @@ namespace Orts.Simulation.RollingStocks.SubSystems.PowerSupplies
 {
     public class Battery : ISubSystem<Battery>
     {
+        TrainCar Car;
         public BatterySwitch BatterySwitch { get; protected set; }
         public float NominalVoltageV = 72;
         public float VoltageV { get; protected set; }
         public float CurrentCapacityJ { get; protected set; }
         public float MaxCapacityJ = 3.6e7f;
-        protected float EnergyFlowW; // < 0 discharging, > 0 charging
+        protected float PowerW; // Power demanded by the power supply, not implemented
+        protected float MaxChargingPowerW = 10000;
+        protected float ChargingVoltageV;
+        protected bool IsCharging
+        {
+            get
+            {
+                if (Car is MSTSLocomotive locomotive)
+                {
+                    return locomotive.LocomotivePowerSupply.AuxiliaryPowerSupplyOn;
+                }
+                else if (Car.PowerSupply != null)
+                {
+                    return Car.PowerSupply.ElectricTrainSupplyOn;
+                }
+                return false;
+            }
+        }
         public Interpolator ChargeVoltageCurve;
         public PowerSupplyState State;
         public Battery(MSTSWagon wagon)
         {
+            Car = wagon;
             BatterySwitch = new BatterySwitch(wagon);
         }
         public virtual void Parse(string lowercasetoken, STFReader stf)
@@ -45,6 +65,12 @@ public virtual void Parse(string lowercasetoken, STFReader stf)
                             case "maxcapacity":
                                 MaxCapacityJ = stf.ReadFloatBlock(STFReader.UNITS.Energy, MaxCapacityJ);
                                 break;
+                            case "chargerpower":
+                                MaxChargingPowerW = stf.ReadFloatBlock(STFReader.UNITS.Power, MaxChargingPowerW);
+                                break;
+                            case "chargervoltage":
+                                ChargingVoltageV = stf.ReadFloatBlock(STFReader.UNITS.Voltage, 0);
+                                break;
                             case "chargevoltagecurve":
                                 ChargeVoltageCurve = new Interpolator(stf);
                                 break;
@@ -70,10 +96,13 @@ public virtual void Copy(Battery other)
         }
         public virtual void Initialize()
         {
-            CurrentCapacityJ = MaxCapacityJ;
+            CurrentCapacityJ = 0.7f * MaxCapacityJ;
+            if (ChargingVoltageV == 0) ChargingVoltageV = NominalVoltageV * 1.15f;
             if (ChargeVoltageCurve == null)
             {
-                ChargeVoltageCurve = new Interpolator(new float[] {0, MaxCapacityJ}, new float[] {0, NominalVoltageV});
+                ChargeVoltageCurve = new Interpolator(
+                    new float[] {0, MaxCapacityJ * 0.1f, MaxCapacityJ}, 
+                    new float[] {0, 0.95f * NominalVoltageV, 1.05f * NominalVoltageV});
             }
 
             BatterySwitch.Initialize();
@@ -86,21 +115,43 @@ public virtual void Save(BinaryWriter outf)
         {
             BatterySwitch.Save(outf);
             outf.Write(CurrentCapacityJ);
-            outf.Write(EnergyFlowW);
         }
         public virtual void Restore(BinaryReader inf)
         {
             BatterySwitch.Restore(inf);
             CurrentCapacityJ = inf.ReadSingle();
-            EnergyFlowW = inf.ReadSingle();
         }
         public virtual void Update(float elapsedClockSeconds)
         {
             BatterySwitch.Update(elapsedClockSeconds);
 
-            CurrentCapacityJ = MathHelper.Clamp(CurrentCapacityJ + EnergyFlowW * elapsedClockSeconds, 0, MaxCapacityJ);
-            VoltageV = ChargeVoltageCurve[CurrentCapacityJ];
+            if (IsCharging)
+            {
+                if (ChargeVoltageCurve[CurrentCapacityJ] < ChargingVoltageV && CurrentCapacityJ < MaxCapacityJ)
+                {
+                    // Charge the battery
+                    float energyJ = MaxChargingPowerW * elapsedClockSeconds;
+                    if (CurrentCapacityJ + energyJ > MaxCapacityJ)
+                        energyJ = MaxCapacityJ - CurrentCapacityJ;
+                    CurrentCapacityJ += energyJ;
+                }
+                // When charging, voltage is that of the battery charger
+                VoltageV = ChargingVoltageV;
+            }
+            else
+            {
+                if (PowerW > 0 && State == PowerSupplyState.PowerOn)
+                {
+                    // Discharge the battery
+                    float energyJ = PowerW * elapsedClockSeconds;
+                    if (CurrentCapacityJ - energyJ > 0)
+                        energyJ = CurrentCapacityJ;
+                    CurrentCapacityJ -= energyJ;
+                }
+                // If battery is draining, voltage will depend on the total charge
+                // Voltage also depends on power drawn, not implemented
+                VoltageV = ChargeVoltageCurve[CurrentCapacityJ];
+            }
         }
-
     }
-}
+}

Source/RunActivity/Viewer3D/Popups/HUDWindow.cs

@@ -1,4 +1,4 @@
-// COPYRIGHT 2011, 2012, 2013 by the Open Rails project.
+// COPYRIGHT 2011, 2012, 2013 by the Open Rails project.
 //
 // This file is part of Open Rails.
 //
@@ -847,7 +847,7 @@ void TextPagePowerSupplyInfo(TableData table)
                     tractionCutOffRelayState,
                     mainPowerSupplyState,
                     auxiliaryPowerSupplyState,
-                    Viewer.Catalog.GetParticularString("PowerSupply", GetStringAttribute.GetPrettyName(car.PowerSupply.BatteryState)),
+                    String.Format("{0} {1}", Viewer.Catalog.GetParticularString("PowerSupply", GetStringAttribute.GetPrettyName(car.PowerSupply.BatteryState)), FormatStrings.FormatVoltage(car.PowerSupply.BatteryVoltageV)),
                     Viewer.Catalog.GetParticularString("PowerSupply", GetStringAttribute.GetPrettyName(car.PowerSupply.LowVoltagePowerSupplyState)),
                     locomotivePowerSupply != null ? Viewer.Catalog.GetParticularString("PowerSupply", GetStringAttribute.GetPrettyName(locomotivePowerSupply.CabPowerSupplyState)) : string.Empty,
                     electricTrainSupplyState,