Changeset 550 for XIOS/trunk/src/calendar.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/calendar.cpp (modified) (2 diffs)

XIOS/trunk/src/calendar.cpp

@@ -165 +165 @@
       int CCalendar::getDayLengthInSeconds(void) const { return getDayLength() * getHourLength() * getMinuteLength(); }
 
+      bool CCalendar::hasLeapYear() const { return false; }
+
       StdString CCalendar::getMonthName(int monthId) const
       {
@@ -176 +178 @@
       { StdString value = this->getMonthName(monthId); value.resize(3); return value; }
 
-      ///----------------------------------------------------------------
-
+      CDuration& CCalendar::resolve(CDuration& dur, bool noNegativeTime /*= false*/) const
+      {
+        const int hourLengthInSeconds = getHourLength() * getMinuteLength();
+
+        // Simplify the days, hours, minutes and seconds.
+        // First convert them to seconds
+        Time t = Time(modf(dur.day, &dur.day) * getDayLengthInSeconds()
+                        + (dur.hour * getHourLength() + dur.minute) * getMinuteLength() + dur.second);
+        // Then convert back to days
+        dur.day += int(t / getDayLengthInSeconds());
+        t %= getDayLengthInSeconds();
+
+        // Do we allow hour, minute, second to be negative?
+        if (noNegativeTime)
+        {
+          // If we don't, we remove some days until the time is positive
+          while (t < 0)
+          {
+            t += getDayLengthInSeconds();
+            dur.day -= 1.0;
+          }
+        }
+
+        // hours
+        dur.hour = int(t / hourLengthInSeconds);
+        t %= hourLengthInSeconds;
+        // minutes
+        dur.minute = int(t / getMinuteLength());
+        // secondes
+        dur.second = int(t % getMinuteLength());
+
+        // Nothing to do for the months yet since this depends on an actual date
+
+        // Simplify the years
+        dur.month  += modf(dur.year, &dur.year) * getYearLength();
+        dur.year   += int(dur.month) / getYearLength(); dur.month = int(dur.month) % getYearLength();
+
+        return dur;
+      }
+
+      /*! Parse a date using a generic parser. */
+      void CCalendar::parseDateDefault(StdIStream& in, CDate& date)
+      {
+        char sep = '-'; // Le caractÚre c est utilisé pour "recueillir" les séparateurs "/" et ":".
+        char c;
+
+        // Default initialize the date
+        int year = 00, month  = 01, day    = 01;
+        int hour = 00, minute = 00, second = 00;
+
+        in >> year >> c;
+        if (c == sep)
+        {
+          in >> month >> c;
+          if (c == sep)
+          {
+            in >> day;
+            c = in.get();
+            sep = ' ';
+            if (c == sep)
+            {
+              in >> hour >> c;
+              sep = ':';
+              if (c == sep)
+              {
+                in >> minute >> c;
+                if (c == sep)
+                {
+                  in >> second;
+                  in >> c;
+                }
+              }
+            }
+          }
+        }
+
+        date.setDate(year, month, day, hour, minute, second);
+
+        // Delay the verification until we get a calendar we can compare the date to
+        if (date.hasRelCalendar() && !date.checkDate())
+          ERROR("void parseDateDefault(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("void parseDateDefault(StdIStream& in, CDate& date)",
+                << "Invalid date format: unexpected trailing character(s)");
+      }
+
+      /*! Parse a date using the calendar's parser. */
+      void CCalendar::parseDate(StdIStream& in, CDate& date) const
+      {
+        parseDateDefault(in, date);
+      }
+
+      /*! Test if a date is valid with regard to the current calendar. */
+      bool CCalendar::checkDate(CDate& date) const
+      {
+        bool isValid = true;
+
+        // Vérification de la valeur du mois.
+        if (date.getMonth() < 1)
+        { isValid = false; date.setMonth(1); }
+        else if (date.getMonth() > getYearLength())
+        { isValid = false; date.setMonth(getYearLength()); }
+
+        // Vérification de la valeur du jour.
+        if (date.getDay() < 1)
+        { isValid = false; date.setDay(1); }
+        else if (date.getDay() > getMonthLength(*this))
+        { isValid = false; date.setDay(getMonthLength(*this)); }
+
+        // Vérification de la valeur de l'heure.
+        if (date.getHour() < 0)
+        { isValid = false; date.setHour(0); }
+        else if (date.getHour() >= getDayLength())
+        { isValid = false; date.setHour(getDayLength() - 1); }
+
+        // Vérification de la valeur des minutes.
+        if (date.getMinute() < 0)
+        { isValid = false; date.setMinute(0); }
+        else if (date.getMinute() >= getHourLength())
+        { isValid = false; date.setMinute(getHourLength() - 1); }
+
+        // Vérification de la valeur des secondes.
+        if (date.getSecond() < 0)
+        { isValid = false; date.setSecond(0); }
+        else if (date.getSecond() >= getMinuteLength())
+        { isValid = false; date.setSecond(getMinuteLength() - 1); }
+
+        return isValid;
+      }
 } // namespace xios