CosineAntenna¶

Package: inet.physicallayer.wireless.common.antenna

compound module CosineAntenna

Models a hypothetical antenna with a cosine-based radiation pattern. This antenna model is commonly used in the real world to approximate various directional antennas.

Gain is computed from the angle as follows:

exponent = -3 / (20 * log10(cos(beamWidth) / 4))
gain = maxGain * abs(cos(angle / 2)) ^ exponent

This module represents the cosine antenna model found in

Li Chunjian, “Efficient Antenna Patterns for Three-Sector WCDMA Systems”, eq. B.1 and B.2

Inheritance diagram¶

Extends¶

Name	Type	Description
AntennaBase	compound module	Serves as the base module for antenna models.

Parameters¶

Name	Type	Default value	Description
displayStringTextFormat	string	“”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
mobilityModule	string		The path to the mobility module relative to this module, only used if no mobility submodule is present
numAntennas	int	1	The number of antennas in the antenna array
maxGain	double		Gain at the antenna boresight
beamWidth	double		3dB beam width

Properties¶

Name	Value	Description
class	CosineAntenna
display	i=device/antennatower

Source code¶

//
// Models a hypothetical antenna with a cosine-based radiation pattern.
// This antenna model is commonly used in the real world to approximate
// various directional antennas.
//
// Gain is computed from the angle as follows:
// <pre>
//   exponent = -3 / (20 * log10(cos(beamWidth) / 4))
//   gain = maxGain * abs(cos(angle / 2)) ^ exponent
// </pre>
// This module represents the cosine antenna model found in
//
// Li Chunjian, "Efficient Antenna Patterns for Three-Sector WCDMA Systems",
// eq. B.1 and B.2
//
module CosineAntenna extends AntennaBase
{
    parameters:
        double maxGain @unit(dB);    // Gain at the antenna boresight
        double beamWidth @unit(deg); // 3dB beam width
        @class(CosineAntenna);
}

File: src/inet/physicallayer/wireless/common/antenna/CosineAntenna.ned