src/Time/moonpos.cxx

   1 // moonpos.cxx (basically, this is a slightly modified version of the
   2 // 'sunpos.cxx' file, adapted from XEarth)
   3 //
   4 // kirk johnson
   5 // july 1993
   6 //
   7 // code for calculating the position on the earth's surface for which
   8 // the moon is directly overhead (adapted from _practical astronomy
   9 // with your calculator, third edition_, peter duffett-smith,
  10 // cambridge university press, 1988.)
  11 //
  12 // Copyright (C) 1989, 1990, 1993, 1994, 1995 Kirk Lauritz Johnson
  13 //
  14 // Parts of the source code (as marked) are:
  15 //   Copyright (C) 1989, 1990, 1991 by Jim Frost
  16 //   Copyright (C) 1992 by Jamie Zawinski <jwz@lucid.com>
  17 //
  18 // Permission to use, copy, modify and freely distribute xearth for
  19 // non-commercial and not-for-profit purposes is hereby granted
  20 // without fee, provided that both the above copyright notice and this
  21 // permission notice appear in all copies and in supporting
  22 // documentation.
  23 //
  24 // The author makes no representations about the suitability of this
  25 // software for any purpose. It is provided "as is" without express or
  26 // implied warranty.
  27 //
  28 // THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  29 // INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS,
  30 // IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, INDIRECT
  31 // OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  32 // LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
  33 // NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  34 // CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  35 //
  36 // $Id$
  37
  38
  39 #ifdef HAVE_CONFIG_H
  40 #  include <config.h>
  41 #endif
  42
  43 #include <simgear/compiler.h>
  44
  45 #ifdef SG_HAVE_STD_INCLUDES
  46 #  include <cmath>
  47 #  include <cstdio>
  48 #  include <ctime>
  49 #else
  50 #  include <math.h>
  51 #  include <stdio.h>
  52 #  include <time.h>
  53 #endif
  54
  55 #include <simgear/constants.h>
  56 #include <simgear/debug/logstream.hxx>
  57 #include <simgear/ephemeris/ephemeris.hxx>
  58 #include <simgear/math/point3d.hxx>
  59 #include <simgear/math/polar3d.hxx>
  60 #include <simgear/math/sg_geodesy.hxx>
  61 #include <simgear/math/vector.hxx>
  62
  63 #include <Main/globals.hxx>
  64 #include <Main/viewer.hxx>
  65 #include <Scenery/scenery.hxx>
  66 #include <Time/light.hxx>
  67
  68 #include "moonpos.hxx"
  69
  70 #undef E
  71
  72
  73 /*
  74  * the epoch upon which these astronomical calculations are based is
  75  * 1990 january 0.0, 631065600 seconds since the beginning of the
  76  * "unix epoch" (00:00:00 GMT, Jan. 1, 1970)
  77  *
  78  * given a number of seconds since the start of the unix epoch,
  79  * DaysSinceEpoch() computes the number of days since the start of the
  80  * astronomical epoch (1990 january 0.0)
  81  */
  82
  83 #define EpochStart           (631065600)
  84 #define DaysSinceEpoch(secs) (((secs)-EpochStart)*(1.0/(24*3600)))
  85
  86 /*
  87  * assuming the apparent orbit of the moon about the earth is circular,
  88  * the rate at which the orbit progresses is given by RadsPerDay --
  89  * SG_2PI radians per orbit divided by 365.242191 days per year:
  90  */
  91
  92 #define RadsPerDay (SG_2PI/365.242191)
  93
  94 /*
  95  * details of moon's apparent orbit at epoch 1990.0 (after
  96  * duffett-smith, table 6, section 46)
  97  *
  98  * Epsilon_g    (ecliptic longitude at epoch 1990.0) 279.403303 degrees
  99  * OmegaBar_g   (ecliptic longitude of perigee)      282.768422 degrees
 100  * Eccentricity (eccentricity of orbit)                0.016713
 101  */
 102
 103 #define Epsilon_g    (279.403303*(SGD_2PI/360))
 104 #define OmegaBar_g   (282.768422*(SGD_2PI/360))
 105 #define Eccentricity (0.016713)
 106
 107 /*
 108  * MeanObliquity gives the mean obliquity of the earth's axis at epoch
 109  * 1990.0 (computed as 23.440592 degrees according to the method given
 110  * in duffett-smith, section 27)
 111  */
 112 #define MeanObliquity (23.440592*(SGD_2PI/360))
 113
 114 /* static double solve_keplers_equation(double); */
 115 /* static double moon_ecliptic_longitude(time_t); */
 116 static void   ecliptic_to_equatorial(double, double, double *, double *);
 117 static double julian_date(int, int, int);
 118 static double GST(time_t);
 119
 120 /*
 121  * solve Kepler's equation via Newton's method
 122  * (after duffett-smith, section 47)
 123  */
 124 /*
 125 static double solve_keplers_equation(double M) {
 126     double E;
 127     double delta;
 128
 129     E = M;
 130     while (1) {
 131         delta = E - Eccentricity*sin(E) - M;
 132         if (fabs(delta) <= 1e-10) break;
 133         E -= delta / (1 - Eccentricity*cos(E));
 134     }
 135
 136     return E;
 137 }
 138 */
 139
 140
 141 /* compute ecliptic longitude of moon (in radians) (after
 142  * duffett-smith, section 47) */
 143 /*
 144 static double moon_ecliptic_longitude(time_t ssue) {
 145     // time_t ssue;              //  seconds since unix epoch
 146     double D, N;
 147     double M_moon, E;
 148     double v;
 149
 150     D = DaysSinceEpoch(ssue);
 151
 152     N = RadsPerDay * D;
 153     N = fmod(N, SG_2PI);
 154     if (N < 0) N += SG_2PI;
 155
 156     M_moon = N + Epsilon_g - OmegaBar_g;
 157     if (M_moon < 0) M_moon += SG_2PI;
 158
 159     E = solve_keplers_equation(M_moon);
 160     v = 2 * atan(sqrt((1+Eccentricity)/(1-Eccentricity)) * tan(E/2));
 161
 162     return (v + OmegaBar_g);
 163 }
 164 */
 165
 166
 167 /* convert from ecliptic to equatorial coordinates (after
 168  * duffett-smith, section 27) */
 169
 170 static void ecliptic_to_equatorial(double lambda, double beta,
 171                                    double *alpha, double *delta) {
 172     /* double  lambda;            ecliptic longitude       */
 173     /* double  beta;              ecliptic latitude        */
 174     /* double *alpha;             (return) right ascension */
 175     /* double *delta;             (return) declination     */
 176
 177     double sin_e, cos_e;
 178     double sin_l, cos_l;
 179
 180     sin_e = sin(MeanObliquity);
 181     cos_e = cos(MeanObliquity);
 182     sin_l = sin(lambda);
 183     cos_l = cos(lambda);
 184
 185     *alpha = atan2(sin_l*cos_e - tan(beta)*sin_e, cos_l);
 186     *delta = asin(sin(beta)*cos_e + cos(beta)*sin_e*sin_l);
 187 }
 188
 189
 190 /* computing julian dates (assuming gregorian calendar, thus this is
 191  * only valid for dates of 1582 oct 15 or later) (after duffett-smith,
 192  * section 4) */
 193
 194 static double julian_date(int y, int m, int d) {
 195     /* int y;                    year (e.g. 19xx)          */
 196     /* int m;                    month (jan=1, feb=2, ...) */
 197     /* int d;                    day of month              */
 198
 199     int    A, B, C, D;
 200     double JD;
 201
 202     /* lazy test to ensure gregorian calendar */
 203     if (y < 1583) {
 204         SG_LOG( SG_EVENT, SG_ALERT,
 205                 "WHOOPS! Julian dates only valid for 1582 oct 15 or later" );
 206     }
 207
 208     if ((m == 1) || (m == 2)) {
 209         y -= 1;
 210         m += 12;
 211     }
 212
 213     A = y / 100;
 214     B = 2 - A + (A / 4);
 215     C = (int)(365.25 * y);
 216     D = (int)(30.6001 * (m + 1));
 217
 218     JD = B + C + D + d + 1720994.5;
 219
 220     return JD;
 221 }
 222
 223
 224 /* compute greenwich mean sidereal time (GST) corresponding to a given
 225  * number of seconds since the unix epoch (after duffett-smith,
 226  * section 12) */
 227 static double GST(time_t ssue) {
 228     /* time_t ssue;           seconds since unix epoch */
 229
 230     double     JD;
 231     double     T, T0;
 232     double     UT;
 233     struct tm *tm;
 234
 235     tm = gmtime(&ssue);
 236
 237     JD = julian_date(tm->tm_year+1900, tm->tm_mon+1, tm->tm_mday);
 238     T  = (JD - 2451545) / 36525;
 239
 240     T0 = ((T + 2.5862e-5) * T + 2400.051336) * T + 6.697374558;
 241
 242     T0 = fmod(T0, 24.0);
 243     if (T0 < 0) T0 += 24;
 244
 245     UT = tm->tm_hour + (tm->tm_min + tm->tm_sec / 60.0) / 60.0;
 246
 247     T0 += UT * 1.002737909;
 248     T0 = fmod(T0, 24.0);
 249     if (T0 < 0) T0 += 24;
 250
 251     return T0;
 252 }
 253
 254
 255 /* given a particular time (expressed in seconds since the unix
 256  * epoch), compute position on the earth (lat, lon) such that moon is
 257  * directly overhead.  (lat, lon are reported in radians */
 258
 259 void fgMoonPosition(time_t ssue, double *lon, double *lat) {
 260     /* time_t  ssue;           seconds since unix epoch */
 261     /* double *lat;            (return) latitude        */
 262     /* double *lon;            (return) longitude       */
 263
 264     /* double lambda; */
 265     double alpha, delta;
 266     double tmp;
 267
 268     /* lambda = moon_ecliptic_longitude(ssue); */
 269     /* ecliptic_to_equatorial(lambda, 0.0, &alpha, &delta); */
 270     //ecliptic_to_equatorial (solarPosition.lonMoon, 0.0, &alpha, &delta);
 271
 272     /* **********************************************************************
 273      * NOTE: in the next function, each time the moon's position is updated, the
 274      * the moon's longitude is returned from solarSystem->moon. Note that the
 275      * moon's position is updated at a much higher frequency than the rate at
 276      * which the solar system's rebuilds occur. This is not a problem, however,
 277      * because the fgMoonPosition we're talking about here concerns the changing
 278      * position of the moon due to the daily rotation of the earth.
 279      * The ecliptic longitude, however, represents the position of the moon with
 280      * respect to the stars, and completes just one cycle over the course of a
 281      * year. Its therefore pretty safe to update the moon's longitude only once
 282      * every ten minutes. (Comment added by Durk Talsma).
 283      ************************************************************************/
 284
 285     ecliptic_to_equatorial( globals->get_ephem()->get_moon()->getLon(),
 286                             0.0, &alpha, &delta );
 287     tmp = alpha - (SGD_2PI/24)*GST(ssue);
 288     if (tmp < -SGD_PI) {
 289         do tmp += SGD_2PI;
 290         while (tmp < -SGD_PI);
 291     } else if (tmp > SGD_PI) {
 292         do tmp -= SGD_2PI;
 293         while (tmp < -SGD_PI);
 294     }
 295
 296     *lon = tmp;
 297     *lat = delta;
 298 }
 299
 300
 301 /* given a particular time expressed in side real time at prime
 302  * meridian (GST), compute position on the earth (lat, lon) such that
 303  * moon is directly overhead.  (lat, lon are reported in radians */
 304
 305 static void fgMoonPositionGST(double gst, double *lon, double *lat) {
 306     /* time_t  ssue;           seconds since unix epoch */
 307     /* double *lat;            (return) latitude        */
 308     /* double *lon;            (return) longitude       */
 309
 310     /* double lambda; */
 311     double alpha, delta;
 312     double tmp;
 313
 314     /* lambda = moon_ecliptic_longitude(ssue); */
 315     /* ecliptic_to_equatorial(lambda, 0.0, &alpha, &delta); */
 316     //ecliptic_to_equatorial (solarPosition.lonMoon, 0.0, &alpha, &delta);
 317     ecliptic_to_equatorial( globals->get_ephem()->get_moon()->getLon(),
 318                             globals->get_ephem()->get_moon()->getLat(),
 319                             &alpha,  &delta );
 320
 321 //    tmp = alpha - (SG_2PI/24)*GST(ssue);
 322     tmp = alpha - (SGD_2PI/24)*gst;
 323     if (tmp < -SGD_PI) {
 324         do tmp += SGD_2PI;
 325         while (tmp < -SGD_PI);
 326     } else if (tmp > SGD_PI) {
 327         do tmp -= SGD_2PI;
 328         while (tmp < -SGD_PI);
 329     }
 330
 331     *lon = tmp;
 332     *lat = delta;
 333 }
 334
 335
 336 // update the cur_time_params structure with the current moon position
 337 void fgUpdateMoonPos( void ) {
 338     fgLIGHT *l;
 339     FGViewer *v;
 340     sgVec3 nup, nmoon;
 341     Point3D p, rel_moonpos;
 342     double dot, east_dot;
 343     double moon_gd_lat, sl_radius;
 344
 345     // vector in cartesian coordinates from current position to the
 346     // postion on the earth's surface the moon is directly over
 347     sgVec3 to_moon;
 348
 349     // surface direction to go to head towards moon
 350     sgVec3 surface_to_moon;
 351
 352     l = &cur_light_params;
 353     SGTime *t = globals->get_time_params();
 354     v = globals->get_current_view();
 355
 356     SG_LOG( SG_EVENT, SG_INFO, "  Updating Moon position" );
 357
 358     // (not sure why there was two)
 359     // fgMoonPosition(t->cur_time, &l->moon_lon, &moon_gd_lat);
 360     fgMoonPositionGST(t->getGst(), &l->moon_lon, &moon_gd_lat);
 361
 362     sgGeodToGeoc(moon_gd_lat, 0.0, &sl_radius, &l->moon_gc_lat);
 363
 364     p = Point3D( l->moon_lon, l->moon_gc_lat, sl_radius );
 365     l->fg_moonpos = sgPolarToCart3d(p);
 366
 367     SG_LOG( SG_EVENT, SG_INFO, "    t->cur_time = " << t->get_cur_time() );
 368     SG_LOG( SG_EVENT, SG_INFO,
 369             "    Moon Geodetic lat = " << moon_gd_lat
 370             << " Geocentric lat = " << l->moon_gc_lat );
 371
 372     // update the sun light vector
 373     sgSetVec4( l->moon_vec,
 374                l->fg_moonpos.x(), l->fg_moonpos.y(), l->fg_moonpos.z(), 0.0 );
 375     sgNormalizeVec4( l->moon_vec );
 376     sgCopyVec4( l->moon_vec_inv, l->moon_vec );
 377     sgNegateVec4( l->moon_vec_inv );
 378
 379     // make sure these are directional light sources only
 380     l->moon_vec[3] = l->moon_vec_inv[3] = 0.0;
 381     // cout << "  l->moon_vec = " << l->moon_vec[0] << "," << l->moon_vec[1]
 382     //      << ","<< l->moon_vec[2] << endl;
 383
 384     // calculate the moon's relative angle to local up
 385     sgCopyVec3( nup, v->get_world_up() );
 386     sgSetVec3( nmoon, l->fg_moonpos.x(), l->fg_moonpos.y(), l->fg_moonpos.z() );
 387     sgNormalizeVec3(nup);
 388     sgNormalizeVec3(nmoon);
 389     // cout << "nup = " << nup[0] << "," << nup[1] << ","
 390     //      << nup[2] << endl;
 391     // cout << "nmoon = " << nmoon[0] << "," << nmoon[1] << ","
 392     //      << nmoon[2] << endl;
 393
 394     l->moon_angle = acos( sgScalarProductVec3( nup, nmoon ) );
 395     SG_LOG( SG_EVENT, SG_INFO, "moon angle relative to current location = "
 396             << l->moon_angle );
 397
 398     // calculate vector to moon's position on the earth's surface
 399     Point3D vp( v->get_view_pos()[0],
 400                 v->get_view_pos()[1],
 401                 v->get_view_pos()[2] );
 402     rel_moonpos = l->fg_moonpos - ( vp + scenery.get_center() );
 403     sgSetVec3( to_moon, rel_moonpos.x(), rel_moonpos.y(), rel_moonpos.z() );
 404     // printf( "Vector to moon = %.2f %.2f %.2f\n",
 405     //         to_moon[0], to_moon[1], to_moon[2]);
 406
 407     // Given a vector from the view position to the point on the
 408     // earth's surface the moon is directly over, map into onto the
 409     // local plane representing "horizontal".
 410
 411     sgmap_vec_onto_cur_surface_plane( v->get_world_up(), v->get_view_pos(),
 412                                       to_moon, surface_to_moon );
 413     sgNormalizeVec3(surface_to_moon);
 414     // cout << "(sg) Surface direction to moon is "
 415     //   << surface_to_moon[0] << ","
 416     //   << surface_to_moon[1] << ","
 417     //   << surface_to_moon[2] << endl;
 418     // cout << "Should be close to zero = "
 419     //   << sgScalarProductVec3(nup, surface_to_moon) << endl;
 420
 421     // calculate the angle between v->surface_to_moon and
 422     // v->surface_east.  We do this so we can sort out the acos()
 423     // ambiguity.  I wish I could think of a more efficient way ... :-(
 424     east_dot = sgScalarProductVec3( surface_to_moon, v->get_surface_east() );
 425     // cout << "  East dot product = " << east_dot << endl;
 426
 427     // calculate the angle between v->surface_to_moon and
 428     // v->surface_south.  this is how much we have to rotate the sky
 429     // for it to align with the moon
 430     dot = sgScalarProductVec3( surface_to_moon, v->get_surface_south() );
 431     // cout << "  Dot product = " << dot << endl;
 432
 433     if ( east_dot >= 0 ) {
 434         l->moon_rotation = acos(dot);
 435     } else {
 436         l->moon_rotation = -acos(dot);
 437     }
 438     // cout << "  Sky needs to rotate = " << angle << " rads = "
 439     //      << angle * SGD_RADIANS_TO_DEGREES << " degrees." << endl;
 440 }
 441
 442