sgp4.hpp

Go to the documentation of this file.

#ifndef PERTURB_SGP4_HPP
#define PERTURB_SGP4_HPP
// clang-format off
/*     ----------------------------------------------------------------
*
*                                 SGP4.h
*
*    this file contains the sgp4 procedures for analytical propagation
*    of a satellite. the code was originally released in the 1980 and 1986
*    spacetrack papers. a detailed discussion of the theory and history
*    may be found in the 2006 aiaa paper by vallado, crawford, hujsak,
*    and kelso.
*
*    current :
*              12 mar 20  david vallado
*                           chg satnum to string for alpha 5 or 9-digit
*    changes :
*               7 dec 15  david vallado
*                           fix jd, jdfrac
*               3 nov 14  david vallado
*                           update to msvs2013 c++
*              30 Dec 11  david vallado
*                           consolidate updated code version
*              30 Aug 10  david vallado
*                           delete unused variables in initl
*                           replace pow inetger 2, 3 with multiplies for speed
*               3 Nov 08  david vallado
*                           put returns in for error codes
*              29 sep 08  david vallado
*                           fix atime for faster operation in dspace
*                           add operationmode for afspc (a) or improved (i)
*                           performance mode
*              20 apr 07  david vallado
*                           misc fixes for constants
*              11 aug 06  david vallado
*                           chg lyddane choice back to strn3, constants, misc doc
*              15 dec 05  david vallado
*                           misc fixes
*              26 jul 05  david vallado
*                           fixes for paper
*                           note that each fix is preceded by a
*                           comment with "sgp4fix" and an explanation of
*                           what was changed
*              10 aug 04  david vallado
*                           2nd printing baseline working
*              14 may 01  david vallado
*                           2nd edition baseline
*                     80  norad
*                           original baseline
*       ----------------------------------------------------------------      */
 
 
// Define `PERTURB_SGP4_ENABLE_DEBUG` to enable Vallado's verification mode.
// Generally, this is unwanted. Only enabled for tests.
#if (defined(PERTURB_SGP4_ENABLE_DEBUG) && defined(PERTURB_DISABLE_IO))
#error "Cannot enable SGP4 debug without I/O functionality"
#endif
 
// NOLINTBEGIN(cppcoreguidelines-avoid-magic-numbers, readability-magic-numbers
// NOLINTBEGIN(readability-avoid-const-params-in-decls)
 
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define PERTURB_SGP4_SGP4Version  "SGP4 Version 2020-07-13"
 
namespace perturb {
 
namespace sgp4 {
 
// -------------------------- structure declarations ----------------------------
typedef enum   // NOLINT(modernize-use-using)
{
  wgs72old,
  wgs72,
  wgs84
} gravconsttype;
 
typedef struct elsetrec  // NOLINT(modernize-use-using,altera-struct-pack-align)
{
  char      satnum[6];
  int       epochyr, epochtynumrev;
  int       error;
  char      operationmode;
  char      init, method;
 
  /* Near Earth */
  int    isimp;
  double aycof  , con41  , cc1    , cc4      , cc5    , d2      , d3   , d4    ,
         delmo  , eta    , argpdot, omgcof   , sinmao , t       , t2cof, t3cof ,
         t4cof  , t5cof  , x1mth2 , x7thm1   , mdot   , nodedot, xlcof , xmcof ,
         nodecf;
 
  /* Deep Space */
  int    irez;
  double d2201  , d2211  , d3210  , d3222    , d4410  , d4422   , d5220 , d5232 ,
         d5421  , d5433  , dedt   , del1     , del2   , del3    , didt  , dmdt  ,
         dnodt  , domdt  , e3     , ee2      , peo    , pgho    , pho   , pinco ,
         plo    , se2    , se3    , sgh2     , sgh3   , sgh4    , sh2   , sh3   ,
         si2    , si3    , sl2    , sl3      , sl4    , gsto    , xfact , xgh2  ,
         xgh3   , xgh4   , xh2    , xh3      , xi2    , xi3     , xl2   , xl3   ,
         xl4    , xlamo  , zmol   , zmos     , atime  , xli     , xni;
 
  double a, altp, alta, epochdays, jdsatepoch, jdsatepochF, nddot, ndot,
         bstar, rcse, inclo, nodeo, ecco, argpo, mo, no_kozai;
  // sgp4fix add new variables from tle
  char  classification, intldesg[11];
  int   ephtype;
  long  elnum    , revnum;
  // sgp4fix add unkozai'd variable
  double no_unkozai;
  // sgp4fix add singly averaged variables
  double am     , em     , im     , Om       , om     , mm      , nm;
  // sgp4fix add constant parameters to eliminate mutliple calls during execution
  double tumin, mus, radiusearthkm, xke, j2, j3, j4, j3oj2;
 
  //       Additional elements to capture relevant TLE and object information:
  long dia_mm; // RSO dia in mm
  double period_sec; // Period in seconds
  unsigned char active; // "Active S/C" flag (0=n, 1=y)
  unsigned char not_orbital; // "Orbiting S/C" flag (0=n, 1=y)
  double rcs_m2; // "RCS (m^2)" storage
 
} elsetrec;
 
 
// namespace SGP4Funcs
// {
 
    //  public class SGP4Class
    //  {
 
    bool sgp4init
        (
        gravconsttype whichconst, char opsmode, const char satn[5], const double epoch,
        const double xbstar, const double xndot, const double xnddot, const double xecco, const double xargpo,
        const double xinclo, const double xmo, const double xno,
        const double xnodeo, elsetrec& satrec
        );
 
    bool sgp4
        (
        // no longer need gravconsttype whichconst, all data contained in satrec
        elsetrec& satrec, double tsince,
        double r[3], double v[3]
        );
 
    void getgravconst
        (
        gravconsttype whichconst,
        double& tumin,
        double& mus,
        double& radiusearthkm,
        double& xke,
        double& j2,
        double& j3,
        double& j4,
        double& j3oj2
        );
 
#ifndef PERTURB_DISABLE_IO
    // older sgp4io methods
    void twoline2rv
        (
        char      longstr1[130], char longstr2[130],
        char      typerun, char typeinput, char opsmode,
        gravconsttype       whichconst,
        double& startmfe, double& stopmfe, double& deltamin,
        elsetrec& satrec
        );
#endif  // PERTURB_DISABLE_IO
 
    // older sgp4ext methods
    double  gstime_SGP4
        (
        double jdut1
        );
 
    double  sgn_SGP4
        (
        double x
        );
 
    double  mag_SGP4
        (
        double x[3]
        );
 
    void    cross_SGP4
        (
        double vec1[3], double vec2[3], double outvec[3]
        );
 
    double  dot_SGP4
        (
        double x[3], double y[3]
        );
 
    double  angle_SGP4
        (
        double vec1[3],
        double vec2[3]
        );
 
    void    newtonnu_SGP4
        (
        double ecc, double nu,
        double& e0, double& m
        );
 
    double  asinh_SGP4
        (
        double xval
        );
 
    void    rv2coe_SGP4
        (
        double r[3], double v[3], double mus,
        double& p, double& a, double& ecc, double& incl, double& omega, double& argp,
        double& nu, double& m, double& arglat, double& truelon, double& lonper
        );
 
    void    jday_SGP4
        (
        int year, int mon, int day, int hr, int minute, double sec,
        double& jd, double& jdFrac
        );
 
    void    days2mdhms_SGP4
        (
        int year, double days,
        int& mon, int& day, int& hr, int& minute, double& sec
        );
 
    void    invjday_SGP4
        (
        double jd, double jdFrac,
        int& year, int& mon, int& day,
        int& hr, int& minute, double& sec
        );
 
 
// }  // namespace
 
}  // namespace sgp4
}  // namespace perturb
 
// NOLINTEND(cppcoreguidelines-avoid-magic-numbers, readability-magic-numbers
// NOLINTEND(readability-avoid-const-params-in-decls)
// clang-format on
 
#endif  // PERTURB_SGP4_HPP