kscomet.cpp

/*
    SPDX-FileCopyrightText: 2001 Jason Harris <jharris@30doradus.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#include "kscomet.h"
 
#include "ksnumbers.h"
#include "kstarsdata.h"
 
#include <QDir>
 
namespace
{
int letterToNum(QChar c)
{
    char l = c.toLatin1();
    if (l < 'A' || l > 'Z' || l == 'I')
        return 0;
    if (l > 'I')
        return l - 'A';
    return l - 'A' + 1;
}
// Convert letter designation like "AZ" to number.
int letterDesigToN(QString s)
{
    int n = 0;
    foreach (const QChar &c, s)
    {
        int nl = letterToNum(c);
        if (nl == 0)
            return 0;
        n = n * 25 + nl;
    }
    return n;
}
 
QMap<QChar, qint64> cometType;
}
 
KSComet::KSComet(const QString &_s, const QString &imfile, double _q, double _e, dms _i, dms _w,
                 dms _Node, double Tp, float _M1, float _M2, float _K1, float _K2)
    : KSPlanetBase(_s, imfile), q(_q), e(_e), M1(_M1), M2(_M2), K1(_K1), K2(_K2), i(_i), w(_w), N(_Node)
{
    setType(SkyObject::COMET);
 
    //Find the Julian Day of Perihelion from Tp
    //Tp is a double which encodes a date like: YYYYMMDD.DDDDD (e.g., 19730521.33333
    //    int year    = int(Tp / 10000.0);
    //    int month   = int((int(Tp) % 10000) / 100.0);
    //    int day     = int(int(Tp) % 100);
    //    double Hour = 24.0 * (Tp - int(Tp));
    //    int h       = int(Hour);
    //    int m       = int(60.0 * (Hour - h));
    //    int s       = int(60.0 * (60.0 * (Hour - h) - m));
 
    //JDp   = KStarsDateTime(QDate(year, month, day), QTime(h, m, s)).djd();
 
    // JM 2021.10.21: In the new JPL format, it's already in JD
    JDp = Tp;
 
    //compute the semi-major axis, a:
    if (e == 1)
        a = 0;
    else
        a = q / (1.0 - e);
 
 
    //Compute the orbital Period from Kepler's 3rd law:
    P = 365.2568984 * pow(a, 1.5); //period in days
 
    //If the name contains a "/", make this name2 and make name a truncated version without the leading "P/" or "C/"
    // 2017-10-03 Jasem: We should keep the full name
    /*if (name().contains(QDir::separator()))
    {
        setLongName(name());
        setName(name().replace("P/", " ").trimmed());
        setName(name().remove("C/"));
    }*/
 
    // Try to calculate UID for comets. It's derived from comet designation.
    // To parse name string regular expressions are used. Not really readable.
    // And its make strong assumptions about format of comets' names.
    // Probably come better algorithm should be used.
 
    // Periodic comet. Designation like: 12P or 12P-C
    QRegularExpression rePerReg("^(\\d+)[PD](-([A-Z]+))?");
    QRegularExpressionMatch rePer = rePerReg.match(_s);
    if (rePer.hasMatch())
    {
        // Comet number
        qint64 num = rePer.captured(1).toInt();
        // Fragment number
        qint64 fragmentN = letterDesigToN(rePer.captured(2));
        // Set UID
        uidPart = num << 16 | fragmentN;
        return;
    }
 
    // Non periodic comet or comets with single approach
    // Designations like C/(2006 A7)
    QRegularExpression reProReg("^([PCXDA])/.*\\((\\d{4}) ([A-Z])(\\d+)(-([A-Z]+))?\\)");
    QRegularExpressionMatch rePro = reProReg.match(_s);
    if (rePro.hasMatch())
    {
        // Fill comet type
        if (cometType.empty())
        {
            cometType.insert('P', 0);
            cometType.insert('C', 1);
            cometType.insert('X', 2);
            cometType.insert('D', 3);
            cometType.insert('A', 4);
        }
        qint64 type       = cometType[rePro.captured(1).at(0)]; // Type of comet
        qint64 year       = rePro.captured(2).toInt();       // Year of discovery
        qint64 halfMonth  = letterToNum(rePro.captured(3).at(0));
        qint64 nHalfMonth = rePro.captured(4).toInt();
        qint64 fragment   = letterDesigToN(rePro.captured(6));
 
        uidPart = 1LL << 43 | type << 40 | // Bits 40-42 (3)
                  halfMonth << 33 |        // Bits 33-39 (7) Hope this is enough
                  nHalfMonth << 28 |       // Bits 28-32 (5)
                  year << 16 |             // Bits 16-27 (12)
                  fragment;                // Bits 0-15  (16)
        return;
    }
    // qDebug() << Q_FUNC_INFO << "Didn't get it: " << _s;
}
 
KSComet *KSComet::clone() const
{
    Q_ASSERT(typeid(this) == typeid(static_cast<const KSComet *>(this))); // Ensure we are not slicing a derived class
    return new KSComet(*this);
}
 
void KSComet::findPhysicalParameters()
{
    // Compute and store the estimated Physical size of the comet's coma, tail and nucleus
    // References:
    // * https://www.projectpluto.com/update7b.htm#comet_tail_formula [Project Pluto / GUIDE]
    // * http://articles.adsabs.harvard.edu//full/1978BAICz..29..103K/0000113.000.html [Kresak, 1978a, "Passages of comets and asteroids near the earth"]
    NuclearSize   = pow(10, 2.1 - 0.2 * M1);
    double mHelio = M1 + K1 * log10(rsun());
    double L0, D0, L, D;
    L0       = pow(10, -0.0075 * mHelio * mHelio - 0.19 * mHelio + 2.10);
    D0       = pow(10, -0.0033 * mHelio * mHelio - 0.07 * mHelio + 3.25);
    L        = L0 * (1 - pow(10, -4 * rsun())) * (1 - pow(10, -2 * rsun()));
    D        = D0 * (1 - pow(10, -2 * rsun())) * (1 - pow(10, -rsun()));
    TailSize = L * 1e6;
    ComaSize = D * 1e3;
    setPhysicalSize(ComaSize);
}
 
bool KSComet::findGeocentricPosition(const KSNumbers *num, const KSPlanetBase *Earth)
{
    // All elements are in the heliocentric ecliptic J2000 reference frame.
 
    double v(0.0), r(0.0);
 
    // Different between lastJD and Tp (Time of periapsis (Julian Day Number))
    long double deltaJDP = lastPrecessJD - JDp;
 
    if (e > 0.98)
    {
        //Use near-parabolic approximation
        double k = 0.01720209895; //Gauss gravitational constant
        double a = 0.75 * (deltaJDP) * k * sqrt((1 + e) / (q * q * q));
        double b = sqrt(1.0 + a * a);
        double W = pow((b + a), 1.0 / 3.0) - pow((b - a), 1.0 / 3.0);
        double c = 1.0 + 1.0 / (W * W);
        double f = (1.0 - e) / (1.0 + e);
        double g = f / (c * c);
 
        double a1 = (2.0 / 3.0) + (2.0 * W * W / 5.0);
        double a2 = (7.0 / 5.0) + (33.0 * W * W / 35.0) + (37.0 * W * W * W * W / 175.0);
        double a3 = W * W * ((432.0 / 175.0) + (956.0 * W * W / 1125.0) + (84.0 * W * W * W * W / 1575.0));
        double w  = W * (1.0 + g * c * (a1 + a2 * g + a3 * g * g));
 
        v = 2.0 * atan(w) / dms::DegToRad;
        r = q * (1.0 + w * w) / (1.0 + w * w * f);
    }
    else
    {
        //Use normal ellipse method
        //Determine Mean anomaly for desired date. deltaJDP is the difference between current JD minus JD of comet epoch.
        // In JPL data, the Modified Julian Day is given to designate the epoch of comet data, which we convert to JD.
        // Check http://astro.if.ufrgs.br/trigesf/position.html#17 for more details
 
        dms m = dms(double(360.0 * (deltaJDP) / P)).reduce();
        double sinm, cosm;
        m.SinCos(sinm, cosm);
 
        //compute eccentric anomaly:
        double E = m.Degrees() + e * 180.0 / dms::PI * sinm * (1.0 + e * cosm);
 
        if (e > 0.005) //need more accurate approximation, iterate...
        {
            double E0;
            int iter(0);
            do
            {
                E0 = E;
                iter++;
                E = E0 - (E0 - e * 180.0 / dms::PI * sin(E0 * dms::DegToRad) - m.Degrees()) /
                    (1 - e * cos(E0 * dms::DegToRad));
            }
            while (fabs(E - E0) > 0.001 && iter < 1000);
        }
 
        // Assert that the solution of the Kepler equation E = M + e sin E is accurate to about 0.1 arcsecond
        //Q_ASSERT( fabs( E - ( m.Degrees() + ( e * 180.0 / dms::PI ) * sin( E * dms::DegToRad ) ) ) < 0.10/3600.0 );
 
        double sinE, cosE;
        dms E1(E);
        E1.SinCos(sinE, cosE);
 
        double xv = a * (cosE - e);
        double yv = a * sqrt(1.0 - e * e) * sinE;
 
        //v is the true anomaly in degrees
        v = atan2(yv, xv) / dms::DegToRad;
        // Comet-Sun Heliocentric Distance in AU
        r = sqrt(xv * xv + yv * yv);
    }
 
    //Precess the longitude of the Ascending Node to the desired epoch
    // i, w, and N are supplied in J2000 Epoch from JPL
    // http://astro.if.ufrgs.br/trigesf/position.html#16
    //dms n = dms(double(N.Degrees() + 3.82394E-5 * (lastPrecessJD - J2000))).reduce();
 
    //vw is the sum of the true anomaly and the argument of perihelion
    dms vw(v + w.Degrees());
 
    double sinN, cosN, sinvw, cosvw, sini, cosi;
 
    // Get sin's and cos's for:
    // Longitude of ascending node
    N.SinCos(sinN, cosN);
    // sum of true anomaly and argument of perihelion
    vw.SinCos(sinvw, cosvw);
    // Inclination
    i.SinCos(sini, cosi);
 
    //xh, yh, zh are the heliocentric cartesian coords with the ecliptic plane congruent with zh=0.
    double xh = r * (cosN * cosvw - sinN * sinvw * cosi);
    double yh = r * (sinN * cosvw + cosN * sinvw * cosi);
    double zh = r * (sinvw * sini);
 
    //the spherical ecliptic coordinates:
    double ELongRad = atan2(yh, xh);
    double ELatRad  = atan2(zh, r);
 
    helEcPos.longitude.setRadians(ELongRad);
    helEcPos.longitude.reduceToRange(dms::ZERO_TO_2PI);
    helEcPos.latitude.setRadians(ELatRad);
    setRsun(r);
 
    //xe, ye, ze are the Earth's heliocentric cartesian coords
    double cosBe, sinBe, cosLe, sinLe;
    Earth->ecLong().SinCos(sinLe, cosLe);
    Earth->ecLat().SinCos(sinBe, cosBe);
 
    double xe = Earth->rsun() * cosBe * cosLe;
    double ye = Earth->rsun() * cosBe * sinLe;
    double ze = Earth->rsun() * sinBe;
 
    //convert to geocentric ecliptic coordinates by subtracting Earth's coords:
    xh -= xe;
    yh -= ye;
    zh -= ze;
 
    //Finally, the spherical ecliptic coordinates:
    ELongRad  = atan2(yh, xh);
    double rr = sqrt(xh * xh + yh * yh);
    ELatRad   = atan2(zh, rr);
 
    ep.longitude.setRadians(ELongRad);
    ep.longitude.reduceToRange(dms::ZERO_TO_2PI);
    ep.latitude.setRadians(ELatRad);
    setRearth(Earth);
 
    // Now convert to geocentric equatorial coords
    EclipticToEquatorial(num->obliquity());
 
    // JM 2017-09-10: The calculations above produce J2000 RESULTS
    // So we have to precess as well
    setRA0(ra());
    setDec0(dec());
    apparentCoord(J2000, lastPrecessJD);
    findPhysicalParameters();
 
    return true;
}
 
// m = M1 + 2.5 * K1 * log10(rsun) + 5 * log10(rearth)
void KSComet::findMagnitude(const KSNumbers *)
{
    setMag(M1 + 2.5 * K1 * log10(rsun()) +  5 * log10(rearth()));
}
 
void KSComet::setEarthMOID(double earth_moid)
{
    EarthMOID = earth_moid;
}
 
void KSComet::setAlbedo(float albedo)
{
    Albedo = albedo;
}
 
void KSComet::setDiameter(float diam)
{
    Diameter = diam;
}
 
void KSComet::setDimensions(QString dim)
{
    Dimensions = dim;
}
 
void KSComet::setNEO(bool neo)
{
    NEO = neo;
}
 
void KSComet::setOrbitClass(QString orbit_class)
{
    OrbitClass = orbit_class;
}
 
void KSComet::setOrbitID(QString orbit_id)
{
    OrbitID = orbit_id;
}
 
void KSComet::setPeriod(float per)
{
    Period = per;
}
 
void KSComet::setRotationPeriod(float rot_per)
{
    RotationPeriod = rot_per;
}
 
//Unused virtual function from KSPlanetBase
bool KSComet::loadData()
{
    return false;
}
 
SkyObject::UID KSComet::getUID() const
{
    return solarsysUID(UID_SOL_COMET) | uidPart;
}