Changeset 549 for XIOS/trunk/src/calendar_util.cpp

Timestamp:

01/26/15 14:39:26 (9 years ago)

Author:

rlacroix

Message:

Revised calendar functionalities:

• the calendar is now configured from a specific calendar child node of the context in the XML configuration file. Example: <calendar type="Gregorian" start_date="2012-03-01 15:00:00" time_origin="2012-02-29 15:00:00" timestep="1h" />
• the calendar type should now be configured when defining the start time and/or the time origin.
• the start time and the time origin are now optional, 0000-01-01 00:00:00 will be used by default. It is also possible to define them partially. For example, 2015 and 2014-12 are valid dates corresponding respectively to 2015-01-01 00:00:00 and 2014-12-01 00:00:00.
• an optional duration offset can be added to the start date and time origin. For example, it's possible to define the date 2015-01-12 12:00:00 as 2015-01-11 + 36h or 2015-01-11 12:00:00 + 1d. The duration format is the same as the time step. Being that the date is optional, it is possible to only use a duration (for example + 42s is the same as 0000-01-01 00:00:00 + 42s). An error will be raised if a duration based on the time step is used before the time step was configured. For example, the following would cause an error: <calendar type="Gregorian" start_date="+ 1ts" /> but <calendar type="Gregorian" start_date="+ 1ts" timestep="0.5h" /> would not.
• new Fortran interface to define the calendar:
  • xios_define_calendar(type[, timestep, start_date, time_origin]) will create a calendar when none had previously been defined. Only the type argument is mandatory, the rest is optional. Calendar operations on dates and durations are possible as soon as the calendar is created (either using this procedure or directly from the XML configuration file).
  • the following getter and setter procedures are available: xios_set_timestep, xios_set_start_date, xios_set_time_origin, xios_get_calendar_type, xios_get_timestep, xios_get_start_date, xios_get_time_origin.
• new Fortran interface to interact with the calendar: xios_update_calendar, xios_get_current_date, xios_get_year_length_in_seconds, xios_get_day_length_in_seconds.
• new Fortran interface for date conversion: xios_date_get_second_of_year, xios_date_get_day_of_year, xios_date_get_fraction_of_year, xios_date_get_second_of_day, xios_date_get_fraction_of_day.
• two new placeholders are available to format the file name when splitting the output (split_freq_format attribute):
  • %S the number of seconds since the time origin
  • %D the integral number of days since the time origin

File:

• XIOS/trunk/src/calendar_util.cpp (modified) (8 diffs)

XIOS/trunk/src/calendar_util.cpp

@@ -5 +5 @@
       /// ////////////////////// Définitions ////////////////////// ///
 
-      CDuration operator*(const double & scal, const CDuration & ddr)
+      CDuration operator*(const double& scal, const CDuration& ddr)
       { return (ddr * scal); }
 
-      CDuration operator-(const CDuration & ddr , const CDuration & dr)
-      {
-         CDuration dur(ddr);
-         dur.year -= dr.year;  dur.month  -= dr.month ; dur.day    -= dr.day;
+      CDuration operator-(const CDuration& ddr , const CDuration& dr)
+      {
+         CDuration dur(ddr);
+         dur.year -= dr.year;  dur.month  -= dr.month; dur.day    -= dr.day;
          dur.hour -= dr.hour;  dur.minute -= dr.minute; dur.second -= dr.second; dur.timestep -= dr.timestep;
          return (dur);
       }
 
-      CDuration operator+(const CDuration & ddr , const CDuration & dr)
-      {
-         CDuration dur(ddr);
-         dur.year += dr.year;  dur.month  += dr.month ; dur.day    += dr.day;
+      CDuration operator+(const CDuration& ddr , const CDuration& dr)
+      {
+         CDuration dur(ddr);
+         dur.year += dr.year;  dur.month  += dr.month; dur.day    += dr.day;
          dur.hour += dr.hour;  dur.minute += dr.minute; dur.second += dr.second; dur.timestep += dr.timestep;
          return (dur);
       }
 
-      CDuration operator*(const CDuration & ddr , const double & scal)
+      CDuration operator*(const CDuration& ddr , const double& scal)
       {
          CDuration dur(ddr);
@@ -32 +32 @@
       }
 
-      CDuration operator-(const CDuration & ddr)
+      CDuration operator-(const CDuration& ddr)
       {
          CDuration dur(ddr);
@@ -47 +47 @@
       //-----------------------------------------------------------------
 
-      CDate operator+(const CDate & dt, const CDuration & dr)
-      {
-         CDuration drr (dr);
+      CDate operator+(const CDate& dt, const CDuration& dr)
+      {
+         CDuration drr(dr);
          int year = 0, month = 0, day = 0, hour = 0, minute = 0, second = 0;
-         const CCalendar & c = dt.getRelCalendar();
-         
-         drr.timestep=0 ;       
-         drr=drr+dr.timestep*dt.getRelCalendar().getTimeStep() ;
-         
-         drr.resolve(dt.getRelCalendar());
+         const CCalendar& c = dt.getRelCalendar();
+
+         drr.timestep = 0;
+         if (dr.timestep)
+         {
+            if (c.getTimeStep() == NoneDu)
+               ERROR("operator+(const CDate& dt, const CDuration& dr)",
+                     << "Impossible to use the timestep before it is set.");
+            drr = drr + dr.timestep * c.getTimeStep();
+         }
+
+         drr.resolve(c);
 
          // Ajustement des minutes par rapport aux secondes.
          second += dt.getSecond() + drr.second;
-         if (second <  0) { minute --; second += c.getMinuteLength(); }
-         if (second >= c.getMinuteLength()) { minute ++; second -= c.getMinuteLength(); }
+         if (second < 0) { minute--; second += c.getMinuteLength(); }
+         if (second >= c.getMinuteLength()) { minute++; second -= c.getMinuteLength(); }
 
          // Ajustement des heures en fonction des minutes.
          minute += dt.getMinute() + drr.minute;
-         if (minute < 0) { hour --; minute += c.getHourLength(); }
-         if (minute >= c.getHourLength()) { hour ++; minute -= c.getHourLength(); }
+         if (minute < 0) { hour--; minute += c.getHourLength(); }
+         if (minute >= c.getHourLength()) { hour++; minute -= c.getHourLength(); }
 
          // Ajustement des jours en fonction des heures.
          hour += dt.getHour() + drr.hour;
-         if (hour <  0) { drr.day --; hour += c.getDayLength(); }
-         if (hour >= c.getDayLength()) { drr.day ++; hour -= c.getDayLength(); }
+         if (hour < 0) { drr.day--; hour += c.getDayLength(); }
+         if (hour >= c.getDayLength()) { drr.day++; hour -= c.getDayLength(); }
 
          // Ajustement des mois en fonction des jours.
-         CDate dtt(dt); 
-         drr.day+=dtt.getDay()-1 ;
-         dtt.setDay(1) ;         
-
-         if ( drr.day >= 0 )
-         {
-           for(; c.getMonthLength(dtt) <= drr.day; dtt.addMonth (1))
-           { drr.day -=  c.getMonthLength(dtt); drr.month += 1 ; }
-
-           day = drr.day+1 ;
-         }
-         else 
-         {
-           dtt.addMonth(-1) ;
-           drr.month-=1 ;
-           for(; c.getMonthLength(dtt) < -drr.day; dtt.addMonth (-1))
-           { drr.day+=c.getMonthLength(dtt) ; drr.month-=1 ; }
-           day=c.getMonthLength(dtt)+drr.day+1 ;
-         }
-            
+         CDate dtt(dt);
+         drr.day += dtt.getDay() - 1;
+         dtt.setDay(1);
+
+         if (drr.day >= 0)
+         {
+           for(; c.getMonthLength(dtt) <= drr.day; dtt.addMonth(1))
+           { drr.day -= c.getMonthLength(dtt); drr.month += 1; }
+
+           day = drr.day + 1;
+         }
+         else
+         {
+           dtt.addMonth(-1);
+           drr.month -= 1;
+           for(; c.getMonthLength(dtt) < -drr.day; dtt.addMonth(-1))
+           { drr.day += c.getMonthLength(dtt); drr.month -= 1; }
+           day = c.getMonthLength(dtt) + drr.day + 1;
+         }
+
 /*
          if (day <  0) { drr.month --; day += c.getMonthLength(dtt); }
          if (day > c.getMonthLength(dtt)) { drr.month ++; day -= c.getMonthLength(dtt); } // << ProblÚme ici
          if (day == 0){ day = c.getMonthLength(dtt); drr.month --; }
-*/         
-         drr.resolve(dt.getRelCalendar());
+*/
+         drr.resolve(c);
 
          // Ajustement des années en fonction des mois.
          month += dt.getMonth() + drr.month;
-         if (month <  0) { drr.year --; month += c.getYearLength(); }
-         if (month >  c.getYearLength()) { drr.year ++; month -= c.getYearLength(); }
+         if (month < 0) { drr.year--; month += c.getYearLength(); }
+         if (month > c.getYearLength()) { drr.year++; month -= c.getYearLength(); }
          if (month == 0){ month = c.getYearLength(); drr.year--; }
 
          year += dt.getYear() + drr.year;
 
-         return (CDate(dt.getRelCalendar(), year, month, day, hour, minute, second));
-      }
-
-      CDate operator-(const CDate & dt, const CDuration & dr) { return (dt + (-dr)); }
-
-      //-----------------------------------------------------------------
-
-      CDuration operator-(const CDate & dt0, const CDate & dt1)
+         return (CDate(c, year, month, day, hour, minute, second));
+      }
+
+      CDate operator-(const CDate& dt, const CDuration& dr) { return (dt + (-dr)); }
+
+      //-----------------------------------------------------------------
+
+      CDuration operator-(const CDate& dt0, const CDate& dt1)
       {
          // TODO :: Vérifier que les deux dates (dt0 et dt1) ont une référence vers le même calendrier.
@@ -131 +137 @@
       bool operator==(const CDuration& ddr, const CDuration& dr)
       {
-         return ((ddr.year == dr.year) && (ddr.month  == dr.month)  && (dr.day    == ddr.day) &&
-                 (ddr.hour == dr.hour) && (ddr.minute == dr.minute) && (dr.second == ddr.second) &&
+         return ((ddr.year == dr.year)&& (ddr.month  == dr.month) && (dr.day    == ddr.day)&&
+                 (ddr.hour == dr.hour)&& (ddr.minute == dr.minute)&& (dr.second == ddr.second)&&
                  (ddr.timestep == dr.timestep));
       }
@@ -144 +150 @@
       {
          // TODO :: Vérifier que les deux dates (dt0 et dt1) ont une référence vers le même calendrier.
-         return ((dt0.getYear() == dt1.getYear()) && (dt0.getMonth()  == dt1.getMonth())  && (dt1.getDay()    == dt0.getDay()) &&
-                 (dt0.getHour() == dt1.getHour()) && (dt0.getMinute() == dt1.getMinute()) && (dt1.getSecond() == dt0.getSecond()));
+         return ((dt0.getYear() == dt1.getYear())&& (dt0.getMonth()  == dt1.getMonth()) && (dt1.getDay()    == dt0.getDay())&&
+                 (dt0.getHour() == dt1.getHour())&& (dt0.getMinute() == dt1.getMinute())&& (dt1.getSecond() == dt0.getSecond()));
       }
 
@@ -152 +158 @@
          // TODO :: Vérifier que les deux dates (dt0 et dt1) ont une référence vers le même calendrier.
          if   (dt0.getYear()  < dt1.getYear())
-         { 
+         {
             return true;
          }
          else if (dt0.getYear() == dt1.getYear())
-         { 
+         {
             if   (dt0.getMonth()  < dt1.getMonth())
             {
@@ -174 +180 @@
                   }
                   else if (dt0.getHour() == dt1.getHour())
-                  { 
+                  {
                      if   (dt0.getMinute()  < dt1.getMinute())
                      {
@@ -193 +199 @@
       //-----------------------------------------------------------------
 
-      bool operator!=(const CDate & dt0, const CDate & dt1){ return !(dt1 == dt0); }
-      bool operator> (const CDate & dt0, const CDate & dt1){ return (dt1 < dt0); }
-      bool operator>=(const CDate & dt0, const CDate & dt1){ return ((dt0 > dt1) || (dt1 == dt0)); }
-      bool operator<=(const CDate & dt0, const CDate & dt1){ return ((dt0 < dt1) || (dt1 == dt0)); }
+      bool operator!=(const CDate& dt0, const CDate& dt1){ return !(dt1 == dt0); }
+      bool operator> (const CDate& dt0, const CDate& dt1){ return (dt1 < dt0); }
+      bool operator>=(const CDate& dt0, const CDate& dt1){ return ((dt0 > dt1) || (dt1 == dt0)); }
+      bool operator<=(const CDate& dt0, const CDate& dt1){ return ((dt0 < dt1) || (dt1 == dt0)); }
 
       ///----------------------------------------------------------------