BackgroundCell

compound module

This module implements a lightweight model for a 4G eNodeB or 5G gNodeB. It is used to generate configurable inter-cell interference in the simulated network. Compared to the eNodeB and gNodeB modules, this module occupies time-frequency resources in both the uplink and downlink bandwidth without simulating the actual transmission or reception of data packets to or from User Equipments (UEs). Therefore, it is significantly more efficient from a simulation speed perspective. To achieve this, it includes a BackgroundTrafficGenerator to customize the level of background traffic to be simulated, a BackgroundChannelModel to configure channel parameters, and a BackgroundScheduler that manages the allocation of time-frequency resources based on the traffic generator. Note that this module can generate interference on only one Component Carrier, as configured in the BackgroundScheduler module. To produce interference across multiple carriers, it is possible to use multiple instances of this module, each configured with the desired carrier frequency.

For further details, refer to: G. Nardini, G. Stea, A. Virdis, "Scalable Real-time Emulation of 5G Networks with Simu5G", IEEE Access, vol. 9, pp. 148504-148520, 2021

Usage diagram

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Used in

Name	Type	Description
ExtClientServer_bgCells	network	ExtClientServer_bgCells

Properties

Name	Value	Description
display	i=device/antennatower;bgb=430,163

Unassigned submodule parameters

Name	Type	Default value	Description
mobility.subjectModule	string	"^"	module path which determines the subject module, the motion of which this mobility model describes, the default value is the parent module
mobility.coordinateSystemModule	string	""	module path of the geographic coordinate system module
mobility.displayStringTextFormat	string	"p: %p\nv: %v"	format string for the mobility module's display string text
mobility.updateDisplayString	bool	true	enables continuous update of the subject module's position via modifying its display string
mobility.constraintAreaMinX	double	-inf m	min x position of the constraint area, unconstrained by default (negative infinity)
mobility.constraintAreaMinY	double	-inf m	min y position of the constraint area, unconstrained by default (negative infinity)
mobility.constraintAreaMinZ	double	-inf m	min z position of the constraint area, unconstrained by default (negative infinity)
mobility.constraintAreaMaxX	double	inf m	max x position of the constraint area, unconstrained by default (positive infinity)
mobility.constraintAreaMaxY	double	inf m	max y position of the constraint area, unconstrained by default (positive infinity)
mobility.constraintAreaMaxZ	double	inf m	max z position of the constraint area, unconstrained by default (positive infinity)
mobility.initialX	double	uniform(this.constraintAreaMinX, this.constraintAreaMaxX)
mobility.initialY	double	uniform(this.constraintAreaMinY, this.constraintAreaMaxY)
mobility.initialZ	double	nanToZero(uniform(this.constraintAreaMinZ, this.constraintAreaMaxZ))
mobility.initialLatitude	double	nan deg
mobility.initialLongitude	double	nan deg
mobility.initialAltitude	double	0m
mobility.initialHeading	double	0deg
mobility.initialElevation	double	0deg
mobility.initialBank	double	0deg
mobility.initFromDisplayString	bool	true	enables one time initialization from the subject module's display string
mobility.updateFromDisplayString	bool	true	enables continuous update from the subject module's display string for dragging and rotating it
bgChannelModel.binderModule	string	"binder"	modules
bgChannelModel.shadowing	bool	true	Enable/disable shadowing
bgChannelModel.scenario	string	"URBAN_MACROCELL"	Pathloss scenario from ITU -->
bgChannelModel.nodeb_height	double	25m	eNodeB height -->
bgChannelModel.building_height	double	20m	Building height -->
bgChannelModel.inside_building	bool	false	determines if the UE is inside a building
bgChannelModel.street_wide	double	20m	TODO width
bgChannelModel.ue_height	double	1.5m
bgChannelModel.tolerateMaxDistViolation	bool	false
bgChannelModel.correlation_distance	double	50m
bgChannelModel.antennaGainUe	double	0dBi	Antenna Gain of UE --> wrt an isotropic antenna
bgChannelModel.antennGainEnB	double	18dBi	Antenna Gain of eNodeB -->
bgChannelModel.antennGainMicro	double	5dBi	Antenna Gain of Micro node -->
bgChannelModel.thermalNoise	double	-104.5dBm	Thermal Noise for 10 MHz of Bandwidth -->
bgChannelModel.ue_noise_figure	double	7dBm	Ue noise figure -->
bgChannelModel.bs_noise_figure	double	5dBm	eNodeB noise figure -->
bgChannelModel.cable_loss	double	2dB	Cable Loss -->
bgChannelModel.dynamic_los	bool	false	If true enable the possibility to switch dinamically the LOS/NLOS pathloss computation -->
bgChannelModel.fixed_los	bool	false	If dynamic-los is false this parameter, if true, compute LOS pathloss otherwise compute NLOS pathloss -->
bgChannelModel.fading	bool	true	Enable/disable fading -->
bgChannelModel.fading_type	string	"JAKES"	Fading type (JAKES or RAYLEIGH) -->
bgChannelModel.fading_paths	int	6	If jakes fading this parameter specify the number of path (tap channel) -->
bgChannelModel.delay_rms	double	363ns
bgChannelModel.bgCell_interference	bool	true	if true, enables the inter-cell interference computation for UL and DL connections from background cells -->
bgChannelModel.downlink_interference	bool	true	if true, enables the inter-cell interference computation for DL connections -->
bgChannelModel.uplink_interference	bool	true	if true, enables the interference computation for UL connections -->
bgScheduler.binderModule	string	"binder"
bgScheduler.channelModelModule	string	"^.bgChannelModel"
bgScheduler.txPower	double	46dBm	transmission power
bgScheduler.txDirection	string	"OMNI"	transmission direction
bgScheduler.txAngle	double	0deg	transmission angle
bgScheduler.isNr	bool	false	flag to indicate whether this is a NR base station
bgScheduler.numerologyIndex	int	0	operating carrier
bgScheduler.carrierFrequency	double	2GHz	operating carrier
bgScheduler.numBands	int	6	carrier bandwidth

Source code

//
// This module implements a lightweight model for a 4G eNodeB or 5G gNodeB. It is used to generate
// configurable inter-cell interference in the simulated network. Compared to the ~eNodeB and ~gNodeB
// modules, this module occupies time-frequency resources in both the uplink and downlink bandwidth
// without simulating the actual transmission or reception of data packets to or from User Equipments (UEs).
// Therefore, it is significantly more efficient from a simulation speed perspective.
// To achieve this, it includes a ~BackgroundTrafficGenerator to customize the level of background
// traffic to be simulated, a ~BackgroundChannelModel to configure channel parameters, and a
// ~BackgroundScheduler that manages the allocation of time-frequency resources based on the traffic
// generator.
// Note that this module can generate interference on only one Component Carrier, as configured
// in the ~BackgroundScheduler module. To produce interference across multiple carriers, it is
// possible to use multiple instances of this module, each configured with the desired carrier frequency.
//
// For further details, refer to:
//     G. Nardini, G. Stea, A. Virdis, "Scalable Real-time Emulation of 5G Networks with Simu5G",
//     IEEE Access, vol. 9, pp. 148504-148520, 2021
//
module BackgroundCell
{
    parameters:
        @display("i=device/antennatower;bgb=430,163");

    submodules:
        // mobility module for the background base station
        mobility: StationaryMobility {
            @display("p=100,38;is=s");
        }

        // channel model for the background cell
        bgChannelModel: BackgroundCellChannelModel {
            @display("p=100,105;is=s");
        }

        // perform the scheduling for the BackgroundCell
        bgScheduler: BackgroundScheduler {
            @display("p=222,38,row");
            trafficManagerModule = "^.bgTrafficGenerator.manager";
        }

        // traffic generator for the background UEs within the BackgroundCell
        bgTrafficGenerator: BackgroundTrafficGenerator {
            @display("p=347,38,row");
            manager.typename = default("BackgroundCellTrafficManager");
        }
}

File: src/nodes/backgroundCell/BackgroundCell.ned