Changeset 549 for XIOS/trunk/src/interface/fortran

Timestamp:

01/26/15 14:39:26 (9 years ago)

Author:

rlacroix

Message:

Revised calendar functionalities:

• the calendar is now configured from a specific calendar child node of the context in the XML configuration file. Example: <calendar type="Gregorian" start_date="2012-03-01 15:00:00" time_origin="2012-02-29 15:00:00" timestep="1h" />
• the calendar type should now be configured when defining the start time and/or the time origin.
• the start time and the time origin are now optional, 0000-01-01 00:00:00 will be used by default. It is also possible to define them partially. For example, 2015 and 2014-12 are valid dates corresponding respectively to 2015-01-01 00:00:00 and 2014-12-01 00:00:00.
• an optional duration offset can be added to the start date and time origin. For example, it's possible to define the date 2015-01-12 12:00:00 as 2015-01-11 + 36h or 2015-01-11 12:00:00 + 1d. The duration format is the same as the time step. Being that the date is optional, it is possible to only use a duration (for example + 42s is the same as 0000-01-01 00:00:00 + 42s). An error will be raised if a duration based on the time step is used before the time step was configured. For example, the following would cause an error: <calendar type="Gregorian" start_date="+ 1ts" /> but <calendar type="Gregorian" start_date="+ 1ts" timestep="0.5h" /> would not.
• new Fortran interface to define the calendar:
  • xios_define_calendar(type[, timestep, start_date, time_origin]) will create a calendar when none had previously been defined. Only the type argument is mandatory, the rest is optional. Calendar operations on dates and durations are possible as soon as the calendar is created (either using this procedure or directly from the XML configuration file).
  • the following getter and setter procedures are available: xios_set_timestep, xios_set_start_date, xios_set_time_origin, xios_get_calendar_type, xios_get_timestep, xios_get_start_date, xios_get_time_origin.
• new Fortran interface to interact with the calendar: xios_update_calendar, xios_get_current_date, xios_get_year_length_in_seconds, xios_get_day_length_in_seconds.
• new Fortran interface for date conversion: xios_date_get_second_of_year, xios_date_get_day_of_year, xios_date_get_fraction_of_year, xios_date_get_second_of_day, xios_date_get_fraction_of_day.
• two new placeholders are available to format the file name when splitting the output (split_freq_format attribute):
  • %S the number of seconds since the time origin
  • %D the integral number of days since the time origin

Location:

XIOS/trunk/src/interface/fortran

Files:

• calendar_interface.F90 (moved) (moved from XIOS/trunk/src/interface/fortran/calendar_interface.f90) (2 diffs)
• calendar_wrapper_interface.F90 (added)
• date_interface.F90 (modified) (2 diffs)
• icalendar.F90 (modified) (3 diffs)
• icalendar_wrapper.F90 (added)
• idate.F90 (modified) (2 diffs)
• ixios.F90 (modified) (4 diffs)

XIOS/trunk/src/interface/fortran/calendar_interface.F90

@@ +1 @@
+#include "xios_fortran_prefix.hpp"
+
 MODULE CALENDAR_INTERFACE
    USE, INTRINSIC :: ISO_C_BINDING
-     
+
    INTERFACE ! Ne pas appeler directement/Interface FORTRAN 2003 <-> C99
-
-      SUBROUTINE cxios_create_calendar() BIND(C)
-      END SUBROUTINE cxios_create_calendar
 
       SUBROUTINE cxios_update_calendar(step) BIND(C)
@@ -12 +11 @@
       END SUBROUTINE cxios_update_calendar
 
+      SUBROUTINE cxios_get_current_date(current_date) BIND(C)
+         USE IDATE
+         TYPE(txios(date))             :: current_date
+      END SUBROUTINE cxios_get_current_date
+
+      INTEGER(kind = C_INT) FUNCTION cxios_get_year_length_in_seconds(year) BIND(C)
+         USE ISO_C_BINDING
+         INTEGER(kind = C_INT), VALUE :: year
+      END FUNCTION cxios_get_year_length_in_seconds
+
+      INTEGER(kind = C_INT) FUNCTION cxios_get_day_length_in_seconds() BIND(C)
+         USE ISO_C_BINDING
+      END FUNCTION cxios_get_day_length_in_seconds
+
    END INTERFACE
-     
+
 END MODULE CALENDAR_INTERFACE

XIOS/trunk/src/interface/fortran/date_interface.F90

@@ -7 +7 @@
       INTEGER(kind = C_INT) :: year, month, day, hour, minute, second
    END TYPE txios(date)
-     
+
    INTERFACE ! Ne pas appeler directement/Interface FORTRAN 2003 <-> C99
 
@@ -75 +75 @@
       END FUNCTION cxios_date_ge
 
+      INTEGER(kind = C_INT) FUNCTION cxios_date_get_second_of_year(date) BIND(C)
+         USE ISO_C_BINDING
+         IMPORT :: txios(date)
+         TYPE(txios(date)), VALUE :: date
+      END FUNCTION cxios_date_get_second_of_year
+
+      REAL(kind = C_DOUBLE) FUNCTION cxios_date_get_day_of_year(date) BIND(C)
+         USE ISO_C_BINDING
+         IMPORT :: txios(date)
+         TYPE(txios(date)), VALUE :: date
+      END FUNCTION cxios_date_get_day_of_year
+
+      REAL(kind = C_DOUBLE) FUNCTION cxios_date_get_fraction_of_year(date) BIND(C)
+         USE ISO_C_BINDING
+         IMPORT :: txios(date)
+         TYPE(txios(date)), VALUE :: date
+      END FUNCTION cxios_date_get_fraction_of_year
+
+      INTEGER(kind = C_INT) FUNCTION cxios_date_get_second_of_day(date) BIND(C)
+         USE ISO_C_BINDING
+         IMPORT :: txios(date)
+         TYPE(txios(date)), VALUE :: date
+      END FUNCTION cxios_date_get_second_of_day
+
+      REAL(kind = C_DOUBLE) FUNCTION cxios_date_get_fraction_of_day(date) BIND(C)
+         USE ISO_C_BINDING
+         IMPORT :: txios(date)
+         TYPE(txios(date)), VALUE :: date
+      END FUNCTION cxios_date_get_fraction_of_day
+
    END INTERFACE
-     
+
 END MODULE DATE_INTERFACE

XIOS/trunk/src/interface/fortran/icalendar.F90

@@ -3 +3 @@
    USE, INTRINSIC :: ISO_C_BINDING
    USE CALENDAR_INTERFACE
+   USE ICALENDAR_WRAPPER
    USE IDATE
    USE IDURATION
@@ -9 +10 @@
    INTEGER(kind = C_INT), PARAMETER :: D360 = 0 , ALLLEAP = 1 , NOLEAP = 2 , JULIAN = 3 , GREGORIAN = 4
 
+   INTERFACE xios(set_start_date)
+      MODULE PROCEDURE xios(set_start_date_date), xios(set_start_date_dur)
+   END INTERFACE xios(set_start_date)
+
+   INTERFACE xios(set_time_origin)
+      MODULE PROCEDURE xios(set_time_origin_date), xios(set_time_origin_dur)
+   END INTERFACE xios(set_time_origin)
+
    CONTAINS ! Fonctions disponibles pour les utilisateurs.
 
-   SUBROUTINE xios(set_calendar)(calendar_type, start_date, time_origin, timestep)
-      USE ICONTEXT, ONLY : txios(context), xios(get_current_context)
-      USE icontext_attr, ONLY : xios(set_context_attr_hdl)
-      USE IDATE, ONLY : txios(date)
-      USE IDURATION, ONLY : txios(duration)
-      IMPLICIT NONE
-      CHARACTER(len = *),    OPTIONAL, INTENT(IN) :: calendar_type
+   SUBROUTINE xios(define_calendar)(type, timestep, start_date, time_origin)
+      USE ICALENDAR_WRAPPER, ONLY : txios(calendar_wrapper), xios(get_default_calendar_wrapper_handle)
+      USE icalendar_wrapper_attr, ONLY : xios(set_calendar_wrapper_attr_hdl)
+      USE IDURATION, ONLY : txios(duration)
+      USE IDATE, ONLY : txios(date)
+      IMPLICIT NONE
+      CHARACTER(len = *),              INTENT(IN) :: type
+      TYPE(txios(duration)), OPTIONAL, INTENT(IN) :: timestep
       TYPE(txios(date)),     OPTIONAL, INTENT(IN) :: start_date
       TYPE(txios(date)),     OPTIONAL, INTENT(IN) :: time_origin
-      TYPE(txios(duration)), OPTIONAL, INTENT(IN) :: timestep
-      TYPE(txios(context)) :: context
-
-      CALL xios(get_current_context)(context)
-
-      IF (PRESENT(calendar_type)) THEN
-         CALL xios(set_context_attr_hdl)(context, calendar_type=calendar_type)
-      END IF
+      TYPE(txios(calendar_wrapper)) :: calendar_wrapper
+
+      CALL xios(get_default_calendar_wrapper_handle)(calendar_wrapper)
+
+      CALL xios(set_calendar_wrapper_attr_hdl)(calendar_wrapper, type=type)
+      IF (PRESENT(timestep)) THEN
+         CALL xios(set_calendar_wrapper_attr_hdl)(calendar_wrapper, timestep=timestep)
+      END IF
+
+      CALL xios(create_calendar)(calendar_wrapper)
+
       IF (PRESENT(start_date)) THEN
-         CALL xios(set_context_attr_hdl)(context, start_date=start_date)
+         CALL xios(set_start_date_hdl)(calendar_wrapper, start_date=start_date)
       END IF
       IF (PRESENT(time_origin)) THEN
-         CALL xios(set_context_attr_hdl)(context, time_origin=time_origin)
-      END IF
-      IF (PRESENT(time_origin)) THEN
-         CALL xios(set_context_attr_hdl)(context, timestep=timestep)
-      END IF
-
-      CALL cxios_create_calendar()
-   END SUBROUTINE xios(set_calendar)
+         CALL xios(set_time_origin_hdl)(calendar_wrapper, time_origin=time_origin)
+      END IF
+   END SUBROUTINE xios(define_calendar)
+
+   SUBROUTINE xios(get_calendar_type)(calendar_type)
+      USE ICALENDAR_WRAPPER, ONLY : txios(calendar_wrapper), xios(get_default_calendar_wrapper_handle)
+      USE icalendar_wrapper_attr, ONLY : xios(get_calendar_wrapper_attr_hdl)
+      IMPLICIT NONE
+      CHARACTER(len = *), INTENT(OUT) :: calendar_type
+      TYPE(txios(calendar_wrapper))   :: calendar_wrapper
+
+      CALL xios(get_default_calendar_wrapper_handle)(calendar_wrapper)
+
+      CALL xios(get_calendar_wrapper_attr_hdl)(calendar_wrapper, type=calendar_type)
+   END SUBROUTINE xios(get_calendar_type)
 
    SUBROUTINE xios(set_timestep)(timestep)
-      USE ICONTEXT, ONLY : txios(context), xios(get_current_context)
-      USE icontext_attr, ONLY : xios(set_context_attr_hdl)
+      USE ICALENDAR_WRAPPER, ONLY : txios(calendar_wrapper), xios(get_default_calendar_wrapper_handle)
+      USE icalendar_wrapper_attr, ONLY : xios(set_calendar_wrapper_attr_hdl)
       USE IDURATION, ONLY : txios(duration)
       IMPLICIT NONE
       TYPE(txios(duration)), INTENT(IN) :: timestep
-      TYPE(txios(context)) :: context
-
-      CALL xios(get_current_context)(context)
-
-      CALL xios(set_context_attr_hdl)(context, timestep=timestep)
+      TYPE(txios(calendar_wrapper))     :: calendar_wrapper
+
+      CALL xios(get_default_calendar_wrapper_handle)(calendar_wrapper)
+
+      CALL xios(set_calendar_wrapper_attr_hdl)(calendar_wrapper, timestep=timestep)
+
+      CALL xios(update_calendar_timestep)(calendar_wrapper)
    END SUBROUTINE xios(set_timestep)
 
+   SUBROUTINE xios(get_timestep)(timestep)
+      USE ICALENDAR_WRAPPER, ONLY : txios(calendar_wrapper), xios(get_default_calendar_wrapper_handle)
+      USE icalendar_wrapper_attr, ONLY : xios(get_calendar_wrapper_attr_hdl)
+      USE IDURATION, ONLY : txios(duration)
+      IMPLICIT NONE
+      TYPE(txios(duration)), INTENT(OUT) :: timestep
+      TYPE(txios(calendar_wrapper))      :: calendar_wrapper
+
+      CALL xios(get_default_calendar_wrapper_handle)(calendar_wrapper)
+
+      CALL xios(get_calendar_wrapper_attr_hdl)(calendar_wrapper, timestep=timestep)
+   END SUBROUTINE xios(get_timestep)
+
+   SUBROUTINE xios(set_start_date_date)(start_date)
+      USE ICALENDAR_WRAPPER, ONLY : txios(calendar_wrapper), xios(get_default_calendar_wrapper_handle)
+      USE IDATE, ONLY : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(IN) :: start_date
+      TYPE(txios(calendar_wrapper)) :: calendar_wrapper
+
+      CALL xios(get_default_calendar_wrapper_handle)(calendar_wrapper)
+
+      CALL xios(set_start_date_hdl)(calendar_wrapper, start_date)
+   END SUBROUTINE xios(set_start_date_date)
+
+   SUBROUTINE xios(set_start_date_dur)(start_date)
+      USE ICALENDAR_WRAPPER, ONLY : txios(calendar_wrapper), xios(get_default_calendar_wrapper_handle)
+      USE IDURATION, ONLY : txios(duration)
+      USE IDATE, ONLY : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(duration)), INTENT(IN) :: start_date
+      TYPE(txios(calendar_wrapper))     :: calendar_wrapper
+      TYPE(txios(date))                 :: start_date_date
+
+      CALL xios(get_default_calendar_wrapper_handle)(calendar_wrapper)
+
+      start_date_date = start_date
+      CALL xios(set_start_date_hdl)(calendar_wrapper, start_date_date)
+   END SUBROUTINE xios(set_start_date_dur)
+
+   SUBROUTINE xios(get_start_date)(start_date)
+      USE ICALENDAR_WRAPPER, ONLY : txios(calendar_wrapper), xios(get_default_calendar_wrapper_handle)
+      USE IDATE, ONLY : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(OUT) :: start_date
+      TYPE(txios(calendar_wrapper))  :: calendar_wrapper
+
+      CALL xios(get_default_calendar_wrapper_handle)(calendar_wrapper)
+
+      CALL xios(get_start_date_hdl)(calendar_wrapper, start_date)
+   END SUBROUTINE xios(get_start_date)
+
+   SUBROUTINE xios(set_time_origin_date)(time_origin)
+      USE ICALENDAR_WRAPPER, ONLY : txios(calendar_wrapper), xios(get_default_calendar_wrapper_handle)
+      USE IDATE, ONLY : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(IN) :: time_origin
+      TYPE(txios(calendar_wrapper)) :: calendar_wrapper
+
+      CALL xios(get_default_calendar_wrapper_handle)(calendar_wrapper)
+
+      CALL xios(set_time_origin_hdl)(calendar_wrapper, time_origin)
+   END SUBROUTINE xios(set_time_origin_date)
+
+   SUBROUTINE xios(set_time_origin_dur)(time_origin)
+      USE ICALENDAR_WRAPPER, ONLY : txios(calendar_wrapper), xios(get_default_calendar_wrapper_handle)
+      USE IDURATION, ONLY : txios(duration)
+      USE IDATE, ONLY : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(duration)), INTENT(IN) :: time_origin
+      TYPE(txios(calendar_wrapper))     :: calendar_wrapper
+      TYPE(txios(date))                 :: time_origin_date
+
+      CALL xios(get_default_calendar_wrapper_handle)(calendar_wrapper)
+
+      time_origin_date = time_origin
+      CALL xios(set_time_origin_hdl)(calendar_wrapper, time_origin_date)
+   END SUBROUTINE xios(set_time_origin_dur)
+
+   SUBROUTINE xios(get_time_origin)(time_origin)
+      USE ICALENDAR_WRAPPER, ONLY : txios(calendar_wrapper), xios(get_default_calendar_wrapper_handle)
+      USE IDATE, ONLY : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(OUT) :: time_origin
+      TYPE(txios(calendar_wrapper))  :: calendar_wrapper
+
+      CALL xios(get_default_calendar_wrapper_handle)(calendar_wrapper)
+
+      CALL xios(get_time_origin_hdl)(calendar_wrapper, time_origin)
+   END SUBROUTINE xios(get_time_origin)
+
    SUBROUTINE xios(update_calendar)(step)
       IMPLICIT NONE
       INTEGER, INTENT(IN) :: step
-      
+
       IF (step < 0) THEN
          PRINT *, "L'argument 'step' ne peut être négatif"
@@ -65 +178 @@
    END SUBROUTINE xios(update_calendar)
 
+   SUBROUTINE xios(get_current_date)(current_date)
+      USE IDATE, ONLY : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(OUT) :: current_date
+
+      CALL cxios_get_current_date(current_date)
+   END SUBROUTINE xios(get_current_date)
+
+   FUNCTION xios(get_year_length_in_seconds)(year) RESULT(res)
+      IMPLICIT NONE
+      INTEGER(kind = C_INT), INTENT(IN) :: year
+      INTEGER(kind = C_INT) :: res
+
+      res = cxios_get_year_length_in_seconds(year)
+   END FUNCTION xios(get_year_length_in_seconds)
+
+   FUNCTION xios(get_day_length_in_seconds)() RESULT(res)
+      IMPLICIT NONE
+      INTEGER(kind = C_INT) :: res
+
+      res = cxios_get_day_length_in_seconds()
+   END FUNCTION xios(get_day_length_in_seconds)
+
 END MODULE ICALENDAR

XIOS/trunk/src/interface/fortran/idate.F90

@@ -37 +37 @@
    END INTERFACE
 
+   INTERFACE ASSIGNMENT(=)
+      MODULE PROCEDURE xios(date_assign_duration)
+   END INTERFACE
+
    CONTAINS ! Fonctions disponibles pour les utilisateurs.
 
@@ -140 +144 @@
    END FUNCTION xios(date_ge)
 
+   SUBROUTINE xios(date_assign_duration)(date, dur)
+      USE DATE_INTERFACE, only : txios(date)
+      USE IDURATION, only : txios(duration)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(OUT) :: date
+      TYPE(txios(duration)), INTENT(IN) :: dur
+
+      date = txios(date)(0, 1, 1, 0, 0, 0) + dur
+   END SUBROUTINE xios(date_assign_duration)
+
+   FUNCTION xios(date_get_second_of_year)(date) RESULT(res)
+      USE DATE_INTERFACE, only : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(OUT) :: date
+      INTEGER(kind = C_INT) :: res
+
+      res = cxios_date_get_second_of_year(date)
+   END FUNCTION xios(date_get_second_of_year)
+
+   FUNCTION xios(date_get_day_of_year)(date) RESULT(res)
+      USE DATE_INTERFACE, only : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(OUT) :: date
+      REAL(kind = C_DOUBLE) :: res
+
+      res = cxios_date_get_day_of_year(date)
+   END FUNCTION xios(date_get_day_of_year)
+
+   FUNCTION xios(date_get_fraction_of_year)(date) RESULT(res)
+      USE DATE_INTERFACE, only : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(OUT) :: date
+      REAL(kind = C_DOUBLE) :: res
+
+      res = cxios_date_get_fraction_of_year(date)
+   END FUNCTION xios(date_get_fraction_of_year)
+
+   FUNCTION xios(date_get_second_of_day)(date) RESULT(res)
+      USE DATE_INTERFACE, only : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(OUT) :: date
+      INTEGER(kind = C_INT) :: res
+
+      res = cxios_date_get_second_of_day(date)
+   END FUNCTION xios(date_get_second_of_day)
+
+   FUNCTION xios(date_get_fraction_of_day)(date) RESULT(res)
+      USE DATE_INTERFACE, only : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(OUT) :: date
+      REAL(kind = C_DOUBLE) :: res
+
+      res = cxios_date_get_fraction_of_day(date)
+   END FUNCTION xios(date_get_fraction_of_day)
+
 END MODULE IDATE

XIOS/trunk/src/interface/fortran/ixios.F90

@@ -3 +3 @@
 MODULE XIOS
 
-USE icalendar, ONLY : xios(set_calendar), xios(set_timestep), xios(update_calendar)
+USE icalendar, ONLY : xios(define_calendar), xios(set_timestep), xios(set_start_date), xios(set_time_origin), &
+                      xios(get_calendar_type), xios(get_timestep), xios(get_start_date), xios(get_time_origin), &
+                      xios(update_calendar), xios(get_current_date), &
+                      xios(get_year_length_in_seconds), xios(get_day_length_in_seconds)
 
 USE icontext, ONLY : txios(context), xios(get_context_handle), xios(set_current_context),    &
@@ -24 +27 @@
                   xios(date_add_duration), xios(date_sub_duration), xios(date_sub), &
                   xios(date_eq), xios(date_neq), xios(date_lt), xios(date_le), xios(date_gt), xios(date_ge), &
+                  xios(date_get_second_of_year), xios(date_get_day_of_year), xios(date_get_fraction_of_year), &
+                  xios(date_get_second_of_day), xios(date_get_fraction_of_day), &
                   OPERATOR(+), OPERATOR(-), &
-                  OPERATOR(==), OPERATOR(/=), OPERATOR(<), OPERATOR(<=), OPERATOR(>), OPERATOR(>=)
+                  OPERATOR(==), OPERATOR(/=), OPERATOR(<), OPERATOR(<=), OPERATOR(>), OPERATOR(>=), &
+                  ASSIGNMENT(=)
 
 USE idomain, ONLY : txios(domain), txios(domaingroup), xios(get_domain_handle),  &
@@ -200 +206 @@
            xios(field_is_active)
 
- PUBLIC :: xios(set_calendar), xios(set_timestep), xios(update_calendar)
+ PUBLIC :: xios(define_calendar), xios(set_timestep), xios(set_start_date), xios(set_time_origin), &
+           xios(get_calendar_type), xios(get_timestep), xios(get_start_date), xios(get_time_origin), &
+           xios(update_calendar), xios(get_current_date), &
+           xios(get_year_length_in_seconds), xios(get_day_length_in_seconds)
 
  PUBLIC :: xios(year), xios(month), xios(day), xios(hour), xios(minute), xios(second), xios(timestep), &
@@ -208 +217 @@
  PUBLIC :: xios(date_convert_to_seconds), &
            xios(date_add_duration), xios(date_sub_duration), xios(date_sub), &
-           xios(date_eq), xios(date_neq), xios(date_lt), xios(date_le), xios(date_gt), xios(date_ge)
+           xios(date_eq), xios(date_neq), xios(date_lt), xios(date_le), xios(date_gt), xios(date_ge), &
+           xios(date_get_second_of_year), xios(date_get_day_of_year), xios(date_get_fraction_of_year), &
+           xios(date_get_second_of_day), xios(date_get_fraction_of_day)
 
  PUBLIC :: OPERATOR(+), OPERATOR(-), OPERATOR(*), &
-           OPERATOR(==), OPERATOR(/=), OPERATOR(<), OPERATOR(<=), OPERATOR(>), OPERATOR(>=)
+           OPERATOR(==), OPERATOR(/=), OPERATOR(<), OPERATOR(<=), OPERATOR(>), OPERATOR(>=), &
+           ASSIGNMENT(=)
 
  PUBLIC :: xios(getVar)