NeQuickIonoNavData.hpp

Go to the documentation of this file.

//==============================================================================
//
//  This file is part of GNSSTk, the ARL:UT GNSS Toolkit.
//
//  The GNSSTk is free software; you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published
//  by the Free Software Foundation; either version 3.0 of the License, or
//  any later version.
//
//  The GNSSTk 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 Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with GNSSTk; if not, write to the Free Software Foundation,
//  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin.
//  Copyright 2004-2022, The Board of Regents of The University of Texas System
//
//==============================================================================
 
 
//==============================================================================
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin, under contract to an agency or agencies
//  within the U.S. Department of Defense. The U.S. Government retains all
//  rights to use, duplicate, distribute, disclose, or release this software.
//
//  Pursuant to DoD Directive 523024
//
//  DISTRIBUTION STATEMENT A: This software has been approved for public
//                            release, distribution is unlimited.
//
//==============================================================================
#ifndef GNSSTK_NEQUICKIONODATA_HPP
#define GNSSTK_NEQUICKIONODATA_HPP
 
#include "IonoNavData.hpp"
#include "CivilTime.hpp"
#include "CCIR.hpp"
#include "MODIP.hpp"
#include "GalileoIonoEllipsoid.hpp"
#include "DebugTrace.hpp"
 
/*
 * ALL EQUATION AND SECTION REFERENCES ARE TO THE DOCUMENT
 * "Ionospheric Correction Algorithm for Galileo Single Frequency Users"
 * aka "Galileo Ionospheric Model"
 * UNLESS OTHERWISE STATED
 */
 
// forward declaration of test class
class NeQuickIonoNavData_T;
 
namespace gnsstk
{
 
 
   class NeQuickIonoNavData : public IonoNavData
   {
   public:
      NeQuickIonoNavData();
 
      bool validate() const override
      { return true; }
 
      void dump(std::ostream& s, DumpDetail dl) const override;
 
      double getIonoCorr(const CommonTime& when,
                         const Position& rxgeo,
                         const Position& svgeo,
                         CarrierBand band) const override;
 
      double getTEC(const CommonTime& when,
                    const Position& rxgeo,
                    const Position& svgeo) const;
 
      double ai[3];
         // These are technically Galileo-specific terms, and they
         // seem to be as yet unused according to the ICD (section
         // 5.1.6, "reserved for future use"), however until such time
         // as we have a situation where we use an NeQuick model that
         // does NOT use this data, I'm leaving it here so it only
         // needs to be defined once.
      bool idf[5]; 
 
      static double neExp(double x);
 
   protected:
      double getEffIonoLevel(double modip_u) const;
 
      class ModelParameters
      {
      public:
         ModelParameters(double modip_u, const Position& pos, double az,
                         CCIR& ccirData, const CivilTime& when);
 
         static AngleReduced solarDeclination(const CivilTime& when);
 
         static Angle solarZenithAngle(const Position& pos,
                                       const CivilTime& when);
 
         static Angle effSolarZenithAngle(const Position& pos,
                                          const CivilTime& when);
 
         void legendre(double modip_u, const Position& pos);
 
         void height();
 
         void thickness();
 
         void exosphereAdjust(unsigned month);
 
         void peakAmplitudes();
 
         static inline double epstein(double x, double y, double z, double w);
 
         static inline double solarGetLongitude(const CivilTime& when);
 
         double electronDensity(const Position& pos);
 
         double electronDensityTop(const Position& pos);
 
         double electronDensityBottom(const Position& pos);
 
         CCIR &ccir;      
         double fAzr;     
         double ffoE;     
         double fNmE;     
         double fBEtop;   
         double fA[3];    
            // hmE and BEbot are constants.
         double ffoF1;    
         double fNmF1;    
         double fhmF1;    
         double fB1top;   
         double fB1bot;   
         double ffoF2;    
         double fNmF2;    
         double fhmF2;    
         double fB2bot;   
         double fM3000F2; 
         double fH0;      
         Angle fXeff;     
 
      private:
         ModelParameters(CCIR& ccirData);
 
         friend class ::NeQuickIonoNavData_T;
      };
 
      class IntegrationParameters
      {
      public:
         IntegrationParameters(const Position& rx, const Position& sv,
                               const Position& Pp, bool vertical);
         std::vector<double> integHeights;
         std::vector<double> intThresh;
      };
 
      double getSED(double dist, const Position& rxgeo, const Position& svgeo,
                    const MODIP& modip, CCIR& ccirData, const CivilTime& when,
                    double azu)
         const;
 
      double getVED(double dist, const Position& rxgeo, const Position& svgeo,
                    double modip_u, CCIR& ccirData, const CivilTime& when,
                    double azu)
         const;
 
      double integrateGaussKronrod(double heightPt1, double heightPt2,
                                   const Position& rxgeo, const Position& svgeo,
                                   const MODIP& modip, double modipSta,
                                   CCIR& ccirData,
                                   const CivilTime& when, double azu,
                                   double tolerance, bool vertical,
                                   unsigned recursionLevel = 0)
         const;
 
      GalileoIonoEllipsoid elModel;
 
   private:
      static constexpr double DEGREE_PER_HOUR = 15.0;
 
      friend class ::NeQuickIonoNavData_T;
   };
 
   double NeQuickIonoNavData::ModelParameters ::
   epstein(double x, double y, double z, double w)
   {
      DEBUGTRACE_FUNCTION();
      DEBUGTRACE("thickness_param=" << std::scientific << z);
      DEBUGTRACE("height_km=" << std::scientific << w);
      DEBUGTRACE("pPeak->height_km=" << std::scientific << y);
      double tmp = exp((w-y)/z);
      DEBUGTRACE("electron_density (1)=" << std::scientific << tmp);
      double rv = (x*tmp) / ((1+tmp)*(1+tmp));                          //eq.3
      DEBUGTRACE("electron_density (2)=" << std::scientific << rv);
      return rv;
   }
 
   double NeQuickIonoNavData::ModelParameters ::
   solarGetLongitude(const CivilTime& when)
   {
         // eq.4, sort of.
      return (DEGREE_PER_HOUR * when.getUTHour() - 180.0) * DEG2RAD;
   }
 
 
}
 
#endif // GNSSTK_NEQUICKIONODATA_HPP