source: XIOS/trunk/src/date.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.

  • 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: 3.5 KB
Line 
1#ifndef __XMLIO_CDate__
2#define __XMLIO_CDate__
3
4/// xios headers ///
5#include "xmlioserver_spl.hpp"
6#include "exception.hpp"
7#include "duration.hpp"
8
9namespace xios
10{
11      /// ////////////////////// Déclarations ////////////////////// ///
12      class CCalendar;
13
14      class CDate
15      {
16         public :
17
18            /// Constructeurs ///
19            //!< Create an empty date associated to no calendar
20            CDate(void);
21            //!< Create an empty date associated to the specified calendar
22            CDate(const CCalendar& cal);
23            //!< Create a date associated to the specified calendar
24            CDate(const CCalendar& cal, int yr, int mth, int d,
25                                        int hr = 0, int min = 0, int sec = 0);
26            CDate(const CDate& odate);
27            CDate(const CDate* const odate); // Not implemented yet
28
29            /// Destructeur ///
30            ~CDate(void);
31
32            /// Opérateurs ///
33            CDate& operator=(const CDate& date);
34            friend StdOStream& operator<<(StdOStream& out, const CDate& date);
35            friend StdIStream& operator>>(StdIStream& in, CDate& date);
36
37            //!< Return the number of seconds since the time origin fixed when creating the calendar
38            operator Time(void) const;
39
40            /// Traitements ///
41            bool checkDate(void); // Vérifie la validité de la date.
42
43            /// Divers accesseurs ///
44            int getYear  (void) const;
45            int getMonth (void) const;
46            int getDay   (void) const;
47            int getHour  (void) const;
48            int getMinute(void) const;
49            int getSecond(void) const;
50
51            //!< Get the calendar associated to the date
52            const CCalendar& getRelCalendar(void) const;
53            bool hasRelCalendar(void) const;
54
55            //!< Get the number of seconds since the beginning of the year
56            int getSecondOfYear() const;
57            //!< Get the number of days (expressed as a real number) since the beginning of the year
58            double getDayOfYear() const;
59            //!< Get the fraction of the current year as a real number between 0 and 1
60            double getFractionOfYear() const;
61            //!< Get the number of seconds since the beginning of the day
62            int getSecondOfDay() const;
63            //!< Get the fraction of the current day as a real number between 0 and 1
64            double getFractionOfDay() const;
65
66            /// Mutateurs ///
67            void setYear  (int newyear);
68            void setMonth (int newmonth);
69            void setDay   (int newday);
70            void setHour  (int newhour);
71            void setMinute(int newminute);
72            void setSecond(int newsecond);
73
74            void setDate(int yr, int mth, int d,
75                         int hr = 0, int min = 0, int sec = 0);
76
77            void addMonth (int value);
78
79            //!< Set the calendar associated to the date
80            bool setRelCalendar(const CCalendar& relCalendar);
81
82            /// Autres ///
83            StdString toString(void) const;
84            StdString getStryyyymmdd(void) const;
85            string getStr(const string& str) const;
86
87
88         public : /* static */
89
90            static CDate FromString(const StdString& str, const CCalendar& calendar);
91
92         private :
93
94            /// Propriétés privées ///
95            const CCalendar* relCalendar; //!< Calendar associated to the date
96            int year, month, day, hour, minute, second; // Année, mois, ...
97
98
99      }; // class CDate;
100
101} // namespace xios
102
103#endif // __XMLIO_CDate__
Note: See TracBrowser for help on using the repository browser.