Changeset 1740


Ignore:
Timestamp:
10/11/19 16:41:33 (3 years ago)
Author:
ymipsl
Message:

Update of the reference guide documentation - YM

File:
1 edited

Legend:

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

    r1623 r1740  
    1 #LyX 2.1 created this file. For more info see http://www.lyx.org/ 
    2 \lyxformat 474 
     1#LyX 2.2 created this file. For more info see http://www.lyx.org/ 
     2\lyxformat 508 
    33\begin_document 
    44\begin_header 
     5\save_transient_properties true 
     6\origin unavailable 
    57\textclass book 
    68\use_default_options true 
     
    1315\inputencoding auto 
    1416\fontencoding global 
    15 \font_roman default 
    16 \font_sans default 
    17 \font_typewriter default 
    18 \font_math auto 
     17\font_roman "default" "default" 
     18\font_sans "default" "default" 
     19\font_typewriter "default" "default" 
     20\font_math "auto" "auto" 
    1921\font_default_family default 
    2022\use_non_tex_fonts false 
    2123\font_sc false 
    2224\font_osf false 
    23 \font_sf_scale 100 
    24 \font_tt_scale 100 
     25\font_sf_scale 100 100 
     26\font_tt_scale 100 100 
    2527\graphics default 
    2628\default_output_format default 
     
    7779\end_layout 
    7880 
    79 \begin_layout Author 
    80 Yann Meurdesoif 
    81 \end_layout 
    82  
    8381\begin_layout Chapter 
    8482Attribute reference 
     
    11021100Defines the precision in bytes of scalar value and boundaries as it will 
    11031101 be written into an output file. 
    1104  Available values are: 2 (integer), 4 (float single precision) and 8 (float 
    1105  double precision). 
    1106  The default value is 8. 
     1102 Available values are: 4 (float single precision) and 8 (float double precision). 
     1103 The default value is 4. 
    11071104\end_layout 
    11081105 
     
    14231420\begin_layout Standard 
    14241421Defines the name of axis dimension as it will appear in the file's metadata. 
     1422 The default axis dimension name is the axis name. 
    14251423\end_layout 
    14261424 
     
    14481446 
    14491447\begin_layout Standard 
    1450 Adds the formula attribute to a parametric vertical axis. 
     1448Adds the  
     1449\begin_inset Flex Code 
     1450status open 
     1451 
     1452\begin_layout Plain Layout 
     1453formula 
     1454\end_layout 
     1455 
     1456\end_inset 
     1457 
     1458 attribute to the metadata associated to the axis in the output file, for 
     1459 CF conformance. 
    14511460\end_layout 
    14521461 
     
    14741483 
    14751484\begin_layout Standard 
    1476 Adds the formula terms attribute to a parametric vertical axis. 
     1485Adds the  
     1486\begin_inset Flex Code 
     1487status open 
     1488 
     1489\begin_layout Plain Layout 
     1490formula_term 
     1491\end_layout 
     1492 
     1493\end_inset 
     1494 
     1495 attribute to the metadata associated to the axis in the output file, for 
     1496 CF conformance. 
    14771497\end_layout 
    14781498 
     
    15001520 
    15011521\begin_layout Standard 
    1502 Adds the formula attribute to the bounds of a parametric vertical axis. 
    1503  The attribute is mandatory if the  
    1504 \begin_inset Flex Strong 
    1505 status collapsed 
     1522Adds the  
     1523\begin_inset Flex Code 
     1524status open 
    15061525 
    15071526\begin_layout Plain Layout 
     
    15111530\end_inset 
    15121531 
    1513  attribute is defined for the axis. 
     1532 attribute to the metadata associated to the axis boundairies in the output 
     1533 file, for CF conformance. 
     1534 This attribute is meaningfull if  
     1535\begin_inset Flex Code 
     1536status open 
     1537 
     1538\begin_layout Plain Layout 
     1539axis_bounds 
     1540\end_layout 
     1541 
     1542\end_inset 
     1543 
     1544 is not defined. 
    15141545\end_layout 
    15151546 
     
    15371568 
    15381569\begin_layout Standard 
    1539 Adds the formula terms attribute to the bounds of a parametric vertical 
    1540  axis. 
    1541  The attribute is mandatory if the  
    1542 \begin_inset Flex Strong 
    1543 status collapsed 
    1544  
    1545 \begin_layout Plain Layout 
    1546 formula 
    1547 \end_layout 
    1548  
    1549 \end_inset 
    1550  
    1551  attribute is defined for the axis. 
     1570Adds the  
     1571\begin_inset Flex Code 
     1572status open 
     1573 
     1574\begin_layout Plain Layout 
     1575formula_term 
     1576\end_layout 
     1577 
     1578\end_inset 
     1579 
     1580 attribute to the metadata associated to the axis boundairies in the output 
     1581 file, for CF conformance. 
     1582 This attribute is meaningfull if  
     1583\begin_inset Flex Code 
     1584status open 
     1585 
     1586\begin_layout Plain Layout 
     1587axis_bounds 
     1588\end_layout 
     1589 
     1590\end_inset 
     1591 
     1592 is not defined. 
    15521593\end_layout 
    15531594 
     
    16351676 
    16361677\begin_layout LyX-Code 
    1637 INTEGER :: zoom_size 
     1678INTEGER :: n 
    16381679\end_layout 
    16391680 
     
    18201861 
    18211862\begin_layout Standard 
    1822 Defines the name of axis boundaries as it will appear in a file. 
     1863Defines the name of axis boundaries as it will appear in an ouput file. 
    18231864 If not defined, the name will be generated automatically based on the axis 
    18241865 id. 
     
    18421883Defines the precision in bytes of axis value and boundaries as it will be 
    18431884 written into an output file. 
    1844  Available values are: 2 (integer), 4 (float single precision) and 8 (float 
    1845  double precision). 
    1846  The default value is 8. 
     1885 Available values are: 4 (float single precision) and 8 (float double precision). 
     1886 The default value is 4. 
    18471887\end_layout 
    18481888 
     
    20012041In case of a compressed vertical axis, the attribute defines the position 
    20022042 of data points stored in the memory. 
    2003  The array size has to be equal to  
    2004 \begin_inset Flex Strong 
    2005 status collapsed 
    2006  
    2007 \begin_layout Plain Layout 
    2008 data_n 
    2009 \end_layout 
    2010  
    2011 \end_inset 
    2012  
    2013 . 
    20142043 For example, for a local axis of size  
    20152044\begin_inset Flex Strong 
     
    20442073 then the first and the last data points are ghosts and only the three middle 
    20452074 values will be written in the reversed order. 
     2075 Only  
     2076\begin_inset Flex Code 
     2077status open 
     2078 
     2079\begin_layout Plain Layout 
     2080data_begin/data_n 
     2081\end_layout 
     2082 
     2083\end_inset 
     2084 
     2085 or  
     2086\begin_inset Flex Code 
     2087status open 
     2088 
     2089\begin_layout Plain Layout 
     2090data_index 
     2091\end_layout 
     2092 
     2093\end_inset 
     2094 
     2095 can be used together. 
    20462096\end_layout 
    20472097 
     
    21032153 
    21042154. 
     2155 Nota: currently this functionnality is broken, this attribute is meaningfull. 
    21052156\end_layout 
    21062157 
     
    21492200\begin_layout Standard 
    21502201Defines the positive direction for fields representing height or depth. 
     2202 It will just be appended in axis metadata in output file, for CF compliance. 
    21512203\end_layout 
    21522204 
     
    22242276\end_layout 
    22252277 
     2278\begin_layout Standard 
     2279It will just be append in axis metadata in ouput file, for CF compliance. 
     2280\end_layout 
     2281 
    22262282\begin_layout Subsection* 
    22272283comment (optional):  
     
    22932349 attribute will be suffixed to the longitude and latitude dimensions and 
    22942350 axis name. 
    2295  If the domain name is not provided, it will be generated automatically. 
     2351 If the domain name is not provided, it will be generated automatically 
     2352 with the id of the domain. 
    22962353\end_layout 
    22972354 
     
    24032460Defines the name of the first domain dimension as it will appear in the 
    24042461 file's metadata. 
     2462 The default value is ' 
     2463\begin_inset Flex Code 
     2464status open 
     2465 
     2466\begin_layout Plain Layout 
     2467X 
     2468\end_layout 
     2469 
     2470\end_inset 
     2471 
     2472'. 
     2473 In case of multiple domain in the file, the dimension will be preffixed 
     2474 by the domain name. 
    24052475\end_layout 
    24062476 
     
    24302500Defines the name of the second domain dimension as it will appear in file's 
    24312501 metadata. 
     2502 The default value is ' 
     2503\begin_inset Flex Code 
     2504status open 
     2505 
     2506\begin_layout Plain Layout 
     2507Y 
     2508\end_layout 
     2509 
     2510\end_inset 
     2511 
     2512'. 
     2513 In case of multiple domain in the file, the dimension will be preffixed 
     2514 by the domain name. 
    24322515\end_layout 
    24332516 
     
    27582841 
    27592842. 
     2843 In this case the first and second dimensions are collapsed into a linear 
     2844 array. 
     2845 For unstrutured and gaussian grid, the array size sould be  
     2846\begin_inset Flex Strong 
     2847status collapsed 
     2848 
     2849\begin_layout Plain Layout 
     2850ni 
     2851\end_layout 
     2852 
     2853\end_inset 
     2854 
     2855 (the second dimension  
     2856\begin_inset Flex Strong 
     2857status collapsed 
     2858 
     2859\begin_layout Plain Layout 
     2860nj 
     2861\end_layout 
     2862 
     2863\end_inset 
     2864 
     2865 is not used). 
     2866 Only latvalue_1d or latvalue_2d can be defined. 
     2867 Also the layout of latitude and longitude should be in conformance with 
     2868 each other: either 1D or 2D. 
    27602869\end_layout 
    27612870 
     
    27762885\begin_layout Standard 
    27772886Defines the longitude values of a local domain. 
    2778  For cartesian and curvilinear grids the array size should be  
    2779 \begin_inset Flex Strong 
    2780 status collapsed 
    2781  
    2782 \begin_layout Plain Layout 
    2783 ni 
    2784 \begin_inset Formula $\times$ 
    2785 \end_inset 
    2786  
    2787 nj 
     2887 For cartesian grid, the array size must beand curvilinear grids the array 
     2888 size should be  
     2889\begin_inset Flex Strong 
     2890status collapsed 
     2891 
     2892\begin_layout Plain Layout 
     2893(ni,nj) 
     2894\end_layout 
     2895 
     2896\end_inset 
     2897 
     2898. 
     2899 For unstructured or gaussian grid it sould be  
     2900\begin_inset Flex Strong 
     2901status collapsed 
     2902 
     2903\begin_layout Plain Layout 
     2904(ni,1) 
    27882905\end_layout 
    27892906 
     
    28122929\begin_layout Standard 
    28132930Defines the latitude values of a local domain. 
    2814  For a cartesian grid, the size of the array will be nj. 
    2815  For a curvilinear grid, the size of the array will be  
     2931 For a cartesian and curvilinear grid, the array size should be  
    28162932\begin_inset Flex Strong 
    28172933status collapsed 
     
    28282944 
    28292945. 
    2830   
     2946 In this case the first and second dimensions are collapsed into a linear 
     2947 array. 
     2948 For unstrutured and gaussian grid, the array size sould be  
     2949\begin_inset Flex Strong 
     2950status collapsed 
     2951 
     2952\begin_layout Plain Layout 
     2953ni 
     2954\end_layout 
     2955 
     2956\end_inset 
     2957 
     2958 (the second dimension  
     2959\begin_inset Flex Strong 
     2960status collapsed 
     2961 
     2962\begin_layout Plain Layout 
     2963nj 
     2964\end_layout 
     2965 
     2966\end_inset 
     2967 
     2968 is not used). 
     2969 Only latvalue_1d or latvalue_2d can be defined. 
     2970 Also the layout of latitude and longitude should be in conformance with 
     2971 each other: either 1D or 2D. 
    28312972\end_layout 
    28322973 
     
    28472988\begin_layout Standard 
    28482989Defines the latitude values of a local domain. 
    2849  For cartesian and curvilinear grids the array size should be  
    2850 \begin_inset Flex Strong 
    2851 status collapsed 
    2852  
    2853 \begin_layout Plain Layout 
    2854 ni 
    2855 \begin_inset Formula $\times$ 
    2856 \end_inset 
    2857  
    2858 nj 
     2990 For cartesian grid and curvilinear grids the array size should be  
     2991\begin_inset Flex Strong 
     2992status collapsed 
     2993 
     2994\begin_layout Plain Layout 
     2995(ni,nj) 
     2996\end_layout 
     2997 
     2998\end_inset 
     2999 
     3000. 
     3001 For unstructured or gaussian grid it sould be  
     3002\begin_inset Flex Strong 
     3003status collapsed 
     3004 
     3005\begin_layout Plain Layout 
     3006(ni,1) 
    28593007\end_layout 
    28603008 
     
    28903038 
    28913039\begin_layout Standard 
    2892 Defines the longitude name as it will appear in an output file. 
     3040Define the longitude name as it will appear in an output file. 
     3041 If not defined, the default will be ' 
     3042\begin_inset Flex Code 
     3043status open 
     3044 
     3045\begin_layout Plain Layout 
     3046lon 
     3047\end_layout 
     3048 
     3049\end_inset 
     3050 
     3051'. 
     3052 In case of multiple domain defined in a file, the longitude name will be 
     3053 suffixed by the domain name. 
    28933054\end_layout 
    28943055 
     
    29163077 
    29173078\begin_layout Standard 
    2918 Defines the latitude name as it will appear in an output file. 
     3079efine the longitude name as it will appear in an output file. 
     3080 If not defined, the default will be ' 
     3081\begin_inset Flex Code 
     3082status open 
     3083 
     3084\begin_layout Plain Layout 
     3085lat 
     3086\end_layout 
     3087 
     3088\end_inset 
     3089 
     3090'. 
     3091 In case of multiple domain defined in a file, the longitude name will be 
     3092 suffixed by the domain name. 
    29193093\end_layout 
    29203094 
     
    29343108 
    29353109\begin_layout Standard 
    2936 Defines the maximum number of vertices for a grid. 
    2937  The attribute is required for specifying the cell boundaries of unstructured 
    2938  meshes. 
     3110Used only for unstructured domain. 
     3111 Defines the maximum number of vertices for a grid. 
     3112 The attribute is required for specifying the cell boundaries of the unstructure 
     3113d meshes. 
     3114 For other grid (cartesian, curvilinear or gaussian), the nvertex value 
     3115 will be set automatically to 4. 
    29393116\end_layout 
    29403117 
     
    29543131 
    29553132\begin_layout Standard 
    2956 Defines the longitude values of domain vertexes. 
    2957  The attribute  
     3133Defines the longitude values of the domain vertexes. 
     3134 For unstructured domain, the attribute  
    29583135\begin_inset Flex Strong 
    29593136status collapsed 
     
    29653142\end_inset 
    29663143 
    2967  must be also defined. 
    2968  The array dimensions must be  
    2969 \begin_inset Formula $\textbf{nvertex}\times\textbf{ni}$ 
     3144 must be also defined (for other mesh it is set automatically to 4). 
     3145 The array dimensions shape must be of size 
     3146\begin_inset Flex Code 
     3147status open 
     3148 
     3149\begin_layout Plain Layout 
     3150(nvertex, ni) 
     3151\end_layout 
     3152 
    29703153\end_inset 
    29713154 
     
    29883171 
    29893172\begin_layout Standard 
    2990 Defines the longitude values of domain vertexes. 
    2991  The attribute  
     3173Defines the longitude values of the domain vertexes. 
     3174 For unstructured domain, the attribute  
     3175\begin_inset Flex Strong 
     3176status collapsed 
     3177 
     3178\begin_layout Plain Layout 
     3179nvertex 
     3180\end_layout 
     3181 
     3182\end_inset 
     3183 
     3184 must be also defined (for other mesh it is set automatically to 4). 
     3185 This attribute is useful when lonvalue_2d is defined. 
     3186 for cartesian and curvilinear domain, the array dimensions shape must be 
     3187 of size  
     3188\begin_inset Flex Code 
     3189status open 
     3190 
     3191\begin_layout Plain Layout 
     3192(nvertex, ni, nj) 
     3193\end_layout 
     3194 
     3195\end_inset 
     3196 
     3197, and for gaussian or unstructured domain, it sould be of size  
     3198\begin_inset Flex Code 
     3199status open 
     3200 
     3201\begin_layout Plain Layout 
     3202(nvertex, ni, 1) 
     3203\end_layout 
     3204 
     3205\end_inset 
     3206 
     3207. 
     3208 For cartesian, curvilinear . 
     3209 Either  
     3210\begin_inset Flex Code 
     3211status open 
     3212 
     3213\begin_layout Plain Layout 
     3214bounds_lon_1d 
     3215\end_layout 
     3216 
     3217\end_inset 
     3218 
     3219 or  
     3220\begin_inset Flex Code 
     3221status open 
     3222 
     3223\begin_layout Plain Layout 
     3224bounds_lon_2d 
     3225\end_layout 
     3226 
     3227\end_inset 
     3228 
     3229 can be defined. 
     3230\end_layout 
     3231 
     3232\begin_layout Subsection* 
     3233bounds_lat_1d (optional):  
     3234\emph on 
     32352D-array of double 
     3236\end_layout 
     3237 
     3238\begin_layout Standard 
     3239Fortran: 
     3240\end_layout 
     3241 
     3242\begin_layout LyX-Code 
     3243DOUBLE PRECISION :: bounds_lat(:,:) 
     3244\end_layout 
     3245 
     3246\begin_layout Standard 
     3247Defines the latitude values of the domain vertexes. 
     3248 For unstructured domain, the attribute  
     3249\begin_inset Flex Strong 
     3250status collapsed 
     3251 
     3252\begin_layout Plain Layout 
     3253nvertex 
     3254\end_layout 
     3255 
     3256\end_inset 
     3257 
     3258 must be also defined (for other mesh it is set automatically to 4). 
     3259 The array dimensions shape must be of size 
     3260\begin_inset Flex Code 
     3261status open 
     3262 
     3263\begin_layout Plain Layout 
     3264(nvertex, ni) 
     3265\end_layout 
     3266 
     3267\end_inset 
     3268 
     3269. 
     3270\end_layout 
     3271 
     3272\begin_layout Subsection* 
     3273bounds_lat_2d (optional):  
     3274\emph on 
     32753D-array of double 
     3276\end_layout 
     3277 
     3278\begin_layout Standard 
     3279Fortran: 
     3280\end_layout 
     3281 
     3282\begin_layout LyX-Code 
     3283DOUBLE PRECISION :: bounds_lat(:,:) 
     3284\end_layout 
     3285 
     3286\begin_layout Standard 
     3287Defines the latitude values of domain vertexes. 
     3288 For unstructured domain, the attribute  
    29923289\begin_inset Flex Strong 
    29933290status collapsed 
     
    30013298 must be also defined. 
    30023299 This attribute is useful when lonvalue_2d is defined. 
    3003  The array dimensions must be  
    3004 \begin_inset Formula $\textbf{nvertex}\times\textbf{ni}\times\textbf{nj}$ 
     3300 for cartesian and curvilinear domain, the array dimensions shape must be 
     3301 of size  
     3302\begin_inset Flex Code 
     3303status open 
     3304 
     3305\begin_layout Plain Layout 
     3306(nvertex, ni, nj) 
     3307\end_layout 
     3308 
     3309\end_inset 
     3310 
     3311, and for gaussian or unstructured domain, it sould be of size  
     3312\begin_inset Flex Code 
     3313status open 
     3314 
     3315\begin_layout Plain Layout 
     3316(nvertex, ni, 1) 
     3317\end_layout 
     3318 
    30053319\end_inset 
    30063320 
    30073321. 
    3008  Either bounds_lon_1d or bounds_lon_2d can be defined. 
    3009 \end_layout 
    3010  
    3011 \begin_layout Subsection* 
    3012 bounds_lat_1d (optional):  
    3013 \emph on 
    3014 2D-array of double 
    3015 \end_layout 
    3016  
    3017 \begin_layout Standard 
    3018 Fortran: 
    3019 \end_layout 
    3020  
    3021 \begin_layout LyX-Code 
    3022 DOUBLE PRECISION :: bounds_lat(:,:) 
    3023 \end_layout 
    3024  
    3025 \begin_layout Standard 
    3026 Defines the latitude values of domain vertexes. 
    3027  The attribute  
    3028 \begin_inset Flex Strong 
    3029 status collapsed 
    3030  
    3031 \begin_layout Plain Layout 
    3032 nvertex 
    3033 \end_layout 
    3034  
    3035 \end_inset 
    3036  
    3037  must be also defined. 
    3038  The array dimensions must be  
    3039 \begin_inset Formula $\textbf{nvertex}\times\textbf{ni}$ 
    3040 \end_inset 
    3041  
    3042 . 
    3043 \end_layout 
    3044  
    3045 \begin_layout Subsection* 
    3046 bounds_lat_2d (optional):  
    3047 \emph on 
    3048 3D-array of double 
    3049 \end_layout 
    3050  
    3051 \begin_layout Standard 
    3052 Fortran: 
    3053 \end_layout 
    3054  
    3055 \begin_layout LyX-Code 
    3056 DOUBLE PRECISION :: bounds_lat(:,:) 
    3057 \end_layout 
    3058  
    3059 \begin_layout Standard 
    3060 Defines the latitude values of domain vertexes. 
    3061  The attribute  
    3062 \begin_inset Flex Strong 
    3063 status collapsed 
    3064  
    3065 \begin_layout Plain Layout 
    3066 nvertex 
    3067 \end_layout 
    3068  
    3069 \end_inset 
    3070  
    3071  must be also defined. 
    3072  The attribute is useful when lonvalue_2d is defined. 
    3073  The array dimensions must be  
    3074 \begin_inset Formula $\textbf{nvertex}\times\textbf{ni}\times\textbf{nj}$ 
    3075 \end_inset 
    3076  
    3077 . 
    3078  Either bounds_lon_1d or bounds_lon_2d can be defined. 
     3322 For cartesian, curvilinear . 
     3323 Either  
     3324\begin_inset Flex Code 
     3325status open 
     3326 
     3327\begin_layout Plain Layout 
     3328bounds_lon_1d 
     3329\end_layout 
     3330 
     3331\end_inset 
     3332 
     3333 or  
     3334\begin_inset Flex Code 
     3335status open 
     3336 
     3337\begin_layout Plain Layout 
     3338bounds_lon_2d 
     3339\end_layout 
     3340 
     3341\end_inset 
     3342 
     3343 can be defined. 
    30793344\end_layout 
    30803345 
     
    30983363 
    30993364\begin_layout LyX-Code 
    3100 CHARACTER(LEN=*) :: lon_name 
    3101 \end_layout 
    3102  
    3103 \begin_layout Standard 
    3104 Defines the longitude name of domain vertexes as it will appear in an output 
    3105  file. 
     3365CHARACTER(LEN=*) :: bounds_lon_name 
     3366\end_layout 
     3367 
     3368\begin_layout Standard 
     3369Defines the boundaries longitude boundaries name of domain as it will appear 
     3370 in an output file. 
     3371 Default value is ' 
     3372\begin_inset Flex Code 
     3373status open 
     3374 
     3375\begin_layout Plain Layout 
     3376bounds_lon 
     3377\end_layout 
     3378 
     3379\end_inset 
     3380 
     3381'. 
     3382 In case of multiple domains defined in a same file, the boundaries name 
     3383 will be suffixed by the domain name. 
     3384  
    31063385\end_layout 
    31073386 
     
    31293408 
    31303409\begin_layout Standard 
    3131 Defines the latitude name of domain vertexes as it will appear in an output 
    3132  file. 
     3410Defines the boundaries longitude boundaries name of domain as it will appear 
     3411 in an output file. 
     3412 Default value is ' 
     3413\begin_inset Flex Code 
     3414status open 
     3415 
     3416\begin_layout Plain Layout 
     3417bounds_lon 
     3418\end_layout 
     3419 
     3420\end_inset 
     3421 
     3422'. 
     3423 In case of multiple domains defined in a same file, the boundaries name 
     3424 will be suffixed by the domain name. 
     3425  
    31333426\end_layout 
    31343427 
     
    31493442\begin_layout Standard 
    31503443The area of cells. 
    3151  The size of the array must be  
    3152 \begin_inset Flex Strong 
    3153 status collapsed 
    3154  
    3155 \begin_layout Plain Layout 
    3156 ni 
    3157 \begin_inset Formula $\times$ 
    3158 \end_inset 
    3159  
    3160 nj 
    3161 \end_layout 
    3162  
    3163 \end_inset 
    3164  
    3165 . 
     3444 The size of the array must  
     3445\begin_inset Flex Code 
     3446status open 
     3447 
     3448\begin_layout Plain Layout 
     3449(ni, nj) 
     3450\end_layout 
     3451 
     3452\end_inset 
     3453 
     3454 for cartesian or curvilinear domain and (ni, 1) for unstructured or gaussian 
     3455 domain. 
     3456 If this attribute is defined, it will be wrote in the output file as domain 
     3457 metadata. 
     3458 This attribute could be also used in domain interpolation to take into 
     3459 account the area of the cell instead to take the computed value (for conservati 
     3460on consideration). 
     3461  
     3462\end_layout 
     3463 
     3464\begin_layout Subsection* 
     3465radius (optional):  
     3466\emph on 
     3467double 
     3468\end_layout 
     3469 
     3470\begin_layout Standard 
     3471Fortran: 
     3472\end_layout 
     3473 
     3474\begin_layout LyX-Code 
     3475DOUBLE PRECISION :: radius 
     3476\end_layout 
     3477 
     3478\begin_layout Standard 
     3479Define the radius of the planet (or earth). 
     3480 If defined, it can be used by domain interpolation together with  
     3481\begin_inset Flex Code 
     3482status open 
     3483 
     3484\begin_layout Plain Layout 
     3485area 
     3486\end_layout 
     3487 
     3488\end_inset 
     3489 
     3490 domain attribute in order to renormalize weight to compute conservative 
     3491 interpolation (see  
     3492\begin_inset Flex Code 
     3493status open 
     3494 
     3495\begin_layout Plain Layout 
     3496domain_interpolate 
     3497\end_layout 
     3498 
     3499\end_inset 
     3500 
     3501 filter). 
    31663502\end_layout 
    31673503 
     
    31813517 
    31823518\begin_layout Standard 
    3183 Defines the precision in bytes of domain attributes. 
    3184  Available values are: 2 (integer), 4 (float single precision) and 8 (float 
    3185  double precision). 
    3186  The default value of 8. 
     3519Defines the precision (in bytes) for which domain attributes (longitude, 
     3520 latitude, boudairies, ...) will be written in output file. 
     3521 Available values are: 4 (float single precision) and 8 (float double precision). 
     3522 The default value is 4 bytes. 
    31873523\end_layout 
    31883524 
     
    33043640 
    33053641 must be defined together. 
     3642 Only data_ibegin/data_ni or data_i_index/  
    33063643\end_layout 
    33073644 
     
    35023839In case of a compressed horizontal domain, define the data indexation for 
    35033840 the first dimension. 
    3504  The array size must be  
    3505 \begin_inset Flex Strong 
    3506 status collapsed 
    3507  
    3508 \begin_layout Plain Layout 
    3509 data_n 
     3841 This attribute cannot be used together with  
     3842\begin_inset Flex Code 
     3843status open 
     3844 
     3845\begin_layout Plain Layout 
     3846data_ibegin/data_ni 
     3847\end_layout 
     3848 
     3849\end_inset 
     3850 
     3851 attributes. 
     3852 This attribute can be used only when  
     3853\begin_inset Flex Code 
     3854status open 
     3855 
     3856\begin_layout Plain Layout 
     3857data_dim=1 
    35103858\end_layout 
    35113859 
     
    35133861 
    35143862. 
     3863 The size of data_i_index determine the size of the fields dimension of 
     3864 the corresponding domain, that is sent from the model. 
     3865 Value can be negative or greater than  
     3866\begin_inset Flex Code 
     3867status open 
     3868 
     3869\begin_layout Plain Layout 
     3870ni 
     3871\end_layout 
     3872 
     3873\end_inset 
     3874 
     3875. 
     3876 In this case, the corresponding point will be considered as masked and 
     3877 will not be extracted to enter the workflow. 
    35153878\end_layout 
    35163879 
     
    35303893 
    35313894\begin_layout Standard 
    3532 In case of a compressed horizontal domain, defines the data indexation for 
    3533  the second dimension. 
    3534  The attribute is meaningful only if  
    3535 \begin_inset Flex Strong 
    3536 status collapsed 
    3537  
    3538 \begin_layout Plain Layout 
    3539 data_dim=2 
     3895In case of a compressed horizontal domain, define the data indexation for 
     3896 the first dimension. 
     3897 This attribute cannot be used together with  
     3898\begin_inset Flex Code 
     3899status open 
     3900 
     3901\begin_layout Plain Layout 
     3902data_jbegin/data_nj 
     3903\end_layout 
     3904 
     3905\end_inset 
     3906 
     3907 attributes. 
     3908 This attribute can be used only when  
     3909\begin_inset Flex Code 
     3910status open 
     3911 
     3912\begin_layout Plain Layout 
     3913data_dim=1 
    35403914\end_layout 
    35413915 
     
    35433917 
    35443918. 
     3919 The size of data_i_index determine the size of the fields dimension of 
     3920 the corresponding domain, that is sent from the model. 
     3921 Value can be negative or greater than  
     3922\begin_inset Flex Code 
     3923status open 
     3924 
     3925\begin_layout Plain Layout 
     3926nj 
     3927\end_layout 
     3928 
     3929\end_inset 
     3930 
     3931. 
     3932 In this case, the corresponding point will be considered as masked and 
     3933 will not be extracted to enter the workflow. 
    35453934\end_layout 
    35463935 
     
    35603949 
    35613950\begin_layout Standard 
    3562 Defines the 1D mask of a local domain. 
     3951Defines a 1D mask of a local domain. 
    35633952 The masked value will be replaced by the value of the field attribute  
    35643953\begin_inset Flex Strong 
     
    35723961 
    35733962 in an output file. 
    3574  This value is useful in case a field is stored linearly in memory. 
    3575  By default none of the values are masked. 
     3963 This attribute must be of size  
     3964\begin_inset Flex Code 
     3965status open 
     3966 
     3967\begin_layout Plain Layout 
     3968ni*nj 
     3969\end_layout 
     3970 
     3971\end_inset 
     3972 
     3973. 
     3974 By default no values are masked. 
    35763975\end_layout 
    35773976 
     
    35913990 
    35923991\begin_layout Standard 
    3593 Defines the 2D mask of a local domain. 
     3992Defines a 2D mask of a local domain. 
    35943993 The masked values will be replaced by the value of the field attribute 
    35953994  
     
    36044003 
    36054004 in an output file. 
    3606  By default, none of the values are masked. 
    3607  Only mask_2d or mask_1d can be defined. 
     4005 This attribute must be of size  
     4006\begin_inset Flex Code 
     4007status open 
     4008 
     4009\begin_layout Plain Layout 
     4010(ni,nj) 
     4011\end_layout 
     4012 
     4013\end_inset 
     4014 
     4015. 
     4016 By default no values are masked. 
    36084017\end_layout 
    36094018 
     
    36534062Defines the global index of the first dimension of a local domain held by 
    36544063 a process. 
    3655  By default the size of the array is equal to  
     4064 By default the size of the array must be  
    36564065\begin_inset Flex Strong 
    36574066status collapsed 
     
    36914100Defines the global index of the second dimension of a local domain held 
    36924101 by a process. 
    3693  By default the size of the array is equal to  
     4102 By default the size of the array must be  
    36944103\begin_inset Flex Strong 
    36954104status collapsed 
     
    40004409\begin_layout Standard 
    40014410Allows a user to set a comment. 
     4411 Meaningfull for the XIOS workflow. 
    40024412\end_layout 
    40034413 
     
    41344544 
    41354545\begin_layout Standard 
    4136 Defines the unit of a field. 
     4546Defines the unit of a field, as it will apear in the associated metadata 
     4547 in the output file. 
    41374548\end_layout 
    41384549 
     
    41824593 
    41834594. 
    4184  It is useful for sub-processes called at different frequency in a model. 
     4595 It can be also useful for sub-processes called at different frequency in 
     4596 a model. 
    41854597 The default value is equal to the file attribute  
    41864598\begin_inset Flex Strong 
     
    42514663 
    42524664\begin_layout Plain Layout 
    4253 freq_op 
     4665freq_op - 1ts 
    42544666\end_layout 
    42554667 
     
    43564768 Available values are: 2 (integer), 4 (float single precision) and 8 (float 
    43574769 double precision). 
    4358  The default value of 8. 
     4770 The default value is 4 (float single precision). 
    43594771\end_layout 
    43604772 
     
    46375049 
    46385050\begin_layout Standard 
    4639 Defines the way operations pass from a grid to other grids. 
     5051Defines the way operations pass from a grid to other grids, combined with 
     5052 field_ref attribute. 
     5053 Each grid name in  
     5054\begin_inset Flex Code 
     5055status open 
     5056 
     5057\begin_layout Plain Layout 
     5058grid_path 
     5059\end_layout 
     5060 
     5061\end_inset 
     5062 
     5063 must be separated by a comma. 
     5064 All tranformation realated to the grid listed in grid_path will be applyed 
     5065 successively, including the grid destination associated to the destination 
     5066 field. 
     5067  
    46405068\end_layout 
    46415069 
     
    46565084\begin_layout Standard 
    46575085Defines the value which will be used instead of missing field data. 
    4658  If no value is provided, the missing data will be replaced by uninitialized 
    4659  values what can lead to undefined behavior. 
     5086 For an entry field (coming from model, or from an input file), if  
     5087\begin_inset Flex Code 
     5088status open 
     5089 
     5090\begin_layout Plain Layout 
     5091detect_missing_value 
     5092\end_layout 
     5093 
     5094\end_inset 
     5095 
     5096 and  
     5097\begin_inset Flex Code 
     5098status open 
     5099 
     5100\begin_layout Plain Layout 
     5101default_value 
     5102\end_layout 
     5103 
     5104\end_inset 
     5105 
     5106 are defined the values of the field equal to  
     5107\begin_inset Flex Code 
     5108status open 
     5109 
     5110\begin_layout Plain Layout 
     5111default_value 
     5112\end_layout 
     5113 
     5114\end_inset 
     5115 
     5116 will be replaced by NaN. 
     5117 For output field (read from the model or sent to server), the NaN values 
     5118 will be replaced by  
     5119\begin_inset Flex Code 
     5120status open 
     5121 
     5122\begin_layout Plain Layout 
     5123default_value 
     5124\end_layout 
     5125 
     5126\end_inset 
     5127 
     5128, if defined. 
     5129 For masked value, in output, if  
     5130\begin_inset Flex Code 
     5131status open 
     5132 
     5133\begin_layout Plain Layout 
     5134default_value 
     5135\end_layout 
     5136 
     5137\end_inset 
     5138 
     5139 is defined, the corresponding value will be replaced by  
     5140\begin_inset Flex Code 
     5141status open 
     5142 
     5143\begin_layout Plain Layout 
     5144default_value 
     5145\end_layout 
     5146 
     5147\end_inset 
     5148 
     5149, otherwise, the value is undefined and will depend of the initial value 
     5150 of the allocated memory block. 
    46605151\end_layout 
    46615152 
     
    46755166 
    46765167\begin_layout Standard 
    4677 All field values below  
    4678 \begin_inset Flex Strong 
    4679 status collapsed 
    4680  
    4681 \begin_layout Plain Layout 
    4682 valid_min 
    4683 \end_layout 
    4684  
    4685 \end_inset 
    4686  
    4687  attribute value will be set to missing value. 
     5168Define the minimum validity range of the field as it will be written as 
     5169 a field metadata in the output file, accordingly to CF compliance. 
     5170  
    46885171\end_layout 
    46895172 
     
    47035186 
    47045187\begin_layout Standard 
    4705 All field values above  
    4706 \begin_inset Flex Strong 
    4707 status collapsed 
    4708  
    4709 \begin_layout Plain Layout 
    4710 valid_max 
    4711 \end_layout 
    4712  
    4713 \end_inset 
    4714  
    4715  attribute value will be set to missing value. 
     5188Define the maximum validity range of the field as it will be written as 
     5189 a field metadata in the output file, accordingly to CF compliance. 
     5190  
    47165191\end_layout 
    47175192 
     
    47315206 
    47325207\begin_layout Standard 
    4733 When XIOS detects a default value in a field, it does not take into account 
    4734  the value during arithmetic operations such as averaging, minimum, maximum, 
    4735  etc. 
     5208For entry field, if  
     5209\begin_inset Flex Code 
     5210status open 
     5211 
     5212\begin_layout Plain Layout 
     5213detect_missing_value 
     5214\end_layout 
     5215 
     5216\end_inset 
     5217 
     5218 is set to true and  
     5219\begin_inset Flex Code 
     5220status open 
     5221 
     5222\begin_layout Plain Layout 
     5223default_value 
     5224\end_layout 
     5225 
     5226\end_inset 
     5227 
     5228 is defined, the corresponding value will be replaced by NaN (see  
     5229\begin_inset Flex Code 
     5230status open 
     5231 
     5232\begin_layout Plain Layout 
     5233default_value 
     5234\end_layout 
     5235 
     5236\end_inset 
     5237 
     5238 attribute). 
     5239 This attribute is also used during temporal operation such as averaging, 
     5240 minimum, maximum, accumulate..., to detect NaN value and remove it from the 
     5241 computation (otherwise the result will be NaN). 
     5242 It is used also in some spatial transformation, but will be replaced later 
     5243 by a specific detect_missing value attribute related to the transformation. 
    47365244\end_layout 
    47375245 
     
    47735281 
    47745282 value will be subtracted from the field values. 
     5283 It can be used together with  
     5284\begin_inset Flex Code 
     5285status open 
     5286 
     5287\begin_layout Plain Layout 
     5288scale_factor 
     5289\end_layout 
     5290 
     5291\end_inset 
     5292 
     5293 and  
     5294\begin_inset Flex Code 
     5295status open 
     5296 
     5297\begin_layout Plain Layout 
     5298prec 
     5299\end_layout 
     5300 
     5301\end_inset 
     5302 
     5303 attributes in order to reduce the data range and the volume of written 
     5304 data. 
     5305 Fo reading, this attribute is also taking into account to  
     5306\begin_inset Quotes eld 
     5307\end_inset 
     5308 
     5309decompress 
     5310\begin_inset Quotes erd 
     5311\end_inset 
     5312 
     5313 data. 
    47755314\end_layout 
    47765315 
     
    48125351 
    48135352 value. 
     5353 It can be used together with  
     5354\begin_inset Flex Code 
     5355status open 
     5356 
     5357\begin_layout Plain Layout 
     5358add_offset 
     5359\end_layout 
     5360 
     5361\end_inset 
     5362 
     5363 and  
     5364\begin_inset Flex Code 
     5365status open 
     5366 
     5367\begin_layout Plain Layout 
     5368prec 
     5369\end_layout 
     5370 
     5371\end_inset 
     5372 
     5373 attributes in order to reduce the data range and the volume of written 
     5374 data. 
     5375 Fo reading, this attribute is also taking into account to  
     5376\begin_inset Quotes eld 
     5377\end_inset 
     5378 
     5379decompress 
     5380\begin_inset Quotes erd 
     5381\end_inset 
     5382 
     5383 data. 
    48145384\end_layout 
    48155385 
     
    48895459\emph default 
    48905460. 
     5461 A field will be tagged as timeseries if  
     5462\begin_inset Flex Code 
     5463status open 
     5464 
     5465\begin_layout Plain Layout 
     5466ts_enabled 
     5467\end_layout 
     5468 
     5469\end_inset 
     5470 
     5471 is set to true, and the associated file attribute timeserie is set to  
     5472\begin_inset Flex Code 
     5473status open 
     5474 
     5475\begin_layout Plain Layout 
     5476only 
     5477\end_layout 
     5478 
     5479\end_inset 
     5480 
     5481,  
     5482\begin_inset Flex Code 
     5483status open 
     5484 
     5485\begin_layout Plain Layout 
     5486both 
     5487\end_layout 
     5488 
     5489\end_inset 
     5490 
     5491 or  
     5492\begin_inset Flex Code 
     5493status open 
     5494 
     5495\begin_layout Plain Layout 
     5496exclusive 
     5497\end_layout 
     5498 
     5499\end_inset 
     5500 
     5501. 
     5502 A field tagged as timeseries will be output alone in a specific file suffixed 
     5503 by the field name. 
     5504  
    48915505\end_layout 
    48925506 
     
    49315545\begin_layout Standard 
    49325546Defines the cell methods field attribute. 
     5547 it will be written as associated field metadata, accordingly to CF compliance. 
    49335548\end_layout 
    49345549 
     
    49495564\begin_layout Standard 
    49505565Defines the cell methods mode of a field. 
     5566  
     5567\end_layout 
     5568 
     5569\begin_layout Standard 
     5570XIOS defined itself the cell_method string, taking into account the operations 
     5571 applied on the field. 
     5572 But in some case it can modified, with the  
     5573\begin_inset Flex Code 
     5574status open 
     5575 
     5576\begin_layout Plain Layout 
     5577cell_methods 
     5578\end_layout 
     5579 
     5580\end_inset 
     5581 
     5582 attribute. 
     5583  
     5584\begin_inset Flex Code 
     5585status open 
     5586 
     5587\begin_layout Plain Layout 
     5588overwrite 
     5589\end_layout 
     5590 
     5591\end_inset 
     5592 
     5593 will replace the computed default string by the  
     5594\begin_inset Flex Code 
     5595status open 
     5596 
     5597\begin_layout Plain Layout 
     5598cell_methods 
     5599\end_layout 
     5600 
     5601\end_inset 
     5602 
     5603 attribute,  
     5604\begin_inset Flex Code 
     5605status open 
     5606 
     5607\begin_layout Plain Layout 
     5608prefix 
     5609\end_layout 
     5610 
     5611\end_inset 
     5612 
     5613 will prefix the default string, and  
     5614\begin_inset Flex Code 
     5615status open 
     5616 
     5617\begin_layout Plain Layout 
     5618suffix 
     5619\end_layout 
     5620 
     5621\end_inset 
     5622 
     5623 will suffix the default string. 
    49515624\end_layout 
    49525625 
     
    49755648\begin_layout Standard 
    49765649Allows a user to set a comment. 
     5650 Meaningfull on XIOS workflow. 
    49775651\end_layout 
    49785652 
     
    50525726\end_layout 
    50535727 
     5728\begin_layout Standard 
     5729This attribute specify if a variable present in a file (global attribute) 
     5730 must be reported in each timeseries generated file. 
     5731 If  
     5732\begin_inset Flex Code 
     5733status open 
     5734 
     5735\begin_layout Plain Layout 
     5736ts_target=none 
     5737\end_layout 
     5738 
     5739\end_inset 
     5740 
     5741, the variable is not included, if  
     5742\begin_inset Flex Code 
     5743status open 
     5744 
     5745\begin_layout Plain Layout 
     5746ts_target=file 
     5747\end_layout 
     5748 
     5749\end_inset 
     5750 
     5751, the variable is included in each generated file as global attribute, if 
     5752  
     5753\begin_inset Flex Code 
     5754status open 
     5755 
     5756\begin_layout Plain Layout 
     5757ts_target=field 
     5758\end_layout 
     5759 
     5760\end_inset 
     5761 
     5762, the variable is included as field attribute associated to the generated 
     5763 files (field metadata), if  
     5764\begin_inset Flex Code 
     5765status open 
     5766 
     5767\begin_layout Plain Layout 
     5768ts_target=both 
     5769\end_layout 
     5770 
     5771\end_inset 
     5772 
     5773, the varible is included twice as file global attribute and field attribute. 
     5774  
     5775\end_layout 
     5776 
    50545777\begin_layout Section 
    50555778File attribute reference 
     
    50575780 
    50585781\begin_layout Subsection* 
    5059 name (mandatory):  
     5782name (optional):  
    50605783\emph on 
    50615784string 
     
    50725795\begin_layout Standard 
    50735796Defines the name of a file. 
     5797 If not specified a name is automaticaly defined from the file id. 
     5798 For netcdf output, a  
     5799\begin_inset Quotes eld 
     5800\end_inset 
     5801 
     5802 
     5803\begin_inset Flex Code 
     5804status open 
     5805 
     5806\begin_layout Plain Layout 
     5807.nc 
     5808\end_layout 
     5809 
     5810\end_inset 
     5811 
     5812 
     5813\begin_inset Quotes erd 
     5814\end_inset 
     5815 
     5816 suffix will be added to the file name. 
    50745817\end_layout 
    50755818 
     
    53506093 
    53516094\begin_layout Subsection* 
    5352 split_start_offset(optional):  
     6095split_start_offset (optional):  
    53536096\emph on 
    53546097duration 
     
    53646107 
    53656108\begin_layout Standard 
    5366 Defines the offset of file splitting. 
     6109Defines the offset of the start splitting date when  
     6110\begin_inset Flex Code 
     6111status open 
     6112 
     6113\begin_layout Plain Layout 
     6114split_freq 
     6115\end_layout 
     6116 
     6117\end_inset 
     6118 
     6119 attribute is enabled. 
     6120 This attribute is used only to shift the start date of the splitting format. 
     6121 It has no impact on the real splitting date. 
    53676122  
    53686123\end_layout 
     
    53826137\end_layout 
    53836138 
     6139\begin_layout Standard 
     6140Defines the offset of the end splitting date when  
     6141\begin_inset Flex Code 
     6142status open 
     6143 
     6144\begin_layout Plain Layout 
     6145split_freq 
     6146\end_layout 
     6147 
     6148\end_inset 
     6149 
     6150 attribute is enabled. 
     6151 This attribute is used only to shift the end date of the splitting format. 
     6152 It has no impact on the real splitting date. 
     6153  
     6154\end_layout 
     6155 
    53846156\begin_layout Subsection* 
    53856157split_last_date (optional):  
     
    53946166\begin_layout LyX-Code 
    53956167CHARACTER(LEN=*) :: split_last_date 
     6168\end_layout 
     6169 
     6170\begin_layout Standard 
     6171Define the end splitting date when  
     6172\begin_inset Flex Code 
     6173status open 
     6174 
     6175\begin_layout Plain Layout 
     6176split_freq 
     6177\end_layout 
     6178 
     6179\end_inset 
     6180 
     6181 attribute is enabled. 
     6182 If  
     6183\begin_inset Flex Code 
     6184status open 
     6185 
     6186\begin_layout Plain Layout 
     6187split_last_date 
     6188\end_layout 
     6189 
     6190\end_inset 
     6191 
     6192 is lesser than the compute end splitting date, then the end splitting date 
     6193 will be replaced by  
     6194\begin_inset Flex Code 
     6195status open 
     6196 
     6197\begin_layout Plain Layout 
     6198split_last_date 
     6199\end_layout 
     6200 
     6201\end_inset 
     6202 
     6203 in the file name. 
     6204 This attribute can be usefull when a simulation is over before the computed 
     6205 splitting date, to be consistent with the file internal calendar. 
     6206 The format of  
     6207\begin_inset Flex Code 
     6208status open 
     6209 
     6210\begin_layout Plain Layout 
     6211split_last_date 
     6212\end_layout 
     6213 
     6214\end_inset 
     6215 
     6216 string attribute must be consistent with a date. 
     6217  
    53966218\end_layout 
    53976219 
     
    54556277 
    54566278\begin_layout Subsection* 
    5457 type (mandatory):  
     6279type (optionnal):  
    54586280\emph on 
    54596281enumeration {one_file, multiple_file} 
     
    54946316 
    54956317: one single global file is wrote using netcdf4 parallel access. 
     6318 The default value is  
     6319\begin_inset Flex Code 
     6320status open 
     6321 
     6322\begin_layout Plain Layout 
     6323multiple_file 
     6324\end_layout 
     6325 
     6326\end_inset 
     6327 
     6328. 
    54966329\end_layout 
    54976330 
     
    55676400\series default 
    55686401\emph default 
    5569  only if the NetCDF4 library was compiled with Parallel NetCDF support (--enable 
    5570 -pnetcdf). 
     6402 only if the NetCDF4 library was compiled with Parallel NetCDF support (–enable- 
     6403pnetcdf). 
    55716404\end_layout 
    55726405 
     
    56006433 
    56016434. 
     6435 Nota : this attribute is now deprecated, and has no effect on I/O parallelism. 
     6436  
    56026437\end_layout 
    56036438 
     
    56196454For files in the read mode, defines if parallel or serial I/O will be used 
    56206455 by model processes for reading file metadata. 
    5621  The default value is false implying serial I/O for reading metadata. 
     6456 The default value is false implying serial I/O for reading metadata on 
     6457 client side. 
     6458  
    56226459\end_layout 
    56236460 
     
    56386475\begin_layout Standard 
    56396476Defines the file conventions. 
     6477 The netcdf file can be output following the CF convention (1.7) or the UGRID 
     6478 convention, usefull for unstructured mesh. 
    56406479 By default the CF conventions are followed. 
     6480 The global file attribute  
     6481\begin_inset Flex Code 
     6482status open 
     6483 
     6484\begin_layout Plain Layout 
     6485Conventions 
     6486\end_layout 
     6487 
     6488\end_inset 
     6489 
     6490 will be added in the output file following the specified value. 
    56416491\end_layout 
    56426492 
     
    56616511\series default 
    56626512attribute to be added to file global attributes. 
     6513 This attribute will overwrite the  
     6514\begin_inset Flex Code 
     6515status open 
     6516 
     6517\begin_layout Plain Layout 
     6518Conventions 
     6519\end_layout 
     6520 
     6521\end_inset 
     6522 
     6523 global file attribute generated by the  
     6524\begin_inset Flex Code 
     6525status open 
     6526 
     6527\begin_layout Plain Layout 
     6528convention 
     6529\end_layout 
     6530 
     6531\end_inset 
     6532 
     6533 XIOS attribute. 
    56636534\end_layout 
    56646535 
     
    56786549 
    56796550\begin_layout Standard 
    5680 Defines whether data is to be appended at the end of a file if it already 
    5681  exists or if the existing file is to be overwritten. 
     6551If this attribute is set to  
     6552\begin_inset Flex Code 
     6553status open 
     6554 
     6555\begin_layout Plain Layout 
     6556true 
     6557\end_layout 
     6558 
     6559\end_inset 
     6560 
     6561 and if the file is present, the file is open, and data will be append at 
     6562 the specified time record. 
     6563 If the time record already exists, data will be overwritten, otherwise 
     6564 a new time record is created and data is appended. 
     6565 If append is set to  
     6566\begin_inset Flex Code 
     6567status open 
     6568 
     6569\begin_layout Plain Layout 
     6570false 
     6571\end_layout 
     6572 
     6573\end_inset 
     6574 
     6575, a new file will be created, even if a old file is present, overwritting 
     6576 it. 
    56826577 The default value is  
    5683 \begin_inset Flex Strong 
    5684 status collapsed 
    5685  
    5686 \begin_layout Plain Layout 
    5687  
    5688 \emph on 
    5689 false 
     6578\begin_inset Flex Code 
     6579status open 
     6580 
     6581\begin_layout Plain Layout 
     6582append = false 
    56906583\end_layout 
    56916584 
     
    58376730\begin_layout Standard 
    58386731The default value is  
    5839 \series bold 
    5840 \emph on 
     6732\begin_inset Flex Code 
     6733status open 
     6734 
     6735\begin_layout Plain Layout 
    58416736centered 
    5842 \series default 
    5843 \emph default 
     6737\end_layout 
     6738 
     6739\end_inset 
     6740 
     6741 if there are only centered time axis. 
     6742 It will be  
     6743\begin_inset Flex Code 
     6744status open 
     6745 
     6746\begin_layout Plain Layout 
     6747instant 
     6748\end_layout 
     6749 
     6750\end_inset 
     6751 
     6752 if there are only instant time axis. 
     6753 If both instant and centered time axis are present, the default value will 
     6754 be  
     6755\begin_inset Flex Code 
     6756status open 
     6757 
     6758\begin_layout Plain Layout 
     6759centered 
     6760\end_layout 
     6761 
     6762\end_inset 
     6763 
    58446764. 
     6765  
    58456766\end_layout 
    58466767 
     
    58616782\begin_layout Standard 
    58626783Define the name of a time counter. 
     6784 The default value is  
     6785\begin_inset Flex Code 
     6786status open 
     6787 
     6788\begin_layout Plain Layout 
     6789time_counter 
     6790\end_layout 
     6791 
     6792\end_inset 
     6793 
     6794. 
    58636795\end_layout 
    58646796 
     
    59236855 
    59246856\begin_layout Standard 
    5925 The default value is  
     6857When time series is enabled, each tagged field (see  
     6858\begin_inset Flex Code 
     6859status open 
     6860 
     6861\begin_layout Plain Layout 
     6862ts_enabled 
     6863\end_layout 
     6864 
     6865\end_inset 
     6866 
     6867 field attribute) is output into a separate file. 
     6868 The default value is  
    59266869\series bold 
    59276870\emph on 
     
    59656908\end_layout 
    59666909 
     6910\begin_layout Standard 
     6911Define the time unit of the time axis present in the file. 
     6912 Two choices are possible :  
     6913\begin_inset Flex Code 
     6914status open 
     6915 
     6916\begin_layout Plain Layout 
     6917seconds 
     6918\end_layout 
     6919 
     6920\end_inset 
     6921 
     6922 or  
     6923\begin_inset Flex Code 
     6924status open 
     6925 
     6926\begin_layout Plain Layout 
     6927days 
     6928\end_layout 
     6929 
     6930\end_inset 
     6931 
     6932. 
     6933 The default value is  
     6934\begin_inset Flex Code 
     6935status open 
     6936 
     6937\begin_layout Plain Layout 
     6938seconds 
     6939\end_layout 
     6940 
     6941\end_inset 
     6942 
     6943. 
     6944\end_layout 
     6945 
    59676946\begin_layout Subsection* 
    59686947record_offset (optional):  
     
    59806959 
    59816960\begin_layout Standard 
    5982 Defines the offset of a record from the beginning record. 
     6961Defines an offset for the time records associated to the file. 
     6962 For a file in  
     6963\begin_inset Flex Code 
     6964status open 
     6965 
     6966\begin_layout Plain Layout 
     6967read 
     6968\end_layout 
     6969 
     6970\end_inset 
     6971 
     6972 mode, the first record sent will be shift of 
     6973\begin_inset Flex Code 
     6974status open 
     6975 
     6976\begin_layout Plain Layout 
     6977record_offset 
     6978\end_layout 
     6979 
     6980\end_inset 
     6981 
     6982 value instead of 0. 
     6983 For file in write mode, the first time record to be output will begin from 
     6984  
     6985\begin_inset Flex Code 
     6986status open 
     6987 
     6988\begin_layout Plain Layout 
     6989record_offset 
     6990\end_layout 
     6991 
     6992\end_inset 
     6993 
     6994 value. 
    59836995 The default value is 0. 
    59846996\end_layout 
     
    61917203 
    61927204\begin_layout Standard 
    6193 Defines the name of file's UUID. 
     7205Defines the name of the global attribute designing the UUID of the file. 
     7206 The default global attribute is  
     7207\begin_inset Quotes eld 
     7208\end_inset 
     7209 
     7210 
     7211\begin_inset Flex Code 
     7212status open 
     7213 
     7214\begin_layout Plain Layout 
     7215uuid 
     7216\end_layout 
     7217 
     7218\end_inset 
     7219 
     7220 
     7221\begin_inset Quotes erd 
     7222\end_inset 
     7223 
     7224. 
    61947225\end_layout 
    61957226 
     
    62187249\begin_layout Standard 
    62197250Defines the format of file's UUID. 
     7251 In the  
     7252\begin_inset Flex Code 
     7253status open 
     7254 
     7255\begin_layout Plain Layout 
     7256uuid_format 
     7257\end_layout 
     7258 
     7259\end_inset 
     7260 
     7261 string, the sub-string  
     7262\begin_inset Flex Code 
     7263status open 
     7264 
     7265\begin_layout Plain Layout 
     7266%uuid% 
     7267\end_layout 
     7268 
     7269\end_inset 
     7270 
     7271 will be replaced by string computed UUID. 
    62207272\end_layout 
    62217273 
     
    62697321 
    62707322\begin_layout Standard 
    6271 Defines a reduction operation performed on a scalar across model processes. 
    6272  (It is analogous to MPI_Allreduce.) 
     7323Defines the type of reduction operation performed on the scalar. 
     7324 Like a scalar is redondant accross process (except if masked), the reduction 
     7325 will be similar to a MPI reduction accros procces. 
     7326  
    62737327\end_layout 
    62747328 
     
    63197373\begin_layout Standard 
    63207374Defines the interpolation type on an axis. 
    6321  For now only polynomial interpolation is available. 
     7375 For now only polynomial interpolation is available, so this attribute is 
     7376 currently meaningless. 
     7377  
    63227378\end_layout 
    63237379 
     
    63807436\begin_layout Standard 
    63817437Defines a reduction operation performed on an axis across model processes. 
    6382  (It is analogous to MPI_Allreduce.) 
    63837438\end_layout 
    63847439 
     
    66387693\begin_layout Standard 
    66397694Defines the domain dimension along which an axis will be extracted. 
     7695  
     7696\begin_inset Flex Code 
     7697status open 
     7698 
     7699\begin_layout Plain Layout 
     7700iDir 
     7701\end_layout 
     7702 
     7703\end_inset 
     7704 
     7705 means along the direction i,  
     7706\begin_inset Flex Code 
     7707status open 
     7708 
     7709\begin_layout Plain Layout 
     7710jDir 
     7711\end_layout 
     7712 
     7713\end_inset 
     7714 
     7715 along the direction j. 
    66407716\end_layout 
    66417717 
     
    66617737Define a file which contains the weight values for interpolation from domain 
    66627738 source to domain destination. 
    6663  If not specified, the internal interpolation module will be used. 
     7739 If not specified, the internal interpolation module will be used to compte 
     7740 the weights. 
    66647741\end_layout 
    66657742 
     
    66817758Defines the order of interpolation. 
    66827759 This attribute is only for internal interpolation module. 
     7760 Currently, only first order and second order are available for conservative 
     7761 interpolations. 
    66837762 The default value is 2. 
    66847763\end_layout 
     
    67057784Defines the domain dimension along which a reduction of the domain into 
    67067785 an axis will be performed. 
     7786  
     7787\begin_inset Flex Code 
     7788status open 
     7789 
     7790\begin_layout Plain Layout 
     7791iDir 
     7792\end_layout 
     7793 
     7794\end_inset 
     7795 
     7796 means along the direction i,  
     7797\begin_inset Flex Code 
     7798status open 
     7799 
     7800\begin_layout Plain Layout 
     7801jDir 
     7802\end_layout 
     7803 
     7804\end_inset 
     7805 
     7806 along the direction j. 
    67077807\end_layout 
    67087808 
     
    67217821\end_layout 
    67227822 
    6723 \begin_layout Subsection* 
    6724 local:  
     7823\begin_layout Standard 
     7824Defines the reduction operation performed on the domain. 
     7825\end_layout 
     7826 
     7827\begin_layout Subsection* 
     7828local (optionnal):  
    67257829\emph on 
    67267830bool 
     
    67377841\begin_layout Standard 
    67387842Defines whether the reduction should be performed locally on data owned 
    6739  by each process. 
     7843 by each process or on the global domain. 
    67407844\end_layout 
    67417845 
     
    67627866\end_layout 
    67637867 
    6764 \begin_layout Subsection* 
    6765 local:  
     7868\begin_layout Standard 
     7869Defines the reduction operation performed on the domain. 
     7870\end_layout 
     7871 
     7872\begin_layout Subsection* 
     7873local (optionnal):  
    67667874\emph on 
    67677875bool 
     7876\emph default 
     7877  
    67687878\end_layout 
    67697879 
     
    67787888\begin_layout Standard 
    67797889Defines whether the reduction should be performed locally on data owned 
    6780  by each process. 
     7890 by each process or on the global domain. 
     7891 The default value is  
     7892\begin_inset Flex Code 
     7893status open 
     7894 
     7895\begin_layout Plain Layout 
     7896false 
     7897\end_layout 
     7898 
     7899\end_inset 
     7900 
     7901. 
    67817902\end_layout 
    67827903 
     
    68337954\series default 
    68347955. 
     7956 Default value is 0. 
    68357957\end_layout 
    68367958 
     
    69478069\end_layout 
    69488070 
     8071\begin_layout Standard 
     8072Define the size of the halo expansion. 
     8073\end_layout 
     8074 
    69498075\begin_layout Subsection* 
    69508076type (optional):  
     
    76958821\begin_layout Itemize 
    76968822If OASIS coupler is not used (using_oasis=false) 
     8823\begin_inset Separator latexpar 
     8824\end_inset 
     8825 
     8826 
    76978827\end_layout 
    76988828 
     
    78338963 
    78348964) 
     8965\begin_inset Separator latexpar 
     8966\end_inset 
     8967 
     8968 
    78358969\end_layout 
    78368970 
     
    78488982 
    78498983)  
     8984\begin_inset Separator latexpar 
     8985\end_inset 
     8986 
     8987 
    78508988\end_layout 
    78518989 
     
    79589096 
    79599097) 
     9098\begin_inset Separator latexpar 
     9099\end_inset 
     9100 
     9101 
    79609102\end_layout 
    79619103 
Note: See TracChangeset for help on using the changeset viewer.