OceanLoadTides.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 CLASS_OCEANLOADING_INCLUDE
#define CLASS_OCEANLOADING_INCLUDE
 
//------------------------------------------------------------------------------------
// system includes
#include <map>
#include <string>
#include <vector>
// GNSSTk
#include "EphTime.hpp"
#include "Exception.hpp"
#include "Triple.hpp"
 
//------------------------------------------------------------------------------------
namespace gnsstk
{
   class OceanLoadTides
   {
   public:
      OceanLoadTides(){};
 
      int initializeSites(std::vector<std::string>& sites,
                          std::string filename);
 
      bool isValid(std::string site)
      {
         return (coefficientMap.find(site) != coefficientMap.end());
      }
 
      Triple computeDisplacement11(std::string site, EphTime t);
 
      Triple computeDisplacement(std::string site, EphTime t);
 
      Triple getPosition(std::string site)
      {
         Triple t(0.0, 0.0, 0.0);
         std::map<std::string, std::vector<double>>::const_iterator it;
         it = positionMap.find(site);
         if (it != positionMap.end())
         {
            t[0] = it->second[0];
            t[1] = it->second[1];
         }
         return t;
      }
 
   private:
      // Compute the astronomical angular arguments for each of the 11 tidal
      // modes. Ref IERS 1996 pg 53.
      // void SchwiderskiArg(int iyear, int doy, double sod, double* angles)
      //;
 
      std::map<std::string, std::vector<double>> coefficientMap;
 
      std::map<std::string, std::vector<double>> positionMap;
 
      typedef struct
      {
         int n[6];
      } NVector;
 
      static const int NSTD;
 
      static const int NDER;
 
      int deriveTides(const NVector SchTides[], const double amp[],
                      const double phs[], const double Dood[],
                      const double freqDood[], double ampDer[], double phsDer[],
                      double freq[], const int Nin);
 
   }; // end class OceanLoadTides
 
} // end namespace gnsstk
 
#endif // nothing below this