Changeset 550 for XIOS/trunk/src/interface/c_attr

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/interface/c_attr/iccalendar_wrapper_attr.cpp (modified) (2 diffs)

XIOS/trunk/src/interface/c_attr/iccalendar_wrapper_attr.cpp

@@ -18 +18 @@
   typedef xios::CCalendarWrapper*  calendar_wrapper_Ptr;
   
+  void cxios_set_calendar_wrapper_day_length(calendar_wrapper_Ptr calendar_wrapper_hdl, int day_length)
+  {
+     CTimer::get("XIOS").resume();
+    calendar_wrapper_hdl->day_length.setValue(day_length);
+     CTimer::get("XIOS").suspend();
+  }
+  
+  void cxios_get_calendar_wrapper_day_length(calendar_wrapper_Ptr calendar_wrapper_hdl, int* day_length)
+  {
+    *day_length = calendar_wrapper_hdl->day_length.getInheritedValue();
+  }
+  
+  bool cxios_is_defined_calendar_wrapper_day_length(calendar_wrapper_Ptr calendar_wrapper_hdl )
+  {
+     CTimer::get("XIOS").resume();
+    return calendar_wrapper_hdl->day_length.hasInheritedValue();
+     CTimer::get("XIOS").suspend();
+  }
+  
+  
+  
+  void cxios_set_calendar_wrapper_leap_year_drift(calendar_wrapper_Ptr calendar_wrapper_hdl, double leap_year_drift)
+  {
+     CTimer::get("XIOS").resume();
+    calendar_wrapper_hdl->leap_year_drift.setValue(leap_year_drift);
+     CTimer::get("XIOS").suspend();
+  }
+  
+  void cxios_get_calendar_wrapper_leap_year_drift(calendar_wrapper_Ptr calendar_wrapper_hdl, double* leap_year_drift)
+  {
+    *leap_year_drift = calendar_wrapper_hdl->leap_year_drift.getInheritedValue();
+  }
+  
+  bool cxios_is_defined_calendar_wrapper_leap_year_drift(calendar_wrapper_Ptr calendar_wrapper_hdl )
+  {
+     CTimer::get("XIOS").resume();
+    return calendar_wrapper_hdl->leap_year_drift.hasInheritedValue();
+     CTimer::get("XIOS").suspend();
+  }
+  
+  
+  
+  void cxios_set_calendar_wrapper_leap_year_drift_offset(calendar_wrapper_Ptr calendar_wrapper_hdl, double leap_year_drift_offset)
+  {
+     CTimer::get("XIOS").resume();
+    calendar_wrapper_hdl->leap_year_drift_offset.setValue(leap_year_drift_offset);
+     CTimer::get("XIOS").suspend();
+  }
+  
+  void cxios_get_calendar_wrapper_leap_year_drift_offset(calendar_wrapper_Ptr calendar_wrapper_hdl, double* leap_year_drift_offset)
+  {
+    *leap_year_drift_offset = calendar_wrapper_hdl->leap_year_drift_offset.getInheritedValue();
+  }
+  
+  bool cxios_is_defined_calendar_wrapper_leap_year_drift_offset(calendar_wrapper_Ptr calendar_wrapper_hdl )
+  {
+     CTimer::get("XIOS").resume();
+    return calendar_wrapper_hdl->leap_year_drift_offset.hasInheritedValue();
+     CTimer::get("XIOS").suspend();
+  }
+  
+  
+  
+  void cxios_set_calendar_wrapper_leap_year_month(calendar_wrapper_Ptr calendar_wrapper_hdl, int leap_year_month)
+  {
+     CTimer::get("XIOS").resume();
+    calendar_wrapper_hdl->leap_year_month.setValue(leap_year_month);
+     CTimer::get("XIOS").suspend();
+  }
+  
+  void cxios_get_calendar_wrapper_leap_year_month(calendar_wrapper_Ptr calendar_wrapper_hdl, int* leap_year_month)
+  {
+    *leap_year_month = calendar_wrapper_hdl->leap_year_month.getInheritedValue();
+  }
+  
+  bool cxios_is_defined_calendar_wrapper_leap_year_month(calendar_wrapper_Ptr calendar_wrapper_hdl )
+  {
+     CTimer::get("XIOS").resume();
+    return calendar_wrapper_hdl->leap_year_month.hasInheritedValue();
+     CTimer::get("XIOS").suspend();
+  }
+  
+  
+  
+  void cxios_set_calendar_wrapper_month_lengths(calendar_wrapper_Ptr calendar_wrapper_hdl, int* month_lengths, int extent1)
+  {
+    CTimer::get("XIOS").resume();
+    CArray<int,1> tmp(month_lengths,shape(extent1),neverDeleteData) ;
+    calendar_wrapper_hdl->month_lengths.reference(tmp.copy());
+     CTimer::get("XIOS").suspend();
+  }
+  
+  void cxios_get_calendar_wrapper_month_lengths(calendar_wrapper_Ptr calendar_wrapper_hdl, int* month_lengths, int extent1)
+  {
+    CTimer::get("XIOS").resume();
+    CArray<int,1> tmp(month_lengths,shape(extent1),neverDeleteData) ;
+    tmp=calendar_wrapper_hdl->month_lengths.getInheritedValue() ;
+     CTimer::get("XIOS").suspend();
+  }
+  
+  bool cxios_is_defined_calendar_wrapper_month_lengths(calendar_wrapper_Ptr calendar_wrapper_hdl )
+  {
+     CTimer::get("XIOS").resume();
+    return calendar_wrapper_hdl->month_lengths.hasInheritedValue();
+     CTimer::get("XIOS").suspend();
+  }
+  
+  
+  
   void cxios_set_calendar_wrapper_start_date(calendar_wrapper_Ptr calendar_wrapper_hdl, const char * start_date, int start_date_size)
   {
@@ -134 +243 @@
   
   
+  void cxios_set_calendar_wrapper_year_length(calendar_wrapper_Ptr calendar_wrapper_hdl, int year_length)
+  {
+     CTimer::get("XIOS").resume();
+    calendar_wrapper_hdl->year_length.setValue(year_length);
+     CTimer::get("XIOS").suspend();
+  }
+  
+  void cxios_get_calendar_wrapper_year_length(calendar_wrapper_Ptr calendar_wrapper_hdl, int* year_length)
+  {
+    *year_length = calendar_wrapper_hdl->year_length.getInheritedValue();
+  }
+  
+  bool cxios_is_defined_calendar_wrapper_year_length(calendar_wrapper_Ptr calendar_wrapper_hdl )
+  {
+     CTimer::get("XIOS").resume();
+    return calendar_wrapper_hdl->year_length.hasInheritedValue();
+     CTimer::get("XIOS").suspend();
+  }
+  
+  
+  
   
 }