Changeset 559 for XIOS/trunk/doc


Ignore:
Timestamp:
02/18/15 08:24:47 (6 years ago)
Author:
rlacroix
Message:

Update the reference guide to account for all recent changes I did.

Location:
XIOS/trunk/doc
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • XIOS/trunk/doc/XIOS_reference_guide.lyx

    r536 r559  
    8989\end_layout 
    9090 
    91 \begin_layout Subsection* 
    92 calendar_type :  
     91\begin_layout Section 
     92Calendar attribute reference 
     93\end_layout 
     94 
     95\begin_layout Subsection* 
     96type:  
    9397\begin_inset Flex Emph 
    9498status collapsed 
    9599 
    96100\begin_layout Plain Layout 
    97 enum { Gregorian, Julian, D360, AllLeap, NoLeap} 
    98 \end_layout 
    99  
    100 \end_inset 
    101  
    102  
    103 \end_layout 
    104  
    105 \begin_layout Standard 
    106 Fortran : 
    107 \end_layout 
    108  
    109 \begin_layout LyX-Code 
    110 CHARACTER(LEN=*) :: calendar_type 
    111 \end_layout 
    112  
    113 \begin_layout Standard 
    114 Define the calendar used for the context. 
    115  This attribute is mandatory 
    116 \end_layout 
    117  
    118 \begin_layout Subsection* 
    119 start_date :  
     101enumeration { Gregorian, Julian, D360, AllLeap, NoLeap, user_defined } 
     102\end_layout 
     103 
     104\end_inset 
     105 
     106 
     107\end_layout 
     108 
     109\begin_layout Standard 
     110Fortran: 
     111\end_layout 
     112 
     113\begin_layout LyX-Code 
     114CHARACTER(LEN=*) :: type 
     115\end_layout 
     116 
     117\begin_layout Standard 
     118Define the calendar used for the current context. 
     119 This attribute is mandatory and cannot be modified once it has been set. 
     120\begin_inset Newline newline 
     121\end_inset 
     122 
     123 
     124\begin_inset Newline newline 
     125\end_inset 
     126 
     127When using the Fortran interface, this attribute must be defined using the 
     128 following subroutine: 
     129\end_layout 
     130 
     131\begin_layout LyX-Code 
     132SUBROUTINE xios_define_calendar(type, timestep, start_date, time_origin, 
     133\begin_inset Newline newline 
     134\end_inset 
     135 
     136                                day_length, month_lengths, year_length, 
     137\begin_inset Newline newline 
     138\end_inset 
     139 
     140                                leap_year_month, leap_year_drift, 
     141\begin_inset Newline newline 
     142\end_inset 
     143 
     144                                leap_year_drift_offset) 
     145\end_layout 
     146 
     147\begin_layout Subsection* 
     148start_date:  
    120149\begin_inset Flex Emph 
    121150status collapsed 
     
    131160 
    132161\begin_layout Standard 
    133 Fortran : 
    134 \end_layout 
    135  
    136 \begin_layout LyX-Code 
    137 CHARACTER(LEN=*) :: start_date 
     162Fortran: 
     163\end_layout 
     164 
     165\begin_layout LyX-Code 
     166TYPE(xios_date) :: start_date 
    138167\end_layout 
    139168 
    140169\begin_layout Standard 
    141170Define the start date of the simulation for the current context. 
    142  This attribute is madatory 
    143 \end_layout 
    144  
    145 \begin_layout Subsection* 
    146 time_origin :  
     171 This attribute is optional, the default value is  
    147172\begin_inset Flex Emph 
    148173status collapsed 
    149174 
    150175\begin_layout Plain Layout 
     176 
     177\series bold 
     1780000-01-01 00:00:00 
     179\end_layout 
     180 
     181\end_inset 
     182 
     183. 
     184 The  
     185\begin_inset Flex Strong 
     186status collapsed 
     187 
     188\begin_layout Plain Layout 
     189type 
     190\end_layout 
     191 
     192\end_inset 
     193 
     194 attribute must always be set at the same time or before this attribute 
     195 is defined. 
     196\begin_inset Newline newline 
     197\end_inset 
     198 
     199 
     200\begin_inset Newline newline 
     201\end_inset 
     202 
     203A partial date is allowed in the configuration file as long as the omitted 
     204 parts are at the end, in which case they are initialized as in the default 
     205 value. 
     206 Optionally an offset can be added to the date using the notation " 
     207\emph on 
     208+ duration 
     209\emph default 
     210". 
     211  
     212\begin_inset Newline newline 
     213\end_inset 
     214 
     215 
     216\begin_inset Newline newline 
     217\end_inset 
     218 
     219When using the Fortran interface, this attribute can be defined at the same 
     220 time as the calendar  
     221\series bold 
     222type 
     223\series default 
     224: 
     225\end_layout 
     226 
     227\begin_layout LyX-Code 
     228SUBROUTINE xios_define_calendar(type, timestep, start_date, time_origin, 
     229\begin_inset Newline newline 
     230\end_inset 
     231 
     232                                day_length, month_lengths, year_length, 
     233\begin_inset Newline newline 
     234\end_inset 
     235 
     236                                leap_year_month, leap_year_drift, 
     237\begin_inset Newline newline 
     238\end_inset 
     239 
     240                                leap_year_drift_offset) 
     241\end_layout 
     242 
     243\begin_layout Standard 
     244or later using the following subroutine: 
     245\end_layout 
     246 
     247\begin_layout LyX-Code 
     248SUBROUTINE xios_set_start_date(start_date) 
     249\end_layout 
     250 
     251\begin_layout Subsection* 
     252time_origin:  
     253\begin_inset Flex Emph 
     254status collapsed 
     255 
     256\begin_layout Plain Layout 
    151257date 
    152258\end_layout 
     
    158264 
    159265\begin_layout Standard 
    160 Fortran : 
    161 \end_layout 
    162  
    163 \begin_layout LyX-Code 
    164 CHARACTER(LEN=*) :: time_origin 
     266Fortran: 
     267\end_layout 
     268 
     269\begin_layout LyX-Code 
     270TYPE(xios_date) :: time_origin 
    165271\end_layout 
    166272 
     
    168274Define the time origin of the time axis. 
    169275 It will appear as metadata attached to the time axis in the output file. 
    170  The default value is the  
    171 \begin_inset Flex Strong 
    172 status collapsed 
    173  
    174 \begin_layout Plain Layout 
    175 start_date 
    176 \end_layout 
    177  
    178 \end_inset 
    179  
    180  attribute. 
    181 \end_layout 
    182  
    183 \begin_layout Subsection* 
    184 timestep :  
     276 This attribute is optional, the default value is  
    185277\begin_inset Flex Emph 
    186278status collapsed 
    187279 
    188280\begin_layout Plain Layout 
     281 
     282\series bold 
     2830000-01-01 00:00:00 
     284\end_layout 
     285 
     286\end_inset 
     287 
     288. 
     289 The  
     290\begin_inset Flex Strong 
     291status collapsed 
     292 
     293\begin_layout Plain Layout 
     294type 
     295\end_layout 
     296 
     297\end_inset 
     298 
     299 attribute must always be set at the same time or before this attribute 
     300 is defined. 
     301\begin_inset Newline newline 
     302\end_inset 
     303 
     304 
     305\begin_inset Newline newline 
     306\end_inset 
     307 
     308A partial date is allowed in the configuration file as long as the omitted 
     309 parts are at the end, in which case they are initialized as in the default 
     310 value. 
     311 Optionally an offset can be added to the date using the notation " 
     312\emph on 
     313+ duration 
     314\emph default 
     315". 
     316  
     317\begin_inset Newline newline 
     318\end_inset 
     319 
     320 
     321\begin_inset Newline newline 
     322\end_inset 
     323 
     324When using the Fortran interface, this attribute can be defined at the same 
     325 time as the calendar  
     326\series bold 
     327type 
     328\series default 
     329: 
     330\end_layout 
     331 
     332\begin_layout LyX-Code 
     333SUBROUTINE xios_define_calendar(type, timestep, start_date, time_origin, 
     334\begin_inset Newline newline 
     335\end_inset 
     336 
     337                                day_length, month_lengths, year_length, 
     338\begin_inset Newline newline 
     339\end_inset 
     340 
     341                                leap_year_month, leap_year_drift, 
     342\begin_inset Newline newline 
     343\end_inset 
     344 
     345                                leap_year_drift_offset) 
     346\end_layout 
     347 
     348\begin_layout Standard 
     349or later using the following subroutine: 
     350\end_layout 
     351 
     352\begin_layout LyX-Code 
     353SUBROUTINE xios_set_time_origin(time_origin) 
     354\end_layout 
     355 
     356\begin_layout Subsection* 
     357timestep:  
     358\begin_inset Flex Emph 
     359status collapsed 
     360 
     361\begin_layout Plain Layout 
    189362duration 
    190363\end_layout 
     
    196369 
    197370\begin_layout Standard 
    198 Fortran :  
    199 \end_layout 
    200  
    201 \begin_layout LyX-Code 
    202 CHARACTER(LEN=*) :: timestep 
    203 \end_layout 
    204  
    205 \begin_layout Standard 
    206 Define the timestep of the context. 
     371Fortran:  
     372\end_layout 
     373 
     374\begin_layout LyX-Code 
     375TYPE(xios_duration) :: timestep 
     376\end_layout 
     377 
     378\begin_layout Standard 
     379Define the time step of the simulation for the current context. 
    207380 This attribute is mandatory. 
    208  The time step can be also defined by calling the Fortran subroutine : 
     381\begin_inset Newline newline 
     382\end_inset 
     383 
     384 
     385\begin_inset Newline newline 
     386\end_inset 
     387 
     388When using the Fortran interface, this attribute can be defined at the same 
     389 time as the calendar  
     390\series bold 
     391type 
     392\series default 
     393: 
     394\end_layout 
     395 
     396\begin_layout LyX-Code 
     397SUBROUTINE xios_define_calendar(type, timestep, start_date, time_origin, 
     398\begin_inset Newline newline 
     399\end_inset 
     400 
     401                                day_length, month_lengths, year_length, 
     402\begin_inset Newline newline 
     403\end_inset 
     404 
     405                                leap_year_month, leap_year_drift, 
     406\begin_inset Newline newline 
     407\end_inset 
     408 
     409                                leap_year_drift_offset) 
     410\end_layout 
     411 
     412\begin_layout Standard 
     413or using the following subroutine: 
    209414\end_layout 
    210415 
     
    213418\end_layout 
    214419 
    215 \begin_layout LyX-Code 
    216 TYPE(xios_time) :: timestep 
     420\begin_layout Subsection* 
     421day_length:  
     422\begin_inset Flex Emph 
     423status collapsed 
     424 
     425\begin_layout Plain Layout 
     426integer 
     427\end_layout 
     428 
     429\end_inset 
     430 
     431 
     432\end_layout 
     433 
     434\begin_layout Standard 
     435Fortran:  
     436\end_layout 
     437 
     438\begin_layout LyX-Code 
     439INTEGER :: day_length 
     440\end_layout 
     441 
     442\begin_layout Standard 
     443Define the duration of a day, in seconds, when using a custom calendar. 
     444 This attribute is mandatory if the calendar  
     445\series bold 
     446type 
     447\series default 
     448 is set to " 
     449\emph on 
     450user_defined 
     451\emph default 
     452", otherwise it must not be defined. 
     453\begin_inset Newline newline 
     454\end_inset 
     455 
     456 
     457\begin_inset Newline newline 
     458\end_inset 
     459 
     460When using the Fortran interface, this attribute must be defined at the 
     461 same time as the calendar  
     462\series bold 
     463type 
     464\series default 
     465: 
     466\end_layout 
     467 
     468\begin_layout LyX-Code 
     469SUBROUTINE xios_define_calendar(type, timestep, start_date, time_origin, 
     470\begin_inset Newline newline 
     471\end_inset 
     472 
     473                                day_length, month_lengths, year_length, 
     474\begin_inset Newline newline 
     475\end_inset 
     476 
     477                                leap_year_month, leap_year_drift, 
     478\begin_inset Newline newline 
     479\end_inset 
     480 
     481                                leap_year_drift_offset) 
     482\end_layout 
     483 
     484\begin_layout Subsection* 
     485month_lengths:  
     486\begin_inset Flex Emph 
     487status collapsed 
     488 
     489\begin_layout Plain Layout 
     4901D-array of integer 
     491\end_layout 
     492 
     493\end_inset 
     494 
     495 
     496\end_layout 
     497 
     498\begin_layout Standard 
     499Fortran:  
     500\end_layout 
     501 
     502\begin_layout LyX-Code 
     503INTEGER :: month_lengths(:) 
     504\end_layout 
     505 
     506\begin_layout Standard 
     507Define the duration of each month, in days, when using a custom calendar. 
     508 The number of elements in the array defines the number of months in a year 
     509 and the sum of all elements is the total number of days in a year. 
     510 This attribute is mandatory if the calendar  
     511\series bold 
     512type 
     513\series default 
     514 is set to  
     515\series bold 
     516\emph on 
     517user_defined 
     518\series default 
     519\emph default 
     520 and the  
     521\series bold 
     522year_length 
     523\series default 
     524 attribute is not used, otherwise it must not be defined. 
     525\begin_inset Newline newline 
     526\end_inset 
     527 
     528 
     529\begin_inset Newline newline 
     530\end_inset 
     531 
     532When using the Fortran interface, this attribute must be defined at the 
     533 same time as the calendar  
     534\series bold 
     535type 
     536\series default 
     537: 
     538\end_layout 
     539 
     540\begin_layout LyX-Code 
     541SUBROUTINE xios_define_calendar(type, timestep, start_date, time_origin, 
     542\begin_inset Newline newline 
     543\end_inset 
     544 
     545                                day_length, month_lengths, year_length, 
     546\begin_inset Newline newline 
     547\end_inset 
     548 
     549                                leap_year_month, leap_year_drift, 
     550\begin_inset Newline newline 
     551\end_inset 
     552 
     553                                leap_year_drift_offset) 
     554\end_layout 
     555 
     556\begin_layout Subsection* 
     557year_length:  
     558\begin_inset Flex Emph 
     559status collapsed 
     560 
     561\begin_layout Plain Layout 
     562integer 
     563\end_layout 
     564 
     565\end_inset 
     566 
     567 
     568\end_layout 
     569 
     570\begin_layout Standard 
     571Fortran:  
     572\end_layout 
     573 
     574\begin_layout LyX-Code 
     575INTEGER :: year_length 
     576\end_layout 
     577 
     578\begin_layout Standard 
     579Define the duration of a year, in seconds, when using a custom calendar. 
     580 This attribute is mandatory if the calendar  
     581\series bold 
     582type 
     583\series default 
     584 is set to  
     585\series bold 
     586\emph on 
     587user_defined 
     588\series default 
     589\emph default 
     590 and the  
     591\series bold 
     592month_lengths 
     593\series default 
     594 attribute is not used, otherwise it must not be defined. 
     595\begin_inset Newline newline 
     596\end_inset 
     597 
     598 
     599\begin_inset Newline newline 
     600\end_inset 
     601 
     602Note that the date format is modified when using this attribute: the month 
     603 must be always be omitted and the day must also be omitted if  
     604\begin_inset Formula $year\_length\leq day\_length$ 
     605\end_inset 
     606 
     607. 
     608\begin_inset Newline newline 
     609\end_inset 
     610 
     611 
     612\begin_inset Newline newline 
     613\end_inset 
     614 
     615When using the Fortran interface, this attribute must be defined at the 
     616 same time as the calendar  
     617\series bold 
     618type 
     619\series default 
     620: 
     621\end_layout 
     622 
     623\begin_layout LyX-Code 
     624SUBROUTINE xios_define_calendar(type, timestep, start_date, time_origin, 
     625\begin_inset Newline newline 
     626\end_inset 
     627 
     628                                day_length, month_lengths, year_length, 
     629\begin_inset Newline newline 
     630\end_inset 
     631 
     632                                leap_year_month, leap_year_drift, 
     633\begin_inset Newline newline 
     634\end_inset 
     635 
     636                                leap_year_drift_offset) 
     637\end_layout 
     638 
     639\begin_layout Subsection* 
     640leap_year_month:  
     641\begin_inset Flex Emph 
     642status collapsed 
     643 
     644\begin_layout Plain Layout 
     645integer 
     646\end_layout 
     647 
     648\end_inset 
     649 
     650 
     651\end_layout 
     652 
     653\begin_layout Standard 
     654Fortran:  
     655\end_layout 
     656 
     657\begin_layout LyX-Code 
     658INTEGER :: leap_year_month 
     659\end_layout 
     660 
     661\begin_layout Standard 
     662Define the month to which the extra day will be added in case of leap year, 
     663 when using a custom calendar. 
     664 This attribute is optional if the calendar  
     665\series bold 
     666type 
     667\series default 
     668 is set to  
     669\series bold 
     670\emph on 
     671user_defined 
     672\series default 
     673\emph default 
     674 and the  
     675\series bold 
     676month_lengths 
     677\series default 
     678 attribute is used, otherwise it must not be defined. 
     679 The default behaviour is not to have any leap year. 
     680 If defined, this attribute must comply with the following constraint:  
     681\begin_inset Formula $1\leq leap\_year\_month\leq size(month\_lengths)$ 
     682\end_inset 
     683 
     684 and the  
     685\series bold 
     686leap_year_drift 
     687\series default 
     688 attribute must also be defined. 
     689\begin_inset Newline newline 
     690\end_inset 
     691 
     692 
     693\begin_inset Newline newline 
     694\end_inset 
     695 
     696When using the Fortran interface, this attribute must be defined at the 
     697 same time as the calendar  
     698\series bold 
     699type 
     700\series default 
     701: 
     702\end_layout 
     703 
     704\begin_layout LyX-Code 
     705SUBROUTINE xios_define_calendar(type, timestep, start_date, time_origin, 
     706\begin_inset Newline newline 
     707\end_inset 
     708 
     709                                day_length, month_lengths, year_length, 
     710\begin_inset Newline newline 
     711\end_inset 
     712 
     713                                leap_year_month, leap_year_drift, 
     714\begin_inset Newline newline 
     715\end_inset 
     716 
     717                                leap_year_drift_offset) 
     718\end_layout 
     719 
     720\begin_layout Subsection* 
     721leap_year_drift:  
     722\begin_inset Flex Emph 
     723status collapsed 
     724 
     725\begin_layout Plain Layout 
     726double 
     727\end_layout 
     728 
     729\end_inset 
     730 
     731 
     732\end_layout 
     733 
     734\begin_layout Standard 
     735Fortran:  
     736\end_layout 
     737 
     738\begin_layout LyX-Code 
     739DOUBLE PRECISION :: leap_year_drift 
     740\end_layout 
     741 
     742\begin_layout Standard 
     743Define the yearly drift, expressed as a fraction of a day, between the calendar 
     744 year and the astronomical year, when using a custom calendar. 
     745 This attribute is optional if the calendar  
     746\series bold 
     747type 
     748\series default 
     749 is set to  
     750\series bold 
     751\emph on 
     752user_defined 
     753\series default 
     754\emph default 
     755 and the  
     756\series bold 
     757month_lengths 
     758\series default 
     759 attribute is used, otherwise it must not be defined. 
     760 The default behaviour is not to have any leap year, i.e. 
     761 the default value is  
     762\begin_inset Formula $\mathbf{0}$ 
     763\end_inset 
     764 
     765. 
     766 If defined, this attribute must comply with the following constraint:  
     767\begin_inset Formula $0\leq leap\_year\_drift<1$ 
     768\end_inset 
     769 
     770 and the  
     771\series bold 
     772leap_year_month 
     773\series default 
     774 attribute must also be defined. 
     775\begin_inset Newline newline 
     776\end_inset 
     777 
     778 
     779\begin_inset Newline newline 
     780\end_inset 
     781 
     782When using the Fortran interface, this attribute must be defined at the 
     783 same time as the calendar  
     784\series bold 
     785type 
     786\series default 
     787: 
     788\end_layout 
     789 
     790\begin_layout LyX-Code 
     791SUBROUTINE xios_define_calendar(type, timestep, start_date, time_origin, 
     792\begin_inset Newline newline 
     793\end_inset 
     794 
     795                                day_length, month_lengths, year_length, 
     796\begin_inset Newline newline 
     797\end_inset 
     798 
     799                                leap_year_month, leap_year_drift, 
     800\begin_inset Newline newline 
     801\end_inset 
     802 
     803                                leap_year_drift_offset) 
     804\end_layout 
     805 
     806\begin_layout Subsection* 
     807leap_year_drift_offset:  
     808\begin_inset Flex Emph 
     809status collapsed 
     810 
     811\begin_layout Plain Layout 
     812double 
     813\end_layout 
     814 
     815\end_inset 
     816 
     817 
     818\end_layout 
     819 
     820\begin_layout Standard 
     821Fortran:  
     822\end_layout 
     823 
     824\begin_layout LyX-Code 
     825DOUBLE PRECISION :: leap_year_drift_offset 
     826\end_layout 
     827 
     828\begin_layout Standard 
     829Define the initial drift between the calendar year and the astronomical 
     830 year, expressed as a fraction of a day, at the beginning of the time origin's 
     831 year, when using a custom calendar. 
     832 This attribute is optional if the  
     833\series bold 
     834leap_year_month 
     835\series default 
     836 and  
     837\series bold 
     838leap_year_drift 
     839\series default 
     840 attributes are used, otherwise it must not be defined. 
     841 The default value is  
     842\begin_inset Formula $\mathbf{0}$ 
     843\end_inset 
     844 
     845. 
     846 If defined, this attribute must comply with the following constraint:  
     847\begin_inset Formula $0\leq leap\_year\_drift\_offset<1$ 
     848\end_inset 
     849 
     850. 
     851 If  
     852\begin_inset Formula $leap\_yeap\_drift\_offset+leap\_yeap\_drift$ 
     853\end_inset 
     854 
     855 is greater or equal to 1, then the first year will be a leap year. 
     856\begin_inset Newline newline 
     857\end_inset 
     858 
     859 
     860\begin_inset Newline newline 
     861\end_inset 
     862 
     863When using the Fortran interface, this attribute must be defined at the 
     864 same time as the calendar  
     865\series bold 
     866type 
     867\series default 
     868: 
     869\end_layout 
     870 
     871\begin_layout LyX-Code 
     872SUBROUTINE xios_define_calendar(type, timestep, start_date, time_origin, 
     873\begin_inset Newline newline 
     874\end_inset 
     875 
     876                                day_length, month_lengths, year_length, 
     877\begin_inset Newline newline 
     878\end_inset 
     879 
     880                                leap_year_month, leap_year_drift, 
     881\begin_inset Newline newline 
     882\end_inset 
     883 
     884                                leap_year_drift_offset) 
    217885\end_layout 
    218886 
     
    222890 
    223891\begin_layout Subsection* 
    224 name :  
     892name:  
    225893\begin_inset Flex Emph 
    226894status collapsed 
     
    236904 
    237905\begin_layout Standard 
    238 Fortran :  
     906Fortran:  
    239907\end_layout 
    240908 
     
    252920 
    253921\begin_layout Subsection* 
    254 standard_name :  
     922standard_name:  
    255923\begin_inset Flex Emph 
    256924status collapsed 
     
    266934 
    267935\begin_layout Standard 
    268 Fortran :  
     936Fortran:  
    269937\end_layout 
    270938 
     
    280948 
    281949\begin_layout Subsection* 
    282 long_name :  
     950long_name:  
    283951\begin_inset Flex Emph 
    284952status collapsed 
     
    294962 
    295963\begin_layout Standard 
    296 Fortran :  
     964Fortran:  
    297965\end_layout 
    298966 
     
    308976 
    309977\begin_layout Subsection* 
    310 unit :  
     978unit:  
    311979\begin_inset Flex Emph 
    312980status collapsed 
     
    322990 
    323991\begin_layout Standard 
    324 Fortran :  
     992Fortran:  
    325993\end_layout 
    326994 
     
    3351003 
    3361004\begin_layout Subsection* 
    337 size :  
     1005size:  
    3381006\begin_inset Flex Emph 
    3391007status collapsed 
     
    3491017 
    3501018\begin_layout Standard 
    351 Fortran : 
     1019Fortran: 
    3521020\end_layout 
    3531021 
     
    3621030 
    3631031\begin_layout Subsection* 
    364 zoom_begin :  
     1032zoom_begin:  
    3651033\begin_inset Flex Emph 
    3661034status collapsed 
     
    3761044 
    3771045\begin_layout Standard 
    378 Fortran : 
     1046Fortran: 
    3791047\end_layout 
    3801048 
     
    3841052 
    3851053\begin_layout Standard 
    386 Define the the begining of the zoom. 
    387  This must be an index betwen 1 and  
     1054Define the the beginning of the zoom. 
     1055 This must be an index between 1 and  
    3881056\begin_inset Flex Strong 
    3891057status collapsed 
     
    4211089 
    4221090\begin_layout Subsection* 
    423 zoom_end :  
     1091zoom_end:  
    4241092\begin_inset Flex Emph 
    4251093status collapsed 
     
    4351103 
    4361104\begin_layout Standard 
    437 Fortran : 
     1105Fortran: 
    4381106\end_layout 
    4391107 
     
    4901158 
    4911159\begin_layout Subsection* 
    492 zoom_size :  
     1160zoom_size:  
    4931161\begin_inset Flex Emph 
    4941162status collapsed 
     
    5041172 
    5051173\begin_layout Standard 
    506 Fortran : 
     1174Fortran: 
    5071175\end_layout 
    5081176 
     
    5131181\begin_layout Standard 
    5141182Define the the size of the zoom. 
    515  This must be an integer betwen 1 and  
     1183 This must be an integer between 1 and  
    5161184\begin_inset Flex Strong 
    5171185status collapsed 
     
    5591227 
    5601228\begin_layout Subsection* 
    561 value :  
     1229value:  
    5621230\begin_inset Flex Emph 
    5631231status collapsed 
     
    5731241 
    5741242\begin_layout Standard 
    575 Fortran : 
     1243Fortran: 
    5761244\end_layout 
    5771245 
     
    6111279 
    6121280\begin_layout Subsection* 
    613 name :  
     1281name:  
    6141282\begin_inset Flex Emph 
    6151283status collapsed 
     
    6251293 
    6261294\begin_layout Standard 
    627 Fortran : 
     1295Fortran: 
    6281296\end_layout 
    6291297 
     
    6521320 
    6531321\begin_layout Subsection* 
    654 type :  
     1322type:  
    6551323\begin_inset Flex Emph 
    6561324status collapsed 
    6571325 
    6581326\begin_layout Plain Layout 
    659 enum { regular, curvilinear, unstructured} 
    660 \end_layout 
    661  
    662 \end_inset 
    663  
    664  
    665 \end_layout 
    666  
    667 \begin_layout Standard 
    668 Fortran : 
     1327enumeration { regular, curvilinear, unstructured } 
     1328\end_layout 
     1329 
     1330\end_inset 
     1331 
     1332 
     1333\end_layout 
     1334 
     1335\begin_layout Standard 
     1336Fortran: 
    6691337\end_layout 
    6701338 
     
    6781346 
    6791347\begin_layout Subsection* 
    680 ni_glo :  
     1348ni_glo:  
    6811349\begin_inset Flex Emph 
    6821350status collapsed 
     
    6921360 
    6931361\begin_layout Standard 
    694 Fortran : 
     1362Fortran: 
    6951363\end_layout 
    6961364 
     
    7051373 
    7061374\begin_layout Subsection* 
    707 nj_glo :  
     1375nj_glo:  
    7081376\begin_inset Flex Emph 
    7091377status collapsed 
     
    7191387 
    7201388\begin_layout Standard 
    721 Fortran : 
     1389Fortran: 
    7221390\end_layout 
    7231391 
     
    7321400 
    7331401\begin_layout Subsection* 
    734 ni :  
     1402ni:  
    7351403\begin_inset Flex Emph 
    7361404status collapsed 
     
    7461414 
    7471415\begin_layout Standard 
    748 Fortran : 
     1416Fortran: 
    7491417\end_layout 
    7501418 
     
    7941462 
    7951463\begin_layout Subsection* 
    796 ibegin :  
     1464ibegin:  
    7971465\begin_inset Flex Emph 
    7981466status collapsed 
     
    8081476 
    8091477\begin_layout Standard 
    810 Fortran : 
     1478Fortran: 
    8111479\end_layout 
    8121480 
     
    8561524 
    8571525\begin_layout Subsection* 
    858 iend :  
     1526iend:  
    8591527\begin_inset Flex Emph 
    8601528status collapsed 
     
    8701538 
    8711539\begin_layout Standard 
    872 Fortran : 
     1540Fortran: 
    8731541\end_layout 
    8741542 
     
    9181586 
    9191587\begin_layout Subsection* 
    920 nj :  
     1588nj:  
    9211589\begin_inset Flex Emph 
    9221590status collapsed 
     
    9321600 
    9331601\begin_layout Standard 
    934 Fortran : 
     1602Fortran: 
    9351603\end_layout 
    9361604 
     
    9801648 
    9811649\begin_layout Subsection* 
    982 jbegin :  
     1650jbegin:  
    9831651\begin_inset Flex Emph 
    9841652status collapsed 
     
    9941662 
    9951663\begin_layout Standard 
    996 Fortran : 
     1664Fortran: 
    9971665\end_layout 
    9981666 
     
    10021670 
    10031671\begin_layout Standard 
    1004 Define the begining index of the second dimension of the local domain. 
     1672Define the beginning index of the second dimension of the local domain. 
    10051673 This attribute may be also computed from  
    10061674\begin_inset Flex Strong 
     
    10421710 
    10431711\begin_layout Subsection* 
    1044 jend :  
     1712jend:  
    10451713\begin_inset Flex Emph 
    10461714status collapsed 
     
    10561724 
    10571725\begin_layout Standard 
    1058 Fortran : 
     1726Fortran: 
    10591727\end_layout 
    10601728 
     
    11041772 
    11051773\begin_layout Subsection* 
    1106 zoom_ni :  
     1774zoom_ni:  
    11071775\emph on 
    11081776integer 
     
    11101778 
    11111779\begin_layout Standard 
    1112 Fortran : 
     1780Fortran: 
    11131781\end_layout 
    11141782 
     
    11411809 
    11421810\begin_layout Subsection* 
    1143 zoom_ibegin :  
     1811zoom_ibegin:  
    11441812\emph on 
    11451813integer 
     
    11551823 
    11561824\begin_layout Standard 
    1157 Define the begining index on the first dimension of the zoom for the global 
     1825Define the beginning index on the first dimension of the zoom for the global 
    11581826 domain. 
    11591827 This attribute is optional. 
     
    11721840 
    11731841\begin_layout Subsection* 
    1174 zoom_nj :  
     1842zoom_nj:  
    11751843\emph on 
    11761844integer 
     
    11781846 
    11791847\begin_layout Standard 
    1180 Fortran : 
     1848Fortran: 
    11811849\end_layout 
    11821850 
     
    12091877 
    12101878\begin_layout Subsection* 
    1211 zoom_jbegin :  
     1879zoom_jbegin:  
    12121880\emph on 
    12131881integer 
     
    12151883 
    12161884\begin_layout Standard 
    1217 Fortran : 
     1885Fortran: 
    12181886\end_layout 
    12191887 
     
    12231891 
    12241892\begin_layout Standard 
    1225 Define the begining index on the second dimension of the zoom for the global 
     1893Define the beginning index on the second dimension of the zoom for the global 
    12261894 domain. 
    12271895 This attribute is optional. 
     
    12401908 
    12411909\begin_layout Subsection* 
    1242 mask :  
     1910mask:  
    12431911\emph on 
    124419122D-array of bool 
     
    12461914 
    12471915\begin_layout Standard 
    1248 Fortran : 
     1916Fortran: 
    12491917\end_layout 
    12501918 
     
    12691937 
    12701938\begin_layout Subsection* 
    1271 lonvalue :  
     1939lonvalue:  
    12721940\emph on 
    127319411D-array of double 
     
    12751943 
    12761944\begin_layout Standard 
    1277 Fortran : 
     1945Fortran: 
    12781946\end_layout 
    12791947 
     
    13141982 
    13151983\begin_layout Subsection* 
    1316 latvalue :  
     1984latvalue:  
    13171985\emph on 
    131819861D-array of double 
     
    13201988 
    13211989\begin_layout Standard 
    1322 Fortran : 
     1990Fortran: 
    13231991\end_layout 
    13241992 
     
    13492017 
    13502018\begin_layout Subsection* 
    1351 nvertex :  
     2019nvertex:  
    13522020\emph on 
    13532021integer 
     
    13552023 
    13562024\begin_layout Standard 
    1357 Fortran : 
     2025Fortran: 
    13582026\end_layout 
    13592027 
     
    13692037 
    13702038\begin_layout Subsection* 
    1371 bounds_lon :  
     2039bounds_lon:  
    13722040\emph on 
    137320411D-array of double 
     
    13752043 
    13762044\begin_layout Standard 
    1377 Fortran : 
     2045Fortran: 
    13782046\end_layout 
    13792047 
     
    13982066 
    13992067\begin_layout Subsection* 
    1400 bounds_lat :  
     2068bounds_lat:  
    14012069\emph on 
    140220701D-array of double 
     
    14042072 
    14052073\begin_layout Standard 
    1406 Fortran : 
     2074Fortran: 
    14072075\end_layout 
    14082076 
     
    14272095 
    14282096\begin_layout Subsection* 
    1429 data_dim :  
     2097data_dim:  
    14302098\emph on 
    14312099integer 
     
    14332101 
    14342102\begin_layout Standard 
    1435 Fortran : 
     2103Fortran: 
    14362104\end_layout 
    14372105 
     
    15002168 
    15012169\begin_layout Subsection* 
    1502 data_ibegin : 
     2170data_ibegin: 
    15032171\emph on 
    15042172 integer 
     
    15062174 
    15072175\begin_layout Standard 
    1508 Fortran : 
     2176Fortran: 
    15092177\end_layout 
    15102178 
     
    15142182 
    15152183\begin_layout Standard 
    1516 Define the begining index of the field data for the first dimension. 
     2184Define the beginning index of the field data for the first dimension. 
    15172185 This attribute is an offset regarding the local domain, so the value can 
    15182186 be negative. 
     
    15472215 
    15482216\begin_layout Subsection* 
    1549 data_ni :  
     2217data_ni:  
    15502218\emph on 
    15512219integer 
     
    15532221 
    15542222\begin_layout Standard 
    1555 Fortran : 
     2223Fortran: 
    15562224\end_layout 
    15572225 
     
    15972265 
    15982266\begin_layout Subsection* 
    1599 data_jbegin :  
     2267data_jbegin:  
    16002268\emph on 
    16012269integer 
     
    16032271 
    16042272\begin_layout Standard 
    1605 Fortran : 
     2273Fortran: 
    16062274\end_layout 
    16072275 
     
    16112279 
    16122280\begin_layout Standard 
    1613 Define the begining index of the field data for the second dimension. 
     2281Define the beginning index of the field data for the second dimension. 
    16142282 This attribute is take account only if 
    16152283\begin_inset Flex Strong 
     
    16652333 
    16662334\begin_layout Subsection* 
    1667 data_nj :  
     2335data_nj:  
    16682336\emph on 
    16692337integer 
     
    16712339 
    16722340\begin_layout Standard 
    1673 Fortran : 
     2341Fortran: 
    16742342\end_layout 
    16752343 
     
    17262394 
    17272395\begin_layout Subsection* 
    1728 data_n_index :  
     2396data_n_index:  
    17292397\emph on 
    17302398integer 
     
    17322400 
    17332401\begin_layout Standard 
    1734 Fortran : 
     2402Fortran: 
    17352403\end_layout 
    17362404 
     
    17452413 
    17462414\begin_layout Subsection* 
    1747 data_i_index :  
     2415data_i_index:  
    17482416\emph on 
    174924171D-array of integer 
     
    17512419 
    17522420\begin_layout Standard 
    1753 Fortran : 
     2421Fortran: 
    17542422\end_layout 
    17552423 
     
    17762444 
    17772445\begin_layout Subsection* 
    1778 data_j_index :  
     2446data_j_index:  
    17792447\emph on 
    178024481D-array of integer 
     
    17822450 
    17832451\begin_layout Standard 
    1784 Fortran : 
     2452Fortran: 
    17852453\end_layout 
    17862454 
     
    18222490 
    18232491\begin_layout Subsection* 
    1824 name : string 
    1825 \end_layout 
    1826  
    1827 \begin_layout Standard 
    1828 Fortran : 
     2492name: string 
     2493\end_layout 
     2494 
     2495\begin_layout Standard 
     2496Fortran: 
    18292497\end_layout 
    18302498 
     
    18402508 
    18412509\begin_layout Subsection* 
    1842 domain_ref : string 
    1843 \end_layout 
    1844  
    1845 \begin_layout Standard 
    1846 Fortran : 
     2510domain_ref: string 
     2511\end_layout 
     2512 
     2513\begin_layout Standard 
     2514Fortran: 
    18472515\end_layout 
    18482516 
     
    18572525 
    18582526\begin_layout Subsection* 
    1859 axis_ref : string 
    1860 \end_layout 
    1861  
    1862 \begin_layout Standard 
    1863 Fortran : 
     2527axis_ref: string 
     2528\end_layout 
     2529 
     2530\begin_layout Standard 
     2531Fortran: 
    18642532\end_layout 
    18652533 
     
    18752543 
    18762544\begin_layout Subsection* 
    1877 mask :  
     2545mask:  
    18782546\emph on 
    187925473D-array of bool 
     
    18812549 
    18822550\begin_layout Standard 
    1883 Fortran : 
     2551Fortran: 
    18842552\end_layout 
    18852553 
     
    19082576 
    19092577\begin_layout Subsection* 
    1910 name :  
     2578name:  
    19112579\emph on 
    19122580string 
     
    19142582 
    19152583\begin_layout Standard 
    1916 Fortran : 
     2584Fortran: 
    19172585\end_layout 
    19182586 
     
    19322600\end_inset 
    19332601 
    1934  of the field as it will apear in an ouput file. 
    1935  This attribut is optional. 
    1936  If not present, the identifer  
     2602 of the field as it will appear in an output file. 
     2603 This attribute is optional. 
     2604 If not present, the identifier  
    19372605\begin_inset Flex Strong 
    19382606status collapsed 
     
    19482616 
    19492617\begin_layout Subsection* 
    1950 standard_name :  
     2618standard_name:  
    19512619\emph on 
    19522620string 
     
    19542622 
    19552623\begin_layout Standard 
    1956 Fortran : 
     2624Fortran: 
    19572625\end_layout 
    19582626 
     
    19682636\begin_layout Plain Layout 
    19692637standard_name 
    1970 \end_layout 
    1971  
    1972 \end_inset 
    1973  
    1974  attribute as it will appear in the metadata of an ouput file. 
    1975  This attribute is optional. 
    1976 \end_layout 
    1977  
    1978 \begin_layout Subsection* 
    1979 long_name :  
    1980 \emph on 
    1981 string 
    1982 \end_layout 
    1983  
    1984 \begin_layout Standard 
    1985 Fortran :  
    1986 \end_layout 
    1987  
    1988 \begin_layout LyX-Code 
    1989 CHARACTER(LEN=*) :: long_name 
    1990 \end_layout 
    1991  
    1992 \begin_layout Standard 
    1993 Define the  
    1994 \begin_inset Flex Strong 
    1995 status collapsed 
    1996  
    1997 \begin_layout Plain Layout 
    1998 long_name 
    19992638\end_layout 
    20002639 
     
    20062645 
    20072646\begin_layout Subsection* 
    2008 unit :  
     2647long_name:  
    20092648\emph on 
    20102649string 
     
    20122651 
    20132652\begin_layout Standard 
    2014 Fortran :  
     2653Fortran:  
     2654\end_layout 
     2655 
     2656\begin_layout LyX-Code 
     2657CHARACTER(LEN=*) :: long_name 
     2658\end_layout 
     2659 
     2660\begin_layout Standard 
     2661Define the  
     2662\begin_inset Flex Strong 
     2663status collapsed 
     2664 
     2665\begin_layout Plain Layout 
     2666long_name 
     2667\end_layout 
     2668 
     2669\end_inset 
     2670 
     2671 attribute as it will appear in the metadata of an output file. 
     2672 This attribute is optional. 
     2673\end_layout 
     2674 
     2675\begin_layout Subsection* 
     2676unit:  
     2677\emph on 
     2678string 
     2679\end_layout 
     2680 
     2681\begin_layout Standard 
     2682Fortran:  
    20152683\end_layout 
    20162684 
     
    20352703 
    20362704\begin_layout Subsection* 
    2037 operation :  
    2038 \emph on 
    2039 enum { once, instant, average, maximum, minimum, accumulate } 
    2040 \end_layout 
    2041  
    2042 \begin_layout Standard 
    2043 Fortran : 
     2705operation: enumeration 
     2706\emph on 
     2707 { once, instant, average, maximum, minimum, accumulate } 
     2708\end_layout 
     2709 
     2710\begin_layout Standard 
     2711Fortran: 
    20442712\end_layout 
    20452713 
     
    20502718\begin_layout Standard 
    20512719Define the temporal operation applied on the field. 
    2052  This attribute is mandatory. 
    2053 \end_layout 
    2054  
    2055 \begin_layout Subsection* 
    2056 freq_op :  
     2720 This attribute is optional, by default no operation is applied. 
     2721\end_layout 
     2722 
     2723\begin_layout Subsection* 
     2724freq_op:  
    20572725\emph on 
    20582726duration 
     
    20602728 
    20612729\begin_layout Standard 
    2062 Fortran : 
    2063 \end_layout 
    2064  
    2065 \begin_layout LyX-Code 
    2066 CHARACTER(LEN=*) :: freq_op 
     2730Fortran: 
     2731\end_layout 
     2732 
     2733\begin_layout LyX-Code 
     2734TYPE(xios_duration) :: freq_op 
    20672735\end_layout 
    20682736 
     
    20792747\end_inset 
    20802748 
    2081  timestep. 
    2082  It is very usefull for sub-processus called at different frequency in a 
     2749 time step. 
     2750 It is very useful for sub-processes called at different frequency in a 
    20832751 model. 
    20842752 This attribute is optional, the default value is  
     
    20922760\end_inset 
    20932761 
    2094 ( 1 time step). 
    2095 \end_layout 
    2096  
    2097 \begin_layout Subsection* 
    2098 freq_offset :  
     2762(1 time step). 
     2763\end_layout 
     2764 
     2765\begin_layout Subsection* 
     2766freq_offset:  
    20992767\emph on 
    21002768duration 
     
    21022770 
    21032771\begin_layout Standard 
    2104 Fortran : 
    2105 \end_layout 
    2106  
    2107 \begin_layout LyX-Code 
    2108 CHARACTER(LEN=*) :: freq_offset 
     2772Fortran: 
     2773\end_layout 
     2774 
     2775\begin_layout LyX-Code 
     2776TYPE(xios_duration) :: freq_offset 
    21092777\end_layout 
    21102778 
     
    21422810 
    21432811\begin_layout Subsection* 
    2144 level :  
     2812level:  
    21452813\emph on 
    21462814integer 
     
    21482816 
    21492817\begin_layout Standard 
    2150 Fortran : 
     2818Fortran: 
    21512819\end_layout 
    21522820 
     
    21862854 
    21872855\begin_layout Subsection* 
    2188 prec :  
     2856prec:  
    21892857\emph on 
    21902858integer 
     
    21922860 
    21932861\begin_layout Standard 
    2194 Fortran : 
     2862Fortran: 
    21952863\end_layout 
    21962864 
     
    22012869\begin_layout Standard 
    22022870Define the precision in byte of a field in an output file. 
    2203  Available value are : 2 (integer), 4 (float single precision) and 8 (float 
     2871 Available value are: 2 (integer), 4 (float single precision) and 8 (float 
    22042872 double precision). 
    22052873\end_layout 
    22062874 
    22072875\begin_layout Subsection* 
    2208 enabled :  
     2876enabled:  
    22092877\emph on 
    22102878bool 
     
    22122880 
    22132881\begin_layout Standard 
    2214 Fortran : 
     2882Fortran: 
    22152883\end_layout 
    22162884 
     
    22212889\begin_layout Standard 
    22222890Define if a field must be output or not. 
    2223  This attribut is optional, the default value is  
     2891 This attribute is optional, the default value is  
    22242892\begin_inset Flex Strong 
    22252893status collapsed 
     
    22352903 
    22362904\begin_layout Subsection* 
    2237 field_ref :  
     2905field_ref:  
    22382906\emph on 
    22392907string 
     
    22412909 
    22422910\begin_layout Standard 
    2243 Fortran : 
     2911Fortran: 
    22442912\end_layout 
    22452913 
     
    22512919Define a field reference. 
    22522920 All attributes are inherited from the referenced field after the classical 
    2253  inheritence mechanism. 
     2921 inheritance mechanism. 
    22542922 The value assigned to the referenced field is transmitted to to current 
    22552923 field to perform temporal operation. 
     
    22582926 
    22592927\begin_layout Subsection* 
    2260 grid_ref :  
     2928grid_ref:  
    22612929\emph on 
    22622930string 
     
    22642932 
    22652933\begin_layout Standard 
    2266 Fortran : 
     2934Fortran: 
    22672935\end_layout 
    22682936 
     
    22732941\begin_layout Standard 
    22742942Define on which grid the current field is defined. 
    2275  This attribut is optional, if missing, domain_ref and axis_ref must be 
     2943 This attribute is optional, if missing, domain_ref and axis_ref must be 
    22762944 defining. 
    22772945\end_layout 
    22782946 
    22792947\begin_layout Subsection* 
    2280 domain_ref :  
     2948domain_ref:  
    22812949\emph on 
    22822950string 
     
    22842952 
    22852953\begin_layout Standard 
    2286 Fortran : 
     2954Fortran: 
    22872955\end_layout 
    22882956 
     
    22932961\begin_layout Standard 
    22942962Define on which horizontal domain the current field is defined. 
    2295  This attribut is optional, but if this attribute is defined,  
     2963 This attribute is optional, but if this attribute is defined,  
    22962964\begin_inset Flex Strong 
    22972965status collapsed 
     
    23072975 
    23082976\begin_layout Subsection* 
    2309 axis_ref :  
     2977axis_ref:  
    23102978\emph on 
    23112979string 
     
    23132981 
    23142982\begin_layout Standard 
    2315 Fortran :  
     2983Fortran:  
    23162984\end_layout 
    23172985 
     
    23463014 
    23473015\begin_layout Subsection* 
    2348 default_value :  
     3016default_value:  
    23493017\emph on 
    23503018double 
     
    23523020 
    23533021\begin_layout Standard 
    2354 Fortran : 
     3022Fortran: 
    23553023\end_layout 
    23563024 
     
    23763044 
    23773045\begin_layout Subsection* 
    2378 valid_min :  
     3046valid_min:  
    23793047\emph on 
    23803048double 
     
    23823050 
    23833051\begin_layout Standard 
    2384 Fortran : 
     3052Fortran: 
    23853053\end_layout 
    23863054 
     
    24043072 
    24053073\begin_layout Subsection* 
    2406 valid_min :  
     3074valid_min:  
    24073075\emph on 
    24083076double 
     
    24103078 
    24113079\begin_layout Standard 
    2412 Fortran : 
     3080Fortran: 
    24133081\end_layout 
    24143082 
     
    24323100 
    24333101\begin_layout Subsection* 
    2434 detect_missing_value :  
     3102detect_missing_value:  
    24353103\emph on 
    24363104bool 
     
    24383106 
    24393107\begin_layout Standard 
    2440 Fortran : 
    2441 \end_layout 
    2442  
    2443 \begin_layout LyX-Code 
    2444 LOGICAL : detect_missing_value 
     3108Fortran: 
     3109\end_layout 
     3110 
     3111\begin_layout LyX-Code 
     3112LOGICAL: detect_missing_value 
    24453113\end_layout 
    24463114 
     
    24513119 
    24523120\begin_layout Subsection* 
    2453 add_offset :  
     3121add_offset:  
    24543122\emph on 
    24553123double 
     
    24573125 
    24583126\begin_layout Standard 
    2459 Fortran : 
    2460 \end_layout 
    2461  
    2462 \begin_layout LyX-Code 
    2463 DOUBLE PRECISION : add_offset 
     3127Fortran: 
     3128\end_layout 
     3129 
     3130\begin_layout LyX-Code 
     3131DOUBLE PRECISION: add_offset 
    24643132\end_layout 
    24653133 
     
    24673135Set the  
    24683136\begin_inset Flex Strong 
    2469 status open 
     3137status collapsed 
    24703138 
    24713139\begin_layout Plain Layout 
     
    24783146 In output, the  
    24793147\begin_inset Flex Strong 
    2480 status open 
     3148status collapsed 
    24813149 
    24823150\begin_layout Plain Layout 
     
    24863154\end_inset 
    24873155 
    2488  value is substracted to the field values. 
    2489 \end_layout 
    2490  
    2491 \begin_layout Subsection* 
    2492 scale_factor :  
     3156 value is subtracted to the field values. 
     3157\end_layout 
     3158 
     3159\begin_layout Subsection* 
     3160scale_factor:  
    24933161\emph on 
    24943162double 
     
    24963164 
    24973165\begin_layout Standard 
    2498 Fortran : 
    2499 \end_layout 
    2500  
    2501 \begin_layout LyX-Code 
    2502 DOUBLE PRECISION : scale_factor 
     3166Fortran: 
     3167\end_layout 
     3168 
     3169\begin_layout LyX-Code 
     3170DOUBLE PRECISION: scale_factor 
    25033171\end_layout 
    25043172 
     
    25063174Set the  
    25073175\begin_inset Flex Strong 
    2508 status open 
     3176status collapsed 
    25093177 
    25103178\begin_layout Plain Layout 
     
    25173185 In output, the field values are divided by the  
    25183186\begin_inset Flex Strong 
    2519 status open 
     3187status collapsed 
    25203188 
    25213189\begin_layout Plain Layout 
     
    25333201 
    25343202\begin_layout Subsection* 
    2535 name :  
     3203name:  
    25363204\emph on 
    25373205string 
     
    25393207 
    25403208\begin_layout Standard 
    2541 Fortran : 
     3209Fortran: 
    25423210\end_layout 
    25433211 
     
    25573225\end_inset 
    25583226 
    2559  of the variable as it will apear in an ouput file. 
    2560  This attribut is optional. 
    2561 \end_layout 
    2562  
    2563 \begin_layout Subsection* 
    2564 name :  
    2565 \emph on 
     3227 of the variable as it will appear in an output file. 
     3228 This attribute is optional. 
     3229\end_layout 
     3230 
     3231\begin_layout Subsection* 
     3232type: enumeration { bool, int, int32, int16, int64, float, double, string 
     3233 } 
     3234\end_layout 
     3235 
     3236\begin_layout Standard 
     3237Fortran: 
     3238\end_layout 
     3239 
     3240\begin_layout LyX-Code 
     3241CHARACTER(LEN=*) :: type 
     3242\end_layout 
     3243 
     3244\begin_layout Standard 
     3245Define the  
     3246\begin_inset Flex Strong 
     3247status collapsed 
     3248 
     3249\begin_layout Plain Layout 
    25663250type 
    25673251\end_layout 
    25683252 
    2569 \begin_layout Standard 
    2570 Fortran : 
    2571 \end_layout 
    2572  
    2573 \begin_layout LyX-Code 
    2574 CHARACTER(LEN=*) :: type 
    2575 \end_layout 
    2576  
    2577 \begin_layout Standard 
    2578 Define the  
    2579 \begin_inset Flex Strong 
    2580 status collapsed 
    2581  
    2582 \begin_layout Plain Layout 
    2583 type 
    2584 \end_layout 
    2585  
    2586 \end_inset 
    2587  
    2588  of the variable : possible value are :  
    2589 \begin_inset Flex Strong 
    2590 status open 
    2591  
    2592 \begin_layout Plain Layout 
    2593 int, short /short int, lon / long int, float, double, long double, bool, 
    2594  string 
    2595 \end_layout 
    2596  
    2597 \end_inset 
    2598  
     3253\end_inset 
     3254 
     3255 of the variable. 
     3256 Note that the  
     3257\series bold 
     3258\emph on 
     3259int 
     3260\series default 
     3261\emph default 
     3262 type is a synonym for  
     3263\series bold 
     3264\emph on 
     3265int32 
     3266\series default 
     3267\emph default 
    25993268. 
    2600  This attribut is optional. 
     3269 This attribute is optional. 
    26013270\end_layout 
    26023271 
     
    26063275 
    26073276\begin_layout Subsection* 
    2608 name :  
     3277name:  
    26093278\emph on 
    26103279string 
     
    26123281 
    26133282\begin_layout Standard 
    2614 Fortran : 
     3283Fortran: 
    26153284\end_layout 
    26163285 
     
    26203289 
    26213290\begin_layout Standard 
    2622 Define the name of the ouput file. 
     3291Define the name of the output file. 
    26233292 This attribute is mandatory. 
    26243293\end_layout 
    26253294 
    26263295\begin_layout Subsection* 
    2627 name_suffix :  
     3296name_suffix:  
    26283297\emph on 
    26293298string 
     
    26313300 
    26323301\begin_layout Standard 
    2633 Fortran :  
     3302Fortran:  
    26343303\end_layout 
    26353304 
     
    26403309\begin_layout Standard 
    26413310Define a suffix to add to the name of the output file. 
    2642  Thisn attribute is optional. 
    2643 \end_layout 
    2644  
    2645 \begin_layout Subsection* 
    2646 output_freq :  
     3311 This attribute is optional. 
     3312\end_layout 
     3313 
     3314\begin_layout Subsection* 
     3315min_digits:  
     3316\emph on 
     3317integer 
     3318\end_layout 
     3319 
     3320\begin_layout Standard 
     3321Fortran:  
     3322\end_layout 
     3323 
     3324\begin_layout LyX-Code 
     3325INTEGER :: min_digits 
     3326\end_layout 
     3327 
     3328\begin_layout Standard 
     3329For multiple_file, define the minimum digits composing the suffix defining 
     3330 the rank of the server, which will be happened to the name of the output 
     3331 file. 
     3332 This attribute is optional and the default value is  
     3333\begin_inset Flex Strong 
     3334status collapsed 
     3335 
     3336\begin_layout Plain Layout 
     33370 
     3338\end_layout 
     3339 
     3340\end_inset 
     3341 
     3342. 
     3343\end_layout 
     3344 
     3345\begin_layout Subsection* 
     3346output_freq:  
    26473347\emph on 
    26483348duration 
     
    26503350 
    26513351\begin_layout Standard 
    2652 Fortran : 
    2653 \end_layout 
    2654  
    2655 \begin_layout LyX-Code 
    2656 CHARACTER(LEN=*) :: output_freq 
     3352Fortran: 
     3353\end_layout 
     3354 
     3355\begin_layout LyX-Code 
     3356TYPE(xios_duration) :: output_freq 
    26573357\end_layout 
    26583358 
     
    26633363 
    26643364\begin_layout Subsection* 
    2665 output_level :  
     3365output_level:  
    26663366\emph on 
    26673367integer 
     
    26693369 
    26703370\begin_layout Standard 
    2671 Fortran : 
     3371Fortran: 
    26723372\end_layout 
    26733373 
     
    26863386 
    26873387\begin_layout Subsection* 
    2688 sync_freq :  
     3388sync_freq:  
    26893389\emph on 
    26903390duration 
     
    26923392 
    26933393\begin_layout Standard 
    2694 Fortran : 
    2695 \end_layout 
    2696  
    2697 \begin_layout LyX-Code 
    2698 CHARACTER(LEN=*) :: sync_freq 
     3394Fortran: 
     3395\end_layout 
     3396 
     3397\begin_layout LyX-Code 
     3398TYPE(xios_duration) :: sync_freq 
    26993399\end_layout 
    27003400 
     
    27073407 
    27083408\begin_layout Subsection* 
    2709 split_freq :  
     3409split_freq:  
    27103410\emph on 
    27113411duration 
     
    27133413 
    27143414\begin_layout Standard 
    2715 Fortran : 
    2716 \end_layout 
    2717  
    2718 \begin_layout LyX-Code 
    2719 CHARACTER(LEN=*) :: split_freq 
     3415Fortran: 
     3416\end_layout 
     3417 
     3418\begin_layout LyX-Code 
     3419TYPE(xios_duration) :: split_freq 
    27203420\end_layout 
    27213421 
    27223422\begin_layout Standard 
    27233423Define the time frequency for splitting the current file. 
    2724  Date is suffixed to the name (see  
     3424 In that case, the start and end dates are added to the file  
     3425\series bold 
     3426name 
     3427\series default 
     3428 (see  
    27253429\begin_inset Flex Emph 
    27263430status collapsed 
    27273431 
    27283432\begin_layout Plain Layout 
     3433 
     3434\series bold 
     3435\emph on 
    27293436split_freq_format 
    27303437\end_layout 
     
    27333440 
    27343441 attribute). 
    2735  This attribute is optional. 
    2736 \end_layout 
    2737  
    2738 \begin_layout Subsection* 
    2739 split_freq_format :  
     3442 This attribute is optional, by default no splitting is done. 
     3443\end_layout 
     3444 
     3445\begin_layout Subsection* 
     3446split_freq_format:  
    27403447\emph on 
    27413448string 
     
    27433450 
    27443451\begin_layout Standard 
    2745 Fortran : 
     3452Fortran: 
    27463453\end_layout 
    27473454 
     
    27523459\begin_layout Standard 
    27533460Define the format of the split date suffixed to the file. 
    2754  Can contain any character, %y will be replaced by the year (4 characters), 
    2755  %mo month (2 char), %d day (2 char), %mi minute (2 char), %s second (2 
    2756  char). 
    2757  This attribute is optional. 
    2758  and the default behavior is to create a suffix with the date until the 
    2759  smaller non zero unit. 
    2760  For example, in one day split frequency, the hour minute and second will 
    2761  note appear in the suffix, only year, month and day. 
    2762 \end_layout 
    2763  
    2764 \begin_layout Subsection* 
    2765 enabled :  
     3461 Can contain any character,  
     3462\emph on 
     3463 
     3464\begin_inset Flex Code 
     3465status collapsed 
     3466 
     3467\begin_layout Plain Layout 
     3468%y 
     3469\end_layout 
     3470 
     3471\end_inset 
     3472 
     3473 
     3474\emph default 
     3475 will be replaced by the year (4 characters),  
     3476\begin_inset Flex Code 
     3477status collapsed 
     3478 
     3479\begin_layout Plain Layout 
     3480%mo 
     3481\end_layout 
     3482 
     3483\end_inset 
     3484 
     3485 by the month (2 char),  
     3486\begin_inset Flex Code 
     3487status collapsed 
     3488 
     3489\begin_layout Plain Layout 
     3490%d 
     3491\end_layout 
     3492 
     3493\end_inset 
     3494 
     3495 by the day (2 char),  
     3496\begin_inset Flex Code 
     3497status collapsed 
     3498 
     3499\begin_layout Plain Layout 
     3500%h 
     3501\end_layout 
     3502 
     3503\end_inset 
     3504 
     3505 by the hour (2 char),  
     3506\begin_inset Flex Code 
     3507status collapsed 
     3508 
     3509\begin_layout Plain Layout 
     3510%mi 
     3511\end_layout 
     3512 
     3513\end_inset 
     3514 
     3515 by the minute (2 char),  
     3516\begin_inset Flex Code 
     3517status collapsed 
     3518 
     3519\begin_layout Plain Layout 
     3520%s 
     3521\end_layout 
     3522 
     3523\end_inset 
     3524 
     3525 by the second (2 char),  
     3526\begin_inset Flex Code 
     3527status collapsed 
     3528 
     3529\begin_layout Plain Layout 
     3530%S 
     3531\end_layout 
     3532 
     3533\end_inset 
     3534 
     3535 by the number of seconds since the time origin and  
     3536\begin_inset Flex Code 
     3537status collapsed 
     3538 
     3539\begin_layout Plain Layout 
     3540%D 
     3541\end_layout 
     3542 
     3543\end_inset 
     3544 
     3545 by the number of full days since the time origin. 
     3546 This attribute is optional and the default behavior is to create a suffix 
     3547 with the date until the smaller non zero unit. 
     3548 For example, in one day split frequency, the hour, minute and second will 
     3549 not appear in the suffix, only year, month and day. 
     3550\end_layout 
     3551 
     3552\begin_layout Subsection* 
     3553enabled:  
    27663554\emph on 
    27673555bool 
     
    27693557 
    27703558\begin_layout Standard 
    2771 Fortran : 
     3559Fortran: 
    27723560\end_layout 
    27733561 
     
    27783566\begin_layout Standard 
    27793567Define if a file must be output or not. 
    2780  This attribute is mandatory, the default value is  
     3568 This attribute is optional, the default value is  
    27813569\begin_inset Flex Strong 
    27823570status collapsed 
     
    27923580 
    27933581\begin_layout Subsection* 
    2794 type :  
     3582type:  
    27953583\emph on 
    27963584enumeration { one_file, multiple_file} 
     
    27983586 
    27993587\begin_layout Standard 
    2800 Fortran : 
     3588Fortran: 
    28013589\end_layout 
    28023590 
     
    28063594 
    28073595\begin_layout Standard 
    2808 Define which type of file will be output. 
    2809   
    2810 \begin_inset Flex Strong 
    2811 status collapsed 
    2812  
    2813 \begin_layout Plain Layout 
     3596Define the type of the output file:  
     3597\begin_inset Flex Strong 
     3598status collapsed 
     3599 
     3600\begin_layout Plain Layout 
     3601 
     3602\emph on 
    28143603multiple_file 
    28153604\end_layout 
     
    28173606\end_inset 
    28183607 
    2819  : one file by server using sequential netcdf writing. 
    2820   
    2821 \begin_inset Flex Strong 
    2822 status collapsed 
    2823  
    2824 \begin_layout Plain Layout 
     3608: one file by server using sequential netcdf writing,  
     3609\begin_inset Flex Strong 
     3610status collapsed 
     3611 
     3612\begin_layout Plain Layout 
     3613 
     3614\emph on 
    28253615one_file 
    28263616\end_layout 
     
    28283618\end_inset 
    28293619 
    2830  : one single global file is wrote using netcdf4 parallel access. 
    2831 \end_layout 
    2832  
    2833 \begin_layout Subsection* 
    2834 par_access :  
     3620: one single global file is wrote using netcdf4 parallel access. 
     3621 This attribute is mandatory. 
     3622\end_layout 
     3623 
     3624\begin_layout Subsection* 
     3625format:  
     3626\emph on 
     3627enumeration { netcdf4, netcdf4_classic} 
     3628\end_layout 
     3629 
     3630\begin_layout Standard 
     3631Fortran: 
     3632\end_layout 
     3633 
     3634\begin_layout LyX-Code 
     3635CHARACTER(LEN=*) :: type 
     3636\end_layout 
     3637 
     3638\begin_layout Standard 
     3639Define the format of the output file:  
     3640\begin_inset Flex Strong 
     3641status collapsed 
     3642 
     3643\begin_layout Plain Layout 
     3644 
     3645\emph on 
     3646netcdf4 
     3647\end_layout 
     3648 
     3649\end_inset 
     3650 
     3651: the HDF5 format will be used,  
     3652\begin_inset Flex Strong 
     3653status collapsed 
     3654 
     3655\begin_layout Plain Layout 
     3656 
     3657\emph on 
     3658netcdf4 
     3659\emph default 
     3660_ 
     3661\emph on 
     3662classic 
     3663\end_layout 
     3664 
     3665\end_inset 
     3666 
     3667: the classic NetCDF format will be used. 
     3668 The attribute is optional, the default value is  
     3669\series bold 
     3670\emph on 
     3671netcdf4 
     3672\series default 
     3673\emph default 
     3674. 
     3675\begin_inset Newline newline 
     3676\end_inset 
     3677 
     3678 
     3679\begin_inset Newline newline 
     3680\end_inset 
     3681 
     3682Note that the  
     3683\series bold 
     3684\emph on 
     3685netcdf4 
     3686\emph default 
     3687_ 
     3688\emph on 
     3689classic 
     3690\series default 
     3691\emph default 
     3692 format can be used with the attribute  
     3693\series bold 
     3694type 
     3695\series default 
     3696 set to  
     3697\series bold 
     3698\emph on 
     3699one_file 
     3700\series default 
     3701\emph default 
     3702 only if the NetCDF4 library was compiled with Parallel NetCDF support (--enable 
     3703-pnetcdf). 
     3704\end_layout 
     3705 
     3706\begin_layout Subsection* 
     3707par_access:  
    28353708\emph on 
    28363709enumeration { collective, independent } 
     
    28383711 
    28393712\begin_layout Standard 
    2840 Fortran : 
     3713Fortran: 
    28413714\end_layout 
    28423715 
     
    28463719 
    28473720\begin_layout Standard 
    2848 For parallel writting, define the MPI call used. 
    2849  This attribut is optional, the default value is  
    2850 \begin_inset Flex Strong 
    2851 status collapsed 
    2852  
    2853 \begin_layout Plain Layout 
     3721For parallel writing, define which type of MPI calls will be used. 
     3722 This attribute is optional, the default value is  
     3723\begin_inset Flex Strong 
     3724status collapsed 
     3725 
     3726\begin_layout Plain Layout 
     3727 
     3728\emph on 
    28543729collective 
    28553730\end_layout 
     
    28613736 
    28623737\begin_layout Subsection* 
    2863 min_digits :  
    2864 \emph on 
    2865 integer 
    2866 \end_layout 
    2867  
    2868 \begin_layout Standard 
    2869 Fortran :  
    2870 \end_layout 
    2871  
    2872 \begin_layout LyX-Code 
    2873 INTEGER :: min_digits 
    2874 \end_layout 
    2875  
    2876 \begin_layout Standard 
    2877 For multiple_file, define the minimum digits composing the suffix defining 
    2878  the rank of the server, which will be happened to the name of the output 
    2879  file. 
    2880  This attribut is optional and the default value is  
    2881 \begin_inset Flex Strong 
    2882 status collapsed 
    2883  
    2884 \begin_layout Plain Layout 
    2885 0 
     3738append:  
     3739\emph on 
     3740bool 
     3741\end_layout 
     3742 
     3743\begin_layout Standard 
     3744Fortran: 
     3745\end_layout 
     3746 
     3747\begin_layout LyX-Code 
     3748LOGICAL :: append 
     3749\end_layout 
     3750 
     3751\begin_layout Standard 
     3752Define whether the output data is to be appended at the end of the file 
     3753 if it already exists or if the existing file is to be overwritten. 
     3754 This attribute is optional, the default value is  
     3755\begin_inset Flex Strong 
     3756status collapsed 
     3757 
     3758\begin_layout Plain Layout 
     3759 
     3760\emph on 
     3761false 
    28863762\end_layout 
    28873763 
     
    29043780 
    29053781\begin_layout Subsubsection* 
    2906 Synopsis : 
     3782Synopsis: 
    29073783\end_layout 
    29083784 
     
    29243800 
    29253801\begin_layout Subsubsection* 
    2926 Argument : 
     3802Argument: 
    29273803\end_layout 
    29283804 
     
    29373813\end_inset 
    29383814 
    2939  : client identifier 
     3815: client identifier 
    29403816\end_layout 
    29413817 
     
    29503826\end_inset 
    29513827 
    2952  : MPI communicator of the client 
     3828: MPI communicator of the client 
    29533829\end_layout 
    29543830 
     
    29633839\end_inset 
    29643840 
    2965  : split return MPI communicator 
    2966 \end_layout 
    2967  
    2968 \begin_layout Subsubsection* 
    2969 Description : 
     3841: split return MPI communicator 
     3842\end_layout 
     3843 
     3844\begin_layout Subsubsection* 
     3845Description: 
    29703846\end_layout 
    29713847 
     
    30503926\end_inset 
    30513927 
    3052 ) : if local_comm MPI communicator is specified then it would be used for 
     3928): if local_comm MPI communicator is specified then it would be used for 
    30533929 internal MPI communication otherwise  
    30543930\begin_inset Flex Code 
     
    31274003\end_inset 
    31284004 
    3129 ) :  
     4005):  
    31304006\begin_inset Flex Code 
    31314007status collapsed 
     
    31474023\end_inset 
    31484024 
    3149  communicator would be splitted by XIOS. 
     4025 communicator would be split by XIOS. 
    31504026 The split communicator is returned in  
    31514027\begin_inset Flex Code 
     
    32304106 
    32314107\begin_layout Itemize 
    3232 Otherwise : if MPI was not initialized, OASIS will be initialized calling 
     4108Otherwise: if MPI was not initialized, OASIS will be initialized calling 
    32334109  
    32344110\begin_inset Flex Code 
     
    33214197 
    33224198\begin_layout Itemize 
    3323 Otherwise : if MPI was not initialized, OASIS will be initialized calling 
     4199Otherwise: if MPI was not initialized, OASIS will be initialized calling 
    33244200  
    33254201\begin_inset Flex Code 
     
    33884264 
    33894265\begin_layout Subsubsection* 
    3390 Synopsis : 
     4266Synopsis: 
    33914267\end_layout 
    33924268 
     
    33964272 
    33974273\begin_layout Subsubsection* 
    3398 Arguments : 
     4274Arguments: 
    33994275\end_layout 
    34004276 
     
    34044280 
    34054281\begin_layout Subsubsection* 
    3406 Description : 
    3407 \end_layout 
    3408  
    3409 \begin_layout Standard 
    3410 This call must be done at the end of the simulation for a succesfull execution. 
     4282Description: 
     4283\end_layout 
     4284 
     4285\begin_layout Standard 
     4286This call must be done at the end of the simulation for a successful execution. 
    34114287 It gives the end signal to the xios server pools to finish it execution. 
    34124288 If MPI has been initialize by XIOS the MPI_Finalize will be called. 
     
    34344310 New elements or group of elements can be added as child in the tree, attributes 
    34354311 of the elements can be set or query. 
    3436  The type of element actually avalaible are : context, axis, domain, grid, 
     4312 The type of element actually available are: context, axis, domain, grid, 
    34374313 field, variable and file. 
    34384314 An element can be identified by a string or by an handle associated to 
    34394315 the type of the element. 
    3440  Root element (ex :  
     4316 Root element (ex:  
    34414317\begin_inset Quotes eld 
    34424318\end_inset 
     
    34714347 
    34724348\begin_layout Quotation 
    3473 TYPE(txios_element) 
     4349TYPE(xios_element) 
    34744350\end_layout 
    34754351 
     
    35394415\end_inset 
    35404416 
    3541 , or the associated group (excepted for context) :  
     4417, or the associated group (excepted for context):  
    35424418\begin_inset Quotes eld 
    35434419\end_inset 
     
    35954471 
    35964472\begin_layout Subsubsection* 
    3597 Synopsis : 
     4473Synopsis: 
    35984474\end_layout 
    35994475 
     
    36074483 
    36084484\begin_layout LyX-Code 
    3609 TYPE(txios_element), INTENT(OUT):: handle 
    3610 \end_layout 
    3611  
    3612 \begin_layout Standard 
    3613 whera element is one of the existing element or group of element. 
    3614 \end_layout 
    3615  
    3616 \begin_layout Subsubsection* 
    3617 Arguments : 
     4485TYPE(xios_element), INTENT(OUT):: handle 
     4486\end_layout 
     4487 
     4488\begin_layout Standard 
     4489where element is one of the existing element or group of element. 
     4490\end_layout 
     4491 
     4492\begin_layout Subsubsection* 
     4493Arguments: 
    36184494\end_layout 
    36194495 
     
    36284504\end_inset 
    36294505 
    3630  : string identifier. 
     4506: string identifier. 
    36314507\end_layout 
    36324508 
     
    36414517\end_inset 
    36424518 
    3643  : element handle 
    3644 \end_layout 
    3645  
    3646 \begin_layout Subsubsection* 
    3647 Description : 
     4519: element handle 
     4520\end_layout 
     4521 
     4522\begin_layout Subsubsection* 
     4523Description: 
    36484524\end_layout 
    36494525 
     
    36594535 
    36604536\begin_layout Subsubsection* 
    3661 Synopsis : 
     4537Synopsis: 
    36624538\end_layout 
    36634539 
     
    36714547 
    36724548\begin_layout Standard 
    3673 whera element is one of the existing element or group of element. 
    3674 \end_layout 
    3675  
    3676 \begin_layout Subsubsection* 
    3677 Arguments : 
     4549where element is one of the existing element or group of element. 
     4550\end_layout 
     4551 
     4552\begin_layout Subsubsection* 
     4553Arguments: 
    36784554\end_layout 
    36794555 
     
    36884564\end_inset 
    36894565 
    3690  : string identifier. 
    3691 \end_layout 
    3692  
    3693 \begin_layout Subsubsection* 
    3694 Description : 
     4566: string identifier. 
     4567\end_layout 
     4568 
     4569\begin_layout Subsubsection* 
     4570Description: 
    36954571\end_layout 
    36964572 
     
    37074583 
    37084584\begin_layout Subsubsection* 
    3709 Synopsis : 
     4585Synopsis: 
    37104586\end_layout 
    37114587 
     
    37154591 
    37164592\begin_layout LyX-Code 
    3717 TYPE(txios_element)         , INTENT(IN) :: parent_handle 
    3718 \end_layout 
    3719  
    3720 \begin_layout LyX-Code 
    3721 TYPE(txios_element)         , INTENT(OUT):: child_handle 
     4593TYPE(xios_element)         , INTENT(IN) :: parent_handle 
     4594\end_layout 
     4595 
     4596\begin_layout LyX-Code 
     4597TYPE(xios_element)         , INTENT(OUT):: child_handle 
    37224598\end_layout 
    37234599 
     
    37314607 
    37324608\begin_layout Subsubsection* 
    3733 Arguments : 
     4609Arguments: 
    37344610\end_layout 
    37354611 
     
    37444620\end_inset 
    37454621 
    3746  : handle of the parent element. 
     4622: handle of the parent element. 
    37474623\end_layout 
    37484624 
     
    37574633\end_inset 
    37584634 
    3759  : handle of the child element. 
     4635: handle of the child element. 
    37604636\end_layout 
    37614637 
     
    37704646\end_inset 
    37714647 
    3772  : string identifier of the child. 
    3773 \end_layout 
    3774  
    3775 \begin_layout Subsubsection* 
    3776 Description : 
     4648: string identifier of the child. 
     4649\end_layout 
     4650 
     4651\begin_layout Subsubsection* 
     4652Description: 
    37774653\end_layout 
    37784654 
     
    37824658 All group elements can contains child of the same kind, provided generic 
    37834659 inheritance. 
    3784  Some elements can contains childs of an other kind for a specific behaviour. 
     4660 Some elements can contains children of an other kind for a specific behaviour. 
    37854661 File element may contains field_group, field, variable and variable_group 
    37864662 child elements. 
     
    37934669 
    37944670\begin_layout Subsubsection* 
    3795 Synopsis : 
     4671Synopsis: 
    37964672\end_layout 
    37974673 
     
    38024678 
    38034679\begin_layout LyX-Code 
    3804 TYPE(txios_element)         , INTENT(IN) :: handle 
     4680TYPE(xios_element)         , INTENT(IN) :: handle 
    38054681\end_layout 
    38064682 
     
    38234699 
    38244700\begin_layout Subsubsection* 
    3825 Arguments : 
     4701Arguments: 
    38264702\end_layout 
    38274703 
     
    38364712\end_inset 
    38374713 
    3838  : element handle. 
     4714: element handle. 
    38394715\end_layout 
    38404716 
     
    38494725\end_inset 
    38504726 
    3851  : return true if the attribute as a defined value. 
    3852 \end_layout 
    3853  
    3854 \begin_layout Subsubsection* 
    3855 Description : 
     4727: return true if the attribute as a defined value. 
     4728\end_layout 
     4729 
     4730\begin_layout Subsubsection* 
     4731Description: 
    38564732\end_layout 
    38574733 
     
    38604736 have a defined value. 
    38614737 The list of attributes and their type are described in a specific chapter 
    3862  of the documention. 
     4738 of the documentation. 
    38634739  
    38644740\end_layout 
     
    38694745 
    38704746\begin_layout Subsubsection* 
    3871 Synopsis : 
     4747Synopsis: 
    38724748\end_layout 
    38734749 
     
    38994775 
    39004776\begin_layout Subsubsection* 
    3901 Arguments : 
     4777Arguments: 
    39024778\end_layout 
    39034779 
     
    39124788\end_inset 
    39134789 
    3914  : element identifier. 
     4790: element identifier. 
    39154791\end_layout 
    39164792 
     
    39254801\end_inset 
    39264802 
    3927  : return true if the attribute as a defined value. 
    3928 \end_layout 
    3929  
    3930 \begin_layout Subsubsection* 
    3931 Description : 
     4803: return true if the attribute as a defined value. 
     4804\end_layout 
     4805 
     4806\begin_layout Subsubsection* 
     4807Description: 
    39324808\end_layout 
    39334809 
     
    39364812 have a defined value. 
    39374813 The list of available attributes and their type are described in a specific 
    3938  chapter of the documention. 
     4814 chapter of the documentation. 
    39394815  
    39404816\end_layout 
     
    39454821 
    39464822\begin_layout Subsubsection* 
    3947 Synopsis : 
     4823Synopsis: 
    39484824\end_layout 
    39494825 
     
    39544830 
    39554831\begin_layout LyX-Code 
    3956 TYPE(txios_element)         , INTENT(IN) :: handle 
     4832TYPE(xios_element)         , INTENT(IN) :: handle 
    39574833\end_layout 
    39584834 
     
    39764852 
    39774853\begin_layout Subsubsection* 
    3978 Arguments : 
     4854Arguments: 
    39794855\end_layout 
    39804856 
     
    39894865\end_inset 
    39904866 
    3991  : element handle. 
     4867: element handle. 
    39924868\end_layout 
    39934869 
     
    40024878\end_inset 
    40034879 
    4004  : value of the attribute to be set. 
    4005 \end_layout 
    4006  
    4007 \begin_layout Subsubsection* 
    4008 Description : 
     4880: value of the attribute to be set. 
     4881\end_layout 
     4882 
     4883\begin_layout Subsubsection* 
     4884Description: 
    40094885\end_layout 
    40104886 
     
    40134889 by its handle. 
    40144890 The list of available attributes and their type are described in a specific 
    4015  chapter of the documention. 
     4891 chapter of the documentation. 
    40164892  
    40174893\end_layout 
     
    40224898 
    40234899\begin_layout Subsubsection* 
    4024 Synopsis : 
     4900Synopsis: 
    40254901\end_layout 
    40264902 
     
    40534929 
    40544930\begin_layout Subsubsection* 
    4055 Arguments : 
     4931Arguments: 
    40564932\end_layout 
    40574933 
     
    40664942\end_inset 
    40674943 
    4068  : string identifier. 
     4944: string identifier. 
    40694945\end_layout 
    40704946 
     
    40794955\end_inset 
    40804956 
    4081  : value of the attribute to be set. 
    4082 \end_layout 
    4083  
    4084 \begin_layout Subsubsection* 
    4085 Description : 
     4957: value of the attribute to be set. 
     4958\end_layout 
     4959 
     4960\begin_layout Subsubsection* 
     4961Description: 
    40864962\end_layout 
    40874963 
     
    40904966 by its string id. 
    40914967 The list of available attributes and their type are described in a specific 
    4092  chapter of the documention. 
     4968 chapter of the documentation. 
    40934969\end_layout 
    40944970 
     
    40984974 
    40994975\begin_layout Subsubsection* 
    4100 Synopsis : 
     4976Synopsis: 
    41014977\end_layout 
    41024978 
     
    41074983 
    41084984\begin_layout LyX-Code 
    4109 TYPE(txios_element)         , INTENT(IN) :: handle 
     4985TYPE(xios_element)         , INTENT(IN) :: handle 
    41104986\end_layout 
    41114987 
     
    41295005 
    41305006\begin_layout Subsubsection* 
    4131 Arguments : 
     5007Arguments: 
    41325008\end_layout 
    41335009 
     
    41425018\end_inset 
    41435019 
    4144  : element handle. 
     5020: element handle. 
    41455021\end_layout 
    41465022 
     
    41555031\end_inset 
    41565032 
    4157  : value of the attribute to be get. 
    4158 \end_layout 
    4159  
    4160 \begin_layout Subsubsection* 
    4161 Description : 
     5033: value of the attribute to be get. 
     5034\end_layout 
     5035 
     5036\begin_layout Subsubsection* 
     5037Description: 
    41625038\end_layout 
    41635039 
     
    41675043 All attributes in the arguments list must be defined. 
    41685044 The list of available attributes and their type are described in a specific 
    4169  chapter of the documention. 
     5045 chapter of the documentation. 
    41705046  
    41715047\end_layout 
     
    41765052 
    41775053\begin_layout Subsubsection* 
    4178 Synopsis : 
     5054Synopsis: 
    41795055\end_layout 
    41805056 
     
    42065082 
    42075083\begin_layout Subsubsection* 
    4208 Arguments : 
     5084Arguments: 
    42095085\end_layout 
    42105086 
     
    42195095\end_inset 
    42205096 
    4221  : element string identifier. 
     5097: element string identifier. 
    42225098\end_layout 
    42235099 
     
    42325108\end_inset 
    42335109 
    4234  : value of the attribute to be get. 
    4235 \end_layout 
    4236  
    4237 \begin_layout Subsubsection* 
    4238 Description : 
     5110: value of the attribute to be get. 
     5111\end_layout 
     5112 
     5113\begin_layout Subsubsection* 
     5114Description: 
    42395115\end_layout 
    42405116 
     
    42445120 All attributes in the arguments list must have a defined value. 
    42455121 The list of available attributes and their type are described in a specific 
    4246  chapter of the documention. 
     5122 chapter of the documentation. 
    42475123\end_layout 
    42485124 
    42495125\begin_layout Section* 
    4250 Interface relative to context managment 
     5126Interface relative to context management 
    42515127\end_layout 
    42525128 
     
    42565132 
    42575133\begin_layout Subsubsection* 
    4258 Synopsis : 
     5134Synopsis: 
    42595135\end_layout 
    42605136 
     
    42725148 
    42735149\begin_layout Subsubsection* 
    4274 Argument : 
     5150Argument: 
    42755151\end_layout 
    42765152 
     
    42855161\end_inset 
    42865162 
    4287  : context identifier 
     5163: context identifier 
    42885164\end_layout 
    42895165 
     
    42985174\end_inset 
    42995175 
    4300  : MPI communicator of the context 
    4301 \end_layout 
    4302  
    4303 \begin_layout Subsubsection* 
    4304 Description : 
     5176: MPI communicator of the context 
     5177\end_layout 
     5178 
     5179\begin_layout Subsubsection* 
     5180Description: 
    43055181\end_layout 
    43065182 
     
    43485224 
    43495225\begin_layout Subsubsection* 
    4350 Synopsis : 
     5226Synopsis: 
    43515227\end_layout 
    43525228 
     
    43565232 
    43575233\begin_layout Subsubsection* 
    4358 Arguments : 
     5234Arguments: 
    43595235\end_layout 
    43605236 
     
    43645240 
    43655241\begin_layout Subsubsection* 
    4366 Description : 
     5242Description: 
    43675243\end_layout 
    43685244 
     
    43885264 
    43895265\begin_layout Subsubsection* 
    4390 Synopsis : 
     5266Synopsis: 
    43915267\end_layout 
    43925268 
     
    43965272 
    43975273\begin_layout LyX-Code 
    4398 TYPE(txios_context),INTENT(IN) :: context_handle 
     5274TYPE(xios_context),INTENT(IN) :: context_handle 
    43995275\end_layout 
    44005276 
     
    44125288 
    44135289\begin_layout Subsubsection* 
    4414 Arguments : 
     5290Arguments: 
    44155291\end_layout 
    44165292 
     
    44255301\end_inset 
    44265302 
    4427  : handle of the context 
     5303: handle of the context 
    44285304\end_layout 
    44295305 
     
    44425318\end_inset 
    44435319 
    4444  : string context identifier 
    4445 \end_layout 
    4446  
    4447 \begin_layout Subsubsection* 
    4448 Description : 
     5320: string context identifier 
     5321\end_layout 
     5322 
     5323\begin_layout Subsubsection* 
     5324Description: 
    44495325\end_layout 
    44505326 
     
    44615337 
    44625338\begin_layout Subsubsection* 
    4463 Synopsis : 
     5339Synopsis: 
    44645340\end_layout 
    44655341 
     
    44695345 
    44705346\begin_layout Subsubsection* 
    4471 Arguments : 
     5347Arguments: 
    44725348\end_layout 
    44735349 
     
    44775353 
    44785354\begin_layout Subsubsection* 
    4479 Description : 
     5355Description: 
    44805356\end_layout 
    44815357 
     
    44865362 contacting servers,...) so this call is mandatory. 
    44875363 Any call related to the tree management definition done after will have 
    4488  an indefined effect. 
    4489 \end_layout 
    4490  
    4491 \begin_layout Subsection* 
    4492 Defining the time step of the context 
    4493 \end_layout 
    4494  
    4495 \begin_layout Subsubsection* 
    4496 Synopsis : 
     5364 an undefined effect. 
     5365\end_layout 
     5366 
     5367\begin_layout Section* 
     5368Interface relative to calendar management 
     5369\end_layout 
     5370 
     5371\begin_layout Subsection* 
     5372Creating the calendar 
     5373\end_layout 
     5374 
     5375\begin_layout Subsubsection* 
     5376Synopsis: 
     5377\end_layout 
     5378 
     5379\begin_layout LyX-Code 
     5380SUBROUTINE xios_define_calendar(type, timestep, start_date, time_origin, 
     5381 & 
     5382\begin_inset Newline newline 
     5383\end_inset 
     5384 
     5385                                day_length, month_lengths, year_length, 
     5386 & 
     5387\begin_inset Newline newline 
     5388\end_inset 
     5389 
     5390                                leap_year_month, leap_year_drift, & 
     5391\begin_inset Newline newline 
     5392\end_inset 
     5393 
     5394                                leap_year_drift_offset) 
     5395\begin_inset Newline newline 
     5396\end_inset 
     5397 
     5398CHARACTER(len = *),              INTENT(IN) :: type 
     5399\begin_inset Newline newline 
     5400\end_inset 
     5401 
     5402TYPE(xios_duration),   OPTIONAL, INTENT(IN) :: timestep 
     5403\begin_inset Newline newline 
     5404\end_inset 
     5405 
     5406TYPE(xios_date),       OPTIONAL, INTENT(IN) :: start_date 
     5407\begin_inset Newline newline 
     5408\end_inset 
     5409 
     5410TYPE(xios_date),       OPTIONAL, INTENT(IN) :: time_origin 
     5411\begin_inset Newline newline 
     5412\end_inset 
     5413 
     5414INTEGER,               OPTIONAL, INTENT(IN) :: day_length 
     5415\begin_inset Newline newline 
     5416\end_inset 
     5417 
     5418INTEGER,               OPTIONAL, INTENT(IN) :: month_lengths(:) 
     5419\begin_inset Newline newline 
     5420\end_inset 
     5421 
     5422INTEGER,               OPTIONAL, INTENT(IN) :: year_length 
     5423\begin_inset Newline newline 
     5424\end_inset 
     5425 
     5426DOUBLE PRECISION,      OPTIONAL, INTENT(IN) :: leap_year_drift 
     5427\begin_inset Newline newline 
     5428\end_inset 
     5429 
     5430DOUBLE PRECISION,      OPTIONAL, INTENT(IN) :: leap_year_drift_offset 
     5431\begin_inset Newline newline 
     5432\end_inset 
     5433 
     5434INTEGER,               OPTIONAL, INTENT(IN) :: leap_year_month 
     5435\end_layout 
     5436 
     5437\begin_layout Subsubsection* 
     5438Arguments: 
     5439\end_layout 
     5440 
     5441\begin_layout Itemize 
     5442\begin_inset Flex Code 
     5443status collapsed 
     5444 
     5445\begin_layout Plain Layout 
     5446type 
     5447\end_layout 
     5448 
     5449\end_inset 
     5450 
     5451: the calendar type, one of  
     5452\begin_inset Flex Code 
     5453status collapsed 
     5454 
     5455\begin_layout Plain Layout 
     5456"Gregorian" 
     5457\end_layout 
     5458 
     5459\end_inset 
     5460 
     5461,  
     5462\begin_inset Flex Code 
     5463status collapsed 
     5464 
     5465\begin_layout Plain Layout 
     5466"Julian" 
     5467\end_layout 
     5468 
     5469\end_inset 
     5470 
     5471,  
     5472\begin_inset Flex Code 
     5473status collapsed 
     5474 
     5475\begin_layout Plain Layout 
     5476"D360" 
     5477\end_layout 
     5478 
     5479\end_inset 
     5480 
     5481,  
     5482\begin_inset Flex Code 
     5483status collapsed 
     5484 
     5485\begin_layout Plain Layout 
     5486"AllLeap" 
     5487\end_layout 
     5488 
     5489\end_inset 
     5490 
     5491,  
     5492\begin_inset Flex Code 
     5493status collapsed 
     5494 
     5495\begin_layout Plain Layout 
     5496"NoLeap" 
     5497\end_layout 
     5498 
     5499\end_inset 
     5500 
     5501,  
     5502\begin_inset Flex Code 
     5503status collapsed 
     5504 
     5505\begin_layout Plain Layout 
     5506"user_defined" 
     5507\end_layout 
     5508 
     5509\end_inset 
     5510 
     5511 
     5512\end_layout 
     5513 
     5514\begin_layout Itemize 
     5515\begin_inset Flex Code 
     5516status collapsed 
     5517 
     5518\begin_layout Plain Layout 
     5519timestep 
     5520\end_layout 
     5521 
     5522\end_inset 
     5523 
     5524: the time step of the simulation (optional, can be set later) 
     5525\end_layout 
     5526 
     5527\begin_layout Itemize 
     5528\begin_inset Flex Code 
     5529status collapsed 
     5530 
     5531\begin_layout Plain Layout 
     5532start_date 
     5533\end_layout 
     5534 
     5535\end_inset 
     5536 
     5537: the start date of the simulation (optional,  
     5538\begin_inset Flex Code 
     5539status collapsed 
     5540 
     5541\begin_layout Plain Layout 
     5542xios_date(0000, 01, 01, 00, 00, 00) 
     5543\end_layout 
     5544 
     5545\end_inset 
     5546 
     5547 is used by default) 
     5548\end_layout 
     5549 
     5550\begin_layout Itemize 
     5551\begin_inset Flex Code 
     5552status collapsed 
     5553 
     5554\begin_layout Plain Layout 
     5555time_origin 
     5556\end_layout 
     5557 
     5558\end_inset 
     5559 
     5560: the origin of the time axis (optional,  
     5561\begin_inset Flex Code 
     5562status collapsed 
     5563 
     5564\begin_layout Plain Layout 
     5565xios_date(0000, 01, 01, 00, 00, 00) 
     5566\end_layout 
     5567 
     5568\end_inset 
     5569 
     5570 is used by default) 
     5571\end_layout 
     5572 
     5573\begin_layout Itemize 
     5574\begin_inset Flex Code 
     5575status collapsed 
     5576 
     5577\begin_layout Plain Layout 
     5578day_length 
     5579\end_layout 
     5580 
     5581\end_inset 
     5582 
     5583: the length of a day in seconds (mandatory when creating an user defined 
     5584 calendar, must not be set otherwise) 
     5585\end_layout 
     5586 
     5587\begin_layout Itemize 
     5588\begin_inset Flex Code 
     5589status collapsed 
     5590 
     5591\begin_layout Plain Layout 
     5592month_lengths 
     5593\end_layout 
     5594 
     5595\end_inset 
     5596 
     5597: the length of each month of the year in days (either  
     5598\begin_inset Flex Code 
     5599status collapsed 
     5600 
     5601\begin_layout Plain Layout 
     5602month_lengths 
     5603\end_layout 
     5604 
     5605\end_inset 
     5606 
     5607 or  
     5608\begin_inset Flex Code 
     5609status collapsed 
     5610 
     5611\begin_layout Plain Layout 
     5612year_length 
     5613\end_layout 
     5614 
     5615\end_inset 
     5616 
     5617 must be set when creating an user defined calendar, must not be set otherwise) 
     5618\end_layout 
     5619 
     5620\begin_layout Itemize 
     5621\begin_inset Flex Code 
     5622status collapsed 
     5623 
     5624\begin_layout Plain Layout 
     5625year_length 
     5626\end_layout 
     5627 
     5628\end_inset 
     5629 
     5630: the length of a year in seconds (either  
     5631\begin_inset Flex Code 
     5632status collapsed 
     5633 
     5634\begin_layout Plain Layout 
     5635month_lengths 
     5636\end_layout 
     5637 
     5638\end_inset 
     5639 
     5640 or  
     5641\begin_inset Flex Code 
     5642status collapsed 
     5643 
     5644\begin_layout Plain Layout 
     5645year_length 
     5646\end_layout 
     5647 
     5648\end_inset 
     5649 
     5650 must be set when creating an user defined calendar, must not be set otherwise) 
     5651\end_layout 
     5652 
     5653\begin_layout Itemize 
     5654\begin_inset Flex Code 
     5655status collapsed 
     5656 
     5657\begin_layout Plain Layout 
     5658leap_year_drift 
     5659\end_layout 
     5660 
     5661\end_inset 
     5662 
     5663: the yearly drift between the user defined calendar and the astronomical 
     5664 calendar, expressed as a fraction of day (can optionally be set when creating 
     5665 an user defined calendar in which case  
     5666\begin_inset Flex Code 
     5667status collapsed 
     5668 
     5669\begin_layout Plain Layout 
     5670leap_year_month 
     5671\end_layout 
     5672 
     5673\end_inset 
     5674 
     5675 must be set too) 
     5676\end_layout 
     5677 
     5678\begin_layout Itemize 
     5679\begin_inset Flex Code 
     5680status collapsed 
     5681 
     5682\begin_layout Plain Layout 
     5683leap_year_drift_offset 
     5684\end_layout 
     5685 
     5686\end_inset 
     5687 
     5688: the initial drift between the user defined calendar and the astronomical 
     5689 calendar at the time origin, expressed as a fraction of day (can optionally 
     5690 be set if  
     5691\begin_inset Flex Code 
     5692status collapsed 
     5693 
     5694\begin_layout Plain Layout 
     5695leap_year_drift 
     5696\end_layout 
     5697 
     5698\end_inset 
     5699 
     5700 and  
     5701\begin_inset Flex Code 
     5702status collapsed 
     5703 
     5704\begin_layout Plain Layout 
     5705leap_year_month 
     5706\end_layout 
     5707 
     5708\end_inset 
     5709 
     5710 are set) 
     5711\end_layout 
     5712 
     5713\begin_layout Itemize 
     5714\begin_inset Flex Code 
     5715status collapsed 
     5716 
     5717\begin_layout Plain Layout 
     5718leap_year_month 
     5719\end_layout 
     5720 
     5721\end_inset 
     5722 
     5723: the month to which an extra day must be added in case of leap year (can 
     5724 optionally be set when creating an user defined calendar in which case 
     5725  
     5726\begin_inset Flex Code 
     5727status collapsed 
     5728 
     5729\begin_layout Plain Layout 
     5730leap_year_drift 
     5731\end_layout 
     5732 
     5733\end_inset 
     5734 
     5735 must be set too) 
     5736\end_layout 
     5737 
     5738\begin_layout Standard 
     5739For a more detailed description of those arguments, see the description 
     5740 of the corresponding attributes in section 1.2  
     5741\begin_inset Quotes eld 
     5742\end_inset 
     5743 
     5744Calendar attribute reference 
     5745\begin_inset Quotes erd 
     5746\end_inset 
     5747 
     5748. 
     5749\end_layout 
     5750 
     5751\begin_layout Subsubsection* 
     5752Description: 
     5753\end_layout 
     5754 
     5755\begin_layout Standard 
     5756This subroutine creates the calendar for the current context. 
     5757 Note that the calendar is created once and for all, either from the XML 
     5758 configuration file or the Fortran interface. 
     5759 If it was not created from the configuration file, then this subroutine 
     5760 must be called once and only once before the context definition is closed. 
     5761 The calendar features can be used immediately after the calendar was created. 
     5762\begin_inset Newline newline 
     5763\end_inset 
     5764 
     5765 
     5766\begin_inset Newline newline 
     5767\end_inset 
     5768 
     5769If an user defined calendar is created, the following arguments must also 
     5770 be provided: 
     5771\begin_inset Flex Code 
     5772status collapsed 
     5773 
     5774\begin_layout Plain Layout 
     5775day_length 
     5776\end_layout 
     5777 
     5778\end_inset 
     5779 
     5780 and either  
     5781\begin_inset Flex Code 
     5782status collapsed 
     5783 
     5784\begin_layout Plain Layout 
     5785month_lengths 
     5786\end_layout 
     5787 
     5788\end_inset 
     5789 
     5790 or  
     5791\begin_inset Flex Code 
     5792status collapsed 
     5793 
     5794\begin_layout Plain Layout 
     5795year_length 
     5796\end_layout 
     5797 
     5798\end_inset 
     5799 
     5800. 
     5801 Optionally it is possible to configure the user defined calendar to have 
     5802 leap years. 
     5803 In this case,  
     5804\begin_inset Flex Code 
     5805status collapsed 
     5806 
     5807\begin_layout Plain Layout 
     5808leap_year_drift 
     5809\end_layout 
     5810 
     5811\end_inset 
     5812 
     5813 and  
     5814\begin_inset Flex Code 
     5815status collapsed 
     5816 
     5817\begin_layout Plain Layout 
     5818leap_year_month 
     5819\end_layout 
     5820 
     5821\end_inset 
     5822 
     5823 must also be provided and  
     5824\begin_inset Flex Code 
     5825status collapsed 
     5826 
     5827\begin_layout Plain Layout 
     5828leap_year_drift_offset 
     5829\end_layout 
     5830 
     5831\end_inset 
     5832 
     5833 might be used. 
     5834\end_layout 
     5835 
     5836\begin_layout Subsection* 
     5837Accessing the calendar type of the current calendar 
     5838\end_layout 
     5839 
     5840\begin_layout Subsubsection* 
     5841Synopsis: 
     5842\end_layout 
     5843 
     5844\begin_layout LyX-Code 
     5845SUBROUTINE xios_get_calendar_type(calendar_type) 
     5846\begin_inset Newline newline 
     5847\end_inset 
     5848 
     5849CHARACTER(len=*), INTENT(OUT) :: calendar_type 
     5850\end_layout 
     5851 
     5852\begin_layout Subsubsection* 
     5853Arguments: 
     5854\end_layout 
     5855 
     5856\begin_layout Itemize 
     5857\begin_inset Flex Code 
     5858status collapsed 
     5859 
     5860\begin_layout Plain Layout 
     5861calendar_type 
     5862\end_layout 
     5863 
     5864\end_inset 
     5865 
     5866: on output, the type of the calendar attached to the current context 
     5867\end_layout 
     5868 
     5869\begin_layout Subsubsection* 
     5870Description: 
     5871\end_layout 
     5872 
     5873\begin_layout Standard 
     5874This subroutine gets the calendar type associated to the current context. 
     5875 It will raise an error if used before the calendar was created. 
     5876\end_layout 
     5877 
     5878\begin_layout Subsection* 
     5879Accessing and defining the time step of the current calendar 
     5880\end_layout 
     5881 
     5882\begin_layout Subsubsection* 
     5883Synopsis: 
     5884\end_layout 
     5885 
     5886\begin_layout LyX-Code 
     5887SUBROUTINE xios_get_timestep(timestep) 
     5888\begin_inset Newline newline 
     5889\end_inset 
     5890 
     5891TYPE(xios_duration), INTENT(OUT) :: timestep 
     5892\end_layout 
     5893 
     5894\begin_layout Standard 
     5895and 
    44975896\end_layout 
    44985897 
    44995898\begin_layout LyX-Code 
    45005899SUBROUTINE xios_set_timestep(timestep) 
    4501 \end_layout 
    4502  
    4503 \begin_layout LyX-Code 
    4504 TYPE(txios_time),INTENT(IN) :: timestep 
    4505 \end_layout 
    4506  
    4507 \begin_layout Subsubsection* 
    4508 Arguments : 
     5900\begin_inset Newline newline 
     5901\end_inset 
     5902 
     5903TYPE(xios_duration), INTENT(IN) :: timestep 
     5904\end_layout 
     5905 
     5906\begin_layout Subsubsection* 
     5907Arguments: 
    45095908\end_layout 
    45105909 
     
    45195918\end_inset 
    45205919 
    4521  : timestep of the model using time units 
    4522 \end_layout 
    4523  
    4524 \begin_layout Subsubsection* 
    4525 Description : 
    4526 \end_layout 
    4527  
    4528 \begin_layout Standard 
    4529 This subroutine fix the timestep of the current context. 
    4530  Must be call before closing context definition. 
     5920: a duration corresponding to the time step of the simulation 
     5921\end_layout 
     5922 
     5923\begin_layout Subsubsection* 
     5924Description: 
     5925\end_layout 
     5926 
     5927\begin_layout Standard 
     5928Those subroutines respectively gets and sets the time step associated to 
     5929 the calendar of the current context. 
     5930 Note that the time step must always be set before the context definition 
     5931 is closed and that an error will be raised if the getter subroutine is 
     5932 used before the time step is defined. 
     5933\end_layout 
     5934 
     5935\begin_layout Subsection* 
     5936Accessing and defining the start date of the current calendar 
     5937\end_layout 
     5938 
     5939\begin_layout Subsubsection* 
     5940Synopsis: 
     5941\end_layout 
     5942 
     5943\begin_layout LyX-Code 
     5944SUBROUTINE xios_get_start_date(start_date) 
     5945\begin_inset Newline newline 
     5946\end_inset 
     5947 
     5948TYPE(xios_date), INTENT(OUT) :: start_date 
     5949\end_layout 
     5950 
     5951\begin_layout Standard 
     5952and 
     5953\end_layout 
     5954 
     5955\begin_layout LyX-Code 
     5956SUBROUTINE xios_set_start_date(start_date) 
     5957\begin_inset Newline newline 
     5958\end_inset 
     5959 
     5960TYPE(xios_date), INTENT(IN) :: start_date 
     5961\end_layout 
     5962 
     5963\begin_layout Subsubsection* 
     5964Arguments: 
     5965\end_layout 
     5966 
     5967\begin_layout Itemize 
     5968\begin_inset Flex Code 
     5969status collapsed 
     5970 
     5971\begin_layout Plain Layout 
     5972start_date 
     5973\end_layout 
     5974 
     5975\end_inset 
     5976 
     5977: a date corresponding to the beginning of the simulation 
     5978\end_layout 
     5979 
     5980\begin_layout Subsubsection* 
     5981Description: 
     5982\end_layout 
     5983 
     5984\begin_layout Standard 
     5985Those subroutines respectively gets and sets the start date associated to 
     5986 the calendar of the current context. 
     5987 They must not be used before the calendar was created. 
     5988\end_layout 
     5989 
     5990\begin_layout Subsection* 
     5991Accessing and defining the time origin of the current calendar 
     5992\end_layout 
     5993 
     5994\begin_layout Subsubsection* 
     5995Synopsis: 
     5996\end_layout 
     5997 
     5998\begin_layout LyX-Code 
     5999SUBROUTINE xios_get_time_origin(time_origin) 
     6000\begin_inset Newline newline 
     6001\end_inset 
     6002 
     6003TYPE(xios_date), INTENT(OUT) :: time_origin 
     6004\end_layout 
     6005 
     6006\begin_layout Standard 
     6007and 
     6008\end_layout 
     6009 
     6010\begin_layout LyX-Code 
     6011SUBROUTINE xios_set_time_date(time_origin) 
     6012\begin_inset Newline newline 
     6013\end_inset 
     6014 
     6015TYPE(xios_date), INTENT(IN) :: time_origin 
     6016\end_layout 
     6017 
     6018\begin_layout Subsubsection* 
     6019Arguments: 
     6020\end_layout 
     6021 
     6022\begin_layout Itemize 
     6023\begin_inset Flex Code 
     6024status collapsed 
     6025 
     6026\begin_layout Plain Layout 
     6027start_date 
     6028\end_layout 
     6029 
     6030\end_inset 
     6031 
     6032: a date corresponding to the origin of the time axis 
     6033\end_layout 
     6034 
     6035\begin_layout Subsubsection* 
     6036Description: 
     6037\end_layout 
     6038 
     6039\begin_layout Standard 
     6040Those subroutines respectively gets and sets the origin of time associated 
     6041 to the calendar of the current context. 
     6042 They must not be used before the calendar was created. 
     6043\end_layout 
     6044 
     6045\begin_layout Subsection* 
     6046Updating the current date of the current calendar 
     6047\end_layout 
     6048 
     6049\begin_layout Subsubsection* 
     6050Synopsis: 
     6051\end_layout 
     6052 
     6053\begin_layout LyX-Code 
     6054SUBROUTINE xios_update_calendar(step) 
     6055\begin_inset Newline newline 
     6056\end_inset 
     6057 
     6058INTEGER, INTENT(IN) :: step 
     6059\end_layout 
     6060 
     6061\begin_layout Subsubsection* 
     6062Arguments: 
     6063\end_layout 
     6064 
     6065\begin_layout Itemize 
     6066\begin_inset Flex Code 
     6067status collapsed 
     6068 
     6069\begin_layout Plain Layout 
     6070step 
     6071\end_layout 
     6072 
     6073\end_inset 
     6074 
     6075: the current iteration number 
     6076\end_layout 
     6077 
     6078\begin_layout Subsubsection* 
     6079Description: 
     6080\end_layout 
     6081 
     6082\begin_layout Standard 
     6083This subroutine sets the current date associated to the calendar of the 
     6084 current context based on the current iteration number:  
     6085\begin_inset Formula $current\_date=start\_date+step\times timestep$ 
     6086\end_inset 
     6087 
     6088. 
     6089 It must not be used before the calendar was created. 
     6090\end_layout 
     6091 
     6092\begin_layout Subsection* 
     6093Accessing the current date of the current calendar 
     6094\end_layout 
     6095 
     6096\begin_layout Subsubsection* 
     6097Synopsis: 
     6098\end_layout 
     6099 
     6100\begin_layout LyX-Code 
     6101SUBROUTINE xios_get_current_date(current_date) 
     6102\begin_inset Newline newline 
     6103\end_inset 
     6104 
     6105TYPE(xios_date), INTENT(OUT) :: current_date 
     6106\end_layout 
     6107 
     6108\begin_layout Subsubsection* 
     6109Arguments: 
     6110\end_layout 
     6111 
     6112\begin_layout Itemize 
     6113\begin_inset Flex Code 
     6114status collapsed 
     6115 
     6116\begin_layout Plain Layout 
     6117current_date 
     6118\end_layout 
     6119 
     6120\end_inset 
     6121 
     6122: on output, the current date 
     6123\end_layout 
     6124 
     6125\begin_layout Subsubsection* 
     6126Description: 
     6127\end_layout 
     6128 
     6129\begin_layout Standard 
     6130This subroutine gets the current date associated to the calendar of the 
     6131 current context. 
     6132 It must not be used before the calendar was created. 
     6133\end_layout 
     6134 
     6135\begin_layout Subsection* 
     6136Accessing the year length of the current calendar 
     6137\end_layout 
     6138 
     6139\begin_layout Subsubsection* 
     6140Synopsis: 
     6141\end_layout 
     6142 
     6143\begin_layout LyX-Code 
     6144INTEGER FUNCTION xios_get_year_length_in_seconds(year) 
     6145\begin_inset Newline newline 
     6146\end_inset 
     6147 
     6148INTEGER, INTENT(IN) :: year 
     6149\end_layout 
     6150 
     6151\begin_layout Subsubsection* 
     6152Arguments: 
     6153\end_layout 
     6154 
     6155\begin_layout Itemize 
     6156\begin_inset Flex Code 
     6157status collapsed 
     6158 
     6159\begin_layout Plain Layout 
     6160year 
     6161\end_layout 
     6162 
     6163\end_inset 
     6164 
     6165: the year whose length is requested 
     6166\end_layout 
     6167 
     6168\begin_layout Subsubsection* 
     6169Description: 
     6170\end_layout 
     6171 
     6172\begin_layout Standard 
     6173This function returns the duration in seconds of the specified year, taking 
     6174 leap years into account based on the calendar of the current context. 
     6175 It must not be used before the calendar was created. 
     6176\end_layout 
     6177 
     6178\begin_layout Subsection* 
     6179Accessing the day length of the current calendar 
     6180\end_layout 
     6181 
     6182\begin_layout Subsubsection* 
     6183Synopsis: 
     6184\end_layout 
     6185 
     6186\begin_layout LyX-Code 
     6187INTEGER FUNCTION xios_get_day_length_in_seconds() 
     6188\end_layout 
     6189 
     6190\begin_layout Subsubsection* 
     6191Arguments: None 
     6192\end_layout 
     6193 
     6194\begin_layout Subsubsection* 
     6195Description: 
     6196\end_layout 
     6197 
     6198\begin_layout Standard 
     6199This function returns the duration in seconds of a day, based on the calendar 
     6200 of the current context. 
     6201 It must not be used before the calendar was created. 
     6202\end_layout 
     6203 
     6204\begin_layout Section* 
     6205Interface relative to duration handling 
     6206\end_layout 
     6207 
     6208\begin_layout Subsection* 
     6209Duration constants 
     6210\end_layout 
     6211 
     6212\begin_layout Standard 
     6213Some duration constants are available to ease duration handling: 
     6214\end_layout 
     6215 
     6216\begin_layout Itemize 
     6217\begin_inset Flex Code 
     6218status collapsed 
     6219 
     6220\begin_layout Plain Layout 
     6221xios_year 
     6222\end_layout 
     6223 
     6224\end_inset 
     6225 
     6226 
     6227\end_layout 
     6228 
     6229\begin_layout Itemize 
     6230\begin_inset Flex Code 
     6231status collapsed 
     6232 
     6233\begin_layout Plain Layout 
     6234xios_month 
     6235\end_layout 
     6236 
     6237\end_inset 
     6238 
     6239 
     6240\end_layout 
     6241 
     6242\begin_layout Itemize 
     6243\begin_inset Flex Code 
     6244status collapsed 
     6245 
     6246\begin_layout Plain Layout 
     6247xios_day 
     6248\end_layout 
     6249 
     6250\end_inset 
     6251 
     6252 
     6253\end_layout 
     6254 
     6255\begin_layout Itemize 
     6256\begin_inset Flex Code 
     6257status collapsed 
     6258 
     6259\begin_layout Plain Layout 
     6260xios_hour 
     6261\end_layout 
     6262 
     6263\end_inset 
     6264 
     6265 
     6266\end_layout 
     6267 
     6268\begin_layout Itemize 
     6269\begin_inset Flex Code 
     6270status collapsed 
     6271 
     6272\begin_layout Plain Layout 
     6273xios_minute 
     6274\end_layout 
     6275 
     6276\end_inset 
     6277 
     6278 
     6279\end_layout 
     6280 
     6281\begin_layout Itemize 
     6282\begin_inset Flex Code 
     6283status collapsed 
     6284 
     6285\begin_layout Plain Layout 
     6286xios_second 
     6287\end_layout 
     6288 
     6289\end_inset 
     6290 
     6291 
     6292\end_layout 
     6293 
     6294\begin_layout Itemize 
     6295\begin_inset Flex Code 
     6296status collapsed 
     6297 
     6298\begin_layout Plain Layout 
     6299xios_timestep 
     6300\end_layout 
     6301 
     6302\end_inset 
     6303 
     6304 
     6305\end_layout 
     6306 
     6307\begin_layout Subsection* 
     6308Arithmetic operations on durations 
     6309\end_layout 
     6310 
     6311\begin_layout Standard 
     6312The following arithmetic operations on durations are available: 
     6313\end_layout 
     6314 
     6315\begin_layout Itemize 
     6316Addition:  
     6317\begin_inset Flex Code 
     6318status collapsed 
     6319 
     6320\begin_layout Plain Layout 
     6321xios_duration = xios_duration + xios_duration 
     6322\end_layout 
     6323 
     6324\end_inset 
     6325 
     6326 
     6327\end_layout 
     6328 
     6329\begin_layout Itemize 
     6330Subtraction:  
     6331\begin_inset Flex Code 
     6332status collapsed 
     6333 
     6334\begin_layout Plain Layout 
     6335xios_duration = xios_duration - xios_duration 
     6336\end_layout 
     6337 
     6338\end_inset 
     6339 
     6340 
     6341\end_layout 
     6342 
     6343\begin_layout Itemize 
     6344Multiplication by a scalar value:  
     6345\begin_inset Flex Code 
     6346status collapsed 
     6347 
     6348\begin_layout Plain Layout 
     6349xios_duration = scalar * xios_duration 
     6350\end_layout 
     6351 
     6352\end_inset 
     6353 
     6354 or  
     6355\begin_inset Flex Code 
     6356status collapsed 
     6357 
     6358\begin_layout Plain Layout 
     6359xios_duration = xios_duration * scalar 
     6360\end_layout 
     6361 
     6362\end_inset 
     6363 
     6364 
     6365\end_layout 
     6366 
     6367\begin_layout Itemize 
     6368Negation:  
     6369\begin_inset Flex Code 
     6370status collapsed 
     6371 
     6372\begin_layout Plain Layout 
     6373xios_duration = -xios_duration 
     6374\end_layout 
     6375 
     6376\end_inset 
     6377 
     6378 
     6379\end_layout 
     6380 
     6381\begin_layout Subsection* 
     6382Comparison operations on durations 
     6383\end_layout 
     6384 
     6385\begin_layout Standard 
     6386The following comparison operations on durations are available: 
     6387\end_layout 
     6388 
     6389\begin_layout Itemize 
     6390Equality:  
     6391\begin_inset Flex Code 
     6392status collapsed 
     6393 
     6394\begin_layout Plain Layout 
     6395LOGICAL = xios_duration == xios_duration 
     6396\end_layout 
     6397 
     6398\end_inset 
     6399 
     6400 
     6401\end_layout 
     6402 
     6403\begin_layout Itemize 
     6404Inequality:  
     6405\begin_inset Flex Code 
     6406status collapsed 
     6407 
     6408\begin_layout Plain Layout 
     6409LOGICAL = xios_duration /= xios_duration 
     6410\end_layout 
     6411 
     6412\end_inset 
     6413 
     6414 
     6415\end_layout 
     6416 
     6417\begin_layout Section* 
     6418Interface relative to date handling 
     6419\end_layout 
     6420 
     6421\begin_layout Subsection* 
     6422Arithmetic operations on dates 
     6423\end_layout 
     6424 
     6425\begin_layout Standard 
     6426The following arithmetic operations on dates are available: 
     6427\end_layout 
     6428 
     6429\begin_layout Itemize 
     6430Addition of a duration:  
     6431\begin_inset Flex Code 
     6432status collapsed 
     6433 
     6434\begin_layout Plain Layout 
     6435xios_date = xios_date + xios_duration 
     6436\end_layout 
     6437 
     6438\end_inset 
     6439 
     6440 
     6441\end_layout 
     6442 
     6443\begin_layout Itemize 
     6444Subtraction of a duration:  
     6445\begin_inset Flex Code 
     6446status collapsed 
     6447 
     6448\begin_layout Plain Layout 
     6449xios_date = xios_date - xios_duration 
     6450\end_layout 
     6451 
     6452\end_inset 
     6453 
     6454 
     6455\end_layout 
     6456 
     6457\begin_layout Itemize 
     6458Subtraction of two dates:  
     6459\begin_inset Flex Code 
     6460status collapsed 
     6461 
     6462\begin_layout Plain Layout 
     6463xios_duration = xios_date - xios_date 
     6464\end_layout 
     6465 
     6466\end_inset 
     6467 
     6468 
     6469\end_layout 
     6470 
     6471\begin_layout Subsection* 
     6472Comparison operations on dates 
     6473\end_layout 
     6474 
     6475\begin_layout Standard 
     6476The following comparison operations on dates are available: 
     6477\end_layout 
     6478 
     6479\begin_layout Itemize 
     6480Equality:  
     6481\begin_inset Flex Code 
     6482status collapsed 
     6483 
     6484\begin_layout Plain Layout 
     6485LOGICAL = xios_date == xios_date 
     6486\end_layout 
     6487 
     6488\end_inset 
     6489 
     6490 
     6491\end_layout 
     6492 
     6493\begin_layout Itemize 
     6494Inequality:  
     6495\begin_inset Flex Code 
     6496status collapsed 
     6497 
     6498\begin_layout Plain Layout 
     6499LOGICAL = xios_date /= xios_date 
     6500\end_layout 
     6501 
     6502\end_inset 
     6503 
     6504 
     6505\end_layout 
     6506 
     6507\begin_layout Itemize 
     6508Less than:  
     6509\begin_inset Flex Code 
     6510status collapsed 
     6511 
     6512\begin_layout Plain Layout 
     6513LOGICAL = xios_date < xios_date 
     6514\end_layout 
     6515 
     6516\end_inset 
     6517 
     6518 
     6519\end_layout 
     6520 
     6521\begin_layout Itemize 
     6522Less or equal:  
     6523\begin_inset Flex Code 
     6524status collapsed 
     6525 
     6526\begin_layout Plain Layout 
     6527LOGICAL = xios_date <= xios_date 
     6528\end_layout 
     6529 
     6530\end_inset 
     6531 
     6532 
     6533\end_layout 
     6534 
     6535\begin_layout Itemize 
     6536Greater than:  
     6537\begin_inset Flex Code 
     6538status collapsed 
     6539 
     6540\begin_layout Plain Layout 
     6541LOGICAL = xios_date > xios_date 
     6542\end_layout 
     6543 
     6544\end_inset 
     6545 
     6546 
     6547\end_layout 
     6548 
     6549\begin_layout Itemize 
     6550Greater or equal:  
     6551\begin_inset Flex Code 
     6552status collapsed 
     6553 
     6554\begin_layout Plain Layout 
     6555LOGICAL = xios_date >= xios_date 
     6556\end_layout 
     6557 
     6558\end_inset 
     6559 
     6560 
     6561\end_layout 
     6562 
     6563\begin_layout Subsection* 
     6564Converting a date to a number of seconds since the time origin 
     6565\end_layout 
     6566 
     6567\begin_layout Subsubsection* 
     6568Synopsis: 
     6569\end_layout 
     6570 
     6571\begin_layout LyX-Code 
     6572FUNCTION INTEGER(kind = 8) xios_date_convert_to_seconds(date) 
     6573\begin_inset Newline newline 
     6574\end_inset 
     6575 
     6576TYPE(xios_date), INTENT(IN) :: date 
     6577\end_layout 
     6578 
     6579\begin_layout Subsubsection* 
     6580Arguments: 
     6581\end_layout 
     6582 
     6583\begin_layout Itemize 
     6584\begin_inset Flex Code 
     6585status collapsed 
     6586 
     6587\begin_layout Plain Layout 
     6588date 
     6589\end_layout 
     6590 
     6591\end_inset 
     6592 
     6593: the date to convert 
     6594\end_layout 
     6595 
     6596\begin_layout Subsubsection* 
     6597Description: 
     6598\end_layout 
     6599 
     6600\begin_layout Standard 
     6601This function returns the number of seconds since the time origin for the 
     6602 specified date, based on the calendar of the current context. 
     6603 It must not be used before the calendar was created. 
     6604\end_layout 
     6605 
     6606\begin_layout Subsection* 
     6607Converting a date to a number of seconds since the beginning of the year 
     6608\end_layout 
     6609 
     6610\begin_layout Subsubsection* 
     6611Synopsis: 
     6612\end_layout 
     6613 
     6614\begin_layout LyX-Code 
     6615FUNCTION INTEGER xios(date_get_second_of_year)(date) 
     6616\begin_inset Newline newline 
     6617\end_inset 
     6618 
     6619TYPE(xios_date), INTENT(IN) :: date 
     6620\end_layout 
     6621 
     6622\begin_layout Subsubsection* 
     6623Arguments: 
     6624\end_layout 
     6625 
     6626\begin_layout Itemize 
     6627\begin_inset Flex Code 
     6628status collapsed 
     6629 
     6630\begin_layout Plain Layout 
     6631date 
     6632\end_layout 
     6633 
     6634\end_inset 
     6635 
     6636: the date to convert 
     6637\end_layout 
     6638 
     6639\begin_layout Subsubsection* 
     6640Description: 
     6641\end_layout 
     6642 
     6643\begin_layout Standard 
     6644This function returns the number of seconds since the beginning of the year 
     6645 for the specified date, based on the calendar of the current context. 
     6646 It must not be used before the calendar was created. 
     6647\end_layout 
     6648 
     6649\begin_layout Subsection* 
     6650Converting a date to a number of days since the beginning of the year 
     6651\end_layout 
     6652 
     6653\begin_layout Subsubsection* 
     6654Synopsis: 
     6655\end_layout 
     6656 
     6657\begin_layout LyX-Code 
     6658FUNCTION DOUBLE_PRECISION xios_date_get_day_of_year(date) 
     6659\begin_inset Newline newline 
     6660\end_inset 
     6661 
     6662TYPE(xios_date), INTENT(IN) :: date 
     6663\end_layout 
     6664 
     6665\begin_layout Subsubsection* 
     6666Arguments: 
     6667\end_layout 
     6668 
     6669\begin_layout Itemize 
     6670\begin_inset Flex Code 
     6671status collapsed 
     6672 
     6673\begin_layout Plain Layout 
     6674date 
     6675\end_layout 
     6676 
     6677\end_inset 
     6678 
     6679: the date to convert 
     6680\end_layout 
     6681 
     6682\begin_layout Subsubsection* 
     6683Description: 
     6684\end_layout 
     6685 
     6686\begin_layout Standard 
     6687This function returns the number of days since the beginning of the year 
     6688 for the specified date, based on the calendar of the current context. 
     6689 It must not be used before the calendar was created. 
     6690\end_layout 
     6691 
     6692\begin_layout Subsection* 
     6693Converting a date to a fraction of the current year 
     6694\end_layout 
     6695 
     6696\begin_layout Subsubsection* 
     6697Synopsis: 
     6698\end_layout 
     6699 
     6700\begin_layout LyX-Code 
     6701FUNCTION DOUBLE_PRECISION xios_date_get_fraction_of_year(date) 
     6702\begin_inset Newline newline 
     6703\end_inset 
     6704 
     6705TYPE(xios_date), INTENT(IN) :: date 
     6706\end_layout 
     6707 
     6708\begin_layout Subsubsection* 
     6709Arguments: 
     6710\end_layout 
     6711 
     6712\begin_layout Itemize 
     6713\begin_inset Flex Code 
     6714status collapsed 
     6715 
     6716\begin_layout Plain Layout 
     6717date 
     6718\end_layout 
     6719 
     6720\end_inset 
     6721 
     6722: the date to convert 
     6723\end_layout 
     6724 
     6725\begin_layout Subsubsection* 
     6726Description: 
     6727\end_layout 
     6728 
     6729\begin_layout Standard 
     6730This function returns the fraction of year corresponding to the specified 
     6731 date, based on the calendar of the current context. 
     6732 It must not be used before the calendar was created. 
     6733\end_layout 
     6734 
     6735\begin_layout Subsection* 
     6736Converting a date to a number of seconds since the beginning of the day 
     6737\end_layout 
     6738 
     6739\begin_layout Subsubsection* 
     6740Synopsis: 
     6741\end_layout 
     6742 
     6743\begin_layout LyX-Code 
     6744FUNCTION INTEGER xios(date_get_second_of_day)(date) 
     6745\begin_inset Newline newline 
     6746\end_inset 
     6747 
     6748TYPE(xios_date), INTENT(IN) :: date 
     6749\end_layout 
     6750 
     6751\begin_layout Subsubsection* 
     6752Arguments: 
     6753\end_layout 
     6754 
     6755\begin_layout Itemize 
     6756\begin_inset Flex Code 
     6757status collapsed 
     6758 
     6759\begin_layout Plain Layout 
     6760date 
     6761\end_layout 
     6762 
     6763\end_inset 
     6764 
     6765: the date to convert 
     6766\end_layout 
     6767 
     6768\begin_layout Subsubsection* 
     6769Description: 
     6770\end_layout 
     6771 
     6772\begin_layout Standard 
     6773This function returns the number of seconds since the beginning of the day 
     6774 for the specified date, based on the calendar of the current context. 
     6775 It must not be used before the calendar was created. 
     6776\end_layout 
     6777 
     6778\begin_layout Subsection* 
     6779Converting a date to a fraction of the current day 
     6780\end_layout 
     6781 
     6782\begin_layout Subsubsection* 
     6783Synopsis: 
     6784\end_layout 
     6785 
     6786\begin_layout LyX-Code 
     6787FUNCTION DOUBLE_PRECISION xios_date_get_fraction_of_day(date) 
     6788\begin_inset Newline newline 
     6789\end_inset 
     6790 
     6791TYPE(xios_date), INTENT(IN) :: date 
     6792\end_layout 
     6793 
     6794\begin_layout Subsubsection* 
     6795Arguments: 
     6796\end_layout 
     6797 
     6798\begin_layout Itemize 
     6799\begin_inset Flex Code 
     6800status collapsed 
     6801 
     6802\begin_layout Plain Layout 
     6803date 
     6804\end_layout 
     6805 
     6806\end_inset 
     6807 
     6808: the date to convert 
     6809\end_layout 
     6810 
     6811\begin_layout Subsubsection* 
     6812Description: 
     6813\end_layout 
     6814 
     6815\begin_layout Standard 
     6816This function returns the fraction of day corresponding to the specified 
     6817 date, based on the calendar of the current context. 
     6818 It must not be used before the calendar was created. 
    45316819\end_layout 
    45326820 
Note: See TracChangeset for help on using the changeset viewer.