SUMO - Simulation of Urban MObility
PollutantsInterface.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2013-2018 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
16 // Interface to capsulate different emission models
17 /****************************************************************************/
18 #ifndef PollutantsInterface_h
19 #define PollutantsInterface_h
20 
21 
22 // ===========================================================================
23 // included modules
24 // ===========================================================================
25 #include <config.h>
26 
27 #include <vector>
28 #include <limits>
29 #include <cmath>
30 #include <algorithm>
31 #include <utils/common/StdDefs.h>
33 #include "PHEMCEP.h"
34 
35 
36 // ===========================================================================
37 // class declarations
38 // ===========================================================================
39 class HelpersHBEFA;
40 class HelpersHBEFA3;
41 class HelpersPHEMlight;
42 class HelpersEnergy;
43 
44 
45 // ===========================================================================
46 // class definitions
47 // ===========================================================================
53 public:
54 
56  enum EmissionType { CO2, CO, HC, FUEL, NO_X, PM_X, ELEC };
57 
58 
63  struct Emissions {
64  double CO2;
65  double CO;
66  double HC;
67  double fuel;
68  double NOx;
69  double PMx;
70  double electricity;
71 
81  Emissions(double co2 = 0, double co = 0, double hc = 0, double f = 0, double nox = 0, double pmx = 0, double elec = 0)
82  : CO2(co2), CO(co), HC(hc), fuel(f), NOx(nox), PMx(pmx), electricity(elec) {
83  }
84 
89  void addScaled(const Emissions& a, const double scale = 1.) {
90  CO2 += scale * a.CO2;
91  CO += scale * a.CO;
92  HC += scale * a.HC;
93  fuel += scale * a.fuel;
94  NOx += scale * a.NOx;
95  PMx += scale * a.PMx;
96  electricity += scale * a.electricity;
97  }
98  };
99 
100 
105  class Helper {
106  public:
110  Helper(std::string name) : myName(name) {}
111 
115  const std::string& getName() const {
116  return myName;
117  }
118 
128  virtual SUMOEmissionClass getClassByName(const std::string& eClass, const SUMOVehicleClass vc) {
129  UNUSED_PARAMETER(vc);
130  if (myEmissionClassStrings.hasString(eClass)) {
131  return myEmissionClassStrings.get(eClass);
132  }
133  std::string eclower = eClass;
134  std::transform(eclower.begin(), eclower.end(), eclower.begin(), tolower);
135  return myEmissionClassStrings.get(eclower);
136  }
137 
142  const std::string getClassName(const SUMOEmissionClass c) const {
143  return myName + "/" + myEmissionClassStrings.getString(c);
144  }
145 
151  virtual bool isSilent(const SUMOEmissionClass c) {
152  return (c & 0xffffffff & ~HEAVY_BIT) == 0;
153  }
154 
157 
168  virtual SUMOEmissionClass getClass(const SUMOEmissionClass base, const std::string& vClass,
169  const std::string& fuel, const std::string& eClass, const double weight) const {
170  UNUSED_PARAMETER(vClass);
171  UNUSED_PARAMETER(fuel);
172  UNUSED_PARAMETER(eClass);
173  UNUSED_PARAMETER(weight);
174  return base;
175  }
176 
182  virtual std::string getAmitranVehicleClass(const SUMOEmissionClass c) const {
183  UNUSED_PARAMETER(c);
184  return "Passenger";
185  }
186 
192  virtual std::string getFuel(const SUMOEmissionClass c) const {
193  UNUSED_PARAMETER(c);
194  return "Gasoline";
195  }
196 
202  virtual int getEuroClass(const SUMOEmissionClass c) const {
203  UNUSED_PARAMETER(c);
204  return 0;
205  }
206 
213  virtual double getWeight(const SUMOEmissionClass c) const {
214  UNUSED_PARAMETER(c);
215  return -1.;
216  }
218 
227  virtual double compute(const SUMOEmissionClass c, const EmissionType e, const double v, const double a, const double slope, const std::map<int, double>* param) const = 0;
228 
237  virtual double getModifiedAccel(const SUMOEmissionClass c, const double v, const double a, const double slope) const {
238  UNUSED_PARAMETER(c);
239  UNUSED_PARAMETER(v);
240  UNUSED_PARAMETER(slope);
241  return a;
242  }
243 
247  void addAllClassesInto(std::vector<SUMOEmissionClass>& list) const {
248  myEmissionClassStrings.addKeysInto(list);
249  }
250 
251 
252  protected:
254  const std::string myName;
255 
258 
259  private:
260  Helper& operator=(const Helper&); // just to avoid a compiler warning
261 
262 
263  };
264 
265 
267  static const int ZERO_EMISSIONS = 0;
268 
270  static const int HEAVY_BIT = 1 << 15;
271 
276  static SUMOEmissionClass getClassByName(const std::string& eClass, const SUMOVehicleClass vc = SVC_IGNORING);
277 
278 
283  static const std::vector<SUMOEmissionClass> getAllClasses();
284 
285 
290  static std::string getName(const SUMOEmissionClass c);
291 
292 
297  static bool isHeavy(const SUMOEmissionClass c);
298 
299 
304  static bool isSilent(const SUMOEmissionClass c);
305 
306 
315  static SUMOEmissionClass getClass(const SUMOEmissionClass base, const std::string& vClass, const std::string& fuel, const std::string& eClass, const double weight);
316 
317 
322  static std::string getAmitranVehicleClass(const SUMOEmissionClass c);
323 
324 
329  static std::string getFuel(const SUMOEmissionClass c);
330 
331 
336  static int getEuroClass(const SUMOEmissionClass c);
337 
338 
344  static double getWeight(const SUMOEmissionClass c);
345 
346 
355  static double compute(const SUMOEmissionClass c, const EmissionType e, const double v, const double a, const double slope, const std::map<int, double>* param = 0);
356 
357 
365  static Emissions computeAll(const SUMOEmissionClass c, const double v, const double a, const double slope, const std::map<int, double>* param = 0);
366 
367 
377  static double computeDefault(const SUMOEmissionClass c, const EmissionType e, const double v, const double a, const double slope, const double tt, const std::map<int, double>* param = 0);
378 
386  static double getModifiedAccel(const SUMOEmissionClass c, const double v, const double a, const double slope);
387 
388  static const HelpersEnergy& getEnergyHelper() {
389  return myEnergyHelper;
390  }
391 
392 private:
402  static Helper* myHelpers[];
403 
404 };
405 
406 
407 #endif
408 
409 /****************************************************************************/
static Emissions computeAll(const SUMOEmissionClass c, const double v, const double a, const double slope, const std::map< int, double > *param=0)
Returns the amount of all emitted pollutants given the vehicle type and state (in mg/s or ml/s for fu...
SUMOVehicleClass
Definition of vehicle classes to differ between different lane usage and authority types...
virtual std::string getFuel(const SUMOEmissionClass c) const
Returns the fuel type described by this emission class as described in the Amitran interface (Gasolin...
virtual bool isSilent(const SUMOEmissionClass c)
Returns whether the class denotes a silent vehicle for interfacing with the noise model...
EmissionType
Enumerating all emission types, including fuel.
Storage for collected values of all emission types.
const std::string myName
the name of the model
static double getModifiedAccel(const SUMOEmissionClass c, const double v, const double a, const double slope)
Returns the adapted acceleration value, useful for comparing with external PHEMlight references...
Emissions(double co2=0, double co=0, double hc=0, double f=0, double nox=0, double pmx=0, double elec=0)
Constructor, intializes all members.
#define UNUSED_PARAMETER(x)
Definition: StdDefs.h:33
static const int HEAVY_BIT
the bit to set for denoting heavy vehicles
Helper methods for PHEMlight-based emission computation.
static const int ZERO_EMISSIONS
the first class in each model representing a zero emission vehicle
Helper methods for energy-based electricity consumption computation based on the battery device...
Definition: HelpersEnergy.h:43
static Helper * myHelpers[]
the known model helpers
static std::string getAmitranVehicleClass(const SUMOEmissionClass c)
Returns the vehicle class described by the given emission class.
static HelpersPHEMlight myPHEMlightHelper
Instance of PHEMlightHelper which gets cleaned up automatically.
abstract superclass for the model helpers
int SUMOEmissionClass
Helper methods for HBEFA3-based emission computation.
Definition: HelpersHBEFA3.h:47
static SUMOEmissionClass getClass(const SUMOEmissionClass base, const std::string &vClass, const std::string &fuel, const std::string &eClass, const double weight)
Returns the emission class fittig the given parameters.
static HelpersHBEFA3 myHBEFA3Helper
Instance of HBEFA3Helper which gets cleaned up automatically.
static const std::vector< SUMOEmissionClass > getAllClasses()
Checks whether the string describes a known vehicle class.
static bool isSilent(const SUMOEmissionClass c)
Checks whether the emission class describes an electric or similar silent vehicle.
static std::string getName(const SUMOEmissionClass c)
Checks whether the string describes a known vehicle class.
static bool isHeavy(const SUMOEmissionClass c)
Checks whether the emission class describes a bus, truck or similar vehicle.
virtual int getEuroClass(const SUMOEmissionClass c) const
Returns the Euro emission class described by this emission class as described in the Amitran interfac...
virtual double getWeight(const SUMOEmissionClass c) const
Returns a reference weight in kg described by this emission class as described in the Amitran interfa...
static int getEuroClass(const SUMOEmissionClass c)
Returns the Euro norm described by the given emission class.
Helper(std::string name)
Constructor, intializes the name.
Helper methods for HBEFA-based emission computation.
Definition: HelpersHBEFA.h:47
const std::string & getName() const
Returns the name of the model.
static double compute(const SUMOEmissionClass c, const EmissionType e, const double v, const double a, const double slope, const std::map< int, double > *param=0)
Returns the amount of the emitted pollutant given the vehicle type and state (in mg/s or ml/s for fue...
virtual SUMOEmissionClass getClass(const SUMOEmissionClass base, const std::string &vClass, const std::string &fuel, const std::string &eClass, const double weight) const
Returns the emission class described by the given parameters. The base is used to determine the model...
static double getWeight(const SUMOEmissionClass c)
Returns a representative weight for the given emission class see http://colombo-fp7.eu/deliverables/COLOMBO_D4.2_ExtendedPHEMSUMO_v1.7.pdf.
static SUMOEmissionClass getClassByName(const std::string &eClass, const SUMOVehicleClass vc=SVC_IGNORING)
Checks whether the string describes a known vehicle class.
StringBijection< SUMOEmissionClass > myEmissionClassStrings
Mapping between emission class names and integer representations.
static HelpersHBEFA myHBEFA2Helper
Instance of HBEFA2Helper which gets cleaned up automatically.
virtual double getModifiedAccel(const SUMOEmissionClass c, const double v, const double a, const double slope) const
Returns the adapted acceleration value, useful for comparing with external PHEMlight references...
const std::string getClassName(const SUMOEmissionClass c) const
Returns the complete name of the emission class including the model.
virtual std::string getAmitranVehicleClass(const SUMOEmissionClass c) const
Returns the vehicle class described by this emission class as described in the Amitran interface (Pas...
static double computeDefault(const SUMOEmissionClass c, const EmissionType e, const double v, const double a, const double slope, const double tt, const std::map< int, double > *param=0)
Returns the amount of emitted pollutant given the vehicle type and default values for the state (in m...
vehicles ignoring classes
void addAllClassesInto(std::vector< SUMOEmissionClass > &list) const
Add all known emission classes of this model to the given container.
static std::string getFuel(const SUMOEmissionClass c)
Returns the fuel type of the given emission class.
void addScaled(const Emissions &a, const double scale=1.)
Add the values of the other struct to this one, scaling the values if needed.
static const HelpersEnergy & getEnergyHelper()
static HelpersEnergy myEnergyHelper
Instance of EnergyHelper which gets cleaned up automatically.
Helper methods for PHEMlight-based emission computation.
virtual SUMOEmissionClass getClassByName(const std::string &eClass, const SUMOVehicleClass vc)
Returns the emission class associated with the given name, aliases are possible If this method is ask...