Changeset 550 for XIOS/trunk/src/date.cpp

Timestamp:

02/10/15 14:23:02 (9 years ago)

Author:

rlacroix

Message:

Add a new user defined calendar type.

A new calendar type "user_defined" is now available. This allows the users to create a custom calendar that we can configured to be suitable for planets other than the Earth.

An user defined calendar is always defined by two mandatory attributes:

• day_length: the duration of a day, in seconds
• and either:
  • month_length: an array containing the duration of each month, in days (the number of elements in the array is the number of months in a year)
  • or year_length: the duration of a year, in seconds (in that case, the calendar does not have months).

If the calendar has months (i.e. month_length attribute is set) and only in that case, it is possible to define leap years in order to compensate for the duration of an astronomical year not being a multiple of the day length. The leap years are defined by two mandatory attributes:

• leap_year_month: the month to which the extra day will be added in case of leap year, expressed as an integer number in the range [1, numberOfMonths]
• and leap_year_drift: the fraction of a day representing the yearly drift between the calendar year and the astronomical year, expressed as a real number in the range [0, 1).

Optionally, one can define the leap_year_drift_offset attribute to set the original drift at the beginning of the time origin's year, again expressed as a real number in the range [0, 1). If leap_year_drift_offset + leap_year_drift is greater or equal to 1, then the first year will be a leap year.

For example, the following configuration creates a Gregorian-like calendar:

<calendar type="user_defined" start_date="2012-03-01 15:00:00" time_origin="2012-02-28 15:00:00 + 1d" day_length="86400" month_lengths="(1, 12) [31 28 31 30 31 30 31 31 30 31 30 31]" leap_year_month="2" leap_year_drift="0.25" leap_year_drift_offset="0.75" />

Note that dates attributes must be written differently in the configuration file when using an user defined calendar without months:

• if the year length is greater than the day length, the input format is year-day hh:min:sec instead of year-month-day hh:min:sec
• if the day length is greater or equal to the year length, the input format is year hh:min:sec.

In all cases, it is still possible to use the date + duration notation to build a date (with both the date and duration parts being optional).

The Fortran interface has been updated accordingly so that xios_define_calendar can accept the new attributes necessary to define custom calendars.

File:

• XIOS/trunk/src/date.cpp (modified) (4 diffs)

XIOS/trunk/src/date.cpp

@@ -87 +87 @@
       }
 
-      StdIStream& operator>>(StdIStream& in, CDate& date) // Non testée.
-      {
-        char sep = '-'; // Le caractÚre c est utilisé pour "recueillir" les séparateurs "/" et ":".
-        char c;
-
-        // Default initialize the date
-        date.year = 0;
-        date.month = 1;
-        date.day = 1;
-        date.hour = 0;
-        date.minute = 0;
-        date.second = 0;
-
-        in >> date.year >> c;
-        if (c == sep)
-        {
-          in >> date.month >> c;
-          if (c == sep)
-          {
-            in >> date.day;
-            c = in.get();
-            sep = ' ';
-            if (c == sep)
-            {
-              in >> date.hour >> c;
-              sep = ':';
-              if (c == sep)
-              {
-                in>>date.minute >> c;
-                if (c == sep)
-                {
-                  in >> date.second;
-                  in >> c;
-                }
-              }
-            }
-          }
-        }
-
-        // Delay the verification until we get a calendar we can compare the date to
-        if (date.relCalendar && !date.checkDate())
-          ERROR("StdIStream& operator >> (StdIStream& in, CDate& date)",
-                << "Bad date format or not conform to calendar");
-
-        if (c == '+') // We will be adding a duration to the date
-        {
-          CDuration dur;
-          in >> dur;
-          date = date + dur;
-        }
-        else if (!in.eof())
-          ERROR("StdIStream& operator >> (StdIStream& in, CDate& date)",
-                << "Invalid date format: unexpected trailing character(s)");
+      StdIStream& operator>>(StdIStream& in, CDate& date)
+      {
+        if (date.relCalendar)
+          date.relCalendar->parseDate(in, date);
+        else
+          CCalendar::parseDateDefault(in, date);
 
         return in;
@@ -152 +105 @@
         Time retvalue = getSecondOfYear() - c.getTimeOrigin().getSecondOfYear();
 
-        if ((c.getId().compare("D360")    == 0) ||
-            (c.getId().compare("AllLeap") == 0) ||
-            (c.getId().compare("NoLeap")  == 0))
-        return (retvalue + (getYear() - c.getTimeOrigin().getYear())
-                                      * c.getYearTotalLength(*this));
-
-        for (CDate _d(c.getTimeOrigin()); _d.getYear() < getYear(); _d.setYear(_d.getYear() + 1))
-           retvalue += c.getYearTotalLength(_d);
+        if (c.hasLeapYear())
+        {
+          for (CDate _d(c.getTimeOrigin()); _d.getYear() < getYear(); _d.setYear(_d.getYear() + 1))
+            retvalue += c.getYearTotalLength(_d);
+        }
+        else
+          retvalue += (getYear() - c.getTimeOrigin().getYear()) * c.getYearTotalLength(*this);
+
 
         return retvalue;
@@ -168 +121 @@
       bool CDate::checkDate(void)
       {
-        bool retValue = true;
-
-        // This will check that a calendar was correctly associated to the date
-        const CCalendar& c = getRelCalendar();
-
-        // Vérification de la valeur du mois.
-        if (month  < 1) { retValue = false; month  = 1; }
-        if (month  > c.getYearLength())
-        { retValue = false; month = c.getYearLength(); }
-
-        // Vérification de la valeur du jour.
-        if (day    < 1) { retValue = false; day  = 1; }
-        if (day    > c.getMonthLength(*this))
-        { retValue = false; day = c.getMonthLength(*this); }
-
-        // Vérification de la valeur de l'heure.
-        if (hour   < 0) { retValue = false; hour  = 0; }
-        if (hour   >= c.getDayLength())
-        { retValue = false; hour = c.getDayLength() - 1; }
-
-        // Vérification de la valeur des minutes.
-        if (minute < 0) { retValue = false; minute = 0; }
-        if (minute >= c.getHourLength())
-        { retValue = false; minute = c.getHourLength() - 1; }
-
-        // Vérification de la valeur des secondes.
-        if (second < 0) { retValue = false; second = 0; }
-        if (second >= c.getMinuteLength())
-        { retValue = false; second = c.getMinuteLength() - 1; }
-
-        return retValue;
+        // This will also check that a calendar was correctly associated to the date
+        return getRelCalendar().checkDate(*this);
       }
 
@@ -238 +162 @@
           nbDay += c.getMonthLength(yearStart);
 
-        return ((((nbDay + getDay() - 1) * c.getDayLength() + getHour()) * c.getHourLength()
-                   + getMinute()) * c.getMinuteLength() + getSecond());
+        // We need to use getDayLengthInSeconds instead of getDayLength since we might
+        // have a non-integral number of hours per day for user defined calendars
+        return ((nbDay + getDay() - 1) * c.getDayLengthInSeconds()
+                  + (getHour() * c.getHourLength() + getMinute()) * c.getMinuteLength() + getSecond());
       }