Helper methods for HBEFA3-based emission computation. More...

#include <HelpersHBEFA3.h>

Inheritance diagram for HelpersHBEFA3:

Collaboration diagram for HelpersHBEFA3:

Public Member Functions
void	addAllClassesInto (std::vector< SUMOEmissionClass > &list) const
	Add all known emission classes of this model to the given container.

double	compute (const SUMOEmissionClass c, const PollutantsInterface::EmissionType e, const double v, const double a, const double slope, const EnergyParams *param) const
	Computes the emitted pollutant amount using the given speed and acceleration.

std::string	getAmitranVehicleClass (const SUMOEmissionClass c) const
	Returns the vehicle class described by this emission class as described in the Amitran interface (Passenger, ...)

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.

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 asked for the "unknown" class it should return the default (possibly depending on the given vehicle class). The class name is case insensitive.

const std::string	getClassName (const SUMOEmissionClass c) const
	Returns the complete name of the emission class including the model.

virtual double	getCoastingDecel (const SUMOEmissionClass c, const double v, const double a, const double slope, const EnergyParams *param) const
	Returns the maximum deceleration value (as a negative number), which can still be considered as non-braking. Default implementation returns always zero.

int	getEuroClass (const SUMOEmissionClass c) const
	Returns the Euro emission class described by this emission class as described in the Amitran interface (0, ..., 6)

std::string	getFuel (const SUMOEmissionClass c) const
	Returns the fuel type described by this emission class as described in the Amitran interface (Gasoline, Diesel, ...)

virtual double	getModifiedAccel (const SUMOEmissionClass c, const double v, const double a, const double slope, const EnergyParams *param) const
	Returns the adapted acceleration value, useful for comparing with external PHEMlight references. Default implementation returns always the input accel.

const std::string &	getName () const
	Returns the name of the model.

	HelpersHBEFA3 ()
	Constructor (initializes myEmissionClassStrings)

bool	includesClass (const SUMOEmissionClass c) const

virtual bool	isSilent (const SUMOEmissionClass c)
	Returns whether the class denotes a silent vehicle for interfacing with the noise model. By default the first class in each model is the silent class.

Methods for Amitran interfaces
virtual double	getWeight (const SUMOEmissionClass c) const
	Returns a reference weight in kg described by this emission class as described in the Amitran interface It might return -1, if the weight is not important to distinguish different emission classes. Default implementation returns always -1.

Protected Attributes
const int	myBaseIndex
	the starting index for classes of this model

StringBijection< SUMOEmissionClass >	myEmissionClassStrings
	Mapping between emission class names and integer representations.

const std::string	myName
	the name of the model

bool	myVolumetricFuel
	return fuel consumption in l instead of mg

Static Protected Attributes
static const double	ZERO_SPEED_ACCURACY = .5
	the lowest speed which allows reliable coasting calculations

Static Private Attributes
static const int	HBEFA3_BASE = 2 << 16

static double	myFunctionParameter [45][6][6]
	The function parameter.

Detailed Description

Helper methods for HBEFA3-based emission computation.

The parameter are stored per vehicle class; 6*6 parameter are used, sorted by the pollutant (CO2, CO, HC, fuel, NOx, PMx), and the function part (c0, cav1, cav2, c1, c2, c3).

Definition at line 45 of file HelpersHBEFA3.h.

Constructor & Destructor Documentation

◆ HelpersHBEFA3()

HelpersHBEFA3::HelpersHBEFA3 ( )

Constructor (initializes myEmissionClassStrings)

Definition at line 448 of file HelpersHBEFA3.cpp.

References StringBijection< T >::addAlias(), StringBijection< T >::get(), HBEFA3_BASE, PollutantsInterface::HEAVY_BIT, StringBijection< T >::insert(), PollutantsInterface::Helper::myEmissionClassStrings, and StringUtils::to_lower_case().

Member Function Documentation

◆ addAllClassesInto()

void PollutantsInterface::Helper::addAllClassesInto ( std::vector< SUMOEmissionClass > & list ) const

inherited

Add all known emission classes of this model to the given container.

Parameters

[in] list the vector to add to

Definition at line 214 of file PollutantsInterface.cpp.

Referenced by PollutantsInterface::getAllClasses(), and PollutantsInterface::getAllClassesStr().

Here is the caller graph for this function:

◆ compute()

double HelpersHBEFA3::compute	(	const SUMOEmissionClass	c,
		const PollutantsInterface::EmissionType	e,
		const double	v,
		const double	a,
		const double	slope,
		const EnergyParams *	param
	)		const

inlinevirtual

Computes the emitted pollutant amount using the given speed and acceleration.

As the functions are defining emissions in g/hour, the function's result is normed by 3.6 (seconds in an hour/1000) yielding mg/s. For fuel ml/s is returned if volumetric fuel has been requested. Coasting and an engine which is off by the given param result directly in zero emission.

Parameters

[in]	c	emission class for the function parameters to use
[in]	e	the type of emission (CO, CO2, ...)
[in]	v	The vehicle's current velocity
[in]	a	The vehicle's current acceleration
[in]	slope	The road's slope at vehicle's position [deg]
[in]	param	parameter of the emission model (only used for the coasting deceleration and to determine whether the engine is off)

Returns: The amount emitted by the given emission class when moving with the given velocity and acceleration [mg/s or ml/s]

Reimplemented from PollutantsInterface::Helper.

Definition at line 97 of file HelpersHBEFA3.h.

References PollutantsInterface::ELEC, PollutantsInterface::FUEL, PollutantsInterface::Helper::getCoastingDecel(), getFuel(), HBEFA3_BASE, EnergyParams::isEngineOff(), MAX2(), myFunctionParameter, PollutantsInterface::Helper::myVolumetricFuel, and PollutantsInterface::Helper::ZERO_SPEED_ACCURACY.

◆ getAmitranVehicleClass()

std::string HelpersHBEFA3::getAmitranVehicleClass ( const SUMOEmissionClass c ) const

virtual

Returns the vehicle class described by this emission class as described in the Amitran interface (Passenger, ...)

Parameters

[in] c the emission class

Returns: the name of the vehicle class

Reimplemented from PollutantsInterface::Helper.

Definition at line 517 of file HelpersHBEFA3.cpp.

References StringBijection< T >::getString(), and PollutantsInterface::Helper::myEmissionClassStrings.

◆ getClass()

SUMOEmissionClass HelpersHBEFA3::getClass	(	const SUMOEmissionClass	base,
		const std::string &	vClass,
		const std::string &	fuel,
		const std::string &	eClass,
		const double	weight
	)		const

virtual

Returns the emission class described by the given parameters.

Parameters

[in]	base	the base class giving the default
[in]	vClass	the vehicle class as described in the Amitran interface (Passenger, ...)
[in]	fuel	the fuel type as described in the Amitran interface (Gasoline, Diesel, ...)
[in]	eClass	the emission class as described in the Amitran interface (Euro0, ...)
[in]	weight	the vehicle weight in kg as described in the Amitran interface

Returns: the class described by the parameters

Reimplemented from PollutantsInterface::Helper.

Definition at line 474 of file HelpersHBEFA3.cpp.

References StringBijection< T >::get(), StringBijection< T >::hasString(), and PollutantsInterface::Helper::myEmissionClassStrings.

◆ getClassByName()

SUMOEmissionClass PollutantsInterface::Helper::getClassByName	(	const std::string &	eClass,
		const SUMOVehicleClass	vc
	)

virtualinherited

Returns the emission class associated with the given name, aliases are possible If this method is asked for the "unknown" class it should return the default (possibly depending on the given vehicle class). The class name is case insensitive.

Parameters

[in]	eClass	the name of the emission class (string after the '/' in the emission class attribute)
[in]	vc	the vehicle class to use when determining default class

Returns: the name of the model (string before the '/' in the emission class)

Reimplemented in HelpersPHEMlight, and HelpersPHEMlight5.

Definition at line 113 of file PollutantsInterface.cpp.

References OptionsCont::exists(), OptionsCont::getBool(), OptionsCont::getOptions(), StringUtils::to_lower_case(), and UNUSED_PARAMETER.

Referenced by PollutantsInterface::getClassByName().

Here is the caller graph for this function:

◆ getClassName()

const std::string PollutantsInterface::Helper::getClassName ( const SUMOEmissionClass c ) const

inherited

Returns the complete name of the emission class including the model.

Parameters

[in] c the emission class

Returns: the name of the class (the complete emission class attribute)

Definition at line 124 of file PollutantsInterface.cpp.

Referenced by PollutantsInterface::getName().

Here is the caller graph for this function:

◆ getCoastingDecel()

double PollutantsInterface::Helper::getCoastingDecel	(	const SUMOEmissionClass	c,
		const double	v,
		const double	a,
		const double	slope,
		const EnergyParams *	param
	)		const

virtualinherited

Returns the maximum deceleration value (as a negative number), which can still be considered as non-braking. Default implementation returns always zero.

Parameters

[in]	c	the emission class
[in]	v	the speed value
[in]	a	the acceleration value
[in]	slope	The road's slope at vehicle's position [deg]
[in]	param	parameter of the emission model affecting the computation

Returns: the coasting deceleration

Reimplemented in HelpersPHEMlight, and HelpersPHEMlight5.

Definition at line 196 of file PollutantsInterface.cpp.

References PollutantsInterface::getCoastingDecel(), EnergyParams::getDefault(), EnergyParams::getDouble(), PHEMlightdllV5::Constants::GRAVITY_CONST, M_PI, MIN2(), PHEMlightdllV5::Constants::SPEED_DCEL_MIN, SUMO_ATTR_HEIGHT, SUMO_ATTR_MASS, and SUMO_ATTR_WIDTH.

Referenced by HelpersHBEFA::compute(), compute(), HelpersHBEFA4::compute(), and PollutantsInterface::getCoastingDecel().

Here is the caller graph for this function:

◆ getEuroClass()

int HelpersHBEFA3::getEuroClass ( const SUMOEmissionClass c ) const

virtual

Returns the Euro emission class described by this emission class as described in the Amitran interface (0, ..., 6)

Parameters

[in] c the emission class

Returns: the Euro class

Reimplemented from PollutantsInterface::Helper.

Definition at line 544 of file HelpersHBEFA3.cpp.

References StringBijection< T >::getString(), and PollutantsInterface::Helper::myEmissionClassStrings.

◆ getFuel()

std::string HelpersHBEFA3::getFuel ( const SUMOEmissionClass c ) const

virtual

Returns the fuel type described by this emission class as described in the Amitran interface (Gasoline, Diesel, ...)

Parameters

[in] c the emission class

Returns: the fuel type

Reimplemented from PollutantsInterface::Helper.

Definition at line 533 of file HelpersHBEFA3.cpp.

References StringBijection< T >::getString(), and PollutantsInterface::Helper::myEmissionClassStrings.

Referenced by compute().

Here is the caller graph for this function:

◆ getModifiedAccel()

double PollutantsInterface::Helper::getModifiedAccel	(	const SUMOEmissionClass	c,
		const double	v,
		const double	a,
		const double	slope,
		const EnergyParams *	param
	)		const

virtualinherited

Returns the adapted acceleration value, useful for comparing with external PHEMlight references. Default implementation returns always the input accel.

Parameters

[in]	c	the emission class
[in]	v	the speed value
[in]	a	the acceleration value
[in]	slope	The road's slope at vehicle's position [deg]

Returns: the modified acceleration

Reimplemented in HelpersPHEMlight, and HelpersPHEMlight5.

Definition at line 186 of file PollutantsInterface.cpp.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getModifiedAccel().

Here is the caller graph for this function:

◆ getName()

const std::string & PollutantsInterface::Helper::getName ( ) const

inherited

Returns the name of the model.

Returns: the name of the model (string before the '/' in the emission class attribute)

Definition at line 107 of file PollutantsInterface.cpp.

◆ getWeight()

double PollutantsInterface::Helper::getWeight ( const SUMOEmissionClass c ) const

virtualinherited

Returns a reference weight in kg described by this emission class as described in the Amitran interface It might return -1, if the weight is not important to distinguish different emission classes. Default implementation returns always -1.

Parameters

[in] c the emission class

Returns: a reference weight

Reimplemented in HelpersPHEMlight.

Definition at line 167 of file PollutantsInterface.cpp.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getWeight().

Here is the caller graph for this function:

◆ includesClass()

bool PollutantsInterface::Helper::includesClass ( const SUMOEmissionClass c ) const

inherited

Definition at line 220 of file PollutantsInterface.cpp.

◆ isSilent()

bool PollutantsInterface::Helper::isSilent ( const SUMOEmissionClass c )

virtualinherited

Returns whether the class denotes a silent vehicle for interfacing with the noise model. By default the first class in each model is the silent class.

Parameters

[in] c the emission class

Returns: whether the class denotes a silent vehicle

Definition at line 130 of file PollutantsInterface.cpp.

References PollutantsInterface::HEAVY_BIT.

Referenced by PollutantsInterface::isSilent().

Here is the caller graph for this function:

Field Documentation

◆ HBEFA3_BASE

const int HelpersHBEFA3::HBEFA3_BASE = 2 << 16

staticprivate

Definition at line 47 of file HelpersHBEFA3.h.

Referenced by compute(), and HelpersHBEFA3().

◆ myBaseIndex

const int PollutantsInterface::Helper::myBaseIndex

protectedinherited

the starting index for classes of this model

Definition at line 228 of file PollutantsInterface.h.

◆ myEmissionClassStrings

StringBijection<SUMOEmissionClass> PollutantsInterface::Helper::myEmissionClassStrings

protectedinherited

Mapping between emission class names and integer representations.

Definition at line 234 of file PollutantsInterface.h.

◆ myFunctionParameter

double HelpersHBEFA3::myFunctionParameter

staticprivate

The function parameter.

Definition at line 36 of file HelpersHBEFA3.h.

Referenced by compute().

◆ myName

const std::string PollutantsInterface::Helper::myName

protectedinherited

the name of the model

Definition at line 225 of file PollutantsInterface.h.

◆ myVolumetricFuel

bool PollutantsInterface::Helper::myVolumetricFuel

protectedinherited

return fuel consumption in l instead of mg

Definition at line 231 of file PollutantsInterface.h.

Referenced by HelpersHBEFA::compute(), compute(), HelpersHBEFA4::compute(), HelpersPHEMlight::compute(), HelpersPHEMlight5::compute(), HelpersPHEMlight::getClassByName(), and HelpersPHEMlight5::getClassByName().

◆ ZERO_SPEED_ACCURACY

const double PollutantsInterface::Helper::ZERO_SPEED_ACCURACY = .5

staticprotectedinherited

the lowest speed which allows reliable coasting calculations

Definition at line 222 of file PollutantsInterface.h.

Referenced by HelpersHBEFA::compute(), compute(), and HelpersHBEFA4::compute().

The documentation for this class was generated from the following files:

Public Member Functions

Protected Attributes

Static Protected Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HelpersHBEFA3()

Member Function Documentation

◆ addAllClassesInto()

◆ compute()

◆ getAmitranVehicleClass()

◆ getClass()

◆ getClassByName()

◆ getClassName()

◆ getCoastingDecel()

◆ getEuroClass()

◆ getFuel()

◆ getModifiedAccel()

◆ getName()

◆ getWeight()

◆ includesClass()

◆ isSilent()

Field Documentation

◆ HBEFA3_BASE

◆ myBaseIndex

◆ myEmissionClassStrings

◆ myFunctionParameter

◆ myName

◆ myVolumetricFuel

◆ ZERO_SPEED_ACCURACY