PollutantsInterface.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2013-2025 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
/****************************************************************************/
// Interface to capsulate different emission models
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include <limits>
#include <cmath>
#include <algorithm>
#include <utils/common/StdDefs.h>
#include <utils/common/SUMOVehicleClass.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class EnergyParams;
class HelpersHBEFA;
class HelpersHBEFA3;
class HelpersHBEFA4;
class HelpersEnergy;
class HelpersMMPEVEM;
class HelpersPHEMlight;
class HelpersPHEMlight5;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class PollutantsInterface {
 
public:
    enum EmissionType { CO2, CO, HC, FUEL, NO_X, PM_X, ELEC };

    struct Emissions {
        Emissions(double co2 = 0, double co = 0, double hc = 0, double f = 0, double nox = 0, double pmx = 0, double elec = 0);

        void addScaled(const Emissions& a, const double scale = 1.);

        double CO2;
        double CO;
        double HC;
        double fuel;
        double NOx;
        double PMx;
        double electricity;
    };

    class Helper {
    public:
        Helper(std::string name, const int baseIndex, const int defaultClass);

        virtual ~Helper() {}

        const std::string& getName() const;

        virtual SUMOEmissionClass getClassByName(const std::string& eClass, const SUMOVehicleClass vc);

        const std::string getClassName(const SUMOEmissionClass c) const;

        virtual bool isSilent(const SUMOEmissionClass c);


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

        virtual std::string getAmitranVehicleClass(const SUMOEmissionClass c) const;

        virtual std::string getFuel(const SUMOEmissionClass c) const;

        virtual int getEuroClass(const SUMOEmissionClass c) const;

        virtual double getWeight(const SUMOEmissionClass c) const;

        virtual double compute(const SUMOEmissionClass c, const EmissionType e, const double v, const double a, const double slope, const EnergyParams* param) const;

        virtual double getModifiedAccel(const SUMOEmissionClass c, const double v, const double a, const double slope, const EnergyParams* param) const;

        virtual double getCoastingDecel(const SUMOEmissionClass c, const double v, const double a, const double slope, const EnergyParams* param) const;

        void addAllClassesInto(std::vector<SUMOEmissionClass>& list) const;
 
        bool includesClass(const SUMOEmissionClass c) const;
 
    protected:
        static const double ZERO_SPEED_ACCURACY;

        const std::string myName;

        const int myBaseIndex;

        bool myVolumetricFuel;

        StringBijection<SUMOEmissionClass> myEmissionClassStrings;
 
    private:
        Helper& operator=(const Helper&) = delete;
    };

    static const int ZERO_EMISSIONS = 0;

    static const int HEAVY_BIT = 1 << 15;

    static SUMOEmissionClass getClassByName(const std::string& eClass, const SUMOVehicleClass vc = SVC_IGNORING);

    static const std::vector<SUMOEmissionClass> getAllClasses();

    static const std::vector<std::string>& getAllClassesStr();

    static std::string getName(const SUMOEmissionClass c);

    static std::string getPollutantName(const EmissionType e);

    static bool isHeavy(const SUMOEmissionClass c);

    static bool isSilent(const SUMOEmissionClass c);

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

    static std::string getAmitranVehicleClass(const SUMOEmissionClass c);

    static std::string getFuel(const SUMOEmissionClass c);

    static int getEuroClass(const SUMOEmissionClass c);

    static double getWeight(const SUMOEmissionClass c);

    static double compute(const SUMOEmissionClass c, const EmissionType e, const double v, const double a, const double slope, const EnergyParams* param);

    static Emissions computeAll(const SUMOEmissionClass c, const double v, const double a, const double slope, const EnergyParams* param);

    static double computeDefault(const SUMOEmissionClass c, const EmissionType e, const double v, const double a, const double slope, const double tt, const EnergyParams* param);

    static double getModifiedAccel(const SUMOEmissionClass c, const double v, const double a, const double slope, const EnergyParams* param);

    static double getCoastingDecel(const SUMOEmissionClass c, const double v, const double a, const double slope, const EnergyParams* param);

    static const HelpersEnergy& getEnergyHelper();
 
private:
    static Helper myZeroHelper;

    static HelpersHBEFA myHBEFA2Helper;

    static HelpersHBEFA3 myHBEFA3Helper;

    static HelpersPHEMlight myPHEMlightHelper;

    static HelpersEnergy myEnergyHelper;

    static HelpersMMPEVEM myMMPEVEMHelper;

    static HelpersPHEMlight5 myPHEMlight5Helper;

    static HelpersHBEFA4 myHBEFA4Helper;

    static Helper* myHelpers[];

    static std::vector<std::string> myAllClassesStr;
};