src/Time/sunsolver.cxx

   1 /*
   2  * sunsolver.cxx - given a location on earth and a time of day/date,
   3  *                 find the number of seconds to various sun positions.
   4  *
   5  * Written by Curtis Olson, started September 2003.
   6  *
   7  * Copyright (C) 2003  Curtis L. Olson  - http://www.flightgear.org/~curt
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License as
  11  * published by the Free Software Foundation; either version 2 of the
  12  * License, or (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  22  *
  23  * $Id$
  24  */
  25
  26 #ifdef HAVE_CONFIG_H
  27 #      include <config.h>
  28 #endif
  29
  30 #include <cmath>
  31 #include <ctime>
  32 #include <cassert>
  33
  34 #include <simgear/math/SGMath.hxx>
  35 #include <simgear/timing/sg_time.hxx>
  36
  37 #include <Main/globals.hxx>
  38 #include <Main/fg_props.hxx>
  39
  40 #include "sunsolver.hxx"
  41
  42
  43 static const time_t day_secs = 86400;
  44 static const time_t half_day_secs = day_secs / 2;
  45 static const time_t step_secs = 60;
  46
  47 /* given a particular time expressed in side real time at prime
  48  * meridian (GST), compute position on the earth (lat, lon) such that
  49  * sun is directly overhead.  (lat, lon are reported in radians */
  50
  51 void fgSunPositionGST(double gst, double *lon, double *lat) {
  52     /* time_t  ssue;           seconds since unix epoch */
  53     /* double *lat;            (return) latitude        */
  54     /* double *lon;            (return) longitude       */
  55
  56     double alpha, delta;
  57     double tmp;
  58
  59     SGPropertyNode* sun = fgGetNode("/ephemeris/sun");
  60     assert(sun);
  61     double xs = sun->getDoubleValue("xs");
  62     double ys = sun->getDoubleValue("ys");
  63     double ye = sun->getDoubleValue("ye");
  64     double ze = sun->getDoubleValue("ze");
  65     double ra = atan2(ye, xs);
  66     double dec = atan2(ze, sqrt(xs * xs + ye * ye));
  67
  68     tmp = ra - (SGD_2PI/24)*gst;
  69     if (tmp < -SGD_PI) {
  70         do tmp += SGD_2PI;
  71         while (tmp < -SGD_PI);
  72     } else if (tmp > SGD_PI) {
  73         do tmp -= SGD_2PI;
  74         while (tmp < -SGD_PI);
  75     }
  76
  77     *lon = tmp;
  78     *lat = dec;
  79 }
  80
  81 static double sun_angle( const SGTime &t, const SGVec3d& world_up,
  82                          double lon_rad, double lat_rad ) {
  83     SG_LOG( SG_EVENT, SG_DEBUG, "  Updating Sun position" );
  84     SG_LOG( SG_EVENT, SG_DEBUG, "  Gst = " << t.getGst() );
  85
  86     double sun_lon, sun_gc_lat;
  87     fgSunPositionGST( t.getGst(), &sun_lon, &sun_gc_lat );
  88     SGVec3d sunpos = SGVec3d::fromGeoc(SGGeoc::fromRadM(sun_lon, sun_gc_lat,
  89                                                         SGGeodesy::EQURAD));
  90
  91     SG_LOG( SG_EVENT, SG_DEBUG, "    t.cur_time = " << t.get_cur_time() );
  92     SG_LOG( SG_EVENT, SG_DEBUG,
  93             "    Sun Geocentric lat = " << sun_gc_lat );
  94
  95     // calculate the sun's relative angle to local up
  96     SGVec3d nup = normalize(world_up);
  97     SGVec3d nsun = normalize(sunpos);
  98     // cout << "nup = " << nup[0] << "," << nup[1] << ","
  99     //      << nup[2] << endl;
 100     // cout << "nsun = " << nsun[0] << "," << nsun[1] << ","
 101     //      << nsun[2] << endl;
 102
 103     double sun_angle = acos( dot( nup, nsun ) );
 104     double sun_angle_deg = sun_angle * SG_RADIANS_TO_DEGREES;
 105     while ( sun_angle_deg < -180 ) { sun_angle += 360; }
 106     SG_LOG( SG_EVENT, SG_DEBUG, "sun angle relative to current location = "
 107             << sun_angle_deg );
 108
 109     return sun_angle_deg;
 110 }
 111
 112
 113 /**
 114  * Given the current unix time in seconds, calculate seconds to the
 115  * specified sun angle (relative to straight up.)  Also specify if we
 116  * want the angle while the sun is ascending or descending.  For
 117  * instance noon is when the sun angle is 0 (or the closest it can
 118  * get.)  Dusk is when the sun angle is 90 and descending.  Dawn is
 119  * when the sun angle is 90 and ascending.
 120  */
 121 time_t fgTimeSecondsUntilSunAngle( time_t cur_time,
 122                                    double lon_rad,
 123                                    double lat_rad,
 124                                    double target_angle_deg,
 125                                    bool ascending )
 126 {
 127     // cout << "location = " << lon_rad * SG_RADIANS_TO_DEGREES << ", "
 128     //      << lat_rad * SG_RADIANS_TO_DEGREES << endl;
 129     SGVec3d world_up = SGVec3d::fromGeod(SGGeod::fromRad(lon_rad, lat_rad));
 130     SGTime t = SGTime( lon_rad, lat_rad, "", 0 );
 131
 132     double best_diff = 180.0;
 133     double last_angle = -99999.0;
 134     time_t best_time = cur_time;
 135
 136     for ( time_t secs = cur_time - half_day_secs;
 137           secs < cur_time + half_day_secs;
 138           secs += step_secs )
 139     {
 140         t.update( lon_rad, lat_rad, secs, 0 );
 141         double angle_deg = sun_angle( t, world_up, lon_rad, lat_rad );
 142         double diff = fabs( angle_deg - target_angle_deg );
 143         if ( diff < best_diff ) {
 144             if ( last_angle <= 180.0 && ascending
 145                  && ( last_angle > angle_deg ) ) {
 146                 // cout << "best angle = " << angle << " offset = "
 147                 //      << secs - cur_time << endl;
 148                 best_diff = diff;
 149                 best_time = secs;
 150             } else if ( last_angle <= 180.0 && !ascending
 151                         && ( last_angle < angle_deg ) ) {
 152                 // cout << "best angle = " << angle << " offset = "
 153                 //      << secs - cur_time << endl;
 154                 best_diff = diff;
 155                 best_time = secs;
 156             }
 157         }
 158
 159         last_angle = angle_deg;
 160     }
 161
 162     return best_time - cur_time;
 163 }