TYAcousticModel9613Solver2024.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_9613SOLVER2024__
#define __TYACOUSTICMODEL_9613SOLVER2024__
 
#include "Tympan/solvers/9613/9613Solver/TYAcousticModel9613Solver.h"
#include "Tympan/solvers/9613/9613Solver2024/TYSolver9613Solver2024.h"
#include "Tympan/solvers/9613/9613Solver2024/TYChemin9613Solver2024.h"
#include "TYReflectionPruningStrategy.h"
#include "TYReflectionPathFinder.h"
#include <gtest/gtest_prod.h>
 
class TYAcousticModel9613Solver2024 : public TYAcousticModel9613Solver
{
public:
    TYAcousticModel9613Solver2024(TYSolver9613Solver2024& solver); //<! Constructor
 
    void init() override;
 
protected:
    std::unique_ptr<TYChemin9613Solver> createChemin() const override
    {
        return std::make_unique<TYChemin9613Solver2024>();
    }
 
    OSpectreOctave calculZMin(const double C2, const OSpectreOctave& C3) const override;
 
    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 override;
 
    OSpectreOctave calculDz(const double z, const double C2, const OSpectreOctave& C3,
                            const OSpectreOctave& Kmeteo, const OSpectreOctave& zmin) const override;
 
    void computeCheminReflexion(const std::deque<TYSIntersection>& tabIntersect, const OSegment3D& ray,
                                const tympan::AcousticSource& source, TYTabChemin9613Solver& TabChemins,
                                double distance) const override;
 
    void computeCheminReflectionImageSourceMethod(size_t multipleReflectionOrder,
                                                  const std::deque<TYSIntersection>& tabIntersect,
                                                  const OSegment3D& ray, const tympan::AcousticSource& source,
                                                  TYTabChemin9613Solver& TabChemins, double distance) const;
 
    bool getGroundfactors(const std::deque<std::deque<TYSIntersection>>& tabIntersectSegments,
                          const std::deque<OPoint3D>& pathPoints2D, double hs, double hr, double& Gs,
                          double& Gm, double& Gr) const;
 
    bool computeGroundFactorSourceZone(const std::deque<std::deque<TYSIntersection>>& tabIntersectSegments,
                                       const std::deque<OPoint3D>& pathPoints2D, double hs, double& Gs) const;
 
    bool computeGroundFactorReceiverZone(const std::deque<std::deque<TYSIntersection>>& tabIntersectSegments,
                                         const std::deque<OPoint3D>& pathPoints2D, double hr,
                                         double& Gr) const;
 
    bool computeGroundFactorMiddleZone(const std::deque<std::deque<TYSIntersection>>& tabIntersectSegments,
                                       const std::deque<OPoint3D>& pathPoints2D, double hs, double hr,
                                       double& Gm) const;
 
private:
    // attributes
    std::unique_ptr<TYAbstractReflectionPathFinder> _pReflectionPathFinder;
    std::unique_ptr<TYAbstractReflectionPruningStrategy> _pReflectionPruningStrategy;
 
    // methods
 
    bool sameReflectingSegment(const TYSIntersection& lhs, const TYSIntersection& rhs) const;
 
    bool buildReflectionPoints(const std::vector<const TYSIntersection*>& currentCombination,
                               const std::deque<OPoint3D>& imageSourcesList, const OPoint3D& receptorPoint,
                               std::deque<OPoint3D>& reflectionPointsList) const;
 
    bool validateReflectionCandidate(const std::vector<const TYSIntersection*>& barrierCombination,
                                     const std::deque<OPoint3D>& reflectionPointsList,
                                     const std::deque<TYSIntersection>& tabIntersect,
                                     const OPoint3D& sourcePoint, const OPoint3D& receptorPoint) const;
 
    bool buildReflectionPath(const std::vector<const TYSIntersection*>& barrierCombination,
                             const std::deque<OPoint3D>& imageSourcesList,
                             const std::deque<OPoint3D>& reflectionPointsList, const OSegment3D& directRay,
                             const tympan::AcousticSource& source, TYTabChemin9613Solver& TabChemins,
                             double distance) const;
 
    struct ReflectingSegmentCache
    {
        const TYSIntersection* barrier{nullptr};
        double ax{0.0};
        double ay{0.0};
        double az{0.0};
        double ux{0.0};
        double uy{0.0};
        double uz{0.0};
        double invNorm2{0.0};
    };
 
    // TODO: transform into a constructor of ReflectingSegmentCache
    ReflectingSegmentCache makeReflectingSegmentCache(const TYSIntersection& inter) const;
 
    // TODO: transform into a method of ReflectingSegmentCache
    void reflectPointAboutCachedLine(const ReflectingSegmentCache& cache, const OPoint3D& inputPoint,
                                     OPoint3D& reflectedPoint) const;
 
    void buildReflectionPathsStreaming(size_t reflectionOrder,
                                       const std::vector<ReflectingSegmentCache>& reflectingSegments,
                                       std::vector<const TYSIntersection*>& currentCombination,
                                       std::deque<OPoint3D>& currentImageSources,
                                       const std::deque<TYSIntersection>& tabIntersect, const OSegment3D& ray,
                                       const tympan::AcousticSource& source,
                                       TYTabChemin9613Solver& TabChemins, double distance) const;
 
    bool buildReflectionPathForCombination(const std::vector<const TYSIntersection*>& currentCombination,
                                           const std::deque<OPoint3D>& imageSourcesList,
                                           const std::deque<TYSIntersection>& tabIntersect,
                                           const OSegment3D& ray, const tympan::AcousticSource& source,
                                           TYTabChemin9613Solver& TabChemins, double distance) const;
 
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, calculZMin);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, calculK_meteo_z_0);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, calculK_meteo_z_30);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, calculK_meteo_lateral_diffraction);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, calculK_meteo_d_500_z_1);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, calculDz_z_greater_than_zmin);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, calculDz_z_general_case);
 
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, sameReflectingSegment_compares_segInter1_only);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024,
                reflectPointAboutCachedLine_order3_builds_expected_image_sources);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, buildReflectionPoints_pointerCombination_order2);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024,
                buildReflectionPoints_pointerCombination_fails_when_intersection_is_outside_segment);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024,
                validateReflectionCandidate_pointerCombination_order2_valid);
    FRIEND_TEST(
        test_TYAcousticModel9613Solver2024,
        validateReflectionCandidate_pointerCombination_order2_invalid_with_intersecting_scene_segment);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024,
                buildReflectionPath_pointerCombination_fails_when_candidate_is_inconsistent);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024,
                buildReflectionPath_pointerCombination_fails_when_material_is_missing);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024,
                buildReflectionPath_pointerCombination_fails_when_face_geom_data_is_missing);
 
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, computeGroundFactorSourceZone_order3_Segments1);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, computeGroundFactorSourceZone_order3_Segments12);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, computeGroundFactorSourceZone_order3_Segments123);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, computeGroundFactorSourceZone_order3_Segments1234);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, computeGroundFactorSourceZone_order3_FullPath);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, computeGroundFactorReceiverZone_order3_Segments4);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, computeGroundFactorReceiverZone_order3_Segments34);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, computeGroundFactorReceiverZone_order3_Segments234);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, computeGroundFactorReceiverZone_order3_Segments1234);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024, computeGroundFactorReceiverZone_order3_FullPath);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024,
                computeGroundFactorMiddleZone_order3_both_bounds_in_segment3);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024,
                computeGroundFactorMiddleZone_order3_spans_several_segments);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024,
                computeGroundFactorMiddleZone_order3_both_bounds_in_segment2);
    FRIEND_TEST(test_TYAcousticModel9613Solver2024,
                computeGroundFactorMiddleZone_order3_no_middle_zone_when_lengths_touch);
};
 
#endif // __TYACOUSTICMODEL_9613SOLVER2024__