source: XIOS/trunk/src/test/test_client.f90 @ 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: 4.5 KB
Line 
1PROGRAM test_client
2
3  USE xios
4  USE mod_wait
5  IMPLICIT NONE
6  INCLUDE "mpif.h"
7  INTEGER :: rank
8  INTEGER :: size
9  INTEGER :: ierr
10
11  CHARACTER(len=*),PARAMETER :: id="client"
12  INTEGER :: comm
13  TYPE(xios_duration) :: dtime
14  TYPE(xios_date) :: date
15  CHARACTER(len=15) :: calendar_type
16  TYPE(xios_context) :: ctx_hdl
17  INTEGER,PARAMETER :: ni_glo=100
18  INTEGER,PARAMETER :: nj_glo=100
19  INTEGER,PARAMETER :: llm=5
20  DOUBLE PRECISION  :: lval(llm)=1
21  TYPE(xios_field) :: field_hdl
22  TYPE(xios_fieldgroup) :: fieldgroup_hdl
23  TYPE(xios_file) :: file_hdl
24  LOGICAL :: ok
25
26  DOUBLE PRECISION,DIMENSION(ni_glo,nj_glo) :: lon_glo,lat_glo
27  DOUBLE PRECISION :: field_A_glo(ni_glo,nj_glo,llm)
28  DOUBLE PRECISION,ALLOCATABLE :: lon(:,:),lat(:,:),field_A(:,:,:), lonvalue(:) ;
29  INTEGER :: ni,ibegin,iend,nj,jbegin,jend
30  INTEGER :: i,j,l,ts,n
31
32!!! MPI Initialization
33
34  CALL MPI_INIT(ierr)
35
36  CALL init_wait
37
38!!! XIOS Initialization (get the local communicator)
39
40  CALL xios_initialize(id,return_comm=comm)
41
42  CALL MPI_COMM_RANK(comm,rank,ierr)
43  CALL MPI_COMM_SIZE(comm,size,ierr)
44
45  DO j=1,nj_glo
46    DO i=1,ni_glo
47      lon_glo(i,j)=(i-1)+(j-1)*ni_glo
48      lat_glo(i,j)=1000+(i-1)+(j-1)*ni_glo
49      DO l=1,llm
50        field_A_glo(i,j,l)=(i-1)+(j-1)*ni_glo+10000*l
51      ENDDO
52    ENDDO
53  ENDDO
54  ni=ni_glo ; ibegin=1
55
56  jbegin=1
57  DO n=0,size-1
58    nj=nj_glo/size
59    IF (n<MOD(nj_glo,size)) nj=nj+1
60    IF (n==rank) exit
61    jbegin=jbegin+nj
62  ENDDO
63
64  iend=ibegin+ni-1 ; jend=jbegin+nj-1
65
66  ALLOCATE(lon(ni,nj),lat(ni,nj),field_A(0:ni+1,-1:nj+2,llm),lonvalue(ni*nj))
67  lon(:,:)=lon_glo(ibegin:iend,jbegin:jend)
68  lat(:,:)=lat_glo(ibegin:iend,jbegin:jend)
69  field_A(1:ni,1:nj,:)=field_A_glo(ibegin:iend,jbegin:jend,:)
70
71  CALL xios_context_initialize("test",comm)
72  CALL xios_get_handle("test",ctx_hdl)
73  CALL xios_set_current_context(ctx_hdl)
74
75  CALL xios_get_calendar_type(calendar_type)
76  PRINT *, "calendar_type = ", calendar_type
77
78  CALL xios_set_axis_attr("axis_A",size=llm ,value=lval) ;
79  CALL xios_set_domain_attr("domain_A",ni_glo=ni_glo, nj_glo=nj_glo, ibegin=ibegin, ni=ni,jbegin=jbegin,nj=nj)
80  CALL xios_set_domain_attr("domain_A",data_dim=2, data_ibegin=-1, data_ni=ni+2, data_jbegin=-2, data_nj=nj+4)
81  CALL xios_set_domain_attr("domain_A",lonvalue=RESHAPE(lon,(/ni*nj/)),latvalue=RESHAPE(lat,(/ni*nj/)))
82  CALL xios_set_fieldgroup_attr("field_definition",enabled=.TRUE.)
83
84  CALL xios_get_handle("field_definition",fieldgroup_hdl)
85  CALL xios_add_child(fieldgroup_hdl,field_hdl,"field_B")
86  CALL xios_set_attr(field_hdl,field_ref="field_A",name="field_B")
87
88  CALL xios_get_handle("output",file_hdl)
89  CALL xios_add_child(file_hdl,field_hdl)
90  CALL xios_set_attr(field_hdl,field_ref="field_A",name="field_C")
91
92  dtime%second = 3600
93  CALL xios_set_timestep(dtime)
94
95  ! The calendar is created as soon as the calendar type is defined. This way
96  ! calendar operations can be used before the context definition is closed
97  CALL xios_get_time_origin(date)
98  PRINT *, "--> year length = ", xios_get_year_length_in_seconds(date%year)
99  PRINT *, "--> day length = ", xios_get_day_length_in_seconds()
100  PRINT *, "time_origin = ", date
101  PRINT *, "xios_date_get_second_of_year(time_origin) = ", xios_date_get_second_of_year(date)
102  PRINT *, "xios_date_get_day_of_year(time_origin) = ", xios_date_get_day_of_year(date)
103  PRINT *, "xios_date_get_fraction_of_year(time_origin) = ", xios_date_get_fraction_of_year(date)
104  PRINT *, "xios_date_get_second_of_day(time_origin) = ", xios_date_get_second_of_day(date)
105  PRINT *, "xios_date_get_fraction_of_day(time_origin) = ", xios_date_get_fraction_of_day(date)
106  dtime%timestep = 1
107  dtime = 0.5 * dtime
108  PRINT *, "duration = ", dtime
109  date = date + 3 * (dtime + dtime)
110  PRINT *, "date = time_origin + 3 * (duration + duration) = ", date
111  PRINT *, "xios_date_convert_to_seconds(date) = ", xios_date_convert_to_seconds(date)
112  PRINT *, "xios_date_convert_to_seconds(date - 2.5h) = ", xios_date_convert_to_seconds(date - 2.5 * xios_hour)
113
114  ni=0 ; lonvalue(:)=0
115  CALL xios_get_domain_attr("domain_A",ni=ni,lonvalue=lonvalue)
116
117  print *,"ni",ni
118  print *,"lonvalue",lonvalue ;
119
120  CALL xios_is_defined_field_attr("field_A",enabled=ok)
121  PRINT *,"field_A : attribute enabled is defined ? ",ok
122  CALL xios_close_context_definition()
123
124  PRINT*,"field field_A is active ? ",xios_field_is_active("field_A")
125  DO ts=1,24*10
126    CALL xios_update_calendar(ts)
127    CALL xios_send_field("field_A",field_A)
128    CALL wait_us(5000) ;
129  ENDDO
130
131  CALL xios_context_finalize()
132  CALL xios_finalize()
133
134  CALL MPI_FINALIZE(ierr)
135
136END PROGRAM test_client
137
138
139
140
141
Note: See TracBrowser for help on using the repository browser.