VcstCmnGeoEclipse.h

Go to the documentation of this file.

/*****************************************************************************
 *
 * NAME:  VcstCmnGeoEclipse
 *
 * DESCRIPTION: Common Geolocation Eclipse object class.
 *
 * Adapted directly from ProSdrCmnGeoEclipse.h developed by Raytheon Company.
 *
 * REFERENCES:
 * Meeus, Jean, "Astronomical Algorithms, 2nd Edition," Willman-Bell Inc,
 * Richmond VA, 1998, 477 pp.
 *
 *
 *****************************************************************************/
 
#ifndef VcstCmnGeoEclipse_h
#define VcstCmnGeoEclipse_h
 
#include <iomanip>
#include <iostream>
 
class VcstCmnGeoEclipse {
public:
 
    VcstCmnGeoEclipse();
 
    VcstCmnGeoEclipse(const VcstCmnGeoEclipse &data);
 
    VcstCmnGeoEclipse& operator=(const VcstCmnGeoEclipse &data);
 
    virtual ~VcstCmnGeoEclipse();
 
    void calcLunarEclipse(const double kFactor);
 
    void calcSolarEclipse(const double kFactor);
 
    /* inline */
    double getTAI() const;
 
    bool getEclipseFlag() const;
 
    double getEclipseBegin() const;
 
    double getEclipseEnd() const;
 
    friend std::ostream& operator<<(std::ostream &strm,
            const VcstCmnGeoEclipse &eclipse);
protected:
 
    double calcT(const double kFactor);
 
    double calcTjdPhase();
 
    double calcMoonArgLat();
 
    double calcSunMeanAnom();
 
    double calcMoonMeanAnom();
 
    double calcMoonLongAscNode();
 
    double calcEarthEccen();
 
    double calcF1(const double moonArgLat, const double moonLAN);
 
    double calcA1();
 
    double calcP(const double earthEccen, const double sunMeanAnom,
            const double moonMeanAnom, const double F1);
 
    double calcQ(const double earthEccen, const double sunMeanAnom,
            const double moonMeanAnom);
 
    double calcGamma(const double P, const double Q, const double F1);
 
    double calcU(const double earthEccen, const double sunMeanAnom,
            const double moonMeanAnom);
 
    double normalizeAngle(const double angle) const;
 
    double convertTJDtoTAI(const double tjd) const;
 
    double convertTAItoTJD(const double inTAI) const;
 
private:
 
    double taiPhase_;
 
    bool eclipseFlag_;
 
    double eclipseBegin_;
 
    double eclipseEnd_;
 
    double kFactor_;
 
    double tjdPhase_;
 
    double tjdCent_;
 
    double tjdCentSqd_;
 
    double tjdCentCube_;
 
    double tjdCentTo4_;
 
    //------------------------------------------------------------------------
    // Define the constants used in the Meeus algorithms for calculating
    // eclipses.  These constants come from Meeus (see reference above),
    // Ch. 49, pages 349-350, and Ch. 54, pages 379-388.
    //------------------------------------------------------------------------
 
    // Eq (49.3), pg 350
    static const double LUNATIONS_PER_CENT;
 
    // Constants for the calculation of mean lunar phase, Eq (49.1), pg 349
    static const double TJD_PHASE_C1;
    static const double TJD_PHASE_C2;
    static const double TJD_PHASE_C3;
 
    // Constants for Moon's argument of latitude, Eq (49.6), pg 350
    static const double MOON_ARG_LAT_C1;
    static const double MOON_ARG_LAT_C2;
    static const double MOON_ARG_LAT_C3;
    static const double MOON_ARG_LAT_C4;
    static const double MOON_ARG_LAT_C5;
 
    // Constants for Sun's mean anomaly, Eq (49.4), pg 350
    static const double SUN_MEAN_ANOM_C1;
    static const double SUN_MEAN_ANOM_C2;
    static const double SUN_MEAN_ANOM_C3;
    static const double SUN_MEAN_ANOM_C4;
 
    // Constants for Moon's mean anomaly, Eq (49.5), pg 350
    static const double MOON_MEAN_ANOM_C1;
    static const double MOON_MEAN_ANOM_C2;
    static const double MOON_MEAN_ANOM_C3;
    static const double MOON_MEAN_ANOM_C4;
    static const double MOON_MEAN_ANOM_C5;
 
    // Constants for Moon's longitude of ascending node, Eq (49.7), pg. 350
    static const double MOON_LAN_C1;
    static const double MOON_LAN_C2;
    static const double MOON_LAN_C3;
    static const double MOON_LAN_C4;
 
    // Critical value of Moon's argument of latitude (F) for eclipse to exist
    // Meeus pg. 380
    static const double CRIT_SIN_F;
 
    // Constants for Earth's orbital eccentricity, Eq (47.6), pg. 338
    static const double EARTH_ECCEN_C1;
    static const double EARTH_ECCEN_C2;
 
    // Constants used for calculation of F1 and A1 parameters, pg. 380.
    static const double F1_ADJUST;
    static const double A1_C1;
    static const double A1_C2;
    static const double A1_C3;
 
    // Constants used in the calculation of "P" and "Q", pg. 381.
    static const double P_C1;
    static const double P_C2;
    static const double P_C3;
    static const double P_C4;
    static const double P_C5;
    static const double P_C6;
    static const double P_C7;
    static const double Q_C1;
    static const double Q_C2;
    static const double Q_C3;
    static const double Q_C4;
    static const double Q_C5;
    static const double Q_C6;
 
    // Constants used in the calculation of "gamma" and "u", pg. 381
    static const double GAMMA_C1;
    static const double U_C1;
    static const double U_C2;
    static const double U_C3;
    static const double U_C4;
    static const double U_C5;
 
    // Constants used to calculate magnitude of eclipses
    static const double LUNAR_MAG_C1;
    static const double LUNAR_MAG_C2;
    static const double SOLAR_MAG_C1;
 
    // Constants used to calculate time of maximum eclipse
    static const double MAX_ECL_C1_LUNAR;
    static const double MAX_ECL_C2_LUNAR;
    static const double MAX_ECL_C1_SOLAR;
    static const double MAX_ECL_C2_SOLAR;
    static const double MAX_ECL_C3;
    static const double MAX_ECL_C4;
    static const double MAX_ECL_C5;
    static const double MAX_ECL_C6;
    static const double MAX_ECL_C7;
    static const double MAX_ECL_C8;
    static const double MAX_ECL_C9;
    static const double MAX_ECL_C10;
    static const double MAX_ECL_C11;
    static const double MAX_ECL_C12;
    static const double MAX_ECL_C13;
    static const double MAX_ECL_C14;
    static const double MAX_ECL_C15;
    static const double MAX_ECL_C16;
 
    // Constants used to calculate semidurations of eclipse
    static const double LUNAR_SD_C1;
    static const double LUNAR_SD_C2;
    static const double LUNAR_SD_C3;
    static const double SOLAR_WORST_SD;
};
 
//---------------------------------------------------------------------------
// inline functions
//---------------------------------------------------------------------------
 
inline double VcstCmnGeoEclipse::getTAI() const {
    return taiPhase_;
}
 
inline std::ostream& operator<<(std::ostream &strm,
        const VcstCmnGeoEclipse &eclipse) {
    strm << "k=" << eclipse.kFactor_ << std::endl << std::fixed
            << std::setprecision(5) << "  tjdPhase = " << eclipse.tjdPhase_
            << ", " << "  taiPhase = " << eclipse.taiPhase_ << std::endl
            << "  eclipseFlag = " << eclipse.eclipseFlag_ << std::endl
            << "  begin = " << eclipse.eclipseBegin_ << ", " << "  end = "
            << eclipse.eclipseEnd_ << std::endl;
    return strm;
}
 
#endif