MSDevice_ElecHybrid.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2002-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// A device which stands as an implementation ElecHybrid and which outputs movereminder calls
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <microsim/devices/MSVehicleDevice.h>
#include <microsim/MSVehicle.h>
#include <microsim/trigger/MSOverheadWire.h>
#include <utils/common/SUMOTime.h>
#include <utils/emissions/EnergyParams.h>
 
// ===========================================================================
// class declarations
// ===========================================================================
class SUMOVehicle;
class MSDevice_Emissions;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSDevice_ElecHybrid : public MSVehicleDevice {
public:
    static void insertOptions(OptionsCont& oc);
 
 
    static void buildVehicleDevices(SUMOVehicle& v, std::vector<MSVehicleDevice*>& into);
 
    ~MSDevice_ElecHybrid();
 
 
 
 
    bool notifyMove(SUMOTrafficObject& tObject, double oldPos, double newPos, double newSpeed);
 
    bool notifyEnter(SUMOTrafficObject& tObject, MSMoveReminder::Notification reason, const MSLane* enteredLane = 0);
 
 
    bool notifyLeave(SUMOTrafficObject& tObject, double lastPos, MSMoveReminder::Notification reason, const MSLane* enteredLane = 0);
 
    virtual void notifyMoveInternal(
        const SUMOTrafficObject& tObject,
        const double frontOnLane,
        const double timeOnLane,
        const double meanSpeedFrontOnLane,
        const double meanSpeedVehicleOnLane,
        const double travelledDistanceFrontOnLane,
        const double travelledDistanceVehicleOnLane,
        const double meanLengthOnLane);
 
    const std::string deviceName() const {
        return "elecHybrid";
    }
 
    std::string getParameter(const std::string& key) const;
 
    void setParameter(const std::string& key, const std::string& value);
 
    void generateOutput(OutputDevice* tripinfoOut) const;
 
    double getActualBatteryCapacity() const;
 
    double getMaximumBatteryCapacity() const;
 
    std::string getOverheadWireSegmentID() const;
 
    std::string getTractionSubstationID() const;
 
    double getEnergyCharged() const;
 
    void setEnergyCharged(double energyCharged);
 
    double getCircuitAlpha() const;
 
    double getPowerWanted() const;
 
    double getCurrentFromOverheadWire() const;
 
    void setCurrentFromOverheadWire(double current);
 
    double getVoltageOfOverheadWire() const;
 
    void setVoltageOfOverheadWire(double voltage);
 
    double getConsum() const;
 
    double getDistance() const {
        return myDistance;
    }
 
    bool isBatteryDischarged() const;
 
    void setActualBatteryCapacity(const double actualBatteryCapacity);
 
    double storeEnergyToBattery(const double energy);
 
    void updateTotalEnergyWasted(const double energyWasted);
 
    void setConsum(const double consumption);
 
    double acceleration(SUMOVehicle& veh, double power, double oldSpeed);
 
    double consumption(SUMOVehicle& veh, double a, double newSpeed);
 
    double computeChargedEnergy(double energyIn);
 
    MSOverheadWire* getActOverheadWireSegment() {
        return myActOverheadWireSegment;
    };
 
    Element* getVehElem() {
        return veh_elem;
    }
 
private:
    MSDevice_ElecHybrid(SUMOVehicle& holder, const std::string& id,
                        const double actualBatteryCapacity, const double maximumBatteryCapacity, const double overheadWireChargingPower);
 
protected:
    double myActualBatteryCapacity;
 
    double myMaximumBatteryCapacity;
 
    double myOverheadWireChargingPower;
 
    MSDevice_Emissions* myEmissionDevice;
 
    double myConsum;
 
    bool myBatteryDischargedLogic;
 
    bool myCharging;
 
    double myEnergyCharged;
 
    double myCircuitCurrent;
 
    double myCircuitVoltage;
 
    double myMaxBatteryCharge;
    double myMinBatteryCharge;
    double myTotalEnergyConsumed;
    double myTotalEnergyRegenerated;
 
    double myTotalEnergyWasted;
 
    double mySOCMin;
    double mySOCMax;
 
    MSOverheadWire* myActOverheadWireSegment;
 
    MSOverheadWire* myPreviousOverheadWireSegment;
 
    double myDistance;
 
    //circuit element of elecHybrid device
    //  ----|veh_pos_tail_elem|---------|pos_veh_node|--------
    //                                        |
    //                                        |
    //                                    |veh_elem|
    //                                        |
    //                                        |
    //  ----------------------------------|ground|------------
    Element* veh_elem;
    Element* veh_pos_tail_elem;
    Node* pos_veh_node;
 
    void deleteVehicleFromCircuit(SUMOVehicle& veh);
 
 
private:
    MSDevice_ElecHybrid(const MSDevice_ElecHybrid&);
 
    MSDevice_ElecHybrid& operator=(const MSDevice_ElecHybrid&);
 
 
};