two-ray-spectrum-propagation-loss-model.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 SIGNET Lab, Department of Information Engineering,
 * University of Padova
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
#ifndef TWO_RAY_SPECTRUM_PROPAGATION_LOSS_H
#define TWO_RAY_SPECTRUM_PROPAGATION_LOSS_H
 
#include "ns3/channel-condition-model.h"
#include "ns3/phased-array-spectrum-propagation-loss-model.h"
#include "ns3/spectrum-signal-parameters.h"
 
#include <map>
 
class FtrFadingModelAverageTest;
class ArrayResponseTest;
class OverallGainAverageTest;
 
namespace ns3
{
 
class NetDevice;
 
class TwoRaySpectrumPropagationLossModel : public PhasedArraySpectrumPropagationLossModel
{
    // Test classes needs access to CalcBeamformingGain and GetFtrFastFading
    friend class ::FtrFadingModelAverageTest;
    friend class ::ArrayResponseTest;
    friend class ::OverallGainAverageTest;
 
  public:
    struct FtrParams
    {
        FtrParams(double m, double sigma, double k, double delta)
        {
            // Make sure the parameter values belong to the proper domains
            NS_ASSERT(delta >= 0.0 && delta <= 1.0);
 
            m_m = m;
            m_sigma = sigma;
            m_k = k;
            m_delta = delta;
        }
 
        FtrParams() = delete;
 
        double m_m = 0;
 
        double m_sigma = 0;
 
        double m_k = 0;
 
        double m_delta = 0;
    };
 
    using CarrierFrequencyFtrParamsTuple = std::tuple<std::vector<double>, std::vector<FtrParams>>;
 
    using FtrParamsLookupTable =
        std::map<std::string,
                 std::map<ChannelCondition::LosConditionValue, CarrierFrequencyFtrParamsTuple>>;
 
    TwoRaySpectrumPropagationLossModel();
 
    ~TwoRaySpectrumPropagationLossModel() override;
 
    void DoDispose() override;
 
    static TypeId GetTypeId();
 
    void SetScenario(const std::string& scenario);
 
    void SetFrequency(double f);
 
    int64_t AssignStreams(int64_t stream);
 
    Ptr<SpectrumValue> DoCalcRxPowerSpectralDensity(
        Ptr<const SpectrumSignalParameters> txPsd,
        Ptr<const MobilityModel> a,
        Ptr<const MobilityModel> b,
        Ptr<const PhasedArrayModel> aPhasedArrayModel,
        Ptr<const PhasedArrayModel> bPhasedArrayModel) const override;
 
  private:
    ChannelCondition::LosConditionValue GetLosCondition(Ptr<const MobilityModel> a,
                                                        Ptr<const MobilityModel> b) const;
 
    FtrParams GetFtrParameters(Ptr<const MobilityModel> a, Ptr<const MobilityModel> b) const;
 
    double GetFtrFastFading(const FtrParams& params) const;
 
    double CalcBeamformingGain(Ptr<const MobilityModel> a,
                               Ptr<const MobilityModel> b,
                               Ptr<const PhasedArrayModel> aPhasedArrayModel,
                               Ptr<const PhasedArrayModel> bPhasedArrayModel) const;
 
    std::size_t SearchClosestFc(const std::vector<double>& frequencies, double targetFc) const;
 
    double m_frequency;
 
    Ptr<UniformRandomVariable> m_uniformRv;
 
    Ptr<NormalRandomVariable> m_normalRv;
 
    Ptr<GammaRandomVariable> m_gammaRv;
 
    std::string m_scenario; 
 
    Ptr<ChannelConditionModel> m_channelConditionModel;
};
 
} // namespace ns3
 
#endif /* TWO_RAY_SPECTRUM_PROPAGATION_LOSS_H */