Skip to content

Commit c861e1c

Browse files
animeshsri14tomhenderson
authored andcommitted
propagation: clarify Cost231 frequency validity and default usage
propagation: simplify Cost231 Frequency attribute documentation propagation: simplify Cost231 Frequency attribute documentation
1 parent 0077dda commit c861e1c

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

src/propagation/model/cost231-propagation-loss-model.cc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Cost231PropagationLossModel::GetTypeId()
3939
MakeDoubleAccessor(&Cost231PropagationLossModel::m_lambda),
4040
MakeDoubleChecker<double>())
4141
.AddAttribute("Frequency",
42-
"The Frequency (default is 2.3 GHz).",
42+
"Carrier Frequency.",
4343
DoubleValue(2.3e9),
4444
MakeDoubleAccessor(&Cost231PropagationLossModel::m_frequency),
4545
MakeDoubleChecker<double>())

src/propagation/model/cost231-propagation-loss-model.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@ namespace ns3
3535
* Base station Antenna Height: 30m to 200m
3636
* Link Distance:up to 20 km
3737
*
38+
* @note Although the classical COST-231 model has been empirically validated
39+
* in the 1500 MHz to 2000 MHz frequency range, the ns-3 implementation
40+
* historically defaults to 2.3 GHz due to its original use in WiMAX studies.
41+
* Users are advised to consciously select the carrier frequency appropriate
42+
* for their scenario and to exercise caution when operating far outside the
43+
* classical validity range.
3844
*/
3945

4046
class Cost231PropagationLossModel : public PropagationLossModel

0 commit comments

Comments
 (0)