Helper methods for energy-based electricity consumption computation based on the battery device. More...

#include <HelpersEnergy.h>

Inheritance diagram for HelpersEnergy:

Collaboration diagram for HelpersEnergy:

Public Member Functions
double	acceleration (const SUMOEmissionClass c, const PollutantsInterface::EmissionType e, const double v, const double P, const double slope, const EnergyParams *param) const
	Computes the achievable acceleration using the given speed and amount of consumed electric power.

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.

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.

std::string	getFuel (const SUMOEmissionClass) 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.

double	getWeight (const SUMOEmissionClass) const
	Returns a reference weight in kg described by this emission class This implementation returns the default mass for this model.

	HelpersEnergy ()
	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 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 to use and as default return values. Default implementation returns always base.

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

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

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	ENERGY_BASE = 4 << 16

static constexpr double	myDefaultAirDragCoefficient = 0.35

static constexpr double	myDefaultConstantPowerIntake = 100.

static constexpr double	myDefaultFrontSurfaceArea = 2.6

static constexpr double	myDefaultMass = 1830.

static constexpr double	myDefaultPropulsionEfficiency = 0.98

static constexpr double	myDefaultRadialDragCoefficient = 0.1

static constexpr double	myDefaultRecuperationEfficiency = 0.96

static constexpr double	myDefaultRecuperationEfficiencyByDeceleration = 0.0

static constexpr double	myDefaultRollDragCoefficient = 0.01

static constexpr double	myDefaultRotatingMass = 40.

Detailed Description

Helper methods for energy-based electricity consumption computation based on the battery device.

Definition at line 41 of file HelpersEnergy.h.

Constructor & Destructor Documentation

◆ HelpersEnergy()

HelpersEnergy::HelpersEnergy ( )

Constructor (initializes myEmissionClassStrings)

Definition at line 35 of file HelpersEnergy.cpp.

Member Function Documentation

◆ acceleration()

double HelpersEnergy::acceleration	(	const SUMOEmissionClass	c,
		const PollutantsInterface::EmissionType	e,
		const double	v,
		const double	P,
		const double	slope,
		const EnergyParams *	param
	)		const

Computes the achievable acceleration using the given speed and amount of consumed electric power.

Parameters

[in]	c	emission class for the function parameters to use
[in]	e	the type of emission (CO, CO2, ...), only electricity gives valid results
[in]	v	The vehicle's current velocity
[in]	P	The vehicle's current power consumption
[in]	slope	The road's slope at vehicle's position [deg]

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

Definition at line 129 of file HelpersEnergy.cpp.

References PolySolver::cubicSolve(), DEG2RAD, PollutantsInterface::ELEC, EnergyParams::getDefault(), EnergyParams::getDoubleOptional(), EnergyParams::getTotalMass(), GRAVITY, MAX2(), MAX3(), myDefaultAirDragCoefficient, myDefaultFrontSurfaceArea, myDefaultMass, myDefaultPropulsionEfficiency, myDefaultRecuperationEfficiency, myDefaultRollDragCoefficient, myDefaultRotatingMass, SUMO_ATTR_AIRDRAGCOEFFICIENT, SUMO_ATTR_FRONTSURFACEAREA, SUMO_ATTR_PROPULSIONEFFICIENCY, SUMO_ATTR_RECUPERATIONEFFICIENCY, SUMO_ATTR_ROLLDRAGCOEFFICIENT, SUMO_ATTR_ROTATINGMASS, TL, TS, and WRITE_ERROR.

Referenced by MSDevice_ElecHybrid::acceleration().

Here is the caller graph for this function:

◆ 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 213 of file PollutantsInterface.cpp.

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

Here is the caller graph for this function:

◆ compute()

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

virtual

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

Returns only valid values for electricity all other types give 0.

Parameters

[in]	c	emission class for the function parameters to use
[in]	e	the type of emission (CO, CO2, ...), only electricity gives valid results
[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]

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 41 of file HelpersEnergy.cpp.

References ACCEL2SPEED, DEG2RAD, PollutantsInterface::ELEC, EnergyParams::getAngleDiff(), EnergyParams::getDefault(), EnergyParams::getDoubleOptional(), EnergyParams::getTotalMass(), GRAVITY, myDefaultAirDragCoefficient, myDefaultConstantPowerIntake, myDefaultFrontSurfaceArea, myDefaultMass, myDefaultPropulsionEfficiency, myDefaultRadialDragCoefficient, myDefaultRecuperationEfficiency, myDefaultRecuperationEfficiencyByDeceleration, myDefaultRollDragCoefficient, myDefaultRotatingMass, SPEED2DIST, SUMO_ATTR_AIRDRAGCOEFFICIENT, SUMO_ATTR_CONSTANTPOWERINTAKE, SUMO_ATTR_FRONTSURFACEAREA, SUMO_ATTR_PROPULSIONEFFICIENCY, SUMO_ATTR_RADIALDRAGCOEFFICIENT, SUMO_ATTR_RECUPERATIONEFFICIENCY, SUMO_ATTR_RECUPERATIONEFFICIENCY_BY_DECELERATION, SUMO_ATTR_ROLLDRAGCOEFFICIENT, SUMO_ATTR_ROTATINGMASS, and TS.

Referenced by MSDevice_ElecHybrid::consumption(), and MSDevice_Battery::notifyMove().

Here is the caller graph for this function:

◆ getAmitranVehicleClass()

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

virtualinherited

Returns the vehicle class described by this emission class as described in the Amitran interface (Passenger, ...) Default implementation returns always "Passenger".

Parameters

[in] c the emission class

Returns: the name of the vehicle class

Reimplemented in HelpersHBEFA3, HelpersHBEFA4, and HelpersPHEMlight.

Definition at line 146 of file PollutantsInterface.cpp.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getAmitranVehicleClass().

Here is the caller graph for this function:

◆ getClass()

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

virtualinherited

Returns the emission class described by the given parameters. The base is used to determine the model to use and as default return values. Default implementation returns always base.

Parameters

[in]	base	the base class giving the model and 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 in HelpersHBEFA3, HelpersHBEFA4, and HelpersPHEMlight.

Definition at line 136 of file PollutantsInterface.cpp.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getClass().

Here is the caller graph for this function:

◆ 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, MIN2(), PHEMlightdllV5::Constants::SPEED_DCEL_MIN, SUMO_ATTR_FRONTSURFACEAREA, and SUMO_ATTR_MASS.

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

Here is the caller graph for this function:

◆ getEuroClass()

int PollutantsInterface::Helper::getEuroClass ( const SUMOEmissionClass c ) const

virtualinherited

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

Parameters

[in] c the emission class

Returns: the Euro class

Reimplemented in HelpersHBEFA3, HelpersHBEFA4, and HelpersPHEMlight.

Definition at line 160 of file PollutantsInterface.cpp.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getEuroClass().

Here is the caller graph for this function:

◆ getFuel()

std::string HelpersEnergy::getFuel ( const SUMOEmissionClass ) const

inlinevirtual

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

Parameters

[in] c the emission class

Returns: always "Electricity"

Reimplemented from PollutantsInterface::Helper.

Definition at line 54 of file HelpersEnergy.h.

◆ 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 HelpersEnergy::getWeight ( const SUMOEmissionClass ) const

inlinevirtual

Returns a reference weight in kg described by this emission class This implementation returns the default mass for this model.

Parameters

[in] c the emission class

Returns: a reference weight

Reimplemented from PollutantsInterface::Helper.

Definition at line 63 of file HelpersEnergy.h.

References myDefaultMass.

◆ includesClass()

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

inherited

Definition at line 219 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

◆ ENERGY_BASE

const int HelpersEnergy::ENERGY_BASE = 4 << 16

staticprivate

Definition at line 43 of file HelpersEnergy.h.

◆ myBaseIndex

const int PollutantsInterface::Helper::myBaseIndex

protectedinherited

the starting index for classes of this model

Definition at line 228 of file PollutantsInterface.h.

◆ myDefaultAirDragCoefficient

constexpr double HelpersEnergy::myDefaultAirDragCoefficient = 0.35

staticconstexprprivate

Definition at line 95 of file HelpersEnergy.h.

Referenced by acceleration(), and compute().

◆ myDefaultConstantPowerIntake

constexpr double HelpersEnergy::myDefaultConstantPowerIntake = 100.

staticconstexprprivate

Definition at line 99 of file HelpersEnergy.h.

Referenced by compute().

◆ myDefaultFrontSurfaceArea

constexpr double HelpersEnergy::myDefaultFrontSurfaceArea = 2.6

staticconstexprprivate

Definition at line 94 of file HelpersEnergy.h.

Referenced by acceleration(), and compute().

◆ myDefaultMass

constexpr double HelpersEnergy::myDefaultMass = 1830.

staticconstexprprivate

Definition at line 93 of file HelpersEnergy.h.

Referenced by acceleration(), compute(), and getWeight().

◆ myDefaultPropulsionEfficiency

constexpr double HelpersEnergy::myDefaultPropulsionEfficiency = 0.98

staticconstexprprivate

Definition at line 100 of file HelpersEnergy.h.

Referenced by acceleration(), and compute().

◆ myDefaultRadialDragCoefficient

constexpr double HelpersEnergy::myDefaultRadialDragCoefficient = 0.1

staticconstexprprivate

Definition at line 97 of file HelpersEnergy.h.

Referenced by compute().

◆ myDefaultRecuperationEfficiency

constexpr double HelpersEnergy::myDefaultRecuperationEfficiency = 0.96

staticconstexprprivate

Definition at line 101 of file HelpersEnergy.h.

Referenced by acceleration(), and compute().

◆ myDefaultRecuperationEfficiencyByDeceleration

constexpr double HelpersEnergy::myDefaultRecuperationEfficiencyByDeceleration = 0.0

staticconstexprprivate

Definition at line 102 of file HelpersEnergy.h.

Referenced by compute().

◆ myDefaultRollDragCoefficient

constexpr double HelpersEnergy::myDefaultRollDragCoefficient = 0.01

staticconstexprprivate

Definition at line 98 of file HelpersEnergy.h.

Referenced by acceleration(), and compute().

◆ myDefaultRotatingMass

constexpr double HelpersEnergy::myDefaultRotatingMass = 40.

staticconstexprprivate

Definition at line 96 of file HelpersEnergy.h.

Referenced by acceleration(), and compute().

◆ myEmissionClassStrings

StringBijection<SUMOEmissionClass> PollutantsInterface::Helper::myEmissionClassStrings

protectedinherited

◆ 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(), HelpersHBEFA3::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(), HelpersHBEFA3::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

◆ HelpersEnergy()

Member Function Documentation

◆ acceleration()

◆ addAllClassesInto()

◆ compute()

◆ getAmitranVehicleClass()

◆ getClass()

◆ getClassByName()

◆ getClassName()

◆ getCoastingDecel()

◆ getEuroClass()

◆ getFuel()

◆ getModifiedAccel()

◆ getName()

◆ getWeight()

◆ includesClass()

◆ isSilent()

Field Documentation

◆ ENERGY_BASE

◆ myBaseIndex

◆ myDefaultAirDragCoefficient

◆ myDefaultConstantPowerIntake

◆ myDefaultFrontSurfaceArea

◆ myDefaultMass

◆ myDefaultPropulsionEfficiency

◆ myDefaultRadialDragCoefficient

◆ myDefaultRecuperationEfficiency

◆ myDefaultRecuperationEfficiencyByDeceleration

◆ myDefaultRollDragCoefficient

◆ myDefaultRotatingMass

◆ myEmissionClassStrings

◆ myName

◆ myVolumetricFuel

◆ ZERO_SPEED_ACCURACY