source: XIOS/trunk/src/calendar.hpp @ 550

Last change on this file since 550 was 550, checked in by rlacroix, 9 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.
  • Property copyright set to
    Software name : XIOS (Xml I/O Server)
    http://forge.ipsl.jussieu.fr/ioserver
    Creation date : January 2009
    Licence : CeCCIL version2
    see license file in root directory : Licence_CeCILL_V2-en.txt
    or http://www.cecill.info/licences/Licence_CeCILL_V2-en.html
    Holder : CEA/LSCE (Laboratoire des Sciences du CLimat et de l'Environnement)
    CNRS/IPSL (Institut Pierre Simon Laplace)
    Project Manager : Yann Meurdesoif
    yann.meurdesoif@cea.fr
File size: 4.4 KB
Line 
1#ifndef __XMLIO_CCalendar__
2#define __XMLIO_CCalendar__
3
4/// xios headers ///
5#include "xmlioserver_spl.hpp"
6#include "exception.hpp"
7#include "date.hpp"
8
9namespace xios
10{
11      /// ////////////////////// Déclarations ////////////////////// ///
12
13      typedef enum _monthEnum
14      {  JAN = 1, FEB = 2, MAR = 3, APR = 4 , MAY = 5 , JUN = 6 ,
15         JUL = 7, AUG = 8, SEP = 9, OCT = 10, NOV = 11, DEC = 12  } MonthEnum;
16
17      ///---------------------------------------------------------------
18
19      class CDate;
20
21      class CCalendar : public CObject
22      {
23            /// Typedef ///
24            typedef CObject SuperClass;
25
26         public :
27
28            /// Destructeur ///
29            virtual ~CCalendar(void);
30
31         protected :
32
33            /// Constructeurs ///
34            CCalendar(void);
35            CCalendar(const StdString& id);
36            CCalendar(const StdString& id,
37                      int yr, int mth, int d,
38                      int hr = 0, int min = 0, int sec = 0);
39            CCalendar(const StdString& id, const CDate& startDate);
40            CCalendar(const StdString& id, const CDate& startDate, const CDate& timeOrigin);
41
42            CCalendar(const CCalendar& calendar);       // Not implemented yet.
43            CCalendar(const CCalendar* const calendar); // Not implemented yet.
44
45         public :
46
47            //------------------------------------------------------------
48
49            /// Autres ///
50            virtual StdString toString(void) const;
51            virtual void fromString(const StdString& str);
52
53            /// Mutateur ///
54            void setTimeStep(const CDuration& timestep);
55            void setInitDate(const CDate& initDate);
56            void setTimeOrigin(const CDate& timeOrigin);
57
58            /// Traitemants ///
59            CDate& update(int step);
60
61            /// Accesseurs ///
62            const CDuration& getTimeStep(void) const;
63            const CDate& getInitDate(void) const;
64            const CDate& getTimeOrigin(void) const;
65            CDate& getCurrentDate(void);
66
67         public :
68
69            //------------------------------------------------------------
70            virtual StdString getType(void) const;
71
72            virtual int getMonthLength(const CDate& date) const;
73
74            virtual int getYearTotalLength(const CDate& date) const; // Retourne la durée d'une année en seconde.
75
76            virtual int getYearLength  (void) const; // Retourne la durée d'une année en mois.
77            virtual int getDayLength   (void) const; // Retourne la durée d'un jour en heures.
78            virtual int getHourLength  (void) const; // Retourne la durée d'une heure en minute.
79            virtual int getMinuteLength(void) const; // Retourne la durée d'une minute en secondes.
80            /*! Returns the day length expressed in seconds. */
81            virtual int getDayLengthInSeconds(void) const;
82
83            virtual StdString getMonthName(int monthId) const;
84            virtual const StdString getMonthShortName(int monthId) const;
85
86            /*! Test if the calendar can have leap year. */
87            virtual bool hasLeapYear() const;
88
89            void initializeDate(int yr, int mth, int d, int hr = 0, int min = 0, int sec = 0);
90            void initializeDate(const StdString& dateStr);
91            void initializeDate(const StdString& dateStr, const StdString& timeOrigin);
92
93            /*! Simplify a duration based on the calendar information. */
94            virtual CDuration& resolve(CDuration& dur, bool noNegativeTime = false) const;
95
96            /*! Parse a date using a generic parser. */
97            static void parseDateDefault(StdIStream& in, CDate& date);
98            /*! Parse a date using the calendar's parser. */
99            virtual void parseDate(StdIStream& in, CDate& date) const;
100
101            /*! Test if a date is valid with regard to the current calendar. */
102            virtual bool checkDate(CDate& date) const;
103
104            //------------------------------------------------------------
105
106         protected:
107
108            //!< Associate the dates to the calendar and check their validity
109            void initializeDate();
110
111            //------------------------------------------------------------
112
113         private :
114
115            /// Propriétés privées ///
116            CDate initDate;
117            CDate timeOrigin;
118            CDate currentDate;
119            CDuration timestep;
120
121      }; // class CCalendar
122
123} // namespace xios
124
125#endif // __XMLIO_CCalendar__
Note: See TracBrowser for help on using the repository browser.