A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::TwoRayGroundPropagationLossModel Class Reference
Propagation Models

a Two-Ray Ground propagation loss model ported from NS2 More...

#include "propagation-loss-model.h"

+ Inheritance diagram for ns3::TwoRayGroundPropagationLossModel:
+ Collaboration diagram for ns3::TwoRayGroundPropagationLossModel:

Public Member Functions

 TwoRayGroundPropagationLossModel ()
 
 TwoRayGroundPropagationLossModel (const TwoRayGroundPropagationLossModel &)=delete
 
double GetFrequency () const
 
double GetMinDistance () const
 
double GetSystemLoss () const
 
TwoRayGroundPropagationLossModel & operator= (const TwoRayGroundPropagationLossModel &)=delete
 
void SetFrequency (double frequency)
 
void SetHeightAboveZ (double heightAboveZ)
 
void SetMinDistance (double minDistance)
 
void SetSystemLoss (double systemLoss)
 
- Public Member Functions inherited from ns3::PropagationLossModel
 PropagationLossModel ()
 
 PropagationLossModel (const PropagationLossModel &)=delete
 
 ~PropagationLossModel () override
 
int64_t AssignStreams (int64_t stream)
 If this loss model uses objects of type RandomVariableStream, set the stream numbers to the integers starting with the offset 'stream'.
 
double CalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
 Returns the Rx Power taking into account all the PropagationLossModel(s) chained to the current one.
 
Ptr< PropagationLossModel > GetNext ()
 Gets the next PropagationLossModel in the chain of loss models that act on the signal.
 
PropagationLossModel & operator= (const PropagationLossModel &)=delete
 
void SetNext (Ptr< PropagationLossModel > next)
 Enables a chain of loss models to act on the signal.
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const final
 Get the most derived TypeId for this Object.
 
template<typename T>
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< Object > GetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T>
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< Object > GetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::PropagationLossModel
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Private Member Functions

double DbmFromW (double w) const
 Transforms a Watt value to Dbm.
 
double DbmToW (double dbm) const
 Transforms a Dbm value to Watt.
 
int64_t DoAssignStreams (int64_t stream) override
 Assign a fixed random variable stream number to the random variables used by this model.
 
double DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
 PropagationLossModel.
 

Private Attributes

double m_frequency
 the carrier frequency
 
double m_heightAboveZ
 antenna height above the node's Z coordinate
 
double m_lambda
 the carrier wavelength
 
double m_minDistance
 minimum distance for the model
 
double m_systemLoss
 the system loss (linear factor)
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 
- Related Symbols inherited from ns3::ObjectBase
 Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.
 

Detailed Description

a Two-Ray Ground propagation loss model ported from NS2

Two-ray ground reflection model.

$ Pr = \frac{P_t * G_t * G_r * (H_t^2 * H_r^2)}{d^4 * L} $

The original equation in Rappaport's book assumes L = 1. To be consistent with the free space equation, L is added here.

Ht and Hr are set at the respective nodes z coordinate plus a model parameter set via SetHeightAboveZ.

The two-ray model does not give a good result for short distances, due to the oscillation caused by constructive and destructive combination of the two rays. Instead the Friis free-space model is used for small distances.

The crossover distance, below which Friis is used, is calculated as follows:

$ dCross = \frac{(4 * \pi * H_t * H_r)}{\lambda} $

In the implementation, $ \lambda $ is calculated as $ \frac{C}{f} $, where $ C = 299792458$ m/s is the speed of light in vacuum, and $ f $ is the frequency in Hz which can be configured by the user via the Frequency attribute.

Config Paths

ns3::TwoRayGroundPropagationLossModel is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::TwoRayGroundPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::TwoRayGroundPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::TwoRayGroundPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::TwoRayGroundPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::lrwpan::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::TwoRayGroundPropagationLossModel"
  • "/ChannelList/[i]/$ns3::SpectrumChannel/PropagationLossModel/$ns3::TwoRayGroundPropagationLossModel"
  • "/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::TwoRayGroundPropagationLossModel"

Attributes

  • Frequency: The carrier frequency (in Hz) at which propagation occurs (default is 5.15 GHz).
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 5.15e+09
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • HeightAboveZ: The height of the antenna (m) above the node's Z coordinate
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • MinDistance: The distance under which the propagation model refuses to give results (m)
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.5
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • SystemLoss: The system loss (linear factor >= 1, not in dB)
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1
    • Flags: constructwriteread
    • Support level: SUPPORTED

No TraceSources are defined for this type
Group: Propagation
Size of this type is 104 bytes (on a 64-bit architecture).

Definition at line 347 of file propagation-loss-model.h.

Constructor & Destructor Documentation

◆ TwoRayGroundPropagationLossModel() [1/2]

ns3::TwoRayGroundPropagationLossModel::TwoRayGroundPropagationLossModel ( )

Definition at line 323 of file propagation-loss-model.cc.

Referenced by TwoRayGroundPropagationLossModel(), GetTypeId(), and operator=().

+ Here is the caller graph for this function:

◆ TwoRayGroundPropagationLossModel() [2/2]

ns3::TwoRayGroundPropagationLossModel::TwoRayGroundPropagationLossModel ( const TwoRayGroundPropagationLossModel & )
delete

References TwoRayGroundPropagationLossModel().

+ Here is the call graph for this function:

Member Function Documentation

◆ DbmFromW()

double ns3::TwoRayGroundPropagationLossModel::DbmFromW ( double w) const
private

Transforms a Watt value to Dbm.

Parameters
wthe Watt value
Returns
the Dbm

Definition at line 380 of file propagation-loss-model.cc.

◆ DbmToW()

double ns3::TwoRayGroundPropagationLossModel::DbmToW ( double dbm) const
private

Transforms a Dbm value to Watt.

Parameters
dbmthe Dbm value
Returns
the Watts

Definition at line 373 of file propagation-loss-model.cc.

◆ DoAssignStreams()

int64_t ns3::TwoRayGroundPropagationLossModel::DoAssignStreams ( int64_t stream)
overrideprivatevirtual

Assign a fixed random variable stream number to the random variables used by this model.

Subclasses must implement this; those not using random variables can return zero.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Implements ns3::PropagationLossModel.

Definition at line 460 of file propagation-loss-model.cc.

◆ DoCalcRxPower()

double ns3::TwoRayGroundPropagationLossModel::DoCalcRxPower ( double txPowerDbm,
Ptr< MobilityModel > a,
Ptr< MobilityModel > b ) const
overrideprivatevirtual

PropagationLossModel.

Parameters
txPowerDbmcurrent transmission power (in dBm)
athe mobility model of the source
bthe mobility model of the destination
Returns
the reception power after adding/multiplying propagation loss (in dBm)

Implements ns3::PropagationLossModel.

Definition at line 387 of file propagation-loss-model.cc.

References m_heightAboveZ, m_lambda, m_minDistance, m_systemLoss, and NS_LOG_DEBUG.

◆ GetFrequency()

double ns3::TwoRayGroundPropagationLossModel::GetFrequency ( ) const
Returns
the current frequency (Hz)

Definition at line 367 of file propagation-loss-model.cc.

References m_frequency.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetMinDistance()

double ns3::TwoRayGroundPropagationLossModel::GetMinDistance ( ) const
Returns
the minimum distance.

Definition at line 347 of file propagation-loss-model.cc.

References m_minDistance.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetSystemLoss()

double ns3::TwoRayGroundPropagationLossModel::GetSystemLoss ( ) const
Returns
the current system loss (linear factor, dimension-less)

Definition at line 335 of file propagation-loss-model.cc.

References m_systemLoss.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::TwoRayGroundPropagationLossModel::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 288 of file propagation-loss-model.cc.

References ns3::PropagationLossModel::PropagationLossModel(), TwoRayGroundPropagationLossModel(), GetFrequency(), GetMinDistance(), GetSystemLoss(), m_heightAboveZ, ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), SetFrequency(), SetMinDistance(), ns3::TypeId::SetParent(), and SetSystemLoss().

+ Here is the call graph for this function:

◆ operator=()

TwoRayGroundPropagationLossModel & ns3::TwoRayGroundPropagationLossModel::operator= ( const TwoRayGroundPropagationLossModel & )
delete

References TwoRayGroundPropagationLossModel().

+ Here is the call graph for this function:

◆ SetFrequency()

void ns3::TwoRayGroundPropagationLossModel::SetFrequency ( double frequency)
Parameters
frequency(Hz)

Set the carrier frequency used in the TwoRayGround model calculation.

Definition at line 359 of file propagation-loss-model.cc.

References m_frequency, and m_lambda.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetHeightAboveZ()

void ns3::TwoRayGroundPropagationLossModel::SetHeightAboveZ ( double heightAboveZ)
Parameters
heightAboveZthe model antenna height above the node's Z coordinate

Set the model antenna height above the node's Z coordinate

Definition at line 353 of file propagation-loss-model.cc.

References m_heightAboveZ.

◆ SetMinDistance()

void ns3::TwoRayGroundPropagationLossModel::SetMinDistance ( double minDistance)
Parameters
minDistancethe minimum distance

Below this distance, the txpower is returned unmodified as the rxpower.

Definition at line 341 of file propagation-loss-model.cc.

References m_minDistance.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetSystemLoss()

void ns3::TwoRayGroundPropagationLossModel::SetSystemLoss ( double systemLoss)
Parameters
systemLoss(linear factor, dimension-less)

Set the system loss used by the TwoRayGround propagation model. Value should be greater than or equal to 1; the default of 1 corresponds to no system loss.

Definition at line 328 of file propagation-loss-model.cc.

References m_systemLoss, and NS_ABORT_MSG_UNLESS.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_frequency

double ns3::TwoRayGroundPropagationLossModel::m_frequency
private

the carrier frequency

Definition at line 426 of file propagation-loss-model.h.

Referenced by GetFrequency(), and SetFrequency().

◆ m_heightAboveZ

double ns3::TwoRayGroundPropagationLossModel::m_heightAboveZ
private

antenna height above the node's Z coordinate

Definition at line 429 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), GetTypeId(), and SetHeightAboveZ().

◆ m_lambda

double ns3::TwoRayGroundPropagationLossModel::m_lambda
private

the carrier wavelength

Definition at line 425 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), and SetFrequency().

◆ m_minDistance

double ns3::TwoRayGroundPropagationLossModel::m_minDistance
private

minimum distance for the model

Definition at line 428 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), GetMinDistance(), and SetMinDistance().

◆ m_systemLoss

double ns3::TwoRayGroundPropagationLossModel::m_systemLoss
private

the system loss (linear factor)

Definition at line 427 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), GetSystemLoss(), and SetSystemLoss().

The documentation for this class was generated from the following files: