Time/sunpos.cxx

   1 // sunpos.c (taken from XEarth)
   2 // kirk johnson
   3 // july 1993
   4 //
   5 // code for calculating the position on the earth's surface for which
   6 // the sun is directly overhead (adapted from _practical astronomy
   7 // with your calculator, third edition_, peter duffett-smith,
   8 // cambridge university press, 1988.)
   9 //
  10 // Copyright (C) 1989, 1990, 1993, 1994, 1995 Kirk Lauritz Johnson
  11 //
  12 // Parts of the source code (as marked) are:
  13 //   Copyright (C) 1989, 1990, 1991 by Jim Frost
  14 //   Copyright (C) 1992 by Jamie Zawinski <jwz@lucid.com>
  15 //
  16 // Permission to use, copy, modify and freely distribute xearth for
  17 // non-commercial and not-for-profit purposes is hereby granted
  18 // without fee, provided that both the above copyright notice and this
  19 // permission notice appear in all copies and in supporting
  20 // documentation.
  21 //
  22 // The author makes no representations about the suitability of this
  23 // software for any purpose. It is provided "as is" without express or
  24 // implied warranty.
  25 //
  26 // THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  27 // INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS,
  28 // IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, INDIRECT
  29 // OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  30 // LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
  31 // NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  32 // CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  33 //
  34 // $Id$
  35 // (Log is kept at end of this file)
  36
  37
  38 #ifdef HAVE_CONFIG_H
  39 #  include <config.h>
  40 #endif
  41
  42 #include <math.h>
  43 #include <stdio.h>
  44 #include <time.h>
  45
  46 //#include <Astro/orbits.hxx>
  47 #include <Astro/solarsystem.hxx>
  48 #include <Include/fg_constants.h>
  49 #include <Main/views.hxx>
  50 #include <Math/fg_geodesy.h>
  51 #include <Math/mat3.h>
  52 #include <Math/polar3d.hxx>
  53 #include <Math/vector.hxx>
  54 #include <Scenery/scenery.hxx>
  55
  56 #include "fg_time.hxx"
  57 #include "sunpos.hxx"
  58
  59 extern SolarSystem *solarSystem;
  60
  61 #undef E
  62
  63
  64 /*
  65  * the epoch upon which these astronomical calculations are based is
  66  * 1990 january 0.0, 631065600 seconds since the beginning of the
  67  * "unix epoch" (00:00:00 GMT, Jan. 1, 1970)
  68  *
  69  * given a number of seconds since the start of the unix epoch,
  70  * DaysSinceEpoch() computes the number of days since the start of the
  71  * astronomical epoch (1990 january 0.0)
  72  */
  73
  74 #define EpochStart           (631065600)
  75 #define DaysSinceEpoch(secs) (((secs)-EpochStart)*(1.0/(24*3600)))
  76
  77 /*
  78  * assuming the apparent orbit of the sun about the earth is circular,
  79  * the rate at which the orbit progresses is given by RadsPerDay --
  80  * FG_2PI radians per orbit divided by 365.242191 days per year:
  81  */
  82
  83 #define RadsPerDay (FG_2PI/365.242191)
  84
  85 /*
  86  * details of sun's apparent orbit at epoch 1990.0 (after
  87  * duffett-smith, table 6, section 46)
  88  *
  89  * Epsilon_g    (ecliptic longitude at epoch 1990.0) 279.403303 degrees
  90  * OmegaBar_g   (ecliptic longitude of perigee)      282.768422 degrees
  91  * Eccentricity (eccentricity of orbit)                0.016713
  92  */
  93
  94 #define Epsilon_g    (279.403303*(FG_2PI/360))
  95 #define OmegaBar_g   (282.768422*(FG_2PI/360))
  96 #define Eccentricity (0.016713)
  97
  98 /*
  99  * MeanObliquity gives the mean obliquity of the earth's axis at epoch
 100  * 1990.0 (computed as 23.440592 degrees according to the method given
 101  * in duffett-smith, section 27)
 102  */
 103 #define MeanObliquity (23.440592*(FG_2PI/360))
 104
 105 /* static double solve_keplers_equation(double); */
 106 /* static double sun_ecliptic_longitude(time_t); */
 107 static void   ecliptic_to_equatorial(double, double, double *, double *);
 108 static double julian_date(int, int, int);
 109 static double GST(time_t);
 110
 111 /*
 112  * solve Kepler's equation via Newton's method
 113  * (after duffett-smith, section 47)
 114  */
 115 /*
 116 static double solve_keplers_equation(double M) {
 117     double E;
 118     double delta;
 119
 120     E = M;
 121     while (1) {
 122         delta = E - Eccentricity*sin(E) - M;
 123         if (fabs(delta) <= 1e-10) break;
 124         E -= delta / (1 - Eccentricity*cos(E));
 125     }
 126
 127     return E;
 128 }
 129 */
 130
 131
 132 /* compute ecliptic longitude of sun (in radians) (after
 133  * duffett-smith, section 47) */
 134 /*
 135 static double sun_ecliptic_longitude(time_t ssue) {
 136     // time_t ssue;              //  seconds since unix epoch
 137     double D, N;
 138     double M_sun, E;
 139     double v;
 140
 141     D = DaysSinceEpoch(ssue);
 142
 143     N = RadsPerDay * D;
 144     N = fmod(N, FG_2PI);
 145     if (N < 0) N += FG_2PI;
 146
 147     M_sun = N + Epsilon_g - OmegaBar_g;
 148     if (M_sun < 0) M_sun += FG_2PI;
 149
 150     E = solve_keplers_equation(M_sun);
 151     v = 2 * atan(sqrt((1+Eccentricity)/(1-Eccentricity)) * tan(E/2));
 152
 153     return (v + OmegaBar_g);
 154 }
 155 */
 156
 157
 158 /* convert from ecliptic to equatorial coordinates (after
 159  * duffett-smith, section 27) */
 160
 161 static void ecliptic_to_equatorial(double lambda, double beta,
 162                                    double *alpha, double *delta) {
 163     /* double  lambda;            ecliptic longitude       */
 164     /* double  beta;              ecliptic latitude        */
 165     /* double *alpha;             (return) right ascension */
 166     /* double *delta;             (return) declination     */
 167
 168     double sin_e, cos_e;
 169     double sin_l, cos_l;
 170
 171     sin_e = sin(MeanObliquity);
 172     cos_e = cos(MeanObliquity);
 173     sin_l = sin(lambda);
 174     cos_l = cos(lambda);
 175
 176     *alpha = atan2(sin_l*cos_e - tan(beta)*sin_e, cos_l);
 177     *delta = asin(sin(beta)*cos_e + cos(beta)*sin_e*sin_l);
 178 }
 179
 180
 181 /* computing julian dates (assuming gregorian calendar, thus this is
 182  * only valid for dates of 1582 oct 15 or later) (after duffett-smith,
 183  * section 4) */
 184
 185 static double julian_date(int y, int m, int d) {
 186     /* int y;                    year (e.g. 19xx)          */
 187     /* int m;                    month (jan=1, feb=2, ...) */
 188     /* int d;                    day of month              */
 189
 190     int    A, B, C, D;
 191     double JD;
 192
 193     /* lazy test to ensure gregorian calendar */
 194     if (y < 1583) {
 195         printf("WHOOPS! Julian dates only valid for 1582 oct 15 or later\n");
 196     }
 197
 198     if ((m == 1) || (m == 2)) {
 199         y -= 1;
 200         m += 12;
 201     }
 202
 203     A = y / 100;
 204     B = 2 - A + (A / 4);
 205     C = (int)(365.25 * y);
 206     D = (int)(30.6001 * (m + 1));
 207
 208     JD = B + C + D + d + 1720994.5;
 209
 210     return JD;
 211 }
 212
 213
 214 /* compute greenwich mean sidereal time (GST) corresponding to a given
 215  * number of seconds since the unix epoch (after duffett-smith,
 216  * section 12) */
 217 static double GST(time_t ssue) {
 218     /* time_t ssue;           seconds since unix epoch */
 219
 220     double     JD;
 221     double     T, T0;
 222     double     UT;
 223     struct tm *tm;
 224
 225     tm = gmtime(&ssue);
 226
 227     JD = julian_date(tm->tm_year+1900, tm->tm_mon+1, tm->tm_mday);
 228     T  = (JD - 2451545) / 36525;
 229
 230     T0 = ((T + 2.5862e-5) * T + 2400.051336) * T + 6.697374558;
 231
 232     T0 = fmod(T0, 24.0);
 233     if (T0 < 0) T0 += 24;
 234
 235     UT = tm->tm_hour + (tm->tm_min + tm->tm_sec / 60.0) / 60.0;
 236
 237     T0 += UT * 1.002737909;
 238     T0 = fmod(T0, 24.0);
 239     if (T0 < 0) T0 += 24;
 240
 241     return T0;
 242 }
 243
 244
 245 /* given a particular time (expressed in seconds since the unix
 246  * epoch), compute position on the earth (lat, lon) such that sun is
 247  * directly overhead.  (lat, lon are reported in radians */
 248
 249 void fgSunPosition(time_t ssue, double *lon, double *lat) {
 250     /* time_t  ssue;           seconds since unix epoch */
 251     /* double *lat;            (return) latitude        */
 252     /* double *lon;            (return) longitude       */
 253
 254     /* double lambda; */
 255     double alpha, delta;
 256     double tmp;
 257
 258     /* lambda = sun_ecliptic_longitude(ssue); */
 259     /* ecliptic_to_equatorial(lambda, 0.0, &alpha, &delta); */
 260     //ecliptic_to_equatorial (solarPosition.lonSun, 0.0, &alpha, &delta);
 261
 262     /* **********************************************************************
 263      * NOTE: in the next function, each time the sun's position is updated, the
 264      * the sun's longitude is returned from solarSystem->sun. Note that the
 265      * sun's position is updated at a much higher frequency than the rate at
 266      * which the solar system's rebuilds occur. This is not a problem, however,
 267      * because the fgSunPosition we're talking about here concerns the changing
 268      * position of the sun due to the daily rotation of the earth.
 269      * The ecliptic longitude, however, represents the position of the sun with
 270      * respect to the stars, and completes just one cycle over the course of a
 271      * year. Its therefore pretty safe to update the sun's longitude only once
 272      * every ten minutes. (Comment added by Durk Talsma).
 273      ************************************************************************/
 274
 275     ecliptic_to_equatorial( SolarSystem::theSolarSystem->getSun()->getLon(),
 276                             0.0, &alpha, &delta );
 277     tmp = alpha - (FG_2PI/24)*GST(ssue);
 278     if (tmp < -FG_PI) {
 279         do tmp += FG_2PI;
 280         while (tmp < -FG_PI);
 281     } else if (tmp > FG_PI) {
 282         do tmp -= FG_2PI;
 283         while (tmp < -FG_PI);
 284     }
 285
 286     *lon = tmp;
 287     *lat = delta;
 288 }
 289
 290
 291 /* given a particular time expressed in side real time at prime
 292  * meridian (GST), compute position on the earth (lat, lon) such that
 293  * sun is directly overhead.  (lat, lon are reported in radians */
 294
 295 static void fgSunPositionGST(double gst, double *lon, double *lat) {
 296     /* time_t  ssue;           seconds since unix epoch */
 297     /* double *lat;            (return) latitude        */
 298     /* double *lon;            (return) longitude       */
 299
 300     /* double lambda; */
 301     double alpha, delta;
 302     double tmp;
 303
 304     /* lambda = sun_ecliptic_longitude(ssue); */
 305     /* ecliptic_to_equatorial(lambda, 0.0, &alpha, &delta); */
 306     //ecliptic_to_equatorial (solarPosition.lonSun, 0.0, &alpha, &delta);
 307     ecliptic_to_equatorial( SolarSystem::theSolarSystem->getSun()->getLon(),
 308                             0.0, &alpha,  &delta );
 309
 310 //    tmp = alpha - (FG_2PI/24)*GST(ssue);
 311     tmp = alpha - (FG_2PI/24)*gst;
 312     if (tmp < -FG_PI) {
 313         do tmp += FG_2PI;
 314         while (tmp < -FG_PI);
 315     } else if (tmp > FG_PI) {
 316         do tmp -= FG_2PI;
 317         while (tmp < -FG_PI);
 318     }
 319
 320     *lon = tmp;
 321     *lat = delta;
 322 }
 323
 324
 325 // update the cur_time_params structure with the current sun position
 326 void fgUpdateSunPos( void ) {
 327     fgLIGHT *l;
 328     fgTIME *t;
 329     fgVIEW *v;
 330     MAT3vec nup, nsun, v0;
 331     fgPoint3d p;
 332     double dot, east_dot;
 333     double sun_gd_lat, sl_radius;
 334     double ntmp;
 335
 336     l = &cur_light_params;
 337     t = &cur_time_params;
 338     v = &current_view;
 339
 340     printf("  Updating Sun position\n");
 341
 342     // (not sure why there was two)
 343     // fgSunPosition(t->cur_time, &l->sun_lon, &sun_gd_lat);
 344     fgSunPositionGST(t->gst, &l->sun_lon, &sun_gd_lat);
 345
 346     fgGeodToGeoc(sun_gd_lat, 0.0, &sl_radius, &l->sun_gc_lat);
 347
 348     p.lon = l->sun_lon;
 349     p.lat = l->sun_gc_lat;
 350     p.radius = sl_radius;
 351     l->fg_sunpos = fgPolarToCart3d(p);
 352
 353     printf( "    t->cur_time = %ld\n", t->cur_time);
 354     printf( "    Sun Geodetic lat = %.5f Geocentric lat = %.5f\n",
 355             sun_gd_lat, l->sun_gc_lat);
 356
 357     // I think this will work better for generating the sun light vector
 358     l->sun_vec[0] = l->fg_sunpos.x;
 359     l->sun_vec[1] = l->fg_sunpos.y;
 360     l->sun_vec[2] = l->fg_sunpos.z;
 361     MAT3_NORMALIZE_VEC(l->sun_vec, ntmp);
 362     MAT3_SCALE_VEC(l->sun_vec_inv, l->sun_vec, -1.0);
 363
 364     // make sure these are directional light sources only
 365     l->sun_vec[3] = 0.0;
 366     l->sun_vec_inv[3] = 0.0;
 367
 368     // printf("  l->sun_vec = %.2f %.2f %.2f\n", l->sun_vec[0], l->sun_vec[1],
 369     //        l->sun_vec[2]);
 370
 371     // calculate the sun's relative angle to local up
 372     MAT3_COPY_VEC(nup, v->local_up);
 373     nsun[0] = l->fg_sunpos.x;
 374     nsun[1] = l->fg_sunpos.y;
 375     nsun[2] = l->fg_sunpos.z;
 376     MAT3_NORMALIZE_VEC(nup, ntmp);
 377     MAT3_NORMALIZE_VEC(nsun, ntmp);
 378
 379     l->sun_angle = acos(MAT3_DOT_PRODUCT(nup, nsun));
 380     // printf("  SUN ANGLE relative to current location = %.3f rads.\n",
 381     //        l->sun_angle);
 382
 383     // calculate vector to sun's position on the earth's surface
 384     v->to_sun[0] = l->fg_sunpos.x - (v->view_pos.x + scenery.center.x);
 385     v->to_sun[1] = l->fg_sunpos.y - (v->view_pos.y + scenery.center.y);
 386     v->to_sun[2] = l->fg_sunpos.z - (v->view_pos.z + scenery.center.z);
 387     // printf( "Vector to sun = %.2f %.2f %.2f\n",
 388     //         v->to_sun[0], v->to_sun[1], v->to_sun[2]);
 389
 390     // make a vector to the current view position
 391     MAT3_SET_VEC(v0, v->view_pos.x, v->view_pos.y, v->view_pos.z);
 392
 393     // Given a vector from the view position to the point on the
 394     // earth's surface the sun is directly over, map into onto the
 395     // local plane representing "horizontal".
 396     map_vec_onto_cur_surface_plane(v->local_up, v0, v->to_sun,
 397                                    v->surface_to_sun);
 398     MAT3_NORMALIZE_VEC(v->surface_to_sun, ntmp);
 399     // printf("Surface direction to sun is %.2f %.2f %.2f\n",
 400     //        v->surface_to_sun[0], v->surface_to_sun[1], v->surface_to_sun[2]);
 401     // printf("Should be close to zero = %.2f\n",
 402     //        MAT3_DOT_PRODUCT(v->local_up, v->surface_to_sun));
 403
 404     // calculate the angle between v->surface_to_sun and
 405     // v->surface_east.  We do this so we can sort out the acos()
 406     // ambiguity.  I wish I could think of a more efficient way ... :-(
 407     east_dot = MAT3_DOT_PRODUCT(v->surface_to_sun, v->surface_east);
 408     // printf("  East dot product = %.2f\n", east_dot);
 409
 410     // calculate the angle between v->surface_to_sun and
 411     // v->surface_south.  this is how much we have to rotate the sky
 412     // for it to align with the sun
 413     dot = MAT3_DOT_PRODUCT(v->surface_to_sun, v->surface_south);
 414     // printf("  Dot product = %.2f\n", dot);
 415     if ( east_dot >= 0 ) {
 416         l->sun_rotation = acos(dot);
 417     } else {
 418         l->sun_rotation = -acos(dot);
 419     }
 420     // printf("  Sky needs to rotate = %.3f rads = %.1f degrees.\n",
 421     //        angle, angle * RAD_TO_DEG); */
 422 }
 423
 424
 425 // $Log$
 426 // Revision 1.12  1998/09/15 04:27:50  curt
 427 // Changes for new astro code.
 428 //
 429 // Revision 1.11  1998/08/12 21:13:22  curt
 430 // Optimizations by Norman Vine.
 431 //
 432 // Revision 1.10  1998/07/22 21:45:39  curt
 433 // fg_time.cxx: Removed call to ctime() in a printf() which should be harmless
 434 //   but seems to be triggering a bug.
 435 // light.cxx: Added code to adjust fog color based on sunrise/sunset effects
 436 //   and view orientation.  This is an attempt to match the fog color to the
 437 //   sky color in the center of the screen.  You see discrepancies at the
 438 //   edges, but what else can be done?
 439 // sunpos.cxx: Caculate local direction to sun here.  (what compass direction
 440 //   do we need to face to point directly at sun)
 441 //
 442 // Revision 1.9  1998/07/08 14:48:39  curt
 443 // polar3d.h renamed to polar3d.hxx
 444 //
 445 // Revision 1.8  1998/05/02 01:53:18  curt
 446 // Fine tuning mktime() support because of varying behavior on different
 447 // platforms.
 448 //
 449 // Revision 1.7  1998/04/30 12:36:05  curt
 450 // C++-ifying a couple source files.
 451 //
 452 // Revision 1.6  1998/04/28 01:22:18  curt
 453 // Type-ified fgTIME and fgVIEW.
 454 //
 455 // Revision 1.5  1998/04/26 05:10:05  curt
 456 // "struct fgLIGHT" -> "fgLIGHT" because fgLIGHT is typedef'd.
 457 //
 458 // Revision 1.4  1998/04/25 22:06:34  curt
 459 // Edited cvs log messages in source files ... bad bad bad!
 460 //
 461 // Revision 1.3  1998/04/25 20:24:03  curt
 462 // Cleaned up initialization sequence to eliminate interdependencies
 463 // between sun position, lighting, and view position.  This creates a
 464 // valid single pass initialization path.
 465 //
 466 // Revision 1.2  1998/04/24 00:52:31  curt
 467 // Wrapped "#include <config.h>" in "#ifdef HAVE_CONFIG_H"
 468 // Fog color fixes.
 469 // Separated out lighting calcs into their own file.
 470 //
 471 // Revision 1.1  1998/04/22 13:24:07  curt
 472 // C++ - ifiing the code a bit.
 473 // Starting to reorginize some of the lighting calcs to use a table lookup.
 474 //
 475 // Revision 1.27  1998/04/03 22:12:57  curt
 476 // Converting to Gnu autoconf system.
 477 // Centralized time handling differences.
 478 //
 479 // Revision 1.26  1998/02/23 19:08:00  curt
 480 // Incorporated Durk's Astro/ tweaks.  Includes unifying the sun position
 481 // calculation code between sun display, and other FG sections that use this
 482 // for things like lighting.
 483 //
 484 // Revision 1.25  1998/02/09 15:07:53  curt
 485 // Minor tweaks.
 486 //
 487 // Revision 1.24  1998/01/27 00:48:07  curt
 488 // Incorporated Paul Bleisch's <pbleisch@acm.org> new debug message
 489 // system and commandline/config file processing code.
 490 //
 491 // Revision 1.23  1998/01/19 19:27:21  curt
 492 // Merged in make system changes from Bob Kuehne <rpk@sgi.com>
 493 // This should simplify things tremendously.
 494 //
 495 // Revision 1.22  1998/01/19 18:40:40  curt
 496 // Tons of little changes to clean up the code and to remove fatal errors
 497 // when building with the c++ compiler.
 498 //
 499 // Revision 1.21  1997/12/30 23:10:19  curt
 500 // Calculate lighting parameters here.
 501 //
 502 // Revision 1.20  1997/12/30 22:22:43  curt
 503 // Further integration of event manager.
 504 //
 505 // Revision 1.19  1997/12/30 20:47:59  curt
 506 // Integrated new event manager with subsystem initializations.
 507 //
 508 // Revision 1.18  1997/12/23 04:58:40  curt
 509 // Tweaked the sky coloring a bit to build in structures to allow finer rgb
 510 // control.
 511 //
 512 // Revision 1.17  1997/12/15 23:55:08  curt
 513 // Add xgl wrappers for debugging.
 514 // Generate terrain normals on the fly.
 515 //
 516 // Revision 1.16  1997/12/11 04:43:57  curt
 517 // Fixed sun vector and lighting problems.  I thing the moon is now lit
 518 // correctly.
 519 //
 520 // Revision 1.15  1997/12/10 22:37:55  curt
 521 // Prepended "fg" on the name of all global structures that didn't have it yet.
 522 // i.e. "struct WEATHER {}" became "struct fgWEATHER {}"
 523 //
 524 // Revision 1.14  1997/12/09 04:25:39  curt
 525 // Working on adding a global lighting params structure.
 526 //
 527 // Revision 1.13  1997/11/25 19:25:42  curt
 528 // Changes to integrate Durk's moon/sun code updates + clean up.
 529 //
 530 // Revision 1.12  1997/11/15 18:15:39  curt
 531 // Reverse direction of sun vector, so object normals can be more normal.
 532 //
 533 // Revision 1.11  1997/10/28 21:07:21  curt
 534 // Changed GLUT/ -> Main/
 535 //
 536 // Revision 1.10  1997/09/13 02:00:09  curt
 537 // Mostly working on stars and generating sidereal time for accurate star
 538 // placement.
 539 //
 540 // Revision 1.9  1997/09/05 14:17:31  curt
 541 // More tweaking with stars.
 542 //
 543 // Revision 1.8  1997/09/05 01:36:04  curt
 544 // Working on getting stars right.
 545 //
 546 // Revision 1.7  1997/09/04 02:17:40  curt
 547 // Shufflin' stuff.
 548 //
 549 // Revision 1.6  1997/08/27 03:30:37  curt
 550 // Changed naming scheme of basic shared structures.
 551 //
 552 // Revision 1.5  1997/08/22 21:34:41  curt
 553 // Doing a bit of reorganizing and house cleaning.
 554 //
 555 // Revision 1.4  1997/08/19 23:55:09  curt
 556 // Worked on better simulating real lighting.
 557 //
 558 // Revision 1.3  1997/08/13 20:23:49  curt
 559 // The interface to sunpos now updates a global structure rather than returning
 560 // current sun position.
 561 //
 562 // Revision 1.2  1997/08/06 00:24:32  curt
 563 // Working on correct real time sun lighting.
 564 //
 565 // Revision 1.1  1997/08/01 15:27:56  curt
 566 // Initial revision.
 567 //