TYAcousticModel9613Solver.h

Go to the documentation of this file.

/*
 * Copyright (C) <2012-2024> <EDF-DTG> <FRANCE>
 * This file is part of Code_TYMPAN (R).
 * Code_TYMPAN (R) is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * Code_TYMPAN (R) is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License along
 * with Code_TYMPAN (R). If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef __TYACOUSTICMODEL_9613SOLVER__
#define __TYACOUSTICMODEL_9613SOLVER__
 
#include "Tympan/core/interfaces.h"
#include "Tympan/solvers/9613/TYAcousticModel.h"
#include "Tympan/solvers/9613/9613Solver/TYTrajet9613Solver.h"
#include "Tympan/solvers/9613/9613Solver/TYSolver9613Solver.h"
#include "Tympan/solvers/TYSolverDefines.h"
#include "Tympan/models/common/plan.h"
#include <gtest/gtest_prod.h>
 
// Custom hash function for OVector3D
struct OVector3DHash
{
    std::size_t operator()(const OVector3D& vec) const
    {
        std::size_t hx = std::hash<double>()(vec._x);
        std::size_t hy = std::hash<double>()(vec._y);
        std::size_t hz = std::hash<double>()(vec._z);
        return hx ^ (hy << 1) ^ (hz << 2); // Combining the hash values
    }
};
 
class TYAcousticModel9613Solver : public TYAcousticModel
{
public:
    TYAcousticModel9613Solver(TYSolver9613Solver& solver); //<! Constructor
 
    void compute(const std::deque<TYSIntersection>& tabIntersect, TYTrajet9613Solver& trajet,
                 TabPoint3D& ptsTop, TabPoint3D& ptsLeft, TabPoint3D& ptsRight);
 
    void computeWaveLength() override;
 
    virtual bool computeCheminsAvecEcran(const OSegment3D& rayon, const tympan::AcousticSource& source,
                                         const TabPoint3D& pts, const bool vertical,
                                         TYTabChemin9613Solver& TabChemins, double distance,
                                         const bool left) const;
 
    virtual void computeCheminReflexion(const std::deque<TYSIntersection>& tabIntersect,
                                        const OSegment3D& ray, const tympan::AcousticSource& source,
                                        TYTabChemin9613Solver& TabChemins, double distance) const;
 
    void computeCheminSansEcran(const std::deque<TYSIntersection>& tabIntersect, const OSegment3D& rayon,
                                const tympan::AcousticSource& source, TYTabChemin9613Solver& TabChemins,
                                double distance, bool conditionFav = false) const;
 
    OSpectreOctave calculAttDiffraction(const OSegment3D& ray, const double& re, const double& dss,
                                        const double& dsr, const double& width, const bool& vertical) const;
 
    OSpectreOctave limAttDiffraction(const OSpectreOctave& sNC, const OSpectreOctave& C) const;
 
    bool addGroundSteps(const OPoint3D& ptStart, const OPoint3D& ptEnd, const tympan::AcousticSource& source,
                        const bool& fromSource, TYTabEtape9613Solver& Etapes) const;
 
    bool getGroundfactors(const std::deque<TYSIntersection>& tabIntersect, const OSegment3D& ray2D, double hs,
                          double hr, double& Gs, double& Gm, double& Gr) const;
 
    bool getGroundfactors(const std::deque<TYSIntersection>& tabIntersectUpSegment,
                          const std::deque<TYSIntersection>& tabIntersectDownSegment, const OSegment3D& SO2D,
                          const OSegment3D& OR2D, double hs, double hr, double& Gs, double& Gm,
                          double& Gr) const;
 
    /*
     * @brief Compute effective barrier attenuation implementing recommandation paragraph 5.6
     *  of ISO TR 17534-3
     * @param [in] Abar_top Barrier attenuation for the vertical path.
     * @param [in] Abar_left Barrier attenuation for the left lateral path.
     * @param [in] Abar_right Barrier attenuation for the right lateral path.
     *
     */
    OSpectreOctave computeEffectiveBarAttenuation(const OSpectreOctave& Abar_top,
                                                  const OSpectreOctave& Abar_left,
                                                  const OSpectreOctave& Abar_right);
 
    bool solve(TYTrajet9613Solver& trajet);
 
protected:
    virtual std::unique_ptr<TYChemin9613Solver> createChemin() const
    {
        return std::make_unique<TYChemin9613Solver>();
    }
 
    bool computeSegmentEdgesHeights(double& hauteurA, double& hauteurB, const OSegment3D& meanSlope,
                                    const OSegment3D& ray) const;
 
    OSpectreOctave calculC3(const double& epaisseur) const;
 
    virtual OSpectreOctave calculZMin(const double C2, const OSpectreOctave& C3) const;
 
    virtual OSpectreOctave calculKmeteo(const bool vertical, const double d_SS, const double d_SR,
                                        const double d, const double z, const double e,
                                        const OSpectreOctave& z_min) const;
 
    virtual OSpectreOctave calculDz(const double z, const double C2, const OSpectreOctave& C3,
                                    const OSpectreOctave& Kmeteo, const OSpectreOctave& zmin) const;
 
    bool computeGZone(const OPoint3D& ptDebut, const OPoint3D& ptFin, double& GZone, double& dpZone,
                      const std::deque<TYSIntersection>& tabIntersect) const;
 
private:
    TYSolver& getSolver() const override
    {
        return _solver;
    }
 
protected:
    OSpectreOctave _lambda;
    TYSolver9613Solver& _solver;
 
private:
    FRIEND_TEST(test_TYAcoustiModel9613Solver, computeGZone);
    FRIEND_TEST(test_TYAcousticModel9613Solver, calculZMin);
    FRIEND_TEST(test_TYAcousticModel9613Solver, calculC3_single_diffraction);
    FRIEND_TEST(test_TYAcousticModel9613Solver, calculC3_multiple_diffraction);
    FRIEND_TEST(test_TYAcousticModel9613Solver, calculK_meteo_z_0);
    FRIEND_TEST(test_TYAcousticModel9613Solver, calculK_meteo_z_30);
    FRIEND_TEST(test_TYAcousticModel9613Solver, calculK_meteo_lateral_diffraction);
    FRIEND_TEST(test_TYAcousticModel9613Solver, calculK_meteo_d_500_z_1);
    FRIEND_TEST(test_TYAcousticModel9613Solver, calculDz_z_positive);
    FRIEND_TEST(test_TYAcousticModel9613Solver, calculDz_z_negative);
 
    OSpectreOctave _absoNulle;
};
 
#endif // __TYACOUSTICMODEL_9613SOLVER__