Changeset 545 for XIOS/trunk/src/interface/fortran/idate.F90

Timestamp:

12/17/14 11:14:05 (9 years ago)

Author:

rlacroix

Message:

Expose the calendar operations through the Fortran interface.

• Add arithmetic operations on the xios_duration and xios_date types:
  • xios_duration + xios_duration = xios_duration
  • xios_duration - xios_duration = xios_duration
  • scalar * xios_duration = xios_duration * scalar = xios_duration
  • - xios_duration = xios_duration
  • xios_date + xios_duration = xios_date
  • xios_date - xios_duration = xios_date
  • xios_date - xios_date = xios_duration
• Add comparison operations on the xios_duration and xios_date types:
  • xios_duration: ==, /=
  • xios_date: ==, /=, <, <=, >, >=
• Add a new function "xios_date_convert_to_seconds" to convert a date into the number of seconds since the time origin of the calendar
• Define some constant durations "xios_second", "xios_minute", "xios_hour", "xios_day", "xios_month", "xios_year" et "xios_timestep" to ease the definition of new durations (for example, 10h is just 10 * xios_hour)
• Add a new function "xios_set_calendar" so that one can manually create the calendar attached to the current context and thus use the calendar operations before calling "xios_close_context_definition". This function can accept optional parameters so that the calendar attributes (calendar_type, start_date, time_origin and timestep) can be easily overwritten. Note that you cannot define a new calendar after one was already created (either because "xios_set_calendar" or "xios_close_context_definition" was used)
• Readd the function "xios_set_timestep" as a simplified alias of "xios_set_context_attr(context, timestep)" for the current context

File:

• XIOS/trunk/src/interface/fortran/idate.F90 (modified) (1 diff)

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

@@ -2 +2 @@
 MODULE IDATE
    USE, INTRINSIC :: ISO_C_BINDING
+   USE DATE_INTERFACE
 
-   ! enum XCalendarType
-   INTEGER(kind = C_INT), PARAMETER :: D360 = 0 , ALLLEAP = 1 , NOLEAP = 2 , JULIAN = 3 , GREGORIAN = 4
+   INTERFACE OPERATOR(+)
+      MODULE PROCEDURE xios(date_add_duration)
+   END INTERFACE
 
-   TYPE, BIND(C) :: txios(date)
-      INTEGER(kind = C_INT) :: year, month, day, hour, minute, second
-   END TYPE txios(date)
+   INTERFACE OPERATOR(-)
+      MODULE PROCEDURE xios(date_sub_duration)
+      MODULE PROCEDURE xios(date_sub)
+   END INTERFACE
 
-   TYPE, BIND(C) :: txios(duration)
-      REAL(kind = C_DOUBLE) :: year=0, month=0, day=0, hour=0, minute=0, second=0, timestep=0
-   END TYPE txios(duration)
+   INTERFACE OPERATOR(==)
+      MODULE PROCEDURE xios(date_eq)
+   END INTERFACE
 
-   INTERFACE ! Ne pas appeler directement/Interface FORTRAN 2003 <-> C99
+   INTERFACE OPERATOR(/=)
+      MODULE PROCEDURE xios(date_neq)
+   END INTERFACE
 
-      SUBROUTINE cxios_update_calendar(step) BIND(C)
-         IMPORT C_INT
-         INTEGER (kind = C_INT), VALUE :: step
-      END SUBROUTINE cxios_update_calendar
+   INTERFACE OPERATOR(<)
+      MODULE PROCEDURE xios(date_lt)
+   END INTERFACE
 
+   INTERFACE OPERATOR(<=)
+      MODULE PROCEDURE xios(date_le)
    END INTERFACE
-   
+
+   INTERFACE OPERATOR(>)
+      MODULE PROCEDURE xios(date_gt)
+   END INTERFACE
+
+   INTERFACE OPERATOR(>=)
+      MODULE PROCEDURE xios(date_ge)
+   END INTERFACE
+
    CONTAINS ! Fonctions disponibles pour les utilisateurs.
 
-   SUBROUTINE xios(update_calendar)(step)
-     IMPLICIT NONE
-     INTEGER, INTENT(IN):: step
-      
-      IF (step < 0) THEN
-         PRINT *, "L'argument 'step' ne peut être négatif"
-         STOP
-      END IF
-      CALL cxios_update_calendar(step)
-   END SUBROUTINE xios(update_calendar)
+   FUNCTION xios(date_convert_to_seconds)(date) RESULT(res)
+      USE DATE_INTERFACE, only : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(IN) :: date
+      INTEGER(kind = C_LONG_LONG) :: res
+
+      res = cxios_date_convert_to_seconds(date)
+   END FUNCTION xios(date_convert_to_seconds)
+
+   ! Addition: date + duration = date
+
+   FUNCTION xios(date_add_duration)(date, dur) RESULT(res)
+      USE DATE_INTERFACE, only : txios(date)
+      USE IDURATION, only : txios(duration)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(IN) :: date
+      TYPE(txios(duration)), INTENT(IN) :: dur
+      TYPE(txios(date)) :: res
+
+      res = cxios_date_add_duration(date, dur)
+   END FUNCTION xios(date_add_duration)
+
+   ! Subtraction: date - duration = date
+
+   FUNCTION xios(date_sub_duration)(date, dur) RESULT(res)
+      USE DATE_INTERFACE, only : txios(date)
+      USE IDURATION, only : txios(duration)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(IN) :: date
+      TYPE(txios(duration)), INTENT(IN) :: dur
+      TYPE(txios(date)) :: res
+
+      res = cxios_date_sub_duration(date, dur)
+   END FUNCTION xios(date_sub_duration)
+
+   ! Subtraction: date - date = duration
+
+   FUNCTION xios(date_sub)(date1, date2) RESULT(res)
+      USE DATE_INTERFACE, only : txios(date)
+      USE IDURATION, only : txios(duration)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(IN) :: date1, date2
+      TYPE(txios(duration)) :: res
+
+      res = cxios_date_sub(date1, date2)
+   END FUNCTION xios(date_sub)
+
+   FUNCTION xios(date_eq)(date1, date2) RESULT(res)
+      USE DATE_INTERFACE, only : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(IN) :: date1, date2
+      LOGICAL :: res
+
+      res = cxios_date_eq(date1, date2)
+   END FUNCTION xios(date_eq)
+
+   FUNCTION xios(date_neq)(date1, date2) RESULT(res)
+      USE DATE_INTERFACE, only : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(IN) :: date1, date2
+      LOGICAL :: res
+
+      res = cxios_date_neq(date1, date2)
+   END FUNCTION xios(date_neq)
+
+   FUNCTION xios(date_lt)(date1, date2) RESULT(res)
+      USE DATE_INTERFACE, only : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(IN) :: date1, date2
+      LOGICAL :: res
+
+      res = cxios_date_lt(date1, date2)
+   END FUNCTION xios(date_lt)
+
+   FUNCTION xios(date_le)(date1, date2) RESULT(res)
+      USE DATE_INTERFACE, only : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(IN) :: date1, date2
+      LOGICAL :: res
+
+      res = cxios_date_le(date1, date2)
+   END FUNCTION xios(date_le)
+
+   FUNCTION xios(date_gt)(date1, date2) RESULT(res)
+      USE DATE_INTERFACE, only : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(IN) :: date1, date2
+      LOGICAL :: res
+
+      res = cxios_date_gt(date1, date2)
+   END FUNCTION xios(date_gt)
+
+   FUNCTION xios(date_ge)(date1, date2) RESULT(res)
+      USE DATE_INTERFACE, only : txios(date)
+      IMPLICIT NONE
+      TYPE(txios(date)), INTENT(IN) :: date1, date2
+      LOGICAL :: res
+
+      res = cxios_date_ge(date1, date2)
+   END FUNCTION xios(date_ge)
 
 END MODULE IDATE