From 70764840d187a569c0649285c18c8123016482da Mon Sep 17 00:00:00 2001 From: "Peter D. Barnes, Jr" Date: Fri, 15 May 2020 13:25:20 -0700 Subject: [PATCH] mob: mob: Clarify RandomDiscPositionAllocator behavior. --- src/mobility/model/position-allocator.h | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/src/mobility/model/position-allocator.h b/src/mobility/model/position-allocator.h index 7c001bdea..a1efc78a9 100644 --- a/src/mobility/model/position-allocator.h +++ b/src/mobility/model/position-allocator.h @@ -279,8 +279,16 @@ private: /** * \ingroup mobility - * \brief Allocate random positions within a disc according to a given distribution for the polar coordinates of each node - with respect to the provided center of the disc + * \brief Allocate random positions within a disc according to + * a given distribution for the polar coordinates of each node + * with respect to the provided center of the disc. + * + * \note With the default uniform distribution over \f$2 \pi\f$ in \c theta and a + * uniform distribution for \c rho this position allocator will *not* + * uniformly populate the disc. The radial distribution will be proportional + * to \f$\frac{1}{r^2}\f$. + * + * To get a uniform distribution over a circle use the UniformDiscPositionAllocator. */ class RandomDiscPositionAllocator : public PositionAllocator { @@ -329,7 +337,7 @@ private: /** * \ingroup mobility - * \brief Allocate the positions uniformely (with constant density) randomly within a disc. + * \brief Allocate the positions uniformly (with constant density) randomly within a disc. * * UniformDiscPositionAllocator allocates the positions randomly within a disc \f$ D \f$ lying on the * plane \f$ z\f$ and having center at coordinates \f$ (x,y,z) \f$