A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
test-uniform-planar-array.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2020 University of Padova, Dep. of Information Engineering, SIGNET lab.
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 */
6
7#include "cmath"
8#include "iostream"
9#include "sstream"
10#include "string"
11
12#include "ns3/double.h"
13#include "ns3/isotropic-antenna-model.h"
14#include "ns3/log.h"
15#include "ns3/pointer.h"
16#include "ns3/simulator.h"
17#include "ns3/test.h"
18#include "ns3/three-gpp-antenna-model.h"
19#include "ns3/uinteger.h"
20#include "ns3/uniform-planar-array.h"
21
22using namespace ns3;
23
24NS_LOG_COMPONENT_DEFINE("TestUniformPlanarArray");
25
26/**
27 * @ingroup antenna-tests
28 *
29 * @brief UniformPlanarArray Test Case
30 */
31class UniformPlanarArrayTestCase : public TestCase
32{
33 public:
34 /**
35 * Generate a string containing all relevant parameters
36 * @param element the antenna element
37 * @param rows the number of rows
38 * @param cols the number of columns
39 * @param rowSpace the row spacing
40 * @param colSpace the column spacing
41 * @param alpha the bearing angle
42 * @param beta the tilting angle
43 * @param direction the direction
44 * @return the string containing all relevant parameters
45 */
46 static std::string BuildNameString(Ptr<AntennaModel> element,
47 uint32_t rows,
48 uint32_t cols,
49 double rowSpace,
50 double colSpace,
51 double alpha,
52 double beta,
53 Angles direction);
54 /**
55 * The constructor of the test case
56 * @param element the antenna element
57 * @param rows the number of rows
58 * @param cols the number of columns
59 * @param rowSpace the row spacing
60 * @param colSpace the column spacing
61 * @param alpha the bearing angle
62 * @param beta the tilting angle
63 * @param direction the direction
64 * @param expectedGainDb the expected antenna gain [dB]
65 */
66 UniformPlanarArrayTestCase(Ptr<AntennaModel> element,
67 uint32_t rows,
68 uint32_t cols,
69 double rowSpace,
70 double colSpace,
71 double alpha,
72 double beta,
73 Angles direction,
74 double expectedGainDb);
75
76 private:
77 /**
78 * Run the test
79 */
80 void DoRun() override;
81 /**
82 * Compute the gain of the antenna array
83 * @param a the antenna array
84 * @return the gain of the antenna array [dB]
85 */
86 double ComputeGain(Ptr<UniformPlanarArray> a);
87
88 Ptr<AntennaModel> m_element; //!< the antenna element
89 uint32_t m_rows; //!< the number of rows
90 uint32_t m_cols; //!< the number of columns
91 double m_rowSpace; //!< the row spacing
92 double m_colSpace; //!< the column spacing
93 double m_alpha; //!< the bearing angle [rad]
94 double m_beta; //!< the titling angle [rad]
95 Angles m_direction; //!< the testing direction
96 double m_expectedGain; //!< the expected antenna gain [dB]
97};
98
99std::string
100UniformPlanarArrayTestCase::BuildNameString(Ptr<AntennaModel> element,
101 uint32_t rows,
102 uint32_t cols,
103 double rowSpace,
104 double colSpace,
105 double alpha,
106 double beta,
107 Angles direction)
108{
109 std::ostringstream oss;
110 oss << "UPA=" << rows << "x" << cols << ", row spacing=" << rowSpace << "*lambda"
111 << ", col spacing=" << colSpace << "*lambda"
112 << ", bearing=" << RadiansToDegrees(alpha) << " deg"
113 << ", tilting=" << RadiansToDegrees(beta) << " deg"
114 << ", element=" << element->GetInstanceTypeId().GetName() << ", direction=" << direction;
115 return oss.str();
116}
117
118UniformPlanarArrayTestCase::UniformPlanarArrayTestCase(Ptr<AntennaModel> element,
119 uint32_t rows,
120 uint32_t cols,
121 double rowSpace,
122 double colSpace,
123 double alpha,
124 double beta,
125 Angles direction,
126 double expectedGainDb)
127 : TestCase(BuildNameString(element, rows, cols, rowSpace, colSpace, alpha, beta, direction)),
128 m_element(element),
129 m_rows(rows),
130 m_cols(cols),
131 m_rowSpace(rowSpace),
132 m_colSpace(colSpace),
133 m_alpha(alpha),
134 m_beta(beta),
135 m_direction(direction),
136 m_expectedGain(expectedGainDb)
137{
138}
139
140double
141UniformPlanarArrayTestCase::ComputeGain(Ptr<UniformPlanarArray> a)
142{
143 // compute gain
144 PhasedArrayModel::ComplexVector sv = a->GetSteeringVector(m_direction);
145 NS_TEST_EXPECT_MSG_EQ(sv.GetSize(), a->GetNumElems(), "steering vector of wrong size");
146 PhasedArrayModel::ComplexVector bf = a->GetBeamformingVector(m_direction);
147 NS_TEST_EXPECT_MSG_EQ(bf.GetSize(), a->GetNumElems(), "beamforming vector of wrong size");
148 std::pair<double, double> fp = a->GetElementFieldPattern(m_direction);
149
150 // scalar product dot (sv, bf)
151 std::complex<double> prod{0};
152 for (size_t i = 0; i < sv.GetSize(); i++)
153 {
154 prod += sv[i] * bf[i];
155 }
156 double bfGain = std::pow(std::abs(prod), 2);
157 double bfGainDb = 10 * std::log10(bfGain);
158
159 // power gain from two polarizations
160 double elementPowerGain = std::pow(std::get<0>(fp), 2) + std::pow(std::get<1>(fp), 2);
161 double elementPowerGainDb = 10 * std::log10(elementPowerGain);
162
163 // sum BF and element gains
164 return bfGainDb + elementPowerGainDb;
165}
166
167void
168UniformPlanarArrayTestCase::DoRun()
169{
170 NS_LOG_FUNCTION(this << BuildNameString(m_element,
171 m_rows,
172 m_cols,
173 m_rowSpace,
174 m_colSpace,
175 m_alpha,
176 m_beta,
177 m_direction));
178
179 Ptr<UniformPlanarArray> a = CreateObject<UniformPlanarArray>();
180 a->SetAttribute("AntennaElement", PointerValue(m_element));
181 a->SetAttribute("NumRows", UintegerValue(m_rows));
182 a->SetAttribute("NumColumns", UintegerValue(m_cols));
183 a->SetAttribute("AntennaVerticalSpacing", DoubleValue(m_rowSpace));
184 a->SetAttribute("AntennaHorizontalSpacing", DoubleValue(m_colSpace));
185 a->SetAttribute("BearingAngle", DoubleValue(m_alpha));
186 a->SetAttribute("DowntiltAngle", DoubleValue(m_beta));
187
188 double actualGainDb = ComputeGain(a);
189 NS_TEST_EXPECT_MSG_EQ_TOL(actualGainDb,
190 m_expectedGain,
191 0.001,
192 "wrong value of the radiation pattern");
193}
194
195/**
196 * @ingroup antenna-tests
197 *
198 * @brief UpdateOnChange Test Case
199 */
200class UpdateOnChangeTestCase : public TestCase
201{
202 public:
203 /**
204 * The constructor of the test case
205 * @param element the antenna element
206 * @param name the test case name
207 */
208 UpdateOnChangeTestCase(Ptr<AntennaModel> element, std::string name)
209 : TestCase(name),
210 m_element(element){};
211
212 private:
213 /**
214 * Run the test
215 */
216 void DoRun() override;
217 Ptr<AntennaModel> m_element; //!< the antenna element
218};
219
220void
221UpdateOnChangeTestCase::DoRun()
222{
223 Ptr<UniformPlanarArray> ant = CreateObject<UniformPlanarArray>();
224 ant->SetAttribute("AntennaElement", PointerValue(m_element));
225 ant->SetAttribute("NumRows", UintegerValue(10));
226 ant->SetAttribute("NumColumns", UintegerValue(10));
227 ant->SetAttribute("AntennaVerticalSpacing", DoubleValue(0.5));
228 ant->SetAttribute("AntennaHorizontalSpacing", DoubleValue(0.5));
229 ant->SetAttribute("BearingAngle", DoubleValue(DegreesToRadians(0)));
230 ant->SetAttribute("DowntiltAngle", DoubleValue(DegreesToRadians(45)));
231
232 Ptr<UniformPlanarArray> ant2 = CreateObject<UniformPlanarArray>();
233 ant2->SetAttribute("AntennaElement", PointerValue(m_element));
234 ant2->SetAttribute("NumRows", UintegerValue(10));
235 ant2->SetAttribute("NumColumns", UintegerValue(10));
236 ant2->SetAttribute("AntennaVerticalSpacing", DoubleValue(0.5));
237 ant2->SetAttribute("AntennaHorizontalSpacing", DoubleValue(0.5));
238 ant2->SetAttribute("BearingAngle", DoubleValue(DegreesToRadians(0)));
239 ant2->SetAttribute("DowntiltAngle", DoubleValue(DegreesToRadians(45)));
240
241 NS_TEST_ASSERT_MSG_EQ(ant.operator bool(), true, "AntennaModel is not a PhasedArrayModel");
242
243 // Initial state of array requires a channel update
244 NS_TEST_ASSERT_MSG_EQ(ant->IsChannelOutOfDate(ant2),
245 true,
246 "Expecting update, since the pair was never setup");
247 NS_TEST_ASSERT_MSG_EQ(
248 ant2->IsChannelOutOfDate(ant),
249 false,
250 "Not expecting update, since the pair was just updated and no settings changed");
251 ant->SetAlpha(DegreesToRadians(90));
252 NS_TEST_ASSERT_MSG_EQ(ant2->IsChannelOutOfDate(ant),
253 true,
254 "Expecting update, antenna parameter changed");
255 NS_TEST_ASSERT_MSG_EQ(
256 ant->IsChannelOutOfDate(ant2),
257 false,
258 "Not expecting update, since the pair was just updated and no settings changed");
259 ant->SetAlpha(DegreesToRadians(90));
260 NS_TEST_ASSERT_MSG_EQ(ant->IsChannelOutOfDate(ant2),
261 true,
262 "Expecting update, antenna parameter changed");
263}
264
265/**
266 * @ingroup antenna-tests
267 *
268 * @brief UniformPlanarArray Test Suite
269 */
270class UniformPlanarArrayTestSuite : public TestSuite
271{
272 public:
273 UniformPlanarArrayTestSuite();
274};
275
276UniformPlanarArrayTestSuite::UniformPlanarArrayTestSuite()
277 : TestSuite("uniform-planar-array-test", Type::UNIT)
278{
279 Ptr<AntennaModel> isotropic = CreateObject<IsotropicAntennaModel>();
280 Ptr<AntennaModel> tgpp = CreateObject<ThreeGppAntennaModel>();
281
282 // element, rows, cols, rowSpace, colSpace, bearing,
283 // tilting, direction (azimuth,
284 // inclination), expectedGainDb
285 // Single element arrays: check if bearing/tilting works on antenna element
286 AddTestCase(new UniformPlanarArrayTestCase(isotropic,
287 1,
288 1,
289 0.5,
290 0.5,
291 DegreesToRadians(0),
292 DegreesToRadians(0),
293 Angles(DegreesToRadians(0), DegreesToRadians(90)),
294 0.0),
295 TestCase::Duration::QUICK);
296 AddTestCase(new UniformPlanarArrayTestCase(tgpp,
297 1,
298 1,
299 0.5,
300 0.5,
301 DegreesToRadians(0),
302 DegreesToRadians(0),
303 Angles(DegreesToRadians(0), DegreesToRadians(90)),
304 8.0),
305 TestCase::Duration::QUICK);
306 AddTestCase(new UniformPlanarArrayTestCase(tgpp,
307 1,
308 1,
309 0.5,
310 0.5,
311 DegreesToRadians(90),
312 DegreesToRadians(0),
313 Angles(DegreesToRadians(90), DegreesToRadians(90)),
314 8.0),
315 TestCase::Duration::QUICK);
316 AddTestCase(new UniformPlanarArrayTestCase(tgpp,
317 1,
318 1,
319 0.5,
320 0.5,
321 DegreesToRadians(-90),
322 DegreesToRadians(0),
323 Angles(DegreesToRadians(-90), DegreesToRadians(90)),
324 8.0),
325 TestCase::Duration::QUICK);
326 AddTestCase(new UniformPlanarArrayTestCase(tgpp,
327 1,
328 1,
329 0.5,
330 0.5,
331 DegreesToRadians(180),
332 DegreesToRadians(0),
333 Angles(DegreesToRadians(180), DegreesToRadians(90)),
334 8.0),
335 TestCase::Duration::QUICK);
336 AddTestCase(new UniformPlanarArrayTestCase(tgpp,
337 1,
338 1,
339 0.5,
340 0.5,
341 DegreesToRadians(-180),
342 DegreesToRadians(0),
343 Angles(DegreesToRadians(-180), DegreesToRadians(90)),
344 8.0),
345 TestCase::Duration::QUICK);
346 AddTestCase(new UniformPlanarArrayTestCase(tgpp,
347 1,
348 1,
349 0.5,
350 0.5,
351 DegreesToRadians(0),
352 DegreesToRadians(45),
353 Angles(DegreesToRadians(0), DegreesToRadians(135)),
354 8.0),
355 TestCase::Duration::QUICK);
356 AddTestCase(new UniformPlanarArrayTestCase(tgpp,
357 1,
358 1,
359 0.5,
360 0.5,
361 DegreesToRadians(0),
362 DegreesToRadians(-45),
363 Angles(DegreesToRadians(0), DegreesToRadians(45)),
364 8.0),
365 TestCase::Duration::QUICK);
366 AddTestCase(new UniformPlanarArrayTestCase(tgpp,
367 1,
368 1,
369 0.5,
370 0.5,
371 DegreesToRadians(0),
372 DegreesToRadians(90),
373 Angles(DegreesToRadians(0), DegreesToRadians(180)),
374 8.0),
375 TestCase::Duration::QUICK);
376 AddTestCase(new UniformPlanarArrayTestCase(tgpp,
377 1,
378 1,
379 0.5,
380 0.5,
381 DegreesToRadians(0),
382 DegreesToRadians(-90),
383 Angles(DegreesToRadians(0), DegreesToRadians(0)),
384 8.0),
385 TestCase::Duration::QUICK);
386
387 // linear array
388 AddTestCase(new UniformPlanarArrayTestCase(tgpp,
389 10,
390 1,
391 0.5,
392 0.5,
393 DegreesToRadians(0),
394 DegreesToRadians(0),
395 Angles(DegreesToRadians(0), DegreesToRadians(90)),
396 18.0),
397 TestCase::Duration::QUICK);
398 AddTestCase(new UniformPlanarArrayTestCase(tgpp,
399 10,
400 1,
401 0.5,
402 0.5,
403 DegreesToRadians(90),
404 DegreesToRadians(0),
405 Angles(DegreesToRadians(90), DegreesToRadians(90)),
406 18.0),
407 TestCase::Duration::QUICK);
408 AddTestCase(new UniformPlanarArrayTestCase(tgpp,
409 10,
410 1,
411 0.5,
412 0.5,
413 DegreesToRadians(0),
414 DegreesToRadians(45),
415 Angles(DegreesToRadians(0), DegreesToRadians(135)),
416 18.0),
417 TestCase::Duration::QUICK);
418
419 // planar array
420 AddTestCase(new UniformPlanarArrayTestCase(tgpp,
421 10,
422 10,
423 0.5,
424 0.5,
425 DegreesToRadians(0),
426 DegreesToRadians(0),
427 Angles(DegreesToRadians(0), DegreesToRadians(90)),
428 28.0),
429 TestCase::Duration::QUICK);
430 AddTestCase(new UniformPlanarArrayTestCase(tgpp,
431 10,
432 10,
433 0.5,
434 0.5,
435 DegreesToRadians(90),
436 DegreesToRadians(0),
437 Angles(DegreesToRadians(90), DegreesToRadians(90)),
438 28.0),
439 TestCase::Duration::QUICK);
440 AddTestCase(new UniformPlanarArrayTestCase(tgpp,
441 10,
442 10,
443 0.5,
444 0.5,
445 DegreesToRadians(0),
446 DegreesToRadians(45),
447 Angles(DegreesToRadians(0), DegreesToRadians(135)),
448 28.0),
449 TestCase::Duration::QUICK);
450 AddTestCase(new UpdateOnChangeTestCase(tgpp,
451 "Test IsChannelOutOfDate() and InvalidateChannels() for "
452 "UniformPlanarArray with 3GPP antenna element"),
453 TestCase::Duration::QUICK);
454}
455
456static UniformPlanarArrayTestSuite staticUniformPlanarArrayTestSuiteInstance;
UniformPlanarArrayTestCase
UniformPlanarArray Test Case.
Definition test-uniform-planar-array.cc:32
UniformPlanarArrayTestCase::m_expectedGain
double m_expectedGain
the expected antenna gain [dB]
Definition test-uniform-planar-array.cc:96
UniformPlanarArrayTestCase::m_element
Ptr< AntennaModel > m_element
the antenna element
Definition test-uniform-planar-array.cc:88
UniformPlanarArrayTestCase::m_colSpace
double m_colSpace
the column spacing
Definition test-uniform-planar-array.cc:92
UniformPlanarArrayTestCase::UniformPlanarArrayTestCase
UniformPlanarArrayTestCase(Ptr< AntennaModel > element, uint32_t rows, uint32_t cols, double rowSpace, double colSpace, double alpha, double beta, Angles direction, double expectedGainDb)
The constructor of the test case.
Definition test-uniform-planar-array.cc:118
UniformPlanarArrayTestCase::ComputeGain
double ComputeGain(Ptr< UniformPlanarArray > a)
Compute the gain of the antenna array.
Definition test-uniform-planar-array.cc:141
UniformPlanarArrayTestCase::m_direction
Angles m_direction
the testing direction
Definition test-uniform-planar-array.cc:95
UniformPlanarArrayTestCase::DoRun
void DoRun() override
Run the test.
Definition test-uniform-planar-array.cc:168
UniformPlanarArrayTestCase::m_cols
uint32_t m_cols
the number of columns
Definition test-uniform-planar-array.cc:90
UniformPlanarArrayTestCase::m_rows
uint32_t m_rows
the number of rows
Definition test-uniform-planar-array.cc:89
UniformPlanarArrayTestCase::BuildNameString
static std::string BuildNameString(Ptr< AntennaModel > element, uint32_t rows, uint32_t cols, double rowSpace, double colSpace, double alpha, double beta, Angles direction)
Generate a string containing all relevant parameters.
Definition test-uniform-planar-array.cc:100
UniformPlanarArrayTestCase::m_alpha
double m_alpha
the bearing angle [rad]
Definition test-uniform-planar-array.cc:93
UniformPlanarArrayTestCase::m_beta
double m_beta
the titling angle [rad]
Definition test-uniform-planar-array.cc:94
UniformPlanarArrayTestSuite
UniformPlanarArray Test Suite.
Definition test-uniform-planar-array.cc:271
UpdateOnChangeTestCase
UpdateOnChange Test Case.
Definition test-uniform-planar-array.cc:201
UpdateOnChangeTestCase::UpdateOnChangeTestCase
UpdateOnChangeTestCase(Ptr< AntennaModel > element, std::string name)
The constructor of the test case.
Definition test-uniform-planar-array.cc:208
UpdateOnChangeTestCase::m_element
Ptr< AntennaModel > m_element
the antenna element
Definition test-uniform-planar-array.cc:217
UpdateOnChangeTestCase::DoRun
void DoRun() override
Run the test.
Definition test-uniform-planar-array.cc:221
ns3::Angles
Class holding the azimuth and inclination angles of spherical coordinates.
Definition angles.h:107
ns3::DoubleValue
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition double.h:31
ns3::PointerValue
AttributeValue implementation for Pointer.
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition mpi-test-fixtures.h:37
ns3::TestCase
encapsulates test code
Definition test.h:1050
ns3::TestCase::AddTestCase
void AddTestCase(TestCase *testCase, Duration duration=Duration::QUICK)
Add an individual child TestCase to this test suite.
Definition test.cc:292
ns3::TestSuite
A suite of tests to run.
Definition test.h:1267
ns3::TestSuite::Type
Type
Type of test.
Definition test.h:1274
ns3::UintegerValue
Hold an unsigned integer type.
Definition uinteger.h:34
ns3::ValArray::GetSize
size_t GetSize() const
Definition val-array.h:394
uint32_t
NS_LOG_COMPONENT_DEFINE
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition log.h:191
NS_LOG_FUNCTION
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
Definition log-macros-enabled.h:229
ns3::CreateObject
Ptr< T > CreateObject(Args &&... args)
Create an object by type, with varying number of constructor parameters.
Definition object.h:619
NS_TEST_ASSERT_MSG_EQ
#define NS_TEST_ASSERT_MSG_EQ(actual, limit, msg)
Test that an actual and expected (limit) value are equal and report and abort if not.
Definition test.h:134
NS_TEST_EXPECT_MSG_EQ
#define NS_TEST_EXPECT_MSG_EQ(actual, limit, msg)
Test that an actual and expected (limit) value are equal and report if not.
Definition test.h:241
NS_TEST_EXPECT_MSG_EQ_TOL
#define NS_TEST_EXPECT_MSG_EQ_TOL(actual, limit, tol, msg)
Test that actual and expected (limit) values are equal to plus or minus some tolerance and report if ...
Definition test.h:500
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::DegreesToRadians
double DegreesToRadians(double degrees)
converts degrees to radians
Definition angles.cc:28
ns3::RadiansToDegrees
double RadiansToDegrees(double radians)
converts radians to degrees
Definition angles.cc:34
staticUniformPlanarArrayTestSuiteInstance
static UniformPlanarArrayTestSuite staticUniformPlanarArrayTestSuiteInstance
Definition test-uniform-planar-array.cc:456