Line data Source code
1 : /****************************************************************************/
2 : // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3 : // Copyright (C) 2001-2025 German Aerospace Center (DLR) and others.
4 : // This program and the accompanying materials are made available under the
5 : // terms of the Eclipse Public License 2.0 which is available at
6 : // https://www.eclipse.org/legal/epl-2.0/
7 : // This Source Code may also be made available under the following Secondary
8 : // Licenses when the conditions for such availability set forth in the Eclipse
9 : // Public License 2.0 are satisfied: GNU General Public License, version 2
10 : // or later which is available at
11 : // https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12 : // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13 : /****************************************************************************/
14 : /// @file EnergyParams.cpp
15 : /// @author Jakob Erdmann
16 : /// @author Michael Behrisch
17 : /// @date Sept 2021
18 : ///
19 : // A class for parameters used by the emission models
20 : /****************************************************************************/
21 : #include <config.h>
22 :
23 : #include <utils/common/MsgHandler.h>
24 : #include <utils/common/StringUtils.h>
25 : #include <utils/common/ToString.h>
26 : #include <utils/geom/GeomHelper.h>
27 : #include <utils/vehicle/SUMOVTypeParameter.h>
28 :
29 : #include "PollutantsInterface.h"
30 : #include "HelpersEnergy.h"
31 : #include "EnergyParams.h"
32 :
33 :
34 : // ===========================================================================
35 : // static definitions
36 : // ===========================================================================
37 : const EnergyParams* EnergyParams::myDefault = nullptr;
38 : const std::vector<SumoXMLAttr> EnergyParams::myParamAttrs = {
39 : SUMO_ATTR_SHUT_OFF_STOP, SUMO_ATTR_SHUT_OFF_AUTO,
40 : SUMO_ATTR_LOADING, SUMO_ATTR_FRONTSURFACEAREA, SUMO_ATTR_AIRDRAGCOEFFICIENT,
41 : SUMO_ATTR_CONSTANTPOWERINTAKE, SUMO_ATTR_WHEELRADIUS, SUMO_ATTR_ROLLDRAGCOEFFICIENT, SUMO_ATTR_ROTATINGMASS,
42 : SUMO_ATTR_RADIALDRAGCOEFFICIENT, SUMO_ATTR_PROPULSIONEFFICIENCY, SUMO_ATTR_RECUPERATIONEFFICIENCY,
43 : SUMO_ATTR_RECUPERATIONEFFICIENCY_BY_DECELERATION,
44 : SUMO_ATTR_MAXIMUMTORQUE, SUMO_ATTR_MAXIMUMPOWER, SUMO_ATTR_GEAREFFICIENCY, SUMO_ATTR_GEARRATIO,
45 : SUMO_ATTR_MAXIMUMRECUPERATIONTORQUE, SUMO_ATTR_MAXIMUMRECUPERATIONPOWER,
46 : SUMO_ATTR_INTERNALBATTERYRESISTANCE, SUMO_ATTR_NOMINALBATTERYVOLTAGE, SUMO_ATTR_INTERNALMOMENTOFINERTIA
47 : };
48 :
49 :
50 : // ===========================================================================
51 : // method definitions
52 : // ===========================================================================
53 330899 : EnergyParams::EnergyParams(const SUMOVTypeParameter* typeParams) {
54 661798 : myCharacteristicMapMap.insert(std::pair<SumoXMLAttr, CharacteristicMap>(SUMO_ATTR_POWERLOSSMAP, CharacteristicMap("2,1|-1e9,1e9;-1e9,1e9|0,0,0,0"))); // P_loss_EM = 0 W for all operating points in the default EV power loss map
55 :
56 330899 : if (typeParams == nullptr) {
57 1957 : myMap[SUMO_ATTR_MASS] = DEFAULT_VEH_MASS;
58 1957 : myHaveDefaultMass = true;
59 1957 : myMap[SUMO_ATTR_FRONTSURFACEAREA] = DEFAULT_VEH_WIDTH * DEFAULT_VEH_HEIGHT * M_PI / 4.;
60 1957 : myHaveDefaultFrontSurfaceArea = true;
61 : } else {
62 7565666 : for (SumoXMLAttr attr : myParamAttrs) {
63 14473448 : if (typeParams->hasParameter(toString(attr))) {
64 2313 : myMap[attr] = typeParams->getDouble(toString(attr), INVALID_DOUBLE);
65 : }
66 : }
67 657884 : for (auto item : myCharacteristicMapMap) {
68 657884 : std::string characteristicMapString = typeParams->getParameter(toString(item.first), "");
69 328942 : if (characteristicMapString != "") {
70 60 : myCharacteristicMapMap.at(item.first) = CharacteristicMap(typeParams->getParameter(toString(item.first)));
71 : }
72 : }
73 328942 : myMap[SUMO_ATTR_MASS] = typeParams->mass;
74 328942 : myHaveDefaultMass = !typeParams->wasSet(VTYPEPARS_MASS_SET);
75 328942 : if (myHaveDefaultMass) {
76 328634 : const double ecMass = PollutantsInterface::getWeight(typeParams->emissionClass);
77 328634 : if (ecMass != -1.) {
78 120 : myMap[SUMO_ATTR_MASS] = ecMass;
79 : }
80 : }
81 : if (myMap.count(SUMO_ATTR_FRONTSURFACEAREA) == 0) {
82 328688 : myHaveDefaultFrontSurfaceArea = true;
83 328688 : myMap[SUMO_ATTR_FRONTSURFACEAREA] = typeParams->width * typeParams->height * M_PI / 4.;
84 : }
85 328942 : const std::string& ecName = PollutantsInterface::getName(typeParams->emissionClass);
86 328942 : if (typeParams->vehicleClass != SVC_IGNORING && (typeParams->vehicleClass & (SVC_PRIVATE | SVC_VIP | SVC_PASSENGER | SVC_HOV | SVC_TAXI | SVC_E_VEHICLE | SVC_CUSTOM1 | SVC_CUSTOM2)) == 0 && myHaveDefaultFrontSurfaceArea) {
87 422040 : if (StringUtils::startsWith(ecName, "MMPEVEM") || StringUtils::startsWith(ecName, "Energy")) {
88 15 : WRITE_WARNINGF(TL("Vehicle type '%' uses the emission class '%' which does not have proper defaults for its vehicle class. "
89 : "Please use a different emission model or complete the vType definition with further parameters."), typeParams->id, ecName);
90 5 : if (!typeParams->wasSet(VTYPEPARS_MASS_SET)) {
91 10 : WRITE_WARNING(TL(" And also set a vehicle mass!"));
92 : }
93 : }
94 : }
95 657884 : if (!StringUtils::startsWith(ecName, "MMPEVEM")) {
96 : if (myMap.count(SUMO_ATTR_INTERNALMOMENTOFINERTIA) > 0) {
97 6 : WRITE_WARNINGF(TL("Vehicle type '%' uses the Energy model parameter 'internalMomentOfInertia' which is deprecated. Use 'rotatingMass' instead."), typeParams->id);
98 4 : if (!typeParams->hasParameter(toString(SUMO_ATTR_ROTATINGMASS))) {
99 2 : myMap[SUMO_ATTR_ROTATINGMASS] = myMap[SUMO_ATTR_INTERNALMOMENTOFINERTIA];
100 : }
101 : }
102 : }
103 : }
104 330899 : }
105 :
106 :
107 1220446 : EnergyParams::~EnergyParams() {}
108 :
109 :
110 : void
111 126901694 : EnergyParams::setDynamicValues(const SUMOTime stopDuration, const bool parking, const SUMOTime waitingTime, const double angle) {
112 126901694 : if ((stopDuration >= 0 && myStopDurationSeconds < 0.) || (stopDuration < 0 && myStopDurationSeconds >= 0.)) {
113 15295 : myStopDurationSeconds = STEPS2TIME(stopDuration);
114 15295 : myAmParking = parking;
115 : }
116 126901694 : myWaitingTimeSeconds = STEPS2TIME(waitingTime);
117 126901694 : myLastAngle = myAngle;
118 126901694 : myAngle = angle;
119 126901694 : }
120 :
121 :
122 : void
123 496 : EnergyParams::setMass(const double mass) {
124 496 : myMap[SUMO_ATTR_MASS] = mass;
125 496 : myHaveDefaultMass = false;
126 496 : }
127 :
128 :
129 : void
130 4264 : EnergyParams::setTransportableMass(const double mass) {
131 4264 : myTransportableMass = mass;
132 4264 : }
133 :
134 :
135 : double
136 640585 : EnergyParams::getTotalMass(const double defaultEmptyMass, const double defaultLoading) const {
137 640585 : return getDoubleOptional(SUMO_ATTR_MASS, defaultEmptyMass) + getDoubleOptional(SUMO_ATTR_LOADING, defaultLoading) + getTransportableMass();
138 : }
139 :
140 :
141 : double
142 635235 : EnergyParams::getAngleDiff() const {
143 635235 : return myLastAngle == INVALID_DOUBLE ? 0. : GeomHelper::angleDiff(myLastAngle, myAngle);
144 : }
145 :
146 :
147 : double
148 1507494249 : EnergyParams::getDouble(SumoXMLAttr attr) const {
149 : auto it = myMap.find(attr);
150 1507494249 : if (it != myMap.end()) {
151 763397227 : return it->second;
152 : }
153 744097022 : if (mySecondaryParams != nullptr) {
154 744097022 : return mySecondaryParams->getDouble(attr);
155 : }
156 0 : throw UnknownElement("Unknown emission model parameter: " + toString(attr));
157 : }
158 :
159 :
160 : double
161 2907401775 : EnergyParams::getDoubleOptional(SumoXMLAttr attr, const double def) const {
162 : auto it = myMap.find(attr);
163 2907401775 : if (it != myMap.end() && it->second != INVALID_DOUBLE) {
164 2550392 : if (attr == SUMO_ATTR_MASS) {
165 990421 : if (!myHaveDefaultMass) {
166 : return it->second;
167 : }
168 1559971 : } else if (attr == SUMO_ATTR_FRONTSURFACEAREA) {
169 929966 : if (!myHaveDefaultFrontSurfaceArea) {
170 : return it->second;
171 : }
172 : } else {
173 : return it->second;
174 : }
175 : }
176 2906554397 : if (mySecondaryParams != nullptr) {
177 1444318122 : return mySecondaryParams->getDoubleOptional(attr, def);
178 : }
179 : return def;
180 : }
181 :
182 :
183 : const CharacteristicMap&
184 10560 : EnergyParams::getCharacteristicMap(SumoXMLAttr attr) const {
185 : auto it = myCharacteristicMapMap.find(attr);
186 10560 : if (it != myCharacteristicMapMap.end()) {
187 5280 : return it->second;
188 : }
189 5280 : if (mySecondaryParams != nullptr) {
190 5280 : return mySecondaryParams->getCharacteristicMap(attr);
191 : }
192 0 : throw UnknownElement("Unknown emission model parameter: " + toString(attr));
193 : }
194 :
195 :
196 : bool
197 737040941 : EnergyParams::isEngineOff() const {
198 1454832667 : return myStopDurationSeconds > getDoubleOptional(SUMO_ATTR_SHUT_OFF_STOP, DEFAULT_VEH_SHUT_OFF_STOP) ||
199 717791726 : myWaitingTimeSeconds > getDoubleOptional(SUMO_ATTR_SHUT_OFF_AUTO, std::numeric_limits<double>::max());
200 : }
201 :
202 :
203 : bool
204 712430 : EnergyParams::isOff() const {
205 712430 : return myStopDurationSeconds > getDoubleOptional(SUMO_ATTR_SHUT_OFF_STOP, DEFAULT_VEH_SHUT_OFF_STOP);
206 : }
207 :
208 :
209 : /****************************************************************************/
|
