unison/src/antenna/model/cosine-antenna-model.cc

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2011 CTTC
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Nicola Baldo <nbaldo@cttc.es>
 */


#include <ns3/log.h>
#include <ns3/double.h>
#include <cmath>

#include "antenna-model.h"
#include "cosine-antenna-model.h"


namespace ns3 {

NS_LOG_COMPONENT_DEFINE ("CosineAntennaModel");

NS_OBJECT_ENSURE_REGISTERED (CosineAntennaModel);


TypeId
CosineAntennaModel::GetTypeId ()
{
  static TypeId tid = TypeId ("ns3::CosineAntennaModel")
    .SetParent<AntennaModel> ()
    .SetGroupName ("Antenna")
    .AddConstructor<CosineAntennaModel> ()
    .AddAttribute ("VerticalBeamwidth",
                   "The 3 dB vertical beamwidth (degrees). A beamwidth of 360 deg corresponds to constant gain",
                   DoubleValue (360),
                   MakeDoubleAccessor (&CosineAntennaModel::SetVerticalBeamwidth,
                                       &CosineAntennaModel::GetVerticalBeamwidth),
                   MakeDoubleChecker<double> (0, 360))
    .AddAttribute ("HorizontalBeamwidth",
                   "The 3 dB horizontal beamwidth (degrees). A beamwidth of 360 deg corresponds to constant gain",
                   DoubleValue (120),
                   MakeDoubleAccessor (&CosineAntennaModel::SetHorizontalBeamwidth,
                                       &CosineAntennaModel::GetHorizontalBeamwidth),
                   MakeDoubleChecker<double> (0, 360))
    .AddAttribute ("Orientation",
                   "The angle (degrees) that expresses the orientation of the antenna on the x-y plane relative to the x axis",
                   DoubleValue (0.0),
                   MakeDoubleAccessor (&CosineAntennaModel::SetOrientation,
                                       &CosineAntennaModel::GetOrientation),
                   MakeDoubleChecker<double> (-360, 360))
    .AddAttribute ("MaxGain",
                   "The gain (dB) at the antenna boresight (the direction of maximum gain)",
                   DoubleValue (0.0),
                   MakeDoubleAccessor (&CosineAntennaModel::m_maxGain),
                   MakeDoubleChecker<double> ())
  ;
  return tid;
}


double
CosineAntennaModel::GetExponentFromBeamwidth (double beamwidthDegrees)
{
  NS_LOG_FUNCTION (beamwidthDegrees);

  // The formula in obtained by inverting the power pattern P(alpha) in a single direction,
  // while imposing that P(alpha0/2) = 0.5 = -3 dB, with respect to the exponent
  // See CosineAntennaModel::GetGainDb for more information.
  //
  // The undetermined case of alpha0=360 is treated separately.
  double exponent;
  if (beamwidthDegrees == 360.0)
  {
    exponent = 0.0;
  }
  else
  {
    exponent = -3.0 / (20 * std::log10 (std::cos (DegreesToRadians (beamwidthDegrees / 4.0))));
  }

  return exponent;
}


double
CosineAntennaModel::GetBeamwidthFromExponent (double exponent)
{
  NS_LOG_FUNCTION (exponent);

  // The formula in obtained by inverting the power pattern P(alpha) in a single direction,
  // while imposing that P(alpha0/2) = 0.5 = -3 dB, with respect to the beamwidth.
  // See CosineAntennaModel::GetGainDb for more information.
  double beamwidthRadians = 4 * std::acos (std::pow (0.5, 1 / (2 * exponent)));
  return RadiansToDegrees (beamwidthRadians);
}


void
CosineAntennaModel::SetVerticalBeamwidth (double verticalBeamwidthDegrees)
{
  NS_LOG_FUNCTION (this << verticalBeamwidthDegrees);
  m_verticalExponent = GetExponentFromBeamwidth (verticalBeamwidthDegrees);
}


void
CosineAntennaModel::SetHorizontalBeamwidth (double horizontalBeamwidthDegrees)
{
  NS_LOG_FUNCTION (this << horizontalBeamwidthDegrees);
  m_horizontalExponent = GetExponentFromBeamwidth (horizontalBeamwidthDegrees);
}


double
CosineAntennaModel::GetVerticalBeamwidth () const
{
  return GetBeamwidthFromExponent (m_verticalExponent);
}


double
CosineAntennaModel::GetHorizontalBeamwidth () const
{
  return GetBeamwidthFromExponent (m_horizontalExponent);
}


void
CosineAntennaModel::SetOrientation (double orientationDegrees)
{
  NS_LOG_FUNCTION (this << orientationDegrees);
  m_orientationRadians = DegreesToRadians (orientationDegrees);
}


double
CosineAntennaModel::GetOrientation () const
{
  return RadiansToDegrees (m_orientationRadians);
}


double
CosineAntennaModel::GetGainDb (Angles a)
{
  NS_LOG_FUNCTION (this << a);

  // make sure phi is in (-pi, pi]
  a.SetAzimuth (a.GetAzimuth () - m_orientationRadians);

  NS_LOG_LOGIC (a);

  // The element power gain is computed as a product of cosine functions on the two axis
  // The power pattern of the element is equal to:
  // P(az,el) = cos(az/2)^2m * cos(pi/2 - incl/2)^2n,
  // where az is the azimuth angle, and incl is the inclination angle.
  double gain = (std::pow (std::cos (a.GetAzimuth () / 2), 2 * m_horizontalExponent)) *
                (std::pow (std::cos ((M_PI / 2 - a.GetInclination ()) / 2), 2 * m_verticalExponent));
  double gainDb = 10 * std::log10 (gain);
  
  NS_LOG_LOGIC ("gain = " << gainDb << " + " << m_maxGain << " dB");
  return gainDb + m_maxGain;
}


}