A Discrete-Event Network Simulator
API
uan-noise-model-default.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 University of Washington
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Leonard Tracy <lentracy@gmail.com>
19  */
20 
22 #include "ns3/double.h"
23 
24 #include <cmath>
25 
26 namespace ns3 {
27 
28 NS_OBJECT_ENSURE_REGISTERED (UanNoiseModelDefault);
29 
31 {
32 
33 }
34 
36 {
37 }
38 
39 TypeId
41 {
42  static TypeId tid = TypeId ("ns3::UanNoiseModelDefault")
44  .SetGroupName ("Uan")
45  .AddConstructor<UanNoiseModelDefault> ()
46  .AddAttribute ("Wind", "Wind speed in m/s.",
47  DoubleValue (1),
49  MakeDoubleChecker<double> (0))
50  .AddAttribute ("Shipping", "Shipping contribution to noise between 0 and 1.",
51  DoubleValue (0),
53  MakeDoubleChecker<double> (0,1))
54  ;
55  return tid;
56 }
57 
58 // Common acoustic noise formulas. These can be found
59 // in "Priniciples of Underwater Sound" by Robert J. Urick
60 double
62 {
63  double turb, wind, ship, thermal;
64  double turbDb, windDb, shipDb, thermalDb, noiseDb;
65 
66  turbDb = 17.0 - 30.0 * std::log10 (fKhz);
67  turb = std::pow (10.0, turbDb * 0.1);
68 
69  shipDb = 40.0 + 20.0 * (m_shipping - 0.5) + 26.0 * std::log10 (fKhz) - 60.0 * std::log10 (fKhz + 0.03);
70  ship = std::pow (10.0, (shipDb * 0.1));
71 
72  windDb = 50.0 + 7.5 * std::pow (m_wind, 0.5) + 20.0 * std::log10 (fKhz) - 40.0 * std::log10 (fKhz + 0.4);
73  wind = std::pow (10.0, windDb * 0.1);
74 
75  thermalDb = -15 + 20 * std::log10 (fKhz);
76  thermal = std::pow (10, thermalDb * 0.1);
77 
78  noiseDb = 10 * std::log10 (turb + ship + wind + thermal);
79 
80  return noiseDb;
81 }
82 
83 } // namespace ns3
Standard ambient acoustic noise model.
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
double m_shipping
Shipping contribution to noise between 0 and 1.
double m_wind
Wind speed in m/s.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
static TypeId GetTypeId(void)
Register this type.
UAN Noise Model base class.
virtual double GetNoiseDbHz(double fKhz) const
Compute the noise power at a given frequency.
Ptr< const AttributeAccessor > MakeDoubleAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: double.h:42
virtual ~UanNoiseModelDefault()
Dummy destructor, DoDispose.
This class can be used to hold variables of floating point type such as &#39;double&#39; or &#39;float&#39;...
Definition: double.h:41
a unique identifier for an interface.
Definition: type-id.h:58
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:915
UanNoiseModelDefault()
Default constructor.