Add BuildingPropagationLossModel User documentation and minor changes to design one
--- a/src/lte/doc/source/conf.py Thu Sep 08 16:08:20 2011 +0200
+++ b/src/lte/doc/source/conf.py Fri Sep 09 11:44:31 2011 +0200
@@ -184,6 +184,7 @@
#('lte', 'lte-sim-doc.tex', u'LTE Simulator Documentation', u'Centre Tecnològic de Telecomunicacions de Catalunya (CTTC)', 'manual'),
('lte-pathloss-design', 'lte-pathloss-design.tex', u'LTE Simulator Pathloss Desing Documentation', u'Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)', 'manual'),
('lte-pathloss-testing', 'lte-pathloss-testing.tex', u'LTE Simulator Pathloss Testing Documentation', u'Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)', 'manual'),
+ ('lte-building-user', 'lte-building-user.tex', u'LTE Simulator Building Propagation User Documentation', u'Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/lte/doc/source/lte-building-user.rst Fri Sep 09 11:44:31 2011 +0200
@@ -0,0 +1,109 @@
+.. include:: replace.txt
+
+
+++++++++++++++++++++++++++++++++++++++++++++++++++++++
+ User Building Propagation & Mobility Model Documentation
+++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+
+Background
+**********
+
+
+
+We assume the reader is already familiar with how to use the ns-3
+simulator to run generic simulation programs. If this is not the case,
+we strongly recommend the reader to consult [ns3tutorial]_.
+
+
+Usage Overview
+**************
+
+The ns-3 LTE model is a software library that allows the simulation of
+LTE networks. The process of performing such simulations typically involves the following
+steps:
+
+ 1. *Define the scenario* to be simulated
+ 2. *Write a simulation program* that recreates the desired scenario
+ topology/architecture. This is done accessing the ns-3 LTE model
+ libraryusing the ``ns3::LenaHelper`` API defined in ``src/lte/helper/lena-helper.h``.
+ 3. *Specify configuration parameters* of the objects that are being
+ used for the simulation. This can be done using input files (via the
+ ``ns3::ConfigStore``) or directly within the simulation program.
+ 4. *Configure the desired output* to be produced by the simulator
+ 5. *Run* the simulation.
+
+All these aspects will be explained in the following sections by means
+of practical examples.
+
+
+
+Basic simulation program
+------------------------
+
+In what following, a few guidelines for the usage of the ``BuildingMobilityModel`` and the ``BuildingPropagationModel`` classes.
+
+.. highlight:: none
+
+#. Inheritance::
+
+ #include <ns3/buildings-mobility-model.h>
+ #include <ns3/buildings-propagation-loss-model.h>
+ #include <ns3/building.h>
+
+#. Propagation model selection
+
+ Ptr<LenaHelper> lena = CreateObject<LenaHelper> ();
+
+ lena->SetAttribute ("PropagationModel", StringValue ("ns3::BuildingsPropagationLossModel"));
+
+#. Mobility model selection
+
+ MobilityHelper mobility;
+ mobility.SetMobilityModel ("ns3::BuildingsMobilityModel");
+
+#. Node creation and positioning
+
+ ueNodes.Create (1);
+ mobility.Install (ueNodes);
+ NetDeviceContainer ueDevs;
+ ueDevs = lena->InstallUeDevice (ueNodes);
+ Ptr<BuildingsMobilityModel> mm = enbNodes.Get (0)->GetObject<BuildingsMobilityModel> ();
+ double x_axis = 0.0;
+ double y_axis = 0.0;
+ double z_axis = 0.0;
+ mm->SetPosition (Vector (x_axis, y_axis, z_axis));
+
+#. Building creation
+
+ double x_min = 0.0;
+ double x_max = 10.0;
+ double y_min = 0.0;
+ double y_max = 20.0;
+ double z_min = 0.0;
+ double z_max = 10.0;
+ Ptr<Building> building = Create<Building> (x_min, x_max, y_min, y_max, z_min, z_max);
+ building->SetBuildingType (Building::Residential);
+ building->SetExtWallsType (Building::ConcreteWithWindows);
+ building->SetFloorsNumber (3);
+ building->SetNumberRoomX (3);
+ building->SetNumberRoomY (2);
+
+ This will instantiate a residential building with base of 10 x 20 meters and height of 10 meters with concrete with windows as external walls, three floors and a grid of rooms of 3 x 2.
+
+#. Building and nodes interactions
+
+ mm->SetIndoor (building);
+ mm->SetFloorNumber (2);
+
+ This informs node's mobility model the fact that the node is inside the building at the second floor. It has to be noted that the simulator does not check the consistence between the node's position and the bulding site, which is user's responsibility.
+
+
+
+
+
+
+
+
+
+
--- a/src/lte/doc/source/lte-pathloss-design.rst Thu Sep 08 16:08:20 2011 +0200
+++ b/src/lte/doc/source/lte-pathloss-design.rst Fri Sep 09 11:44:31 2011 +0200
@@ -398,9 +398,9 @@
The shadowing is modeled according to a log-normal distribution with variable standard deviation as function of the connection characteristics. In the implementation we considered three main possible scenarios which correspond to three standard deviations (i.e., the mean is always 0), in detail:
- * outdoor (defaul value of 7 dB) :math:`\rightarrow X_\mathrm{O} \sim N(\mu_\mathrm{O}, \sigma_\mathrm{O}^2)`.
- * indoor (defaul value of 10 dB) :math:`\rightarrow X_\mathrm{I} \sim N(\mu_\mathrm{I}, \sigma_\mathrm{I}^2)`.
- * external walls penetration (default value 5 dB) :math:`\rightarrow X_\mathrm{W} \sim N(\mu_\mathrm{W}, \sigma_\mathrm{W}^2)`
+ * outdoor (``m_shadowingSigmaOutdoor``, defaul value of 7 dB) :math:`\rightarrow X_\mathrm{O} \sim N(\mu_\mathrm{O}, \sigma_\mathrm{O}^2)`.
+ * indoor (``m_shadowingSigmaIndoor``, defaul value of 10 dB) :math:`\rightarrow X_\mathrm{I} \sim N(\mu_\mathrm{I}, \sigma_\mathrm{I}^2)`.
+ * external walls penetration (``m_shadowingSigmaExtWalls``, default value 5 dB) :math:`\rightarrow X_\mathrm{W} \sim N(\mu_\mathrm{W}, \sigma_\mathrm{W}^2)`
The simulator generates a shadowing value per each active link according to nodes' position the first time the link is used for transmitting. In case of transmissions from outdoor nodes to indoor ones, and vice-versa, the standard deviation (:math:`\sigma_\mathrm{IO}`) has to be calculated as the square root of the sum of the quadratic values of the standard deviatio in case of outdoor nodes and the one for the external walls penetration. This is due to the fact that that the components producing the shadowing are independent of each other; therefore, the variance of a distribution resulting from the sum of two independent normal ones is the sum of the variances.