Time/sunpos.c

   1 /*
   2  * sunpos.c
   3  * kirk johnson
   4  * july 1993
   5  *
   6  * code for calculating the position on the earth's surface for which
   7  * the sun is directly overhead (adapted from _practical astronomy
   8  * with your calculator, third edition_, peter duffett-smith,
   9  * cambridge university press, 1988.)
  10  *
  11  * RCS $Id$
  12  *
  13  * Copyright (C) 1989, 1990, 1993, 1994, 1995 Kirk Lauritz Johnson
  14  *
  15  * Parts of the source code (as marked) are:
  16  *   Copyright (C) 1989, 1990, 1991 by Jim Frost
  17  *   Copyright (C) 1992 by Jamie Zawinski <jwz@lucid.com>
  18  *
  19  * Permission to use, copy, modify and freely distribute xearth for
  20  * non-commercial and not-for-profit purposes is hereby granted
  21  * without fee, provided that both the above copyright notice and this
  22  * permission notice appear in all copies and in supporting
  23  * documentation.
  24  *
  25  * The author makes no representations about the suitability of this
  26  * software for any purpose. It is provided "as is" without express or
  27  * implied warranty.
  28  *
  29  * THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  30  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS,
  31  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, INDIRECT
  32  * OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  33  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
  34  * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  35  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  36  *
  37  * $Id$
  38  * (Log is kept at end of this file)
  39  */
  40
  41
  42 #include <math.h>
  43 #include <stdio.h>
  44 #include <time.h>
  45
  46 #include <Time/sunpos.h>
  47 #include <Time/fg_time.h>
  48 #include <Include/fg_constants.h>
  49 #include <Main/views.h>
  50 #include <Math/fg_geodesy.h>
  51 #include <Math/mat3.h>
  52 #include <Math/polar.h>
  53
  54
  55 #undef E
  56
  57
  58 /*
  59  * the epoch upon which these astronomical calculations are based is
  60  * 1990 january 0.0, 631065600 seconds since the beginning of the
  61  * "unix epoch" (00:00:00 GMT, Jan. 1, 1970)
  62  *
  63  * given a number of seconds since the start of the unix epoch,
  64  * DaysSinceEpoch() computes the number of days since the start of the
  65  * astronomical epoch (1990 january 0.0)
  66  */
  67
  68 #define EpochStart           (631065600)
  69 #define DaysSinceEpoch(secs) (((secs)-EpochStart)*(1.0/(24*3600)))
  70
  71 /*
  72  * assuming the apparent orbit of the sun about the earth is circular,
  73  * the rate at which the orbit progresses is given by RadsPerDay --
  74  * FG_2PI radians per orbit divided by 365.242191 days per year:
  75  */
  76
  77 #define RadsPerDay (FG_2PI/365.242191)
  78
  79 /*
  80  * details of sun's apparent orbit at epoch 1990.0 (after
  81  * duffett-smith, table 6, section 46)
  82  *
  83  * Epsilon_g    (ecliptic longitude at epoch 1990.0) 279.403303 degrees
  84  * OmegaBar_g   (ecliptic longitude of perigee)      282.768422 degrees
  85  * Eccentricity (eccentricity of orbit)                0.016713
  86  */
  87
  88 #define Epsilon_g    (279.403303*(FG_2PI/360))
  89 #define OmegaBar_g   (282.768422*(FG_2PI/360))
  90 #define Eccentricity (0.016713)
  91
  92 /*
  93  * MeanObliquity gives the mean obliquity of the earth's axis at epoch
  94  * 1990.0 (computed as 23.440592 degrees according to the method given
  95  * in duffett-smith, section 27)
  96  */
  97 #define MeanObliquity (23.440592*(FG_2PI/360))
  98
  99 static double solve_keplers_equation(double);
 100 static double sun_ecliptic_longitude(time_t);
 101 static void   ecliptic_to_equatorial(double, double, double *, double *);
 102 static double julian_date(int, int, int);
 103 static double GST(time_t);
 104
 105 /*
 106  * solve Kepler's equation via Newton's method
 107  * (after duffett-smith, section 47)
 108  */
 109 static double solve_keplers_equation(double M) {
 110     double E;
 111     double delta;
 112
 113     E = M;
 114     while (1) {
 115         delta = E - Eccentricity*sin(E) - M;
 116         if (fabs(delta) <= 1e-10) break;
 117         E -= delta / (1 - Eccentricity*cos(E));
 118     }
 119
 120     return E;
 121 }
 122
 123
 124 /* compute ecliptic longitude of sun (in radians) (after
 125  * duffett-smith, section 47) */
 126
 127 static double sun_ecliptic_longitude(time_t ssue) {
 128     /* time_t ssue;              seconds since unix epoch */
 129     double D, N;
 130     double M_sun, E;
 131     double v;
 132
 133     D = DaysSinceEpoch(ssue);
 134
 135     N = RadsPerDay * D;
 136     N = fmod(N, FG_2PI);
 137     if (N < 0) N += FG_2PI;
 138
 139     M_sun = N + Epsilon_g - OmegaBar_g;
 140     if (M_sun < 0) M_sun += FG_2PI;
 141
 142     E = solve_keplers_equation(M_sun);
 143     v = 2 * atan(sqrt((1+Eccentricity)/(1-Eccentricity)) * tan(E/2));
 144
 145     return (v + OmegaBar_g);
 146 }
 147
 148
 149 /* convert from ecliptic to equatorial coordinates (after
 150  * duffett-smith, section 27) */
 151
 152 static void ecliptic_to_equatorial(double lambda, double beta,
 153                                    double *alpha, double *delta) {
 154     /* double  lambda;            ecliptic longitude       */
 155     /* double  beta;              ecliptic latitude        */
 156     /* double *alpha;             (return) right ascension */
 157     /* double *delta;             (return) declination     */
 158
 159     double sin_e, cos_e;
 160
 161     sin_e = sin(MeanObliquity);
 162     cos_e = cos(MeanObliquity);
 163
 164     *alpha = atan2(sin(lambda)*cos_e - tan(beta)*sin_e, cos(lambda));
 165     *delta = asin(sin(beta)*cos_e + cos(beta)*sin_e*sin(lambda));
 166 }
 167
 168
 169 /* computing julian dates (assuming gregorian calendar, thus this is
 170  * only valid for dates of 1582 oct 15 or later) (after duffett-smith,
 171  * section 4) */
 172
 173 static double julian_date(int y, int m, int d) {
 174     /* int y;                    year (e.g. 19xx)          */
 175     /* int m;                    month (jan=1, feb=2, ...) */
 176     /* int d;                    day of month              */
 177
 178     int    A, B, C, D;
 179     double JD;
 180
 181     /* lazy test to ensure gregorian calendar */
 182     if (y < 1583) {
 183         printf("WHOOPS! Julian dates only valid for 1582 oct 15 or later\n");
 184     }
 185
 186     if ((m == 1) || (m == 2)) {
 187         y -= 1;
 188         m += 12;
 189     }
 190
 191     A = y / 100;
 192     B = 2 - A + (A / 4);
 193     C = 365.25 * y;
 194     D = 30.6001 * (m + 1);
 195
 196     JD = B + C + D + d + 1720994.5;
 197
 198     return JD;
 199 }
 200
 201
 202 /* compute greenwich mean sidereal time (GST) corresponding to a given
 203  * number of seconds since the unix epoch (after duffett-smith,
 204  * section 12) */
 205 static double GST(time_t ssue) {
 206     /* time_t ssue;           seconds since unix epoch */
 207
 208     double     JD;
 209     double     T, T0;
 210     double     UT;
 211     struct tm *tm;
 212
 213     tm = gmtime(&ssue);
 214
 215     JD = julian_date(tm->tm_year+1900, tm->tm_mon+1, tm->tm_mday);
 216     T  = (JD - 2451545) / 36525;
 217
 218     T0 = ((T + 2.5862e-5) * T + 2400.051336) * T + 6.697374558;
 219
 220     T0 = fmod(T0, 24.0);
 221     if (T0 < 0) T0 += 24;
 222
 223     UT = tm->tm_hour + (tm->tm_min + tm->tm_sec / 60.0) / 60.0;
 224
 225     T0 += UT * 1.002737909;
 226     T0 = fmod(T0, 24.0);
 227     if (T0 < 0) T0 += 24;
 228
 229     return T0;
 230 }
 231
 232
 233 /* given a particular time (expressed in seconds since the unix
 234  * epoch), compute position on the earth (lat, lon) such that sun is
 235  * directly overhead.  (lat, lon are reported in radians */
 236
 237 void fgSunPosition(time_t ssue, double *lon, double *lat) {
 238     /* time_t  ssue;           seconds since unix epoch */
 239     /* double *lat;            (return) latitude        */
 240     /* double *lon;            (return) longitude       */
 241
 242     double lambda;
 243     double alpha, delta;
 244     double tmp;
 245
 246     lambda = sun_ecliptic_longitude(ssue);
 247     ecliptic_to_equatorial(lambda, 0.0, &alpha, &delta);
 248
 249     tmp = alpha - (FG_2PI/24)*GST(ssue);
 250     if (tmp < -FG_PI) {
 251         do tmp += FG_2PI;
 252         while (tmp < -FG_PI);
 253     } else if (tmp > FG_PI) {
 254         do tmp -= FG_2PI;
 255         while (tmp < -FG_PI);
 256     }
 257
 258     *lon = tmp;
 259     *lat = delta;
 260 }
 261
 262
 263 /* update the cur_time_params structure with the current sun position */
 264 void fgUpdateSunPos( void ) {
 265     struct fgLIGHT *l;
 266     struct fgTIME *t;
 267     struct fgVIEW *v;
 268     MAT3vec nup, nsun;
 269     /* if the 4th field is 0.0, this specifies a direction ... */
 270     GLfloat white[4] = { 1.0, 1.0, 1.0, 1.0 };
 271     /* base sky color */
 272     GLfloat base_sky_color[4] =        {0.60, 0.60, 0.90, 1.0};
 273     /* base fog color */
 274     GLfloat base_fog_color[4] = {0.70, 0.70, 0.70, 1.0};
 275     double sun_gd_lat, sl_radius, temp;
 276     double x_2, x_4, x_8, x_10;
 277     double light, ambient, diffuse, sky_brightness;
 278     static int time_warp = 0;
 279
 280     l = &cur_light_params;
 281     t = &cur_time_params;
 282     v = &current_view;
 283
 284     printf("  Updating Sun position\n");
 285
 286     time_warp += 0; /* increase this to make the world spin real fast */
 287
 288     fgSunPosition(t->cur_time + time_warp, &l->sun_lon, &sun_gd_lat);
 289
 290     fgGeodToGeoc(sun_gd_lat, 0.0, &sl_radius, &l->sun_gc_lat);
 291
 292     l->fg_sunpos = fgPolarToCart(l->sun_lon, l->sun_gc_lat, sl_radius);
 293
 294     /* printf("  Geodetic lat = %.5f Geocentric lat = %.5f\n", sun_gd_lat,
 295        t->sun_gc_lat); */
 296
 297     /* FALSE! (?> the sun position has to be translated just like
 298      * everything else */
 299     /* l->sun_vec_inv[0] = l->fg_sunpos.x - scenery_center.x;  */
 300     /* l->sun_vec_inv[1] = l->fg_sunpos.y - scenery_center.y; */
 301     /* l->sun_vec_inv[2] = l->fg_sunpos.z - scenery_center.z; */
 302     /* MAT3_SCALE_VEC(l->sun_vec, l->sun_vec_inv, -1.0); */
 303
 304     /* I think this will work better for generating the sun light vector */
 305     l->sun_vec[0] = l->fg_sunpos.x;
 306     l->sun_vec[1] = l->fg_sunpos.y;
 307     l->sun_vec[2] = l->fg_sunpos.z;
 308     MAT3_NORMALIZE_VEC(l->sun_vec, temp);
 309     MAT3_SCALE_VEC(l->sun_vec_inv, l->sun_vec, -1.0);
 310
 311     /* make these are directional light sources only */
 312     l->sun_vec[3] = 0.0;
 313     l->sun_vec_inv[3] = 0.0;
 314
 315     printf("  l->sun_vec = %.2f %.2f %.2f\n", l->sun_vec[0], l->sun_vec[1],
 316            l->sun_vec[2]);
 317
 318     /* calculate the sun's relative angle to local up */
 319     MAT3_COPY_VEC(nup, v->local_up);
 320     nsun[0] = l->fg_sunpos.x;
 321     nsun[1] = l->fg_sunpos.y;
 322     nsun[2] = l->fg_sunpos.z;
 323     MAT3_NORMALIZE_VEC(nup, temp);
 324     MAT3_NORMALIZE_VEC(nsun, temp);
 325
 326     l->sun_angle = acos(MAT3_DOT_PRODUCT(nup, nsun));
 327     printf("  SUN ANGLE relative to current location = %.3f rads.\n",
 328            l->sun_angle);
 329
 330     /* calculate lighting parameters based on sun's relative angle to
 331      * local up */
 332     /* ya kind'a have to plot this to see how it works */
 333
 334     /* x = t->sun_angle^8 */
 335     x_2 = l->sun_angle * l->sun_angle;
 336     x_4 = x_2 * x_2;
 337     x_8 = x_4 * x_4;
 338     x_10 = x_8 * x_2;
 339
 340     light = pow(1.1, -x_10 / 30.0);
 341     ambient = 0.2 * light;
 342     diffuse = 0.9 * light;
 343
 344     sky_brightness = 0.85 * pow(1.2, -x_8 / 20.0) + 0.15;
 345
 346     /* sky_brightness = 0.15; */ /* to force a dark sky (for testing) */
 347
 348     if ( ambient < 0.02 ) { ambient = 0.02; }
 349     if ( diffuse < 0.0 ) { diffuse = 0.0; }
 350
 351     if ( sky_brightness < 0.1 ) { sky_brightness = 0.1; }
 352
 353     l->scene_ambient[0] = white[0] * ambient;
 354     l->scene_ambient[1] = white[1] * ambient;
 355     l->scene_ambient[2] = white[2] * ambient;
 356
 357     l->scene_diffuse[0] = white[0] * diffuse;
 358     l->scene_diffuse[1] = white[1] * diffuse;
 359     l->scene_diffuse[2] = white[2] * diffuse;
 360
 361     /* set fog color */
 362     l->fog_color[0] = base_fog_color[0] * (ambient + diffuse);
 363     l->fog_color[1] = base_fog_color[1] * (ambient + diffuse);
 364     l->fog_color[2] = base_fog_color[2] * (ambient + diffuse);
 365     l->fog_color[3] = base_fog_color[3];
 366
 367     /* set sky color */
 368     l->sky_color[0] = base_sky_color[0] * sky_brightness;
 369     l->sky_color[1] = base_sky_color[1] * sky_brightness;
 370     l->sky_color[2] = base_sky_color[2] * sky_brightness;
 371     l->sky_color[3] = base_sky_color[3];
 372 }
 373
 374
 375 /* $Log$
 376 /* Revision 1.24  1998/01/27 00:48:07  curt
 377 /* Incorporated Paul Bleisch's <bleisch@chromatic.com> new debug message
 378 /* system and commandline/config file processing code.
 379 /*
 380  * Revision 1.23  1998/01/19 19:27:21  curt
 381  * Merged in make system changes from Bob Kuehne <rpk@sgi.com>
 382  * This should simplify things tremendously.
 383  *
 384  * Revision 1.22  1998/01/19 18:40:40  curt
 385  * Tons of little changes to clean up the code and to remove fatal errors
 386  * when building with the c++ compiler.
 387  *
 388  * Revision 1.21  1997/12/30 23:10:19  curt
 389  * Calculate lighting parameters here.
 390  *
 391  * Revision 1.20  1997/12/30 22:22:43  curt
 392  * Further integration of event manager.
 393  *
 394  * Revision 1.19  1997/12/30 20:47:59  curt
 395  * Integrated new event manager with subsystem initializations.
 396  *
 397  * Revision 1.18  1997/12/23 04:58:40  curt
 398  * Tweaked the sky coloring a bit to build in structures to allow finer rgb
 399  * control.
 400  *
 401  * Revision 1.17  1997/12/15 23:55:08  curt
 402  * Add xgl wrappers for debugging.
 403  * Generate terrain normals on the fly.
 404  *
 405  * Revision 1.16  1997/12/11 04:43:57  curt
 406  * Fixed sun vector and lighting problems.  I thing the moon is now lit
 407  * correctly.
 408  *
 409  * Revision 1.15  1997/12/10 22:37:55  curt
 410  * Prepended "fg" on the name of all global structures that didn't have it yet.
 411  * i.e. "struct WEATHER {}" became "struct fgWEATHER {}"
 412  *
 413  * Revision 1.14  1997/12/09 04:25:39  curt
 414  * Working on adding a global lighting params structure.
 415  *
 416  * Revision 1.13  1997/11/25 19:25:42  curt
 417  * Changes to integrate Durk's moon/sun code updates + clean up.
 418  *
 419  * Revision 1.12  1997/11/15 18:15:39  curt
 420  * Reverse direction of sun vector, so object normals can be more normal.
 421  *
 422  * Revision 1.11  1997/10/28 21:07:21  curt
 423  * Changed GLUT/ -> Main/
 424  *
 425  * Revision 1.10  1997/09/13 02:00:09  curt
 426  * Mostly working on stars and generating sidereal time for accurate star
 427  * placement.
 428  *
 429  * Revision 1.9  1997/09/05 14:17:31  curt
 430  * More tweaking with stars.
 431  *
 432  * Revision 1.8  1997/09/05 01:36:04  curt
 433  * Working on getting stars right.
 434  *
 435  * Revision 1.7  1997/09/04 02:17:40  curt
 436  * Shufflin' stuff.
 437  *
 438  * Revision 1.6  1997/08/27 03:30:37  curt
 439  * Changed naming scheme of basic shared structures.
 440  *
 441  * Revision 1.5  1997/08/22 21:34:41  curt
 442  * Doing a bit of reorganizing and house cleaning.
 443  *
 444  * Revision 1.4  1997/08/19 23:55:09  curt
 445  * Worked on better simulating real lighting.
 446  *
 447  * Revision 1.3  1997/08/13 20:23:49  curt
 448  * The interface to sunpos now updates a global structure rather than returning
 449  * current sun position.
 450  *
 451  * Revision 1.2  1997/08/06 00:24:32  curt
 452  * Working on correct real time sun lighting.
 453  *
 454  * Revision 1.1  1997/08/01 15:27:56  curt
 455  * Initial revision.
 456  *
 457  */