battery.h

Go to the documentation of this file.

 
#ifndef BATTERY_H
#define BATTERY_H
 
#include <iostream>
 
class Battery {
private:
    double batteryMaxCapacity;               // Battery max capacity
    double batteryInitialCharge;             // Battery initial capacity
    double batteryCurrentCharge;             // Battery current charge
    double batteryStateOfCharge;             // Battery State of Charge
    double batteryDischargeCRate;            // The C-Rate value of the battery while discharging
    double batteryRechargeCRate;             // The C-Rate value of the battery while recharging
    double batteryDOD;                       // The minimum battery depth of discharge
    double batteryRechargeSOCUpperBound;     // The depth of recharge at which the battery stops recharging
    double batteryRechargeSOCLowerBound;     // The depth of discharge at which the battery requires a recharge
    bool enableRecharge = false;                     // Indicates whether the battery needs to recharge
    double batteryCumEnergyConsumed = 0.0;         // Cumulative energy consumed by the battery
    double batteryCumEnergyRegenerated = 0.0;      // Cumulative energy regenerated by the battery
    double batteryCumNetEnergyConsumed = 0.0;      // Cumulative net energy consumed by the battery
 
public:
    void setBattery(double maxCharge, double initialChargePercentage, double depthOfDischarge,
                    double batteryCRate, double maxRechargeSOC = 0.9, double minRechargeSOC = 0.5);
 
    double getBatteryMaxCharge() const;
 
    void setBatteryMaxCharge(double newMaxCharge);
 
    double getBatteryInitialCharge() const;
 
    void setBatteryInitialCharge(double newInitialCharge);
 
    double getBatteryCurrentCharge() const;
 
    std::pair<bool, double> consumeBattery(double timeStep, double consumedCharge);
 
    double rechargeBatteryForHybrids(double timeStep, double recharge);
 
    double rechargeBatteryByRegeneratedEnergy(double timeStep, double recharge);
 
    double getBatteryStateOfCharge() const;
 
    double getBatteryDOD() const;
 
    void setBatteryDOD(double newBatteryDOD);
 
    double getBatteryCRate() const;
 
    void setBatteryCRate(double newBatteryCRate);
 
    bool isBatteryDrainable(double requiredCharge);
 
    bool isBatteryRechargable();
 
    double getBatteryMaxDischarge(double timeStep);
 
    double getBatteryMaxRecharge(double timeStep);
 
    bool isRechargeRequired() const;
 
    double getBatteryRechargeSOCUpperBound() const;
 
    void setBatteryRechargeSOCUpperBound(double newBatteryMaxSOC);
 
    double getBatteryRechargeSOCLowerBound() const;
 
    void setBatteryRechargeSOCLowerBound(double newBatteryRechargeSOCLowerBound);
 
    double getBatteryCumEnergyConsumption();
 
    double getBatteryCumEnergyRegenerated();
 
    double getBatteryCumNetEnergyConsumption();
 
    bool batteryHasCharge();
 
    bool IsBatteryExceedingThresholds();
};
 
#endif // BATTERY_H