source: XIOS/trunk/src/node/calendar_wrapper.hpp @ 550

Last change on this file since 550 was 550, checked in by rlacroix, 6 years ago

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 size: 2.4 KB
Line 
1#ifndef __XMLIO_CCalendarWrapper__
2#define __XMLIO_CCalendarWrapper__
3
4/// xios headers ///
5#include "xmlioserver_spl.hpp"
6#include "attribute_enum.hpp"
7#include "attribute_enum_impl.hpp"
8#include "attribute_array.hpp"
9#include "declare_attribute.hpp"
10#include "object_template.hpp"
11
12#include "calendar.hpp"
13
14namespace xios {
15
16  /// ////////////////////// Déclarations ////////////////////// ///
17  class CCalendarWrapperAttributes;
18  class CCalendarWrapper;
19  ///--------------------------------------------------------------
20
21  // Declare/Define CFileAttribute
22  BEGIN_DECLARE_ATTRIBUTE_MAP(CCalendarWrapper)
23#include "calendar_wrapper_attribute.conf"
24  END_DECLARE_ATTRIBUTE_MAP(CCalendarWrapper)
25
26  ///--------------------------------------------------------------
27  /*!
28    \class CCalendarWrapper
29    This class a simple wrapper for the calendar
30  */
31  class CCalendarWrapper
32    : public CObjectTemplate<CCalendarWrapper>
33    , public CCalendarWrapperAttributes
34  {
35    public :
36
37      /// typedef ///
38      typedef CObjectTemplate<CCalendarWrapper> SuperClass;
39      typedef CCalendarWrapperAttributes SuperClassAttribute;
40
41      //---------------------------------------------------------
42
43    public :
44
45      /// Constructeurs ///
46      CCalendarWrapper(void);
47      explicit CCalendarWrapper(const StdString& id);
48
49      /// Destructeur ///
50      virtual ~CCalendarWrapper(void);
51
52      /// Accesseurs statiques ///
53      static StdString GetName(void);
54      static StdString GetDefName(void);
55      static ENodeType GetType(void);
56
57      //---------------------------------------------------------
58
59    public :
60      // Parse xml calendar node
61      virtual void parse(xml::CXMLNode& node);
62      // Try to create the calendar from the current attributes
63      void createCalendar(void);
64      // Try to update the timestep of the calendar with the corresponding attribute
65      void updateTimestep(void);
66
67    public :
68      /// Accesseurs ///
69      boost::shared_ptr<CCalendar> getCalendar(bool checkValid = false) const;
70
71      const CDate& getInitDate() const;
72      const CDate& getTimeOrigin() const;
73
74      /// Mutateurs ///
75      void setInitDate(const CDate& initDate);
76      void setTimeOrigin(const CDate& timeOrigin);
77
78    private:
79      // Calendar of context
80      boost::shared_ptr<CCalendar> calendar;
81
82  }; // class CCalendarWrapper
83
84  typedef CCalendarWrapper CCalendarWrapperDefinition;
85} // namespace xios
86
87#endif // __XMLIO_CCalendarWrapper__
Note: See TracBrowser for help on using the repository browser.