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 (void) const

double	GetMinDistance (void) const

double	GetSystemLoss (void) 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

virtual	~PropagationLossModel ()

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'. More...

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. More...

Ptr< PropagationLossModel >	GetNext ()
	Gets the next PropagationLossModel in the chain of loss models that act on the signal. More...

PropagationLossModel &	operator= (const PropagationLossModel &)=delete

void	SetNext (Ptr< PropagationLossModel > next)
	Enables a chain of loss models to act on the signal. More...

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized (void) const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::PropagationLossModel
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Member Functions
double	DbmFromW (double w) const
	Transforms a Watt value to Dbm. More...

double	DbmToW (double dbm) const
	Transforms a Dbm value to Watt. More...

int64_t	DoAssignStreams (int64_t stream) override
	Assign a fixed random variable stream number to the random variables used by this model. More...

double	DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
	PropagationLossModel. More...

Private Attributes
double	m_frequency
	the carrier frequency More...

double	m_heightAboveZ
	antenna height above the node's Z coordinate More...

double	m_lambda
	the carrier wavelength More...

double	m_minDistance
	minimum distance for the model More...

double	m_systemLoss
	the system loss More...

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoDispose (void)
	Destructor implementation. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

virtual void	NotifyNewAggregate (void)
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

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 m/s is the speed of light in vacuum, and 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/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::TwoRayGroundPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::TwoRayGroundPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::TwoRayGroundPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::TwoRayGroundPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::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: construct write read
SystemLoss: The system loss
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 1
- Flags: construct write read
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: construct write read
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: construct write read

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

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

Constructor & Destructor Documentation

◆ TwoRayGroundPropagationLossModel() [1/2]

ns3::TwoRayGroundPropagationLossModel::TwoRayGroundPropagationLossModel ( )

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

◆ TwoRayGroundPropagationLossModel() [2/2]

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

delete

Member Function Documentation

◆ DbmFromW()

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

private

Transforms a Watt value to Dbm.

Parameters

w	the Watt value

Returns: the Dbm

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

◆ DbmToW()

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

private

Transforms a Dbm value to Watt.

Parameters

dbm	the Dbm value

Returns: the Watts

Definition at line 361 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

stream first stream index to use

Returns: the number of stream indices assigned by this model

Implements ns3::PropagationLossModel.

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

◆ DoCalcRxPower()

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

overrideprivatevirtual

PropagationLossModel.

Parameters

txPowerDbm	current transmission power (in dBm)
a	the mobility model of the source
b	the mobility model of the destination

Returns: the reception power after adding/multiplying propagation loss (in dBm)

Implements ns3::PropagationLossModel.

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

References ns3::MobilityModel::GetDistanceFrom(), ns3::MobilityModel::GetPosition(), m_heightAboveZ, m_lambda, m_minDistance, m_systemLoss, and NS_LOG_DEBUG.

Here is the call graph for this function:

◆ GetFrequency()

double ns3::TwoRayGroundPropagationLossModel::GetFrequency ( void ) const

Returns: the current frequency (Hz)

Definition at line 355 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 ( void ) const

Returns: the minimum distance.

Definition at line 336 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 ( void ) const

Returns: the current system loss (dimension-less)

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

References m_systemLoss.

◆ GetTypeId()

TypeId ns3::TwoRayGroundPropagationLossModel::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

References GetFrequency(), GetMinDistance(), m_heightAboveZ, m_systemLoss, ns3::MakeDoubleAccessor(), SetFrequency(), SetMinDistance(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ operator=()

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

delete

◆ SetFrequency()

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

Parameters

frequency (Hz)

Set the carrier frequency used in the TwoRayGround model calculation.

Definition at line 347 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

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

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

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

References m_heightAboveZ.

◆ SetMinDistance()

void ns3::TwoRayGroundPropagationLossModel::SetMinDistance ( double minDistance )

Parameters

minDistance the minimum distance

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

Definition at line 331 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 (dimension-less)

Set the system loss used by the TwoRayGround propagation model.

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

References m_systemLoss.

Member Data Documentation

◆ m_frequency

double ns3::TwoRayGroundPropagationLossModel::m_frequency

private

the carrier frequency

Definition at line 434 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 437 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 433 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 436 of file propagation-loss-model.h.

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

◆ m_systemLoss

double ns3::TwoRayGroundPropagationLossModel::m_systemLoss

private

the system loss

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

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

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

src/propagation/model/propagation-loss-model.h
src/propagation/model/propagation-loss-model.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Constructor & Destructor Documentation

◆ TwoRayGroundPropagationLossModel() [1/2]

◆ TwoRayGroundPropagationLossModel() [2/2]

Member Function Documentation

◆ DbmFromW()

◆ DbmToW()

◆ DoAssignStreams()

◆ DoCalcRxPower()

◆ GetFrequency()

◆ GetMinDistance()

◆ GetSystemLoss()

◆ GetTypeId()

◆ operator=()

◆ SetFrequency()

◆ SetHeightAboveZ()

◆ SetMinDistance()

◆ SetSystemLoss()

Member Data Documentation

◆ m_frequency

◆ m_heightAboveZ

◆ m_lambda

◆ m_minDistance

◆ m_systemLoss