Changeset 1623


Ignore:
Timestamp:
12/11/18 17:58:35 (8 months ago)
Author:
oabramkina
Message:

Updating reference guide.

Location:
XIOS/trunk/doc
Files:
4 edited

Legend:

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

    r821 r1623  
    1010\maintain_unincluded_children false 
    1111\language english 
    12 \language_package default 
     12\language_package auto 
    1313\inputencoding auto 
    1414\fontencoding global 
     
    9999 
    100100\begin_layout Plain Layout 
    101 enumeration { Gregorian, Julian, D360, AllLeap, NoLeap, user_defined } 
     101enumeration {Gregorian, Julian, D360, AllLeap, NoLeap, user_defined} 
    102102\end_layout 
    103103 
     
    272272 
    273273\begin_layout Standard 
    274 Define the time origin of the time axis. 
    275  It will appear as metadata attached to the time axis in the output file. 
     274Define the time origin of a time axis. 
     275 It will appear as metadata attached to the time axis in an output file. 
    276276 This attribute is optional, the default value is  
    277277\begin_inset Flex Emph 
     
    441441 
    442442\begin_layout Standard 
    443 Define the duration of a day, in seconds, when using a custom calendar. 
     443Define the duration of a day in seconds when using a custom calendar. 
    444444 This attribute is mandatory if the calendar  
    445445\series bold 
     
    677677\series default 
    678678 attribute is used, otherwise it must not be defined. 
    679  The default behaviour is not to have any leap year. 
     679 The default behavior is not to have any leap year. 
    680680 If defined, this attribute must comply with the following constraint:  
    681681\begin_inset Formula $1\leq leap\_year\_month\leq size(month\_lengths)$ 
     
    758758\series default 
    759759 attribute is used, otherwise it must not be defined. 
    760  The default behaviour is not to have any leap year, i.e. 
     760 The default behavior is not to have any leap year, i.e. 
    761761 the default value is  
    762762\begin_inset Formula $\mathbf{0}$ 
     
    886886 
    887887\begin_layout Section 
     888Scalar attribute reference 
     889\end_layout 
     890 
     891\begin_layout Subsection* 
     892name (optional):  
     893\begin_inset Flex Emph 
     894status collapsed 
     895 
     896\begin_layout Plain Layout 
     897string 
     898\end_layout 
     899 
     900\end_inset 
     901 
     902 
     903\end_layout 
     904 
     905\begin_layout Standard 
     906Fortran:  
     907\end_layout 
     908 
     909\begin_layout LyX-Code 
     910CHARACTER(LEN=*) :: name 
     911\end_layout 
     912 
     913\begin_layout Standard 
     914Defines the name of a scalar as it will appear in a file. 
     915 If not defined, the name will be generated automatically based on the id. 
     916 If multiple scalars are defined in the same file, each scalar must have 
     917 a unique name. 
     918  
     919\end_layout 
     920 
     921\begin_layout Subsection* 
     922standard_name (optional):  
     923\begin_inset Flex Emph 
     924status collapsed 
     925 
     926\begin_layout Plain Layout 
     927string 
     928\end_layout 
     929 
     930\end_inset 
     931 
     932 
     933\end_layout 
     934 
     935\begin_layout Standard 
     936Fortran:  
     937\end_layout 
     938 
     939\begin_layout LyX-Code 
     940CHARACTER(LEN=*) :: standard_name 
     941\end_layout 
     942 
     943\begin_layout Standard 
     944Defines the standard name of a scalar as it will appear in the scalar's 
     945 metadata in an output file. 
     946  
     947\end_layout 
     948 
     949\begin_layout Subsection* 
     950long_name (optional):  
     951\begin_inset Flex Emph 
     952status collapsed 
     953 
     954\begin_layout Plain Layout 
     955string 
     956\end_layout 
     957 
     958\end_inset 
     959 
     960 
     961\end_layout 
     962 
     963\begin_layout Standard 
     964Fortran:  
     965\end_layout 
     966 
     967\begin_layout LyX-Code 
     968CHARACTER(LEN=*) :: long_name 
     969\end_layout 
     970 
     971\begin_layout Standard 
     972Defines the long name of a scalar as it will appear in the scalar's metadata 
     973 in an output file. 
     974  
     975\end_layout 
     976 
     977\begin_layout Subsection* 
     978unit (optional):  
     979\begin_inset Flex Emph 
     980status collapsed 
     981 
     982\begin_layout Plain Layout 
     983string 
     984\end_layout 
     985 
     986\end_inset 
     987 
     988 
     989\end_layout 
     990 
     991\begin_layout Standard 
     992Fortran:  
     993\end_layout 
     994 
     995\begin_layout LyX-Code 
     996CHARACTER(LEN=*) :: unit 
     997\end_layout 
     998 
     999\begin_layout Standard 
     1000Defines the scalar unit as it will appear in the scalar's metadata in an 
     1001 output file. 
     1002\end_layout 
     1003 
     1004\begin_layout Subsection* 
     1005value (optional):  
     1006\begin_inset Flex Emph 
     1007status collapsed 
     1008 
     1009\begin_layout Plain Layout 
     1010double 
     1011\end_layout 
     1012 
     1013\end_inset 
     1014 
     1015 
     1016\end_layout 
     1017 
     1018\begin_layout Standard 
     1019Fortran: 
     1020\end_layout 
     1021 
     1022\begin_layout LyX-Code 
     1023DOUBLE PRECISION :: value 
     1024\end_layout 
     1025 
     1026\begin_layout Standard 
     1027Defines the value of a scalar. 
     1028 If both, the label and the value, are set then only the label will be written 
     1029 into a file. 
     1030\end_layout 
     1031 
     1032\begin_layout Subsection* 
     1033bounds (optional):  
     1034\begin_inset Flex Emph 
     1035status collapsed 
     1036 
     1037\begin_layout Plain Layout 
     10381D-array of double 
     1039\end_layout 
     1040 
     1041\end_inset 
     1042 
     1043 
     1044\end_layout 
     1045 
     1046\begin_layout Standard 
     1047Fortran: 
     1048\end_layout 
     1049 
     1050\begin_layout LyX-Code 
     1051DOUBLE PRECISION :: bounds(:) 
     1052\end_layout 
     1053 
     1054\begin_layout Standard 
     1055Defines (two) scalar boundaries. 
     1056 The array size must should be equal to 2. 
     1057\end_layout 
     1058 
     1059\begin_layout Subsection* 
     1060bounds_name (optional):  
     1061\begin_inset Flex Emph 
     1062status collapsed 
     1063 
     1064\begin_layout Plain Layout 
     1065string 
     1066\end_layout 
     1067 
     1068\end_inset 
     1069 
     1070 
     1071\end_layout 
     1072 
     1073\begin_layout Standard 
     1074Fortran:  
     1075\end_layout 
     1076 
     1077\begin_layout LyX-Code 
     1078CHARACTER(LEN=*) :: bounds_name 
     1079\end_layout 
     1080 
     1081\begin_layout Standard 
     1082Defines the name of scalar bounds as it will appear in a file. 
     1083 If not defined, the name will be generated automatically based on the scalar 
     1084 id. 
     1085\end_layout 
     1086 
     1087\begin_layout Subsection* 
     1088prec (optional):  
     1089\emph on 
     1090integer 
     1091\end_layout 
     1092 
     1093\begin_layout Standard 
     1094Fortran: 
     1095\end_layout 
     1096 
     1097\begin_layout LyX-Code 
     1098INTEGER :: prec 
     1099\end_layout 
     1100 
     1101\begin_layout Standard 
     1102Defines the precision in bytes of scalar value and boundaries as it will 
     1103 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. 
     1107\end_layout 
     1108 
     1109\begin_layout Subsection* 
     1110label (optional):  
     1111\begin_inset Flex Emph 
     1112status collapsed 
     1113 
     1114\begin_layout Plain Layout 
     1115string 
     1116\end_layout 
     1117 
     1118\end_inset 
     1119 
     1120 
     1121\end_layout 
     1122 
     1123\begin_layout Standard 
     1124Fortran:  
     1125\end_layout 
     1126 
     1127\begin_layout LyX-Code 
     1128CHARACTER(LEN=*) :: label 
     1129\end_layout 
     1130 
     1131\begin_layout Standard 
     1132Defines the label of a scalar. 
     1133 If both, the label and the value, are set then only the label will be output 
     1134 into a file. 
     1135\end_layout 
     1136 
     1137\begin_layout Subsection* 
     1138scalar_ref (optional): string 
     1139\end_layout 
     1140 
     1141\begin_layout Standard 
     1142Fortran: 
     1143\end_layout 
     1144 
     1145\begin_layout LyX-Code 
     1146CHARACTER(LEN=*) :: scalar_ref 
     1147\end_layout 
     1148 
     1149\begin_layout Standard 
     1150Defines the reference to a scalar. 
     1151 All attributes will be inherited from the referenced scalar via the classical 
     1152 inheritance mechanism. 
     1153 The value assigned to the referenced scalar will be transmitted to the 
     1154 current scalar. 
     1155\end_layout 
     1156 
     1157\begin_layout Subsection* 
     1158positive (optional):  
     1159\begin_inset Flex Emph 
     1160status collapsed 
     1161 
     1162\begin_layout Plain Layout 
     1163enumeration {up, down} 
     1164\end_layout 
     1165 
     1166\end_inset 
     1167 
     1168 
     1169\end_layout 
     1170 
     1171\begin_layout Standard 
     1172Fortran: 
     1173\end_layout 
     1174 
     1175\begin_layout LyX-Code 
     1176CHARACTER(LEN=*) :: positive 
     1177\end_layout 
     1178 
     1179\begin_layout Standard 
     1180Defines the positive direction for fields representing height or depth. 
     1181\end_layout 
     1182 
     1183\begin_layout Subsection* 
     1184axis_type (optional):  
     1185\begin_inset Flex Emph 
     1186status collapsed 
     1187 
     1188\begin_layout Plain Layout 
     1189enumeration {X, Y, Z, T} 
     1190\end_layout 
     1191 
     1192\end_inset 
     1193 
     1194 
     1195\end_layout 
     1196 
     1197\begin_layout Standard 
     1198Fortran: 
     1199\end_layout 
     1200 
     1201\begin_layout LyX-Code 
     1202CHARACTER(LEN=*) :: axis_type 
     1203\end_layout 
     1204 
     1205\begin_layout Standard 
     1206Defines the type of a (scalar) axis. 
     1207 The values correspond to the following axis types: 
     1208\end_layout 
     1209 
     1210\begin_layout Itemize 
     1211 
     1212\series bold 
     1213\shape italic 
     1214X: 
     1215\series default 
     1216\shape default 
     1217 longitude 
     1218\end_layout 
     1219 
     1220\begin_layout Itemize 
     1221 
     1222\series bold 
     1223\shape italic 
     1224\emph on 
     1225Y 
     1226\emph default 
     1227: 
     1228\series default 
     1229\shape default 
     1230 latitude 
     1231\end_layout 
     1232 
     1233\begin_layout Itemize 
     1234 
     1235\series bold 
     1236\shape italic 
     1237\emph on 
     1238Z 
     1239\emph default 
     1240: 
     1241\series default 
     1242\shape default 
     1243 vertical axis 
     1244\end_layout 
     1245 
     1246\begin_layout Itemize 
     1247 
     1248\series bold 
     1249\shape italic 
     1250T:  
     1251\series default 
     1252\shape default 
     1253time axis. 
     1254\end_layout 
     1255 
     1256\begin_layout Subsection* 
     1257comment:  
     1258\begin_inset Flex Emph 
     1259status collapsed 
     1260 
     1261\begin_layout Plain Layout 
     1262string 
     1263\end_layout 
     1264 
     1265\end_inset 
     1266 
     1267 
     1268\end_layout 
     1269 
     1270\begin_layout Standard 
     1271Fortran:  
     1272\end_layout 
     1273 
     1274\begin_layout LyX-Code 
     1275CHARACTER(LEN=*) :: comment 
     1276\end_layout 
     1277 
     1278\begin_layout Standard 
     1279Allows a user to set a comment. 
     1280  
     1281\end_layout 
     1282 
     1283\begin_layout Section 
    8881284Axis attribute reference 
    8891285\end_layout 
    8901286 
    8911287\begin_layout Subsection* 
    892 name:  
     1288name (optional):  
    8931289\begin_inset Flex Emph 
    8941290status collapsed 
     
    9121308 
    9131309\begin_layout Standard 
    914 Define the name of the vertical axis, as it will appear in a file. 
    915  If not defined, a name is self generated from the id. 
    916  If multiple vertical axis are defined in a same file, each name must be 
    917  different. 
     1310Defines the name of a vertical axis as it will appear in an output file. 
     1311 If not defined, the name will be generated automatically based on the axis 
     1312 id. 
     1313 If multiple vertical axes are defined in the same file, each axis must 
     1314 have a unique name. 
    9181315  
    9191316\end_layout 
    9201317 
    9211318\begin_layout Subsection* 
    922 standard_name:  
     1319standard_name (optional):  
    9231320\begin_inset Flex Emph 
    9241321status collapsed 
     
    9421339 
    9431340\begin_layout Standard 
    944 Define the standard name of the vertical axis, as it will appear in the 
    945  metadata attached to the axis of the output file. 
     1341Defines the standard name of a vertical axis as it will appear in the axis' 
     1342 metadata in an output file. 
    9461343  
    9471344\end_layout 
    9481345 
    9491346\begin_layout Subsection* 
    950 long_name:  
     1347long_name (optional):  
    9511348\begin_inset Flex Emph 
    9521349status collapsed 
     
    9701367 
    9711368\begin_layout Standard 
    972 Define the long name of the vertical axis, as it will appear in the metadata 
    973  attached to the axis of the output file. 
     1369Defines the long name of a vertical axis as it will appear in the axis' 
     1370 metadata in an output file. 
    9741371  
    9751372\end_layout 
    9761373 
    9771374\begin_layout Subsection* 
    978 unit:  
     1375unit (optional):  
    9791376\begin_inset Flex Emph 
    9801377status collapsed 
     
    9981395 
    9991396\begin_layout Standard 
    1000 Define the unit of the axis as it will appear in the metadata attached to 
    1001  the axis in the output file. 
    1002 \end_layout 
    1003  
    1004 \begin_layout Subsection* 
    1005 n_glo:  
     1397Defines the unit of an axis as it will appear in the axis' metadata in an 
     1398 output file. 
     1399\end_layout 
     1400 
     1401\begin_layout Subsection* 
     1402dim_name (optional):  
    10061403\begin_inset Flex Emph 
    10071404status collapsed 
    10081405 
    10091406\begin_layout Plain Layout 
     1407string 
     1408\end_layout 
     1409 
     1410\end_inset 
     1411 
     1412 
     1413\end_layout 
     1414 
     1415\begin_layout Standard 
     1416Fortran:  
     1417\end_layout 
     1418 
     1419\begin_layout LyX-Code 
     1420CHARACTER(LEN=*) :: dim_name 
     1421\end_layout 
     1422 
     1423\begin_layout Standard 
     1424Defines the name of axis dimension as it will appear in the file's metadata. 
     1425\end_layout 
     1426 
     1427\begin_layout Subsection* 
     1428formula (optional):  
     1429\begin_inset Flex Emph 
     1430status collapsed 
     1431 
     1432\begin_layout Plain Layout 
     1433string 
     1434\end_layout 
     1435 
     1436\end_inset 
     1437 
     1438 
     1439\end_layout 
     1440 
     1441\begin_layout Standard 
     1442Fortran:  
     1443\end_layout 
     1444 
     1445\begin_layout LyX-Code 
     1446CHARACTER(LEN=*) :: formula 
     1447\end_layout 
     1448 
     1449\begin_layout Standard 
     1450Adds the formula attribute to a parametric vertical axis. 
     1451\end_layout 
     1452 
     1453\begin_layout Subsection* 
     1454formula_term (optional):  
     1455\begin_inset Flex Emph 
     1456status collapsed 
     1457 
     1458\begin_layout Plain Layout 
     1459string 
     1460\end_layout 
     1461 
     1462\end_inset 
     1463 
     1464 
     1465\end_layout 
     1466 
     1467\begin_layout Standard 
     1468Fortran:  
     1469\end_layout 
     1470 
     1471\begin_layout LyX-Code 
     1472CHARACTER(LEN=*) :: formula_term 
     1473\end_layout 
     1474 
     1475\begin_layout Standard 
     1476Adds the formula terms attribute to a parametric vertical axis. 
     1477\end_layout 
     1478 
     1479\begin_layout Subsection* 
     1480formula_bounds (optional):  
     1481\begin_inset Flex Emph 
     1482status collapsed 
     1483 
     1484\begin_layout Plain Layout 
     1485string 
     1486\end_layout 
     1487 
     1488\end_inset 
     1489 
     1490 
     1491\end_layout 
     1492 
     1493\begin_layout Standard 
     1494Fortran:  
     1495\end_layout 
     1496 
     1497\begin_layout LyX-Code 
     1498CHARACTER(LEN=*) :: formula_bounds 
     1499\end_layout 
     1500 
     1501\begin_layout Standard 
     1502Adds the formula attribute to the bounds of a parametric vertical axis. 
     1503 The attribute is mandatory if the  
     1504\begin_inset Flex Strong 
     1505status collapsed 
     1506 
     1507\begin_layout Plain Layout 
     1508formula 
     1509\end_layout 
     1510 
     1511\end_inset 
     1512 
     1513 attribute is defined for the axis. 
     1514\end_layout 
     1515 
     1516\begin_layout Subsection* 
     1517formula_term_bounds (optional):  
     1518\begin_inset Flex Emph 
     1519status collapsed 
     1520 
     1521\begin_layout Plain Layout 
     1522string 
     1523\end_layout 
     1524 
     1525\end_inset 
     1526 
     1527 
     1528\end_layout 
     1529 
     1530\begin_layout Standard 
     1531Fortran:  
     1532\end_layout 
     1533 
     1534\begin_layout LyX-Code 
     1535CHARACTER(LEN=*) :: formula_term_bounds 
     1536\end_layout 
     1537 
     1538\begin_layout Standard 
     1539Adds 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 
     1543status collapsed 
     1544 
     1545\begin_layout Plain Layout 
     1546formula 
     1547\end_layout 
     1548 
     1549\end_inset 
     1550 
     1551 attribute is defined for the axis. 
     1552\end_layout 
     1553 
     1554\begin_layout Subsection* 
     1555n_glo (mandatory):  
     1556\begin_inset Flex Emph 
     1557status collapsed 
     1558 
     1559\begin_layout Plain Layout 
    10101560integer 
    10111561\end_layout 
     
    10251575 
    10261576\begin_layout Standard 
    1027 Define the global size of the axis. 
    1028  This attribute is mandatory. 
    1029 \end_layout 
    1030  
    1031 \begin_layout Subsection* 
    1032 begin:  
     1577Defines the global size of an axis. 
     1578\end_layout 
     1579 
     1580\begin_layout Subsection* 
     1581begin (optional):  
    10331582\begin_inset Flex Emph 
    10341583status collapsed 
     
    10521601 
    10531602\begin_layout Standard 
    1054 Define the the beginning index of the local domain. 
    1055  This attribute is optional. 
    1056  This must be an index between 0 and  
     1603Defines the beginning index of the local domain. 
     1604 It can take value between 0 and  
    10571605\begin_inset Flex Strong 
    10581606status collapsed 
     
    10691617 
    10701618\begin_layout Subsection* 
    1071 n:  
     1619n (optional):  
    10721620\begin_inset Flex Emph 
    10731621status collapsed 
     
    10911639 
    10921640\begin_layout Standard 
    1093 Define the the local size of the axis. 
    1094  This attribute is optional. 
    1095  This must be an integer between 1 and  
     1641Defines the local size of an axis. 
     1642 It can take value between 0 and  
    10961643\begin_inset Flex Strong 
    10971644status collapsed 
     
    11151662 
    11161663. 
    1117   
    1118 \end_layout 
    1119  
    1120 \begin_layout Subsection* 
    1121 value:  
     1664 Local axis decomposition can be declared either with attributes  
     1665\series bold 
     1666\shape italic 
     1667{n, begin} 
     1668\series default 
     1669\shape default 
     1670 or with  
     1671\series bold 
     1672\shape italic 
     1673index 
     1674\series default 
     1675\shape default 
     1676. 
     1677\end_layout 
     1678 
     1679\begin_layout Subsection* 
     1680index (optional):  
    11221681\begin_inset Flex Emph 
    11231682status collapsed 
     
    11371696 
    11381697\begin_layout LyX-Code 
     1698DOUBLE PRECISION :: index(:) 
     1699\end_layout 
     1700 
     1701\begin_layout Standard 
     1702Defines the global indexes of a local axis held by each process. 
     1703 If the attribute is specified, its array size must be equal to  
     1704\begin_inset Flex Strong 
     1705status collapsed 
     1706 
     1707\begin_layout Plain Layout 
     1708n 
     1709\end_layout 
     1710 
     1711\end_inset 
     1712 
     1713. 
     1714 Local axis decomposition can be declared either with attributes  
     1715\series bold 
     1716\shape italic 
     1717{n, begin} 
     1718\series default 
     1719\shape default 
     1720 or with  
     1721\series bold 
     1722\shape italic 
     1723index 
     1724\series default 
     1725\shape default 
     1726. 
     1727\end_layout 
     1728 
     1729\begin_layout Subsection* 
     1730value (optional):  
     1731\begin_inset Flex Emph 
     1732status collapsed 
     1733 
     1734\begin_layout Plain Layout 
     17351D-array of double 
     1736\end_layout 
     1737 
     1738\end_inset 
     1739 
     1740 
     1741\end_layout 
     1742 
     1743\begin_layout Standard 
     1744Fortran: 
     1745\end_layout 
     1746 
     1747\begin_layout LyX-Code 
    11391748DOUBLE PRECISION :: value(:) 
    11401749\end_layout 
    11411750 
    11421751\begin_layout Standard 
    1143 Define the value of each level of a vertical axis. 
    1144  The size of the array must be equal to the  
    1145 \begin_inset Flex Strong 
    1146 status collapsed 
    1147  
    1148 \begin_layout Plain Layout 
    1149 size 
    1150 \end_layout 
    1151  
    1152 \end_inset 
    1153  
    1154  attribute. 
    1155  If not defined the default values are filled with values from 1 to  
    1156 \begin_inset Flex Strong 
    1157 status collapsed 
    1158  
    1159 \begin_layout Plain Layout 
    1160 size 
     1752Defines the value of each level of a vertical axis. 
     1753 The array size must be equal to the value of the attribute  
     1754\begin_inset Flex Strong 
     1755status collapsed 
     1756 
     1757\begin_layout Plain Layout 
     1758n 
    11611759\end_layout 
    11621760 
     
    11641762 
    11651763. 
    1166 \end_layout 
    1167  
    1168 \begin_layout Subsection* 
    1169 bounds:  
     1764 If the label is provided then only the label will be written into a file 
     1765 and not the axis value and the axis boundaries. 
     1766\end_layout 
     1767 
     1768\begin_layout Subsection* 
     1769bounds (optional):  
    11701770\begin_inset Flex Emph 
    11711771status collapsed 
     
    11851785 
    11861786\begin_layout LyX-Code 
    1187 DOUBLE PRECISION :: value(:,:) 
    1188 \end_layout 
    1189  
    1190 \begin_layout Standard 
    1191 Define the boundaries of each level of a the vertical axis. 
     1787DOUBLE PRECISION :: bounds(:,:) 
     1788\end_layout 
     1789 
     1790\begin_layout Standard 
     1791Defines the boundaries of each level of a vertical axis. 
    11921792 The dimensions of the array must be  
    11931793\begin_inset Formula $2\times n$ 
     
    11981798 
    11991799\begin_layout Subsection* 
    1200 data_begin: 
     1800bounds_name (optional):  
     1801\begin_inset Flex Emph 
     1802status collapsed 
     1803 
     1804\begin_layout Plain Layout 
     1805string 
     1806\end_layout 
     1807 
     1808\end_inset 
     1809 
     1810 
     1811\end_layout 
     1812 
     1813\begin_layout Standard 
     1814Fortran:  
     1815\end_layout 
     1816 
     1817\begin_layout LyX-Code 
     1818CHARACTER(LEN=*) :: bounds_name 
     1819\end_layout 
     1820 
     1821\begin_layout Standard 
     1822Defines the name of axis boundaries as it will appear in a file. 
     1823 If not defined, the name will be generated automatically based on the axis 
     1824 id. 
     1825\end_layout 
     1826 
     1827\begin_layout Subsection* 
     1828prec (optional):  
     1829\emph on 
     1830integer 
     1831\end_layout 
     1832 
     1833\begin_layout Standard 
     1834Fortran: 
     1835\end_layout 
     1836 
     1837\begin_layout LyX-Code 
     1838INTEGER :: prec 
     1839\end_layout 
     1840 
     1841\begin_layout Standard 
     1842Defines the precision in bytes of axis value and boundaries as it will be 
     1843 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. 
     1847\end_layout 
     1848 
     1849\begin_layout Subsection* 
     1850label (optional):  
     1851\begin_inset Flex Emph 
     1852status collapsed 
     1853 
     1854\begin_layout Plain Layout 
     1855string 
     1856\end_layout 
     1857 
     1858\end_inset 
     1859 
     1860 
     1861\end_layout 
     1862 
     1863\begin_layout Standard 
     1864Fortran:  
     1865\end_layout 
     1866 
     1867\begin_layout LyX-Code 
     1868CHARACTER, ALLOCATABLE :: label(:) 
     1869\end_layout 
     1870 
     1871\begin_layout Standard 
     1872Defines the label of an axis. 
     1873 The size of the array must be equal to the value of the attribute  
     1874\begin_inset Flex Strong 
     1875status collapsed 
     1876 
     1877\begin_layout Plain Layout 
     1878n 
     1879\end_layout 
     1880 
     1881\end_inset 
     1882 
     1883. 
     1884 If the label is provided then only the label will be written into a file 
     1885 and not the axis value and the axis boundaries. 
     1886\end_layout 
     1887 
     1888\begin_layout Subsection* 
     1889data_begin (optional): 
    12011890\emph on 
    12021891 integer 
     
    12121901 
    12131902\begin_layout Standard 
    1214 Define the beginning index of the field data for the axis. 
    1215  This attribute is an offset regarding the local axis, so the value can 
     1903Defines the beginning index of local field data owned by each process. 
     1904 The attribute is an offset relative to the local axis, so the value can 
    12161905 be negative. 
    12171906 A negative value indicates that only some valid part of the data will extracted 
     
    12191908 A positive value indicates that the local domain is greater than the data 
    12201909 stored in memory. 
    1221  A 0-value means that the local domain matches the data in memory. 
    1222  This attribute is optional and the default value is 0. 
    1223  Otherwise  
     1910 The 0-value means that the local domain matches the data in memory. 
     1911 The default value is 0. 
     1912 The attributes  
    12241913\begin_inset Flex Strong 
    12251914status collapsed 
     
    12451934 
    12461935\begin_layout Subsection* 
    1247 data_n:  
     1936data_n (optional):  
    12481937\emph on 
    12491938integer 
     
    12591948 
    12601949\begin_layout Standard 
    1261 Define the size of the field data for the first axis. 
    1262  This attribute is optional and the default value is  
     1950Defines the size of local field data. 
     1951 The attribute can take value starting from 0 (no data on a process). 
     1952 The default value is  
    12631953\begin_inset Flex Strong 
    12641954status collapsed 
     
    12711961 
    12721962. 
    1273  Otherwise  
     1963 The attributes  
    12741964\begin_inset Flex Strong 
    12751965status collapsed 
     
    12951985 
    12961986\begin_layout Subsection* 
    1297 data_index:  
     1987data_index (optional):  
    12981988\emph on 
    12991989integer 
     
    13091999 
    13102000\begin_layout Standard 
    1311 In case of a compressed vertical axis, this attribute define the number 
    1312  of points stored in memory on the local axis. 
    1313 \end_layout 
    1314  
    1315 \begin_layout Subsection* 
    1316 mask:  
     2001In case of a compressed vertical axis, the attribute defines the position 
     2002 of data points stored in the memory. 
     2003 The array size has to be equal to  
     2004\begin_inset Flex Strong 
     2005status collapsed 
     2006 
     2007\begin_layout Plain Layout 
     2008data_n 
     2009\end_layout 
     2010 
     2011\end_inset 
     2012 
     2013. 
     2014 For example, for a local axis of size  
     2015\begin_inset Flex Strong 
     2016status collapsed 
     2017 
     2018\begin_layout Plain Layout 
     2019n=3 
     2020\end_layout 
     2021 
     2022\end_inset 
     2023 
     2024 and local data size of  
     2025\begin_inset Flex Strong 
     2026status collapsed 
     2027 
     2028\begin_layout Plain Layout 
     2029data_n=5 
     2030\end_layout 
     2031 
     2032\end_inset 
     2033 
     2034, if  
     2035\begin_inset Flex Strong 
     2036status collapsed 
     2037 
     2038\begin_layout Plain Layout 
     2039data_index=(/ -1, 2, 1, 0, -1 /) 
     2040\end_layout 
     2041 
     2042\end_inset 
     2043 
     2044 then the first and the last data points are ghosts and only the three middle 
     2045 values will be written in the reversed order. 
     2046\end_layout 
     2047 
     2048\begin_layout Subsection* 
     2049mask (optional):  
    13172050\emph on 
    131820511D-array of bool 
     
    13282061 
    13292062\begin_layout Standard 
    1330 Define the mask of the local axis. 
     2063Defines the mask of the local axis. 
    13312064 The masked value will be replaced by the value of the field attribute  
    13322065\begin_inset Flex Strong 
     
    13392072\end_inset 
    13402073 
    1341  in the output file. 
    1342 \end_layout 
    1343  
    1344 \begin_layout Subsection* 
    1345 n_distributed_partition:  
     2074 in an output file. 
     2075\end_layout 
     2076 
     2077\begin_layout Subsection* 
     2078n_distributed_partition (optional):  
    13462079\emph on 
    13472080integer 
     
    13572090 
    13582091\begin_layout Standard 
    1359 Define the number of local axis in case axis is auto-generated. 
    1360  This attribute is optional and the default value is  
     2092Defines the number of local axes in case if the axis is generated automatically 
     2093 by XIOS. 
     2094 The default value is  
    13612095\begin_inset Flex Strong 
    13622096status collapsed 
     
    13722106 
    13732107\begin_layout Subsection* 
    1374 positive:  
     2108axis_ref (optional): string 
     2109\end_layout 
     2110 
     2111\begin_layout Standard 
     2112Fortran: 
     2113\end_layout 
     2114 
     2115\begin_layout LyX-Code 
     2116CHARACTER(LEN=*) :: axis_ref 
     2117\end_layout 
     2118 
     2119\begin_layout Standard 
     2120Defines the reference of an axis. 
     2121 All attributes will be inherited from the referenced axis with the classical 
     2122 inheritance mechanism. 
     2123 The value assigned to the referenced axis will be transmitted to the current 
     2124 axis. 
     2125\end_layout 
     2126 
     2127\begin_layout Subsection* 
     2128positive (optional):  
    13752129\begin_inset Flex Emph 
    13762130status collapsed 
    13772131 
    13782132\begin_layout Plain Layout 
    1379 enumeration { up, down } 
     2133enumeration {up, down} 
    13802134\end_layout 
    13812135 
     
    13942148 
    13952149\begin_layout Standard 
    1396 Define the direction of vertical axis. 
    1397 \end_layout 
    1398  
    1399 \begin_layout Subsection* 
    1400 axis_ref: string 
    1401 \end_layout 
    1402  
    1403 \begin_layout Standard 
    1404 Fortran: 
    1405 \end_layout 
    1406  
    1407 \begin_layout LyX-Code 
    1408 CHARACTER(LEN=*) :: axis_ref 
    1409 \end_layout 
    1410  
    1411 \begin_layout Standard 
    1412 Define the reference of the axis. 
    1413  All attributes are inherited from the referenced axis with the classical 
    1414  inheritance mechanism. 
    1415  The value assigned to the referenced axis is transmitted to to current 
    1416  axis. 
    1417  This attribute is optional. 
    1418 \end_layout 
    1419  
    1420 \begin_layout Subsection* 
    1421 index:  
     2150Defines the positive direction for fields representing height or depth. 
     2151\end_layout 
     2152 
     2153\begin_layout Subsection* 
     2154axis_type (optional):  
    14222155\begin_inset Flex Emph 
    14232156status collapsed 
    14242157 
    14252158\begin_layout Plain Layout 
    1426 1D-array of double 
    1427 \end_layout 
    1428  
    1429 \end_inset 
    1430  
    1431  
    1432 \end_layout 
    1433  
    1434 \begin_layout Standard 
    1435 Fortran: 
    1436 \end_layout 
    1437  
    1438 \begin_layout LyX-Code 
    1439 DOUBLE PRECISION :: index(:) 
    1440 \end_layout 
    1441  
    1442 \begin_layout Standard 
    1443 Define the global index of axis which the local axis holds. 
    1444  This attribute is optional and the size of the array is equal to  
    1445 \begin_inset Flex Strong 
    1446 status collapsed 
    1447  
    1448 \begin_layout Plain Layout 
    1449 n 
    1450 \end_layout 
    1451  
    1452 \end_inset 
    1453  
    1454 . 
     2159enumeration {X, Y, Z, T} 
     2160\end_layout 
     2161 
     2162\end_inset 
     2163 
     2164 
     2165\end_layout 
     2166 
     2167\begin_layout Standard 
     2168Fortran: 
     2169\end_layout 
     2170 
     2171\begin_layout LyX-Code 
     2172CHARACTER(LEN=*) :: axis_type 
     2173\end_layout 
     2174 
     2175\begin_layout Standard 
     2176Defines the type of an axis. 
     2177 The values correspond to the following axis types: 
     2178\end_layout 
     2179 
     2180\begin_layout Itemize 
     2181 
     2182\series bold 
     2183\shape italic 
     2184X: 
     2185\series default 
     2186\shape default 
     2187 longitude 
     2188\end_layout 
     2189 
     2190\begin_layout Itemize 
     2191 
     2192\series bold 
     2193\shape italic 
     2194\emph on 
     2195Y 
     2196\emph default 
     2197: 
     2198\series default 
     2199\shape default 
     2200 latitude 
     2201\end_layout 
     2202 
     2203\begin_layout Itemize 
     2204 
     2205\series bold 
     2206\shape italic 
     2207\emph on 
     2208Z 
     2209\emph default 
     2210: 
     2211\series default 
     2212\shape default 
     2213 vertical axis 
     2214\end_layout 
     2215 
     2216\begin_layout Itemize 
     2217 
     2218\series bold 
     2219\shape italic 
     2220T:  
     2221\series default 
     2222\shape default 
     2223time axis. 
     2224\end_layout 
     2225 
     2226\begin_layout Subsection* 
     2227comment (optional):  
     2228\begin_inset Flex Emph 
     2229status collapsed 
     2230 
     2231\begin_layout Plain Layout 
     2232string 
     2233\end_layout 
     2234 
     2235\end_inset 
     2236 
     2237 
     2238\end_layout 
     2239 
     2240\begin_layout Standard 
     2241Fortran:  
     2242\end_layout 
     2243 
     2244\begin_layout LyX-Code 
     2245CHARACTER(LEN=*) :: comment 
     2246\end_layout 
     2247 
     2248\begin_layout Standard 
     2249Allows a user to set a comment. 
     2250  
    14552251\end_layout 
    14562252 
     
    14602256 
    14612257\begin_layout Subsection* 
    1462 name:  
     2258name (optional):  
    14632259\begin_inset Flex Emph 
    14642260status collapsed 
     
    14822278 
    14832279\begin_layout Standard 
    1484 Define the name of the horizontal domain. 
     2280Defines the name of a horizontal domain. 
    14852281 This attribute may be used in case of multiple domains defined in the same 
    14862282 file. 
     
    14972293 attribute will be suffixed to the longitude and latitude dimensions and 
    14982294 axis name. 
    1499  Otherwise, a suffix will be self-generated. 
    1500 \end_layout 
    1501  
    1502 \begin_layout Subsection* 
    1503 standard_name:  
     2295 If the domain name is not provided, it will be generated automatically. 
     2296\end_layout 
     2297 
     2298\begin_layout Subsection* 
     2299standard_name (optional):  
    15042300\begin_inset Flex Emph 
    15052301status collapsed 
     
    15232319 
    15242320\begin_layout Standard 
    1525 Define the standard name of the domain, as it will appear in the metadata 
    1526  attached to the domain of the output file. 
     2321Defines the standard name of a domain as it will appear in the domain's 
     2322 metadata in an output file. 
    15272323  
    15282324\end_layout 
    15292325 
    15302326\begin_layout Subsection* 
    1531 long_name:  
     2327long_name (optional):  
    15322328\begin_inset Flex Emph 
    15332329status collapsed 
     
    15512347 
    15522348\begin_layout Standard 
    1553 Define the long name of the domain, as it will appear in the metadata attached 
    1554  to the domain of the output file. 
     2349Defines the long name of a domain as it will appear in the domain's metadata 
     2350 in an output file. 
    15552351  
    15562352\end_layout 
    15572353 
    15582354\begin_layout Subsection* 
    1559 type:  
     2355type (mandatory):  
    15602356\begin_inset Flex Emph 
    15612357status collapsed 
    15622358 
    15632359\begin_layout Plain Layout 
    1564 enumeration { rectilinear, curvilinear, unstructured } 
     2360enumeration {rectilinear, curvilinear, unstructured, gaussian} 
    15652361\end_layout 
    15662362 
     
    15792375 
    15802376\begin_layout Standard 
    1581 Define the type of the grid. 
    1582  This attribute is mandatory. 
    1583 \end_layout 
    1584  
    1585 \begin_layout Subsection* 
    1586 ni_glo:  
     2377Defines the type of a grid. 
     2378\end_layout 
     2379 
     2380\begin_layout Subsection* 
     2381dim_i_name (optional):  
    15872382\begin_inset Flex Emph 
    15882383status collapsed 
    15892384 
    15902385\begin_layout Plain Layout 
     2386string 
     2387\end_layout 
     2388 
     2389\end_inset 
     2390 
     2391 
     2392\end_layout 
     2393 
     2394\begin_layout Standard 
     2395Fortran:  
     2396\end_layout 
     2397 
     2398\begin_layout LyX-Code 
     2399CHARACTER(LEN=*) :: dim_i_name 
     2400\end_layout 
     2401 
     2402\begin_layout Standard 
     2403Defines the name of the first domain dimension as it will appear in the 
     2404 file's metadata. 
     2405\end_layout 
     2406 
     2407\begin_layout Subsection* 
     2408dim_j_name (optional):  
     2409\begin_inset Flex Emph 
     2410status collapsed 
     2411 
     2412\begin_layout Plain Layout 
     2413string 
     2414\end_layout 
     2415 
     2416\end_inset 
     2417 
     2418 
     2419\end_layout 
     2420 
     2421\begin_layout Standard 
     2422Fortran:  
     2423\end_layout 
     2424 
     2425\begin_layout LyX-Code 
     2426CHARACTER(LEN=*) :: dim_j_name 
     2427\end_layout 
     2428 
     2429\begin_layout Standard 
     2430Defines the name of the second domain dimension as it will appear in file's 
     2431 metadata. 
     2432\end_layout 
     2433 
     2434\begin_layout Subsection* 
     2435ni_glo (mandatory):  
     2436\begin_inset Flex Emph 
     2437status collapsed 
     2438 
     2439\begin_layout Plain Layout 
    15912440integer 
    15922441\end_layout 
     
    16062455 
    16072456\begin_layout Standard 
    1608 Define the first dimension of the global domain. 
    1609  This attribute is mandatory. 
    1610 \end_layout 
    1611  
    1612 \begin_layout Subsection* 
    1613 nj_glo:  
     2457Defines the size of the first dimension of the global domain. 
     2458\end_layout 
     2459 
     2460\begin_layout Subsection* 
     2461nj_glo (mandatory):  
    16142462\begin_inset Flex Emph 
    16152463status collapsed 
     
    16332481 
    16342482\begin_layout Standard 
    1635 Define the second dimension of the global domain. 
    1636  This attribute is mandatory. 
    1637 \end_layout 
    1638  
    1639 \begin_layout Subsection* 
    1640 ibegin:  
     2483Defines the size of the second dimension of the global domain. 
     2484\end_layout 
     2485 
     2486\begin_layout Subsection* 
     2487ibegin (optional):  
    16412488\begin_inset Flex Emph 
    16422489status collapsed 
     
    16602507 
    16612508\begin_layout Standard 
    1662 Define the begining index of the first dimension of the local domain. 
    1663  This attribute is optional. 
    1664  This must be an integer between  
     2509Defines the beginning index of the first dimension of a local domain. 
     2510 The attribute takes value between  
    16652511\begin_inset Flex Strong 
    16662512status collapsed 
     
    16972543 
    16982544\begin_layout Subsection* 
    1699 ni:  
     2545ni (optional):  
    17002546\begin_inset Flex Emph 
    17012547status collapsed 
     
    17192565 
    17202566\begin_layout Standard 
    1721 Define the first dimension of the local domain. 
    1722  This attribute is optional. 
    1723  This must be an integer between  
     2567Defines the size of the first dimension of a local domain. 
     2568 The attribute takes value between  
    17242569\begin_inset Flex Strong 
    17252570status collapsed 
     
    17562601 
    17572602\begin_layout Subsection* 
    1758 jbegin:  
     2603jbegin (optional):  
    17592604\begin_inset Flex Emph 
    17602605status collapsed 
     
    17782623 
    17792624\begin_layout Standard 
    1780 Define the beginning index of the second dimension of the local domain. 
    1781  This attribute is optional. 
    1782  This must be an integer between  
     2625Defines the beginning index of the second dimension of a local domain. 
     2626 The attribute takes value between  
    17832627\begin_inset Flex Strong 
    17842628status collapsed 
     
    18152659 
    18162660\begin_layout Subsection* 
    1817 nj:  
     2661nj (optional):  
    18182662\begin_inset Flex Emph 
    18192663status collapsed 
     
    18372681 
    18382682\begin_layout Standard 
    1839 Define the second dimension of the local domain. 
    1840  This attribute is optional. 
    1841  This must be an integer between  
     2683Defines the size of the second dimension of a local domain. 
     2684 he attribute takes value between  
    18422685\begin_inset Flex Strong 
    18432686status collapsed 
     
    18742717 
    18752718\begin_layout Subsection* 
    1876 lonvalue_1d:  
     2719lonvalue_1d (optional):  
    18772720\emph on 
    187827211D-array of double 
     
    18882731 
    18892732\begin_layout Standard 
    1890 Define the value of the longitude on the local domain. 
    1891  For a cartesian grid, the size of the array will be  
     2733Defines the longitude values of a local domain. 
     2734 For a cartesian grid, the array size should be  
    18922735\begin_inset Flex Strong 
    18932736status collapsed 
     
    19002743 
    19012744. 
    1902  For a curvilinear grid, the size of the array will be  
     2745 For a curvilinear grid, the array size should be  
    19032746\begin_inset Flex Strong 
    19042747status collapsed 
     
    19152758 
    19162759. 
    1917  This attribute is optional. 
    1918 \end_layout 
    1919  
    1920 \begin_layout Subsection* 
    1921 lonvalue_2d:  
     2760\end_layout 
     2761 
     2762\begin_layout Subsection* 
     2763lonvalue_2d (optional):  
    19222764\emph on 
    192327652D-array of double 
     
    19332775 
    19342776\begin_layout Standard 
    1935 Define the value of the longitude on the local domain. 
    1936  For a cartesian and curvilinear grid, the size of the array will be  
     2777Defines the longitude values of a local domain. 
     2778 For cartesian and curvilinear grids the array size should be  
    19372779\begin_inset Flex Strong 
    19382780status collapsed 
     
    19492791 
    19502792. 
    1951  This attribute is mandatory. 
    19522793 Only lonvalue_1d or lonvalue_2d can be defined. 
    1953 \end_layout 
    1954  
    1955 \begin_layout Subsection* 
    1956 latvalue_1d:  
     2794 Also the layout of latitude and longitude should be in conformance with 
     2795 each other: either 1D or 2D. 
     2796\end_layout 
     2797 
     2798\begin_layout Subsection* 
     2799latvalue_1d (optional):  
    19572800\emph on 
    195828011D-array of double 
     
    19682811 
    19692812\begin_layout Standard 
    1970 Define the value of the latitude on the local domain. 
     2813Defines the latitude values of a local domain. 
    19712814 For a cartesian grid, the size of the array will be nj. 
    19722815 For a curvilinear grid, the size of the array will be  
     
    19852828 
    19862829. 
    1987  This attribute is optional. 
    1988 \end_layout 
    1989  
    1990 \begin_layout Subsection* 
    1991 latvalue_2d:  
     2830  
     2831\end_layout 
     2832 
     2833\begin_layout Subsection* 
     2834latvalue_2d (optional):  
    19922835\emph on 
    199328362D-array of double 
     
    20032846 
    20042847\begin_layout Standard 
    2005 Define the value of the latitude on the local domain. 
    2006  For a cartesian and a curvilinear grid, the size of the array will be  
     2848Defines the latitude values of a local domain. 
     2849 For cartesian and curvilinear grids the array size should be  
    20072850\begin_inset Flex Strong 
    20082851status collapsed 
     
    20192862 
    20202863. 
    2021  This attribute is mandatory. 
    20222864 Only latvalue_1d or latvalue_2d can be defined. 
    2023 \end_layout 
    2024  
    2025 \begin_layout Subsection* 
    2026 nvertex:  
     2865 Also the layout of latitude and longitude should be in conformance with 
     2866 each other: either 1D or 2D. 
     2867\end_layout 
     2868 
     2869\begin_layout Subsection* 
     2870lon_name (optional):  
     2871\begin_inset Flex Emph 
     2872status collapsed 
     2873 
     2874\begin_layout Plain Layout 
     2875string 
     2876\end_layout 
     2877 
     2878\end_inset 
     2879 
     2880 
     2881\end_layout 
     2882 
     2883\begin_layout Standard 
     2884Fortran:  
     2885\end_layout 
     2886 
     2887\begin_layout LyX-Code 
     2888CHARACTER(LEN=*) :: lon_name 
     2889\end_layout 
     2890 
     2891\begin_layout Standard 
     2892Defines the longitude name as it will appear in an output file. 
     2893\end_layout 
     2894 
     2895\begin_layout Subsection* 
     2896lat_name (optional):  
     2897\begin_inset Flex Emph 
     2898status collapsed 
     2899 
     2900\begin_layout Plain Layout 
     2901string 
     2902\end_layout 
     2903 
     2904\end_inset 
     2905 
     2906 
     2907\end_layout 
     2908 
     2909\begin_layout Standard 
     2910Fortran:  
     2911\end_layout 
     2912 
     2913\begin_layout LyX-Code 
     2914CHARACTER(LEN=*) :: lat_name 
     2915\end_layout 
     2916 
     2917\begin_layout Standard 
     2918Defines the latitude name as it will appear in an output file. 
     2919\end_layout 
     2920 
     2921\begin_layout Subsection* 
     2922nvertex (optional):  
    20272923\emph on 
    20282924integer 
     
    20382934 
    20392935\begin_layout Standard 
    2040 Define the the maximum number of vertices for a cell. 
    2041  This is useful to specify the boundaries of cells for an unstructured mesh. 
    2042  This attribute is optional. 
    2043 \end_layout 
    2044  
    2045 \begin_layout Subsection* 
    2046 bounds_lon_1d:  
     2936Defines the maximum number of vertices for a grid. 
     2937 The attribute is required for specifying the cell boundaries of unstructured 
     2938 meshes. 
     2939\end_layout 
     2940 
     2941\begin_layout Subsection* 
     2942bounds_lon_1d (optional):  
    20472943\emph on 
    204829442D-array of double 
     
    20582954 
    20592955\begin_layout Standard 
    2060 Longitude value of the vertex of the cells. 
     2956Defines the longitude values of domain vertexes. 
     2957 The attribute  
    20612958\begin_inset Flex Strong 
    20622959status collapsed 
     
    20682965\end_inset 
    20692966 
    2070  attribute must also be defined. 
    2071  This attribute is optional. 
    2072 \end_layout 
    2073  
    2074 \begin_layout Subsection* 
    2075 bounds_lon_2d:  
     2967 must be also defined. 
     2968 The array dimensions must be  
     2969\begin_inset Formula $\textbf{nvertex}\times\textbf{ni}$ 
     2970\end_inset 
     2971 
     2972. 
     2973\end_layout 
     2974 
     2975\begin_layout Subsection* 
     2976bounds_lon_2d (optional):  
    20762977\emph on 
    207729783D-array of double 
     
    20872988 
    20882989\begin_layout Standard 
    2089 Longitude value of the vertex of the cells. 
     2990Defines the longitude values of domain vertexes. 
     2991 The attribute  
    20902992\begin_inset Flex Strong 
    20912993status collapsed 
     
    20972999\end_inset 
    20983000 
    2099  attribute must also be defined. 
    2100  This attribute is optional. 
     3001 must be also defined. 
    21013002 This attribute is useful when lonvalue_2d is defined. 
    2102  Only bounds_lon_1d or bounds_lon_2d can be defined. 
    2103 \end_layout 
    2104  
    2105 \begin_layout Subsection* 
    2106 bounds_lat_1d:  
     3003 The array dimensions must be  
     3004\begin_inset Formula $\textbf{nvertex}\times\textbf{ni}\times\textbf{nj}$ 
     3005\end_inset 
     3006 
     3007. 
     3008 Either bounds_lon_1d or bounds_lon_2d can be defined. 
     3009\end_layout 
     3010 
     3011\begin_layout Subsection* 
     3012bounds_lat_1d (optional):  
    21073013\emph on 
    210830142D-array of double 
     
    21183024 
    21193025\begin_layout Standard 
    2120 Latitude value of the vertex of the cells. 
     3026Defines the latitude values of domain vertexes. 
     3027 The attribute  
    21213028\begin_inset Flex Strong 
    21223029status collapsed 
     
    21283035\end_inset 
    21293036 
    2130  attribute must also be defined. 
    2131  This attribute is optional. 
    2132 \end_layout 
    2133  
    2134 \begin_layout Subsection* 
    2135 bounds_lat_2d:  
     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* 
     3046bounds_lat_2d (optional):  
    21363047\emph on 
    213730483D-array of double 
     
    21473058 
    21483059\begin_layout Standard 
    2149 Latitude value of the vertex of the cells. 
     3060Defines the latitude values of domain vertexes. 
     3061 The attribute  
    21503062\begin_inset Flex Strong 
    21513063status collapsed 
     
    21573069\end_inset 
    21583070 
    2159  attribute must also be defined. 
    2160  This attribute is optional. 
    2161  This attribute is useful when latvalue_2d is defined. 
    2162  Only bounds_lat_1d or bounds_lat_2d can be defined. 
    2163 \end_layout 
    2164  
    2165 \begin_layout Subsection* 
    2166 area:  
     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. 
     3079\end_layout 
     3080 
     3081\begin_layout Subsection* 
     3082bounds_lon_name (optional):  
     3083\begin_inset Flex Emph 
     3084status collapsed 
     3085 
     3086\begin_layout Plain Layout 
     3087string 
     3088\end_layout 
     3089 
     3090\end_inset 
     3091 
     3092 
     3093\end_layout 
     3094 
     3095\begin_layout Standard 
     3096Fortran:  
     3097\end_layout 
     3098 
     3099\begin_layout LyX-Code 
     3100CHARACTER(LEN=*) :: lon_name 
     3101\end_layout 
     3102 
     3103\begin_layout Standard 
     3104Defines the longitude name of domain vertexes as it will appear in an output 
     3105 file. 
     3106\end_layout 
     3107 
     3108\begin_layout Subsection* 
     3109bounds_lat_name (optional):  
     3110\begin_inset Flex Emph 
     3111status collapsed 
     3112 
     3113\begin_layout Plain Layout 
     3114string 
     3115\end_layout 
     3116 
     3117\end_inset 
     3118 
     3119 
     3120\end_layout 
     3121 
     3122\begin_layout Standard 
     3123Fortran:  
     3124\end_layout 
     3125 
     3126\begin_layout LyX-Code 
     3127CHARACTER(LEN=*) :: lat_name 
     3128\end_layout 
     3129 
     3130\begin_layout Standard 
     3131Defines the latitude name of domain vertexes as it will appear in an output 
     3132 file. 
     3133\end_layout 
     3134 
     3135\begin_layout Subsection* 
     3136area (optional):  
    21673137\emph on 
    216831382D-array of double 
     
    21783148 
    21793149\begin_layout Standard 
    2180 Area of the cells. 
     3150The area of cells. 
    21813151 The size of the array must be  
    21823152\begin_inset Flex Strong 
     
    21943164 
    21953165. 
    2196  This attribute is optional. 
    2197 \end_layout 
    2198  
    2199 \begin_layout Subsection* 
    2200 data_dim:  
     3166\end_layout 
     3167 
     3168\begin_layout Subsection* 
     3169prec (optional):  
    22013170\emph on 
    22023171integer 
     
    22083177 
    22093178\begin_layout LyX-Code 
     3179INTEGER :: prec 
     3180\end_layout 
     3181 
     3182\begin_layout Standard 
     3183Defines 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. 
     3187\end_layout 
     3188 
     3189\begin_layout Subsection* 
     3190data_dim (optional):  
     3191\emph on 
     3192integer 
     3193\end_layout 
     3194 
     3195\begin_layout Standard 
     3196Fortran: 
     3197\end_layout 
     3198 
     3199\begin_layout LyX-Code 
    22103200INTEGER :: datadim 
    22113201\end_layout 
    22123202 
    22133203\begin_layout Standard 
    2214 Define how a field is stored on memory for the client code. 
    2215   
    2216 \begin_inset Flex Strong 
    2217 status collapsed 
    2218  
    2219 \begin_layout Plain Layout 
    2220 datadim 
    2221 \end_layout 
    2222  
    2223 \end_inset 
    2224  
    2225  value can be  
     3204Defines how a field is stored on memory for the client code. 
     3205 The value can be either  
    22263206\begin_inset Flex Strong 
    22273207status collapsed 
     
    22443224 
    22453225. 
    2246  A value of  
     3226 The value of  
    22473227\begin_inset Flex Strong 
    22483228status collapsed 
     
    22543234\end_inset 
    22553235 
    2256  indicates that the horizontal layer of the field is stored on a 1D array 
    2257  as a vector of points. 
    2258  A value of  
     3236 indicates that the horizontal layer of the field is stored as a 1D array. 
     3237 The value of  
    22593238\begin_inset Flex Strong 
    22603239status collapsed 
     
    22663245\end_inset 
    22673246 
    2268  indicates that the horizontal layer is stored in a 2D array. 
    2269  This attribute is optional. 
     3247 indicates that the horizontal layer is stored as a 2D array. 
    22703248 The default value is  
    22713249\begin_inset Flex Strong 
     
    22823260 
    22833261\begin_layout Subsection* 
    2284 data_ibegin: 
     3262data_ibegin (optional): 
    22853263\emph on 
    22863264 integer 
     
    22963274 
    22973275\begin_layout Standard 
    2298 Define the beginning index of the field data for the first dimension. 
    2299  This attribute is an offset regarding the local domain, so the value can 
    2300  be negative. 
     3276Defines the beginning index of field data for the first dimension. 
     3277 This attribute is an offset relative to the local domain, so the value 
     3278 can be negative. 
    23013279 A negative value indicates that only some valid part of the data will extracted 
    23023280, for example in the case of a ghost cell. 
     
    23043282 stored in memory. 
    23053283 A 0-value means that the local domain matches the data in memory. 
    2306  This attribute is optional and the default value is 0. 
    2307  Otherwise  
     3284 The default value is 0. 
     3285 The attributes  
    23083286\begin_inset Flex Strong 
    23093287status collapsed 
     
    23293307 
    23303308\begin_layout Subsection* 
    2331 data_ni:  
     3309data_ni (optional):  
    23323310\emph on 
    23333311integer 
     
    23433321 
    23443322\begin_layout Standard 
    2345 Define the size of the field data for the first dimension. 
    2346  This attribute is optional and the default value is  
     3323Defines the size of field data for the first dimension. 
     3324 The default value is  
    23473325\begin_inset Flex Strong 
    23483326status collapsed 
     
    23553333 
    23563334. 
    2357  Otherwise  
     3335 The attributes  
    23583336\begin_inset Flex Strong 
    23593337status collapsed 
     
    23793357 
    23803358\begin_layout Subsection* 
    2381 data_jbegin:  
     3359data_jbegin (optional):  
    23823360\emph on 
    23833361integer 
     
    23933371 
    23943372\begin_layout Standard 
    2395 Define the beginning index of the field data for the second dimension. 
    2396  This attribute is take account only if 
     3373Defines the beginning index of field data for the second dimension. 
     3374 The attribute is taken into account only if 
    23973375\begin_inset Flex Strong 
    23983376status collapsed 
     
    24053383 
    24063384. 
    2407  This attribute is an offset regarding the local domain, so the value can 
     3385 The attribute is an offset relative to the local domain, so the value can 
    24083386 be negative. 
    24093387 A negative value indicate that only some valid part of the data will extracted, 
     
    24113389 A positive value indicate that the local domain is greater than the data 
    24123390 stored in memory. 
    2413  A 0-value means that the local domain match the data in memory. 
    2414  This attribute is optional and the default value is  
     3391 The 0-value means that the local domain matches the data in memory. 
     3392 The default value is  
    24153393\begin_inset Flex Strong 
    24163394status collapsed 
     
    24233401 
    24243402. 
    2425  Otherwise  
     3403 The attributes  
    24263404\begin_inset Flex Strong 
    24273405status collapsed 
     
    24473425 
    24483426\begin_layout Subsection* 
    2449 data_nj:  
     3427data_nj (optional):  
    24503428\emph on 
    24513429integer 
     
    24613439 
    24623440\begin_layout Standard 
    2463 Define the size of the field data for the second dimension. 
    2464  This attribute is taken account only if  
     3441Defines the size of field data for the second dimension. 
     3442 The attribute is taken account only if  
    24653443\begin_inset Flex Strong 
    24663444status collapsed 
     
    24733451 
    24743452. 
    2475  This attribute is optional and the default value is  
     3453 The default value is  
    24763454\begin_inset Flex Strong 
    24773455status collapsed 
     
    24843462 
    24853463. 
    2486  Otherwise  
     3464 The attributes  
    24873465\begin_inset Flex Strong 
    24883466status collapsed 
     
    25083486 
    25093487\begin_layout Subsection* 
    2510 data_i_index:  
     3488data_i_index (optional):  
    25113489\emph on 
    251234901D-array of integer 
     
    25223500 
    25233501\begin_layout Standard 
    2524 In case of a compressed horizontal domain, define the indexation the indexation 
    2525  of the data for the first dimension. 
    2526  The size of the array must be  
    2527 \begin_inset Flex Strong 
    2528 status collapsed 
    2529  
    2530 \begin_layout Plain Layout 
    2531 data_nindex 
     3502In case of a compressed horizontal domain, define the data indexation for 
     3503 the first dimension. 
     3504 The array size must be  
     3505\begin_inset Flex Strong 
     3506status collapsed 
     3507 
     3508\begin_layout Plain Layout 
     3509data_n 
    25323510\end_layout 
    25333511 
     
    25353513 
    25363514. 
    2537  This attribute is optional. 
    2538 \end_layout 
    2539  
    2540 \begin_layout Subsection* 
    2541 data_j_index:  
     3515\end_layout 
     3516 
     3517\begin_layout Subsection* 
     3518data_j_index (optional):  
    25423519\emph on 
    254335201D-array of integer 
     
    25533530 
    25543531\begin_layout Standard 
    2555 In case of a compressed horizontal domain, define the indexation the indexation 
    2556  of the data for the second dimension. 
    2557  This is meaningful only if  
     3532In case of a compressed horizontal domain, defines the data indexation for 
     3533 the second dimension. 
     3534 The attribute is meaningful only if  
    25583535\begin_inset Flex Strong 
    25593536status collapsed 
     
    25663543 
    25673544. 
    2568  This attribute is optional. 
    2569 \end_layout 
    2570  
    2571 \begin_layout Subsection* 
    2572 mask_1d:  
     3545\end_layout 
     3546 
     3547\begin_layout Subsection* 
     3548mask_1d (optional):  
    25733549\emph on 
    257435501D-array of bool 
     
    25843560 
    25853561\begin_layout Standard 
    2586 Define the 1-dimension mask of the local domain. 
    2587  The attribute is optional. 
    2588  By default, none value is masked. 
     3562Defines the 1D mask of a local domain. 
    25893563 The masked value will be replaced by the value of the field attribute  
    25903564\begin_inset Flex Strong 
     
    25973571\end_inset 
    25983572 
    2599  in the output file. 
     3573 in an output file. 
    26003574 This value is useful in case a field is stored linearly in memory. 
    2601  This attribute is optional. 
    2602 \end_layout 
    2603  
    2604 \begin_layout Subsection* 
    2605 mask_2d:  
     3575 By default none of the values are masked. 
     3576\end_layout 
     3577 
     3578\begin_layout Subsection* 
     3579mask_2d (optional):  
    26063580\emph on 
    260735812D-array of bool 
     
    26173591 
    26183592\begin_layout Standard 
    2619 Define the mask of the local domain. 
    2620  The attribute is optional. 
    2621  By default, none value is masked. 
    2622  The masked value will be replaced by the value of the field attribute  
     3593Defines the 2D mask of a local domain. 
     3594 The masked values will be replaced by the value of the field attribute 
     3595  
    26233596\begin_inset Flex Strong 
    26243597status collapsed 
     
    26303603\end_inset 
    26313604 
    2632  in the output file. 
     3605 in an output file. 
     3606 By default, none of the values are masked. 
    26333607 Only mask_2d or mask_1d can be defined. 
    26343608\end_layout 
    26353609 
    26363610\begin_layout Subsection* 
    2637 domain_ref: string 
     3611domain_ref (optional): string 
    26383612\end_layout 
    26393613 
     
    26473621 
    26483622\begin_layout Standard 
    2649 Define the reference of the domain. 
     3623Defines the reference to a domain. 
    26503624 All attributes are inherited from the referenced domain with the classic 
    26513625 inheritance mechanism. 
    26523626 The value assigned to the referenced domain is transmitted to to current 
    26533627 domain. 
    2654  This attribute is optional. 
    2655 \end_layout 
    2656  
    2657 \begin_layout Subsection* 
    2658 i_index:  
     3628\end_layout 
     3629 
     3630\begin_layout Subsection* 
     3631i_index (optional):  
    26593632\begin_inset Flex Emph 
    26603633status collapsed 
     
    26783651 
    26793652\begin_layout Standard 
    2680 Define the global index of the first dimension of domain which the local 
    2681  domain holds. 
    2682  This attribute is optional and by default, the size of the array is equal 
    2683  to  
     3653Defines the global index of the first dimension of a local domain held by 
     3654 a process. 
     3655 By default the size of the array is equal to  
    26843656\begin_inset Flex Strong 
    26853657status collapsed 
     
    26953667 
    26963668\begin_layout Subsection* 
    2697 j_index:  
     3669j_index (optional):  
    26983670\begin_inset Flex Emph 
    26993671status collapsed 
     
    27173689 
    27183690\begin_layout Standard 
    2719 Define the global index of the second dimension of domain which the local 
    2720  domain holds. 
    2721  This attribute is optional and by default, the size of the array is equal 
    2722  to  
     3691Defines the global index of the second dimension of a local domain held 
     3692 by a process. 
     3693 By default the size of the array is equal to  
    27233694\begin_inset Flex Strong 
    27243695status collapsed 
     
    27313702 
    27323703. 
     3704\end_layout 
     3705 
     3706\begin_layout Subsection* 
     3707comment (optional):  
     3708\begin_inset Flex Emph 
     3709status collapsed 
     3710 
     3711\begin_layout Plain Layout 
     3712string 
     3713\end_layout 
     3714 
     3715\end_inset 
     3716 
     3717 
     3718\end_layout 
     3719 
     3720\begin_layout Standard 
     3721Fortran:  
     3722\end_layout 
     3723 
     3724\begin_layout LyX-Code 
     3725CHARACTER(LEN=*) :: comment 
     3726\end_layout 
     3727 
     3728\begin_layout Standard 
     3729Allows a user to set a comment. 
    27333730\end_layout 
    27343731 
     
    27383735 
    27393736\begin_layout Subsection* 
    2740 name: string 
     3737name (optional): string 
    27413738\end_layout 
    27423739 
     
    27503747 
    27513748\begin_layout Standard 
    2752 Define the name of the grid. 
    2753  This attribute is actually not used internally. 
    2754  Optional attribute. 
    2755 \end_layout 
    2756  
    2757 \begin_layout Subsection* 
    2758 description: string 
     3749Defines the name of a grid. 
     3750\end_layout 
     3751 
     3752\begin_layout Subsection* 
     3753description (optional): string 
    27593754\end_layout 
    27603755 
     
    27683763 
    27693764\begin_layout Standard 
    2770 Define the description of the grid. 
    2771  This attribute is optional. 
    2772 \end_layout 
    2773  
    2774 \begin_layout Subsection* 
    2775 mask_1d:  
     3765Defines the descriptions of a grid. 
     3766\end_layout 
     3767 
     3768\begin_layout Subsection* 
     3769mask_1d (optional):  
    27763770\emph on 
    277737711D-array of bool 
     
    27873781 
    27883782\begin_layout Standard 
    2789 Define the mask of the local 1-dimension grid. 
    2790  Masked value will be replaced by the value of the field attribute  
     3783Defines the mask of a local 1D grid. 
     3784 Masked values will be replaced by the value of the field attribute  
    27913785\begin_inset Flex Strong 
    27923786status collapsed 
     
    27983792\end_inset 
    27993793 
    2800  in the output file. 
    2801  This attribute is optional. 
    2802  By default, none value is masked. 
    2803 \end_layout 
    2804  
    2805 \begin_layout Subsection* 
    2806 mask_2d:  
     3794 in an output file. 
     3795 By default none of the value are masked. 
     3796\end_layout 
     3797 
     3798\begin_layout Subsection* 
     3799mask_2d (optional):  
    28073800\emph on 
    280838012D-array of bool 
     
    28183811 
    28193812\begin_layout Standard 
    2820 Define the mask of the local 2-dimension grid. 
    2821  Masked value will be replaced by the value of the field attribute  
     3813Defines the mask of a local 2D grid. 
     3814 Masked values will be replaced by the value of the field attribute  
    28223815\begin_inset Flex Strong 
    28233816status collapsed 
     
    28293822\end_inset 
    28303823 
    2831  in the output file. 
    2832  This attribute is optional. 
    2833  By default, none value is masked. 
    2834 \end_layout 
    2835  
    2836 \begin_layout Subsection* 
    2837 mask_3d:  
     3824 in an output file. 
     3825 By default none of the value are masked. 
     3826\end_layout 
     3827 
     3828\begin_layout Subsection* 
     3829mask_3d (optional):  
    28383830\emph on 
    283938313D-array of bool 
     
    28493841 
    28503842\begin_layout Standard 
    2851 Define the mask of the local 3-dimension grid. 
    2852  Masked value will be replaced by the value of the field attribute  
     3843Define the mask of a local 3D grid. 
     3844 Masked values will be replaced by the value of the field attribute  
    28533845\begin_inset Flex Strong 
    28543846status collapsed 
     
    28603852\end_inset 
    28613853 
    2862  in the output file. 
    2863  This attribute is optional. 
    2864  By default, none value is masked. 
    2865  Only one mask can be defined. 
     3854 in an output file. 
     3855 By default none of the value are masked. 
     3856\end_layout 
     3857 
     3858\begin_layout Subsection* 
     3859mask_4d (optional):  
     3860\emph on 
     38614D-array of bool 
     3862\end_layout 
     3863 
     3864\begin_layout Standard 
     3865Fortran: 
     3866\end_layout 
     3867 
     3868\begin_layout LyX-Code 
     3869LOGICAL :: mask_4d(:,:,:) 
     3870\end_layout 
     3871 
     3872\begin_layout Standard 
     3873Define the mask of a local 4D grid. 
     3874 Masked values will be replaced by the value of the field attribute  
     3875\begin_inset Flex Strong 
     3876status collapsed 
     3877 
     3878\begin_layout Plain Layout 
     3879default_value 
     3880\end_layout 
     3881 
     3882\end_inset 
     3883 
     3884 in an output file. 
     3885 By default none of the value are masked. 
     3886\end_layout 
     3887 
     3888\begin_layout Subsection* 
     3889mask_5d (optional):  
     3890\emph on 
     38915D-array of bool 
     3892\end_layout 
     3893 
     3894\begin_layout Standard 
     3895Fortran: 
     3896\end_layout 
     3897 
     3898\begin_layout LyX-Code 
     3899LOGICAL :: mask_5d(:,:,:) 
     3900\end_layout 
     3901 
     3902\begin_layout Standard 
     3903Define the mask of a local 5D grid. 
     3904 Masked values will be replaced by the value of the field attribute  
     3905\begin_inset Flex Strong 
     3906status collapsed 
     3907 
     3908\begin_layout Plain Layout 
     3909default_value 
     3910\end_layout 
     3911 
     3912\end_inset 
     3913 
     3914 in an output file. 
     3915 By default none of the value are masked. 
     3916\end_layout 
     3917 
     3918\begin_layout Subsection* 
     3919mask_6d (optional):  
     3920\emph on 
     39216D-array of bool 
     3922\end_layout 
     3923 
     3924\begin_layout Standard 
     3925Fortran: 
     3926\end_layout 
     3927 
     3928\begin_layout LyX-Code 
     3929LOGICAL :: mask_6d(:,:,:) 
     3930\end_layout 
     3931 
     3932\begin_layout Standard 
     3933Define the mask of a local 6D grid. 
     3934 Masked values will be replaced by the value of the field attribute  
     3935\begin_inset Flex Strong 
     3936status collapsed 
     3937 
     3938\begin_layout Plain Layout 
     3939default_value 
     3940\end_layout 
     3941 
     3942\end_inset 
     3943 
     3944 in an output file. 
     3945 By default none of the value are masked. 
     3946\end_layout 
     3947 
     3948\begin_layout Subsection* 
     3949mask_7d (optional):  
     3950\emph on 
     39517D-array of bool 
     3952\end_layout 
     3953 
     3954\begin_layout Standard 
     3955Fortran: 
     3956\end_layout 
     3957 
     3958\begin_layout LyX-Code 
     3959LOGICAL :: mask_7d(:,:,:) 
     3960\end_layout 
     3961 
     3962\begin_layout Standard 
     3963Define the mask of a local 7D grid. 
     3964 Masked values will be replaced by the value of the field attribute  
     3965\begin_inset Flex Strong 
     3966status collapsed 
     3967 
     3968\begin_layout Plain Layout 
     3969default_value 
     3970\end_layout 
     3971 
     3972\end_inset 
     3973 
     3974 in an output file. 
     3975 By default none of the value are masked. 
     3976\end_layout 
     3977 
     3978\begin_layout Subsection* 
     3979comment (optional):  
     3980\begin_inset Flex Emph 
     3981status collapsed 
     3982 
     3983\begin_layout Plain Layout 
     3984string 
     3985\end_layout 
     3986 
     3987\end_inset 
     3988 
     3989 
     3990\end_layout 
     3991 
     3992\begin_layout Standard 
     3993Fortran:  
     3994\end_layout 
     3995 
     3996\begin_layout LyX-Code 
     3997CHARACTER(LEN=*) :: comment 
     3998\end_layout 
     3999 
     4000\begin_layout Standard 
     4001Allows a user to set a comment. 
    28664002\end_layout 
    28674003 
     
    28714007 
    28724008\begin_layout Subsection* 
    2873 name:  
     4009name (optional):  
    28744010\emph on 
    28754011string 
     
    28854021 
    28864022\begin_layout Standard 
    2887 Define the  
    2888 \begin_inset Flex Strong 
    2889 status collapsed 
    2890  
    2891 \begin_layout Plain Layout 
    2892 name 
    2893 \end_layout 
    2894  
    2895 \end_inset 
    2896  
    2897  of the field as it will appear in an output file. 
    2898  This attribute is optional. 
     4023Defines the name of a field as it will appear in an output file. 
    28994024 If not present, the identifier  
    29004025\begin_inset Flex Strong 
     
    29114036 
    29124037\begin_layout Subsection* 
    2913 standard_name:  
     4038standard_name (optional):  
    29144039\emph on 
    29154040string 
     
    29254050 
    29264051\begin_layout Standard 
    2927 Define the  
     4052Defines the  
    29284053\begin_inset Flex Strong 
    29294054status collapsed 
     
    29364061 
    29374062 attribute as it will appear in the metadata of an output file. 
    2938  This attribute is optional. 
    2939 \end_layout 
    2940  
    2941 \begin_layout Subsection* 
    2942 long_name:  
     4063\end_layout 
     4064 
     4065\begin_layout Subsection* 
     4066long_name (optional):  
    29434067\emph on 
    29444068string 
     
    29544078 
    29554079\begin_layout Standard 
    2956 Define the  
    2957 \begin_inset Flex Strong 
    2958 status collapsed 
    2959  
    2960 \begin_layout Plain Layout 
    2961 long_name 
    2962 \end_layout 
    2963  
    2964 \end_inset 
    2965  
    2966  attribute as it will appear in the metadata of an output file. 
    2967  This attribute is optional. 
    2968 \end_layout 
    2969  
    2970 \begin_layout Subsection* 
    2971 unit:  
     4080Defines the long name as it will appear in the metadata of an output file. 
     4081\end_layout 
     4082 
     4083\begin_layout Subsection* 
     4084expr (optional):  
    29724085\emph on 
    29734086string 
     
    29794092 
    29804093\begin_layout LyX-Code 
     4094CHARACTER(LEN=*) :: expr 
     4095\end_layout 
     4096 
     4097\begin_layout Standard 
     4098Defines the expression for arithmetic or time-integration operations performed 
     4099 on a field. 
     4100 For example if  
     4101\series bold 
     4102expr= 
     4103\begin_inset Quotes erd 
     4104\end_inset 
     4105 
     4106sqrt(@temp2 - pow(@temp, 2)) 
     4107\begin_inset Quotes erd 
     4108\end_inset 
     4109 
     4110 
     4111\series default 
     4112 then the variance will be calculated on the incoming flux of the field 
     4113  
     4114\series bold 
     4115temp 
     4116\series default 
     4117 (given that field temp2 that holds the square of temp was correctly defined). 
     4118  
     4119\end_layout 
     4120 
     4121\begin_layout Subsection* 
     4122unit (optional):  
     4123\emph on 
     4124string 
     4125\end_layout 
     4126 
     4127\begin_layout Standard 
     4128Fortran:  
     4129\end_layout 
     4130 
     4131\begin_layout LyX-Code 
    29814132CHARACTER(LEN=*) :: unit 
    29824133\end_layout 
    29834134 
    29844135\begin_layout Standard 
    2985 Define the  
    2986 \begin_inset Flex Strong 
    2987 status collapsed 
    2988  
    2989 \begin_layout Plain Layout 
    2990 unit 
    2991 \end_layout 
    2992  
    2993 \end_inset 
    2994  
    2995  of the field. 
    2996  This attribute is optional. 
    2997 \end_layout 
    2998  
    2999 \begin_layout Subsection* 
    3000 operation: enumeration 
    3001 \emph on 
    3002  { once, instant, average, maximum, minimum, accumulate } 
     4136Defines the unit of a field. 
     4137\end_layout 
     4138 
     4139\begin_layout Subsection* 
     4140operation (mandatory): enumeration 
     4141\emph on 
     4142 {once, instant, average, maximum, minimum, accumulate} 
    30034143\end_layout 
    30044144 
     
    30124152 
    30134153\begin_layout Standard 
    3014 Define the temporal operation applied on the field. 
    3015  This attribute is optional, by default no operation is applied. 
    3016 \end_layout 
    3017  
    3018 \begin_layout Subsection* 
    3019 freq_op:  
     4154Defines the temporal operation applied to a field. 
     4155\end_layout 
     4156 
     4157\begin_layout Subsection* 
     4158freq_op (optional):  
    30204159\emph on 
    30214160duration 
     
    30314170 
    30324171\begin_layout Standard 
    3033 Define the frequency of the sampling for the temporal operation, so a field 
    3034  value will be used for temporal averaging every  
     4172Defines the sampling frequency of a temporal operation, so that field values 
     4173 will be used for temporal sampling at frequency  
    30354174\begin_inset Flex Strong 
    30364175status collapsed 
     
    30424181\end_inset 
    30434182 
    3044  time step. 
    3045  It is very useful for sub-processes called at different frequency in a 
    3046  model. 
    3047  This attribute is optional, the default value is  
     4183. 
     4184 It is useful for sub-processes called at different frequency in a model. 
     4185 The default value is equal to the file attribute  
     4186\begin_inset Flex Strong 
     4187status collapsed 
     4188 
     4189\begin_layout Plain Layout 
     4190output_freq 
     4191\end_layout 
     4192 
     4193\end_inset 
     4194 
     4195 for  
     4196\begin_inset Flex Strong 
     4197status collapsed 
     4198 
     4199\begin_layout Plain Layout 
     4200instant 
     4201\end_layout 
     4202 
     4203\end_inset 
     4204 
     4205 operations and  
    30484206\begin_inset Flex Strong 
    30494207status collapsed 
     
    30554213\end_inset 
    30564214 
    3057 (1 time step). 
    3058 \end_layout 
    3059  
    3060 \begin_layout Subsection* 
    3061 freq_offset:  
     4215 (1 time step) otherwise. 
     4216\end_layout 
     4217 
     4218\begin_layout Subsection* 
     4219freq_offset (optional):  
    30624220\emph on 
    30634221duration 
     
    30734231 
    30744232\begin_layout Standard 
    3075 Define the offset when  
     4233Defines the offset when  
    30764234\begin_inset Flex Strong 
    30774235status collapsed 
     
    30844242 
    30854243 is defined. 
    3086  This attribute is optional, the default value is  
    3087 \begin_inset Flex Strong 
    3088 status collapsed 
    3089  
    3090 \begin_layout Plain Layout 
    3091 0ts 
    3092 \end_layout 
    3093  
    3094 \end_inset 
    3095  
    3096 (0 time step). 
    3097 \end_layout 
    3098  
    3099 \begin_layout Standard 
    3100 \begin_inset Formula $0\leq freq\_offset<freq\_op$ 
    3101 \end_inset 
    3102  
    3103  
    3104 \end_layout 
    3105  
    3106 \begin_layout Subsection* 
    3107 level:  
     4244 Accepted values lie between  
     4245\series bold 
     42460 
     4247\series default 
     4248 and  
     4249\begin_inset Flex Strong 
     4250status collapsed 
     4251 
     4252\begin_layout Plain Layout 
     4253freq_op 
     4254\end_layout 
     4255 
     4256\end_inset 
     4257 
     4258. 
     4259 The default value is  
     4260\begin_inset Flex Strong 
     4261status collapsed 
     4262 
     4263\begin_layout Plain Layout 
     4264freq_op - 1ts 
     4265\end_layout 
     4266 
     4267\end_inset 
     4268 
     4269 for fields in the  
     4270\begin_inset Flex Strong 
     4271status collapsed 
     4272 
     4273\begin_layout Plain Layout 
     4274write 
     4275\end_layout 
     4276 
     4277\end_inset 
     4278 
     4279 mode and  
     4280\series bold 
     42810 
     4282\series default 
     4283 for fields in the  
     4284\begin_inset Flex Strong 
     4285status collapsed 
     4286 
     4287\begin_layout Plain Layout 
     4288read 
     4289\end_layout 
     4290 
     4291\end_inset 
     4292 
     4293 mode. 
     4294\end_layout 
     4295 
     4296\begin_layout Subsection* 
     4297level (optional):  
    31084298\emph on 
    31094299integer 
     
    31194309 
    31204310\begin_layout Standard 
    3121 Define the level of output of the field. 
    3122  A field will be output only if the file attribute 
     4311Defines the output level of a field. 
     4312 The field will be output only if the file attribute 
    31234313\begin_inset Flex Strong 
    31244314status collapsed 
     
    31354325 
    31364326. 
    3137  This attribute is optional, the default value is  
     4327 The default value is  
    31384328\begin_inset Flex Strong 
    31394329status collapsed 
     
    31494339 
    31504340\begin_layout Subsection* 
    3151 prec:  
     4341prec (optional):  
    31524342\emph on 
    31534343integer 
     
    31634353 
    31644354\begin_layout Standard 
    3165 Define the precision in byte of a field in an output file. 
    3166  Available value are: 2 (integer), 4 (float single precision) and 8 (float 
     4355Defines the precision in bytes of a field in an output file. 
     4356 Available values are: 2 (integer), 4 (float single precision) and 8 (float 
    31674357 double precision). 
    3168 \end_layout 
    3169  
    3170 \begin_layout Subsection* 
    3171 enabled:  
     4358 The default value of 8. 
     4359\end_layout 
     4360 
     4361\begin_layout Subsection* 
     4362enabled (optional):  
    31724363\emph on 
    31734364bool 
     
    31834374 
    31844375\begin_layout Standard 
    3185 Define if a field must be output or not. 
    3186  This attribute is optional, the default value is  
     4376Defines if a field must be output or not. 
     4377 The default value is  
    31874378\begin_inset Flex Strong 
    31884379status collapsed 
     
    31984389 
    31994390\begin_layout Subsection* 
    3200 read_access:  
     4391check_if_active (optional):  
    32014392\emph on 
    32024393bool 
     
    32084399 
    32094400\begin_layout LyX-Code 
     4401LOGICAL :: check_if_active 
     4402\end_layout 
     4403 
     4404\begin_layout Standard 
     4405Sets a check if a field will be used at a given time step. 
     4406 Activating the check may improve performance for fields which are not used 
     4407 frequently, while it can detoriate performance for fields used at each 
     4408 time step. 
     4409 The default value is false. 
     4410\end_layout 
     4411 
     4412\begin_layout Subsection* 
     4413read_access (optional):  
     4414\emph on 
     4415bool 
     4416\end_layout 
     4417 
     4418\begin_layout Standard 
     4419Fortran: 
     4420\end_layout 
     4421 
     4422\begin_layout LyX-Code 
    32104423LOGICAL :: read_access 
    32114424\end_layout 
    32124425 
    32134426\begin_layout Standard 
    3214 Define whether a field can be read from the model or not. 
    3215  This attribute is optional, the default value is  
     4427Defines whether a field can be read from the model or not. 
     4428 The default value is  
    32164429\begin_inset Flex Strong 
    32174430status collapsed 
     
    32424455 
    32434456\begin_layout Subsection* 
    3244 field_ref:  
     4457field_ref (optional):  
    32454458\emph on 
    32464459string 
     
    32564469 
    32574470\begin_layout Standard 
    3258 Define a field reference. 
    3259  All attributes are inherited from the referenced field after the classical 
     4471Defines the field reference. 
     4472 All attributes will be inherited from the referenced field via the classical 
    32604473 inheritance mechanism. 
    3261  The value assigned to the referenced field is transmitted to to current 
    3262  field to perform temporal operation. 
    3263  This attribute is optional. 
    3264 \end_layout 
    3265  
    3266 \begin_layout Subsection* 
    3267 grid_ref:  
     4474 The values assigned to the referenced field will be transmitted to the 
     4475 current field to perform temporal operation. 
     4476\end_layout 
     4477 
     4478\begin_layout Subsection* 
     4479grid_ref (optional):  
    32684480\emph on 
    32694481string 
     
    32794491 
    32804492\begin_layout Standard 
    3281 Define on which grid the current field is defined. 
    3282  This attribute is optional, if missing, domain_ref and axis_ref must be 
    3283  defining. 
    3284 \end_layout 
    3285  
    3286 \begin_layout Subsection* 
    3287 domain_ref:  
     4493Defines the field grid. 
     4494 Note that only either  
     4495\begin_inset Flex Strong 
     4496status collapsed 
     4497 
     4498\begin_layout Plain Layout 
     4499grid_ref 
     4500\end_layout 
     4501 
     4502\end_inset 
     4503 
     4504 or a combination of  
     4505\begin_inset Flex Strong 
     4506status collapsed 
     4507 
     4508\begin_layout Plain Layout 
     4509domain_ref 
     4510\end_layout 
     4511 
     4512\end_inset 
     4513 
     4514,  
     4515\begin_inset Flex Strong 
     4516status collapsed 
     4517 
     4518\begin_layout Plain Layout 
     4519scalar_ref 
     4520\end_layout 
     4521 
     4522\end_inset 
     4523 
     4524 or  
     4525\begin_inset Flex Strong 
     4526status collapsed 
     4527 
     4528\begin_layout Plain Layout 
     4529axis_ref 
     4530\end_layout 
     4531 
     4532\end_inset 
     4533 
     4534 can be specified. 
     4535\end_layout 
     4536 
     4537\begin_layout Subsection* 
     4538domain_ref (optional):  
    32884539\emph on 
    32894540string 
     
    32994550 
    33004551\begin_layout Standard 
    3301 Define on which horizontal domain the current field is defined. 
    3302  This attribute is optional, but if this attribute is defined,  
     4552Defines the field domain. 
     4553 If the attribute is defined, the attribute  
    33034554\begin_inset Flex Strong 
    33044555status collapsed 
     
    33104561\end_inset 
    33114562 
    3312  must not be. 
    3313 \end_layout 
    3314  
    3315 \begin_layout Subsection* 
    3316 axis_ref:  
     4563 must not be specified. 
     4564\end_layout 
     4565 
     4566\begin_layout Subsection* 
     4567axis_ref (optional):  
    33174568\emph on 
    33184569string 
     
    33284579 
    33294580\begin_layout Standard 
    3330 Define on which vertical axis the current field is defined. 
    3331  This attribute is optional, but if this attribute is defined,  
    3332 \begin_inset Flex Strong 
    3333 status collapsed 
    3334  
    3335 \begin_layout Plain Layout 
    3336 domain_ref 
    3337 \end_layout 
    3338  
    3339 \end_inset 
    3340  
    3341  must be too and  
     4581Defines an axis for the current field. 
     4582 If the attribute is defined, the attribute  
    33424583\begin_inset Flex Strong 
    33434584status collapsed 
     
    33494590\end_inset 
    33504591 
    3351  must not. 
    3352 \end_layout 
    3353  
    3354 \begin_layout Subsection* 
    3355 grid_path:  
     4592 must not be specified. 
     4593\end_layout 
     4594 
     4595\begin_layout Subsection* 
     4596scalar_ref (optional):  
    33564597\emph on 
    33574598string 
     
    33634604 
    33644605\begin_layout LyX-Code 
     4606CHARACTER(LEN=*) :: scalar_ref 
     4607\end_layout 
     4608 
     4609\begin_layout Standard 
     4610Defines a scalar domain for the current field. 
     4611 If the attribute is defined, the attribute  
     4612\begin_inset Flex Strong 
     4613status collapsed 
     4614 
     4615\begin_layout Plain Layout 
     4616grid_ref 
     4617\end_layout 
     4618 
     4619\end_inset 
     4620 
     4621 must not be specified. 
     4622\end_layout 
     4623 
     4624\begin_layout Subsection* 
     4625grid_path (optional):  
     4626\emph on 
     4627string 
     4628\end_layout 
     4629 
     4630\begin_layout Standard 
     4631Fortran:  
     4632\end_layout 
     4633 
     4634\begin_layout LyX-Code 
    33654635CHARACTER(LEN=*) :: grid_path 
    33664636\end_layout 
    33674637 
    33684638\begin_layout Standard 
    3369 Define the way operations passing from a grid to others. 
    3370  This attribute is optional. 
    3371 \end_layout 
    3372  
    3373 \begin_layout Subsection* 
    3374 default_value:  
     4639Defines the way operations pass from a grid to other grids. 
     4640\end_layout 
     4641 
     4642\begin_layout Subsection* 
     4643default_value (optional):  
    33754644\emph on 
    33764645double 
     
    33864655 
    33874656\begin_layout Standard 
    3388 Define the value which should be used in place of the missing data of a 
    3389  field. 
    3390  This attribute is optional. 
    3391  If no value was defined, the missing data will be replaced by uninitialized 
    3392  values which can lead to undefined behaviors. 
    3393 \end_layout 
    3394  
    3395 \begin_layout Subsection* 
    3396 valid_min:  
     4657Defines 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. 
     4660\end_layout 
     4661 
     4662\begin_layout Subsection* 
     4663valid_min (optional):  
    33974664\emph on 
    33984665double 
     
    34184685\end_inset 
    34194686 
    3420  attribute value are set to missing value. 
    3421 \end_layout 
    3422  
    3423 \begin_layout Subsection* 
    3424 valid_max:  
     4687 attribute value will be set to missing value. 
     4688\end_layout 
     4689 
     4690\begin_layout Subsection* 
     4691valid_max (optional):  
    34254692\emph on 
    34264693double 
     
    34464713\end_inset 
    34474714 
    3448  attribute value are set to missing value. 
    3449 \end_layout 
    3450  
    3451 \begin_layout Subsection* 
    3452 detect_missing_value:  
     4715 attribute value will be set to missing value. 
     4716\end_layout 
     4717 
     4718\begin_layout Subsection* 
     4719detect_missing_value (optional):  
    34534720\emph on 
    34544721bool 
     
    34644731 
    34654732\begin_layout Standard 
    3466 When XIOS detect a default value in a field, it does not include the value 
    3467  in the statistic of the operation, like averaging, minimum, maximum... 
    3468 \end_layout 
    3469  
    3470 \begin_layout Subsection* 
    3471 add_offset:  
     4733When 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. 
     4736\end_layout 
     4737 
     4738\begin_layout Subsection* 
     4739add_offset (optional):  
    34724740\emph on 
    34734741double 
     
    34834751 
    34844752\begin_layout Standard 
    3485 Set the  
     4753Sets the  
    34864754\begin_inset Flex Strong 
    34874755status collapsed 
     
    34934761\end_inset 
    34944762 
    3495  metadata CF attribute in the output file. 
     4763 metadata CF attribute in an output file. 
    34964764 In output, the  
    34974765\begin_inset Flex Strong 
     
    35044772\end_inset 
    35054773 
    3506  value is subtracted to the field values. 
     4774 value will be subtracted from the field values. 
    35074775\end_layout 
    35084776 
     
    35224790 
    35234791\begin_layout Standard 
    3524 Set the  
     4792Sets the  
    35254793\begin_inset Flex Strong 
    35264794status collapsed 
     
    35324800\end_inset 
    35334801 
    3534  metadata CF attribute in the output file. 
    3535  In output, the field values are divided by the  
     4802 metadata CF attribute in an output file. 
     4803 In output, the field values will be divided by the  
    35364804\begin_inset Flex Strong 
    35374805status collapsed 
     
    35474815 
    35484816\begin_layout Subsection* 
    3549 compression_level:  
     4817compression_level (optional):  
    35504818\emph on 
    35514819integer 
     
    35614829 
    35624830\begin_layout Standard 
    3563 Define whether the field should be compressed using NetCDF-4 built-in compressio 
    3564 n. 
     4831Defines whether a field should be compressed using NetCDF-4 built-in compression. 
    35654832 The compression level must range from 0 to 9. 
    3566  An higher compression level means a better compression at the cost of using 
     4833 A higher compression level means a better compression at the cost of using 
    35674834 more processing power. 
    3568  This attribute is optional, the default value is inherited from the file 
    3569  attribute  
     4835 The default value is inherited from the file attribute  
    35704836\series bold 
    35714837compression_level 
     
    35754841 
    35764842\begin_layout Subsection* 
    3577 indexed_output:  
     4843indexed_output (optional):  
    35784844\emph on 
    35794845bool 
     
    35894855 
    35904856\begin_layout Standard 
    3591 Define whether the field data must be outputted as an indexed grid instead 
    3592  of a full grid whenever possible. 
    3593  This attribute is optional, the default value is  
     4857Defines whether field data must be output as an indexed grid instead of 
     4858 a full grid whenever possible. 
     4859 The default value is  
    35944860\series bold 
    35954861\emph on 
     
    36014867 
    36024868\begin_layout Subsection* 
    3603 ts_enabled:  
     4869ts_enabled (optional):  
    36044870\emph on 
    36054871bool 
     
    36154881 
    36164882\begin_layout Standard 
    3617 Define whether the field can be outputted as a timeserie if requested. 
    3618  This attribute is optional, the default value is  
     4883Defines whether a field can be output as a timeseries. 
     4884 The default value is  
    36194885\series bold 
    36204886\emph on 
     
    36264892 
    36274893\begin_layout Subsection* 
    3628 ts_split_freq:  
     4894ts_split_freq (optional):  
    36294895\emph on 
    36304896duration 
     
    36404906 
    36414907\begin_layout Standard 
    3642 Define the splitting frequency that should be used for the timeserie if 
     4908Defines the splitting frequency that should be used for a timeseries if 
    36434909 it has been requested. 
    3644  This attribute is optional, by default this value is inherited from the 
    3645  file  
     4910 By default the attribute value is inherited from the file attribute  
    36464911\series bold 
    36474912split_freq 
     
    36504915\end_layout 
    36514916 
     4917\begin_layout Subsection* 
     4918cell_methods (optional):  
     4919\emph on 
     4920string 
     4921\end_layout 
     4922 
     4923\begin_layout Standard 
     4924Fortran:  
     4925\end_layout 
     4926 
     4927\begin_layout LyX-Code 
     4928CHARACTER(LEN=*) :: cell_methods 
     4929\end_layout 
     4930 
     4931\begin_layout Standard 
     4932Defines the cell methods field attribute. 
     4933\end_layout 
     4934 
     4935\begin_layout Subsection* 
     4936cell_methods_mode (optional): enumeration 
     4937\emph on 
     4938 {overwrite, prefix, suffix, none} 
     4939\end_layout 
     4940 
     4941\begin_layout Standard 
     4942Fortran: 
     4943\end_layout 
     4944 
     4945\begin_layout LyX-Code 
     4946CHARACTER(LEN=*) :: cell_methods_mode 
     4947\end_layout 
     4948 
     4949\begin_layout Standard 
     4950Defines the cell methods mode of a field. 
     4951\end_layout 
     4952 
     4953\begin_layout Subsection* 
     4954comment (optional):  
     4955\begin_inset Flex Emph 
     4956status collapsed 
     4957 
     4958\begin_layout Plain Layout 
     4959string 
     4960\end_layout 
     4961 
     4962\end_inset 
     4963 
     4964 
     4965\end_layout 
     4966 
     4967\begin_layout Standard 
     4968Fortran:  
     4969\end_layout 
     4970 
     4971\begin_layout LyX-Code 
     4972CHARACTER(LEN=*) :: comment 
     4973\end_layout 
     4974 
     4975\begin_layout Standard 
     4976Allows a user to set a comment. 
     4977\end_layout 
     4978 
    36524979\begin_layout Section 
    36534980Variable attribute reference 
     
    36554982 
    36564983\begin_layout Subsection* 
    3657 name:  
     4984name (optional):  
    36584985\emph on 
    36594986string 
     
    36694996 
    36704997\begin_layout Standard 
    3671 Define the  
    3672 \begin_inset Flex Strong 
    3673 status collapsed 
    3674  
    3675 \begin_layout Plain Layout 
    3676 name 
    3677 \end_layout 
    3678  
    3679 \end_inset 
    3680  
    3681  of the variable as it will appear in an output file. 
    3682  This attribute is optional. 
    3683  If not present, the  
     4998Defines the name of a variable as it will appear in an output file. 
     4999 If not present, the variable  
    36845000\begin_inset Flex Strong 
    36855001status collapsed 
     
    36915007\end_inset 
    36925008 
    3693  will be used instead. 
    3694 \end_layout 
    3695  
    3696 \begin_layout Subsection* 
    3697 type: enumeration { bool, int, int32, int16, int64, float, double, string 
    3698  } 
     5009 will be used. 
     5010\end_layout 
     5011 
     5012\begin_layout Subsection* 
     5013type (mandatory): enumeration {bool, int, int32, int16, int64, float, double, 
     5014 string} 
    36995015\end_layout 
    37005016 
     
    37085024 
    37095025\begin_layout Standard 
    3710 Define the  
    3711 \begin_inset Flex Strong 
    3712 status collapsed 
    3713  
    3714 \begin_layout Plain Layout 
    3715 type 
    3716 \end_layout 
    3717  
    3718 \end_inset 
    3719  
    3720  of the variable. 
     5026Defines the type of a variable. 
    37215027 Note that the  
    37225028\series bold 
     
    37325038\emph default 
    37335039. 
    3734  This attribute is mandatory. 
     5040\end_layout 
     5041 
     5042\begin_layout Subsection* 
     5043ts_target (optional): enumeration {file, field, both, none} 
     5044\end_layout 
     5045 
     5046\begin_layout Standard 
     5047Fortran: 
     5048\end_layout 
     5049 
     5050\begin_layout LyX-Code 
     5051CHARACTER(LEN=*) :: ts_target 
    37355052\end_layout 
    37365053 
     
    37405057 
    37415058\begin_layout Subsection* 
    3742 name:  
     5059name (mandatory):  
    37435060\emph on 
    37445061string 
     
    37545071 
    37555072\begin_layout Standard 
    3756 Define the name of the file. 
    3757  This attribute is mandatory. 
    3758 \end_layout 
    3759  
    3760 \begin_layout Subsection* 
    3761 description:  
     5073Defines the name of a file. 
     5074\end_layout 
     5075 
     5076\begin_layout Subsection* 
     5077description (optional):  
    37625078\emph on 
    37635079string 
     
    37735089 
    37745090\begin_layout Standard 
    3775 Define the description of the file. 
    3776  This attribute is optional. 
    3777 \end_layout 
    3778  
    3779 \begin_layout Subsection* 
    3780 name_suffix:  
     5091Defines the description of a file. 
     5092\end_layout 
     5093 
     5094\begin_layout Subsection* 
     5095name_suffix (optional):  
    37815096\emph on 
    37825097string 
     
    37925107 
    37935108\begin_layout Standard 
    3794 Define a suffix to add to the name of the file. 
    3795  This attribute is optional. 
    3796 \end_layout 
    3797  
    3798 \begin_layout Subsection* 
    3799 min_digits:  
     5109Defines a suffix added to the file name. 
     5110\end_layout 
     5111 
     5112\begin_layout Subsection* 
     5113min_digits (optional):  
    38005114\emph on 
    38015115integer 
     
    38115125 
    38125126\begin_layout Standard 
    3813 For multiple_file, define the minimum digits composing the suffix defining 
    3814  the rank of the server, which will be happened to the name of the file. 
    3815  This attribute is optional and the default value is  
     5127For the  
     5128\series bold 
     5129multiple_file 
     5130\series default 
     5131 mode defines the minimum number of digits of the suffix describing the 
     5132 server rank which will be appended to the file name. 
     5133 The default value is  
    38165134\begin_inset Flex Strong 
    38175135status collapsed 
     
    38235141\end_inset 
    38245142 
     5143 (no server rank suffix is added). 
     5144\end_layout 
     5145 
     5146\begin_layout Subsection* 
     5147output_freq (mandatory):  
     5148\emph on 
     5149duration 
     5150\end_layout 
     5151 
     5152\begin_layout Standard 
     5153Fortran: 
     5154\end_layout 
     5155 
     5156\begin_layout LyX-Code 
     5157TYPE(xios_duration) :: output_freq 
     5158\end_layout 
     5159 
     5160\begin_layout Standard 
     5161Defines the output frequency for the current file. 
     5162\end_layout 
     5163 
     5164\begin_layout Subsection* 
     5165output_level (optional):  
     5166\emph on 
     5167integer 
     5168\end_layout 
     5169 
     5170\begin_layout Standard 
     5171Fortran: 
     5172\end_layout 
     5173 
     5174\begin_layout LyX-Code 
     5175INTEGER :: output_level 
     5176\end_layout 
     5177 
     5178\begin_layout Standard 
     5179Defines the output level for all fields of the current file. 
     5180 The field is output only if the field attribute  
     5181\series bold 
     5182level 
     5183\series default 
     5184 is less or equal to the file attribute  
     5185\series bold 
     5186output_level 
     5187\series default 
    38255188. 
    38265189\end_layout 
    38275190 
    38285191\begin_layout Subsection* 
    3829 output_freq:  
     5192sync_freq (optional):  
    38305193\emph on 
    38315194duration 
     
    38375200 
    38385201\begin_layout LyX-Code 
    3839 TYPE(xios_duration) :: output_freq 
    3840 \end_layout 
    3841  
    3842 \begin_layout Standard 
    3843 Define the output frequency for the current file. 
    3844  This attribute is mandatory. 
    3845 \end_layout 
    3846  
    3847 \begin_layout Subsection* 
    3848 output_level:  
    3849 \emph on 
    3850 integer 
    3851 \end_layout 
    3852  
    3853 \begin_layout Standard 
    3854 Fortran: 
    3855 \end_layout 
    3856  
    3857 \begin_layout LyX-Code 
    3858 INTEGER :: output_level 
    3859 \end_layout 
    3860  
    3861 \begin_layout Standard 
    3862 Define an output level for the field defining inside the current file. 
    3863  Field is output only if the field attribute  
    3864 \begin_inset Formula $level\leq output\_level$ 
    3865 \end_inset 
    3866  
    3867 . 
    3868 \end_layout 
    3869  
    3870 \begin_layout Subsection* 
    3871 sync_freq:  
     5202TYPE(xios_duration) :: sync_freq 
     5203\end_layout 
     5204 
     5205\begin_layout Standard 
     5206Defines the frequency for flushing the current file onto a disk. 
     5207 It may result in poor performances but data will be written even if a file 
     5208 is not yet closed. 
     5209\end_layout 
     5210 
     5211\begin_layout Subsection* 
     5212split_freq (optional):  
    38725213\emph on 
    38735214duration 
     
    38795220 
    38805221\begin_layout LyX-Code 
    3881 TYPE(xios_duration) :: sync_freq 
    3882 \end_layout 
    3883  
    3884 \begin_layout Standard 
    3885 Define the frequency for flushing the current file onto disk. 
    3886  It may result bad performance but data are wrote even if the file will 
    3887  not be closed. 
    3888  This attribute is optional. 
    3889 \end_layout 
    3890  
    3891 \begin_layout Subsection* 
    3892 split_freq:  
    3893 \emph on 
    3894 duration 
    3895 \end_layout 
    3896  
    3897 \begin_layout Standard 
    3898 Fortran: 
    3899 \end_layout 
    3900  
    3901 \begin_layout LyX-Code 
    39025222TYPE(xios_duration) :: split_freq 
    39035223\end_layout 
    39045224 
    39055225\begin_layout Standard 
    3906 Define the time frequency for splitting the current file. 
    3907  In that case, the start and end dates are added to the file  
     5226Defines the frequency for splitting the current file. 
     5227 The start and end dates will be added to the file name (see  
     5228\begin_inset Flex Emph 
     5229status collapsed 
     5230 
     5231\begin_layout Plain Layout 
     5232 
    39085233\series bold 
    3909 name 
    3910 \series default 
    3911  (see  
    3912 \begin_inset Flex Emph 
    3913 status collapsed 
    3914  
    3915 \begin_layout Plain Layout 
    3916  
    3917 \series bold 
    39185234\emph on 
    39195235split_freq_format 
     
    39235239 
    39245240 attribute). 
    3925  This attribute is optional, by default no splitting is done. 
    3926 \end_layout 
    3927  
    3928 \begin_layout Subsection* 
    3929 split_freq_format:  
     5241 By default no splitting is done. 
     5242\end_layout 
     5243 
     5244\begin_layout Subsection* 
     5245split_freq_format (optional):  
    39305246\emph on 
    39315247string 
     
    39415257 
    39425258\begin_layout Standard 
    3943 Define the format of the split date suffixed to the file. 
    3944  Can contain any character,  
     5259Defines the format of the split date suffixed to a file. 
     5260 It can contain any character,  
    39455261\emph on 
    39465262 
     
    40275343 
    40285344 by the number of full days since the time origin. 
    4029  This attribute is optional and the default behavior is to create a suffix 
    4030  with the date until the smaller non zero unit. 
     5345 The default behavior is to create a suffix with the date until the smaller 
     5346 non zero unit. 
    40315347 For example, in one day split frequency, the hour, minute and second will 
    40325348 not appear in the suffix, only year, month and day. 
     
    40345350 
    40355351\begin_layout Subsection* 
    4036 enabled:  
     5352split_start_offset(optional):  
     5353\emph on 
     5354duration 
     5355\end_layout 
     5356 
     5357\begin_layout Standard 
     5358Fortran: 
     5359\end_layout 
     5360 
     5361\begin_layout LyX-Code 
     5362TYPE(xios_duration) :: split_start_offset 
     5363\end_layout 
     5364 
     5365\begin_layout Standard 
     5366Defines the offset of file splitting. 
     5367  
     5368\end_layout 
     5369 
     5370\begin_layout Subsection* 
     5371split_end_offset(optional):  
     5372\emph on 
     5373duration 
     5374\end_layout 
     5375 
     5376\begin_layout Standard 
     5377Fortran: 
     5378\end_layout 
     5379 
     5380\begin_layout LyX-Code 
     5381TYPE(xios_duration) :: split_end_offset 
     5382\end_layout 
     5383 
     5384\begin_layout Subsection* 
     5385split_last_date (optional):  
     5386\emph on 
     5387string 
     5388\end_layout 
     5389 
     5390\begin_layout Standard 
     5391Fortran: 
     5392\end_layout 
     5393 
     5394\begin_layout LyX-Code 
     5395CHARACTER(LEN=*) :: split_last_date 
     5396\end_layout 
     5397 
     5398\begin_layout Subsection* 
     5399enabled (optional):  
    40375400\emph on 
    40385401bool 
     
    40485411 
    40495412\begin_layout Standard 
    4050 Define if a file must be written/read or not. 
    4051  This attribute is optional, the default value is  
     5413Defines if a file must be written/read or not. 
     5414 The default value is  
    40525415\begin_inset Flex Strong 
    40535416status collapsed 
     
    40635426 
    40645427\begin_layout Subsection* 
    4065 mode:  
    4066 \emph on 
    4067 enumeration { read, write } 
     5428mode (optional):  
     5429\emph on 
     5430enumeration {read, write} 
    40685431\end_layout 
    40695432 
     
    40775440 
    40785441\begin_layout Standard 
    4079 Define whether the file will be read or written. 
    4080  This attribute is optional, the default value is  
     5442Defines whether a file will be read or written. 
     5443 The default value is  
    40815444\begin_inset Flex Strong 
    40825445status collapsed 
     
    40925455 
    40935456\begin_layout Subsection* 
    4094 type:  
    4095 \emph on 
    4096 enumeration { one_file, multiple_file } 
     5457type (mandatory):  
     5458\emph on 
     5459enumeration {one_file, multiple_file} 
    40975460\end_layout 
    40985461 
     
    41065469 
    41075470\begin_layout Standard 
    4108 Define the type of the file:  
     5471Defines the type of a file:  
    41095472\begin_inset Flex Strong 
    41105473status collapsed 
     
    41315494 
    41325495: one single global file is wrote using netcdf4 parallel access. 
    4133  This attribute is mandatory. 
    4134 \end_layout 
    4135  
    4136 \begin_layout Subsection* 
    4137 format:  
    4138 \emph on 
    4139 enumeration { netcdf4, netcdf4_classic } 
    4140 \end_layout 
    4141  
    4142 \begin_layout Standard 
    4143 Fortran: 
    4144 \end_layout 
    4145  
    4146 \begin_layout LyX-Code 
    4147 CHARACTER(LEN=*) :: type 
    4148 \end_layout 
    4149  
    4150 \begin_layout Standard 
    4151 Define the format of the file:  
     5496\end_layout 
     5497 
     5498\begin_layout Subsection* 
     5499format (optional):  
     5500\emph on 
     5501enumeration {netcdf4, netcdf4_classic} 
     5502\end_layout 
     5503 
     5504\begin_layout Standard 
     5505Fortran: 
     5506\end_layout 
     5507 
     5508\begin_layout LyX-Code 
     5509CHARACTER(LEN=*) :: format 
     5510\end_layout 
     5511 
     5512\begin_layout Standard 
     5513Define the format of a file:  
    41525514\begin_inset Flex Strong 
    41535515status collapsed 
     
    41785540 
    41795541: the classic NetCDF format will be used. 
    4180  The attribute is optional, the default value is  
     5542 The default value is  
    41815543\series bold 
    41825544\emph on 
     
    42105572 
    42115573\begin_layout Subsection* 
    4212 par_access:  
    4213 \emph on 
    4214 enumeration { collective, independent } 
     5574par_access (optional):  
     5575\emph on 
     5576enumeration {collective, independent} 
    42155577\end_layout 
    42165578 
     
    42245586 
    42255587\begin_layout Standard 
    4226 For parallel writing, define which type of MPI calls will be used. 
    4227  This attribute is optional, the default value is  
     5588For parallel writing, defines which type of MPI calls will be used. 
     5589 The default value is  
    42285590\begin_inset Flex Strong 
    42295591status collapsed 
     
    42415603 
    42425604\begin_layout Subsection* 
    4243 append:  
     5605read_metadata_par (optional):  
    42445606\emph on 
    42455607bool 
     
    42515613 
    42525614\begin_layout LyX-Code 
     5615LOGICAL :: read_metadata_par 
     5616\end_layout 
     5617 
     5618\begin_layout Standard 
     5619For files in the read mode, defines if parallel or serial I/O will be used 
     5620 by model processes for reading file metadata. 
     5621 The default value is false implying serial I/O for reading metadata. 
     5622\end_layout 
     5623 
     5624\begin_layout Subsection* 
     5625convention (optional):  
     5626\emph on 
     5627enumeration {CF, UGRID} 
     5628\end_layout 
     5629 
     5630\begin_layout Standard 
     5631Fortran: 
     5632\end_layout 
     5633 
     5634\begin_layout LyX-Code 
     5635CHARACTER(LEN=*) :: convention 
     5636\end_layout 
     5637 
     5638\begin_layout Standard 
     5639Defines the file conventions. 
     5640 By default the CF conventions are followed. 
     5641\end_layout 
     5642 
     5643\begin_layout Subsection* 
     5644convention_str (optional):  
     5645\emph on 
     5646string 
     5647\end_layout 
     5648 
     5649\begin_layout Standard 
     5650Fortran: 
     5651\end_layout 
     5652 
     5653\begin_layout LyX-Code 
     5654CHARACTER(LEN=*) :: convention_str 
     5655\end_layout 
     5656 
     5657\begin_layout Standard 
     5658Defines the  
     5659\series bold 
     5660Conventions  
     5661\series default 
     5662attribute to be added to file global attributes. 
     5663\end_layout 
     5664 
     5665\begin_layout Subsection* 
     5666append (optional):  
     5667\emph on 
     5668bool 
     5669\end_layout 
     5670 
     5671\begin_layout Standard 
     5672Fortran: 
     5673\end_layout 
     5674 
     5675\begin_layout LyX-Code 
    42535676LOGICAL :: append 
    42545677\end_layout 
    42555678 
    42565679\begin_layout Standard 
    4257 Define whether the output data is to be appended at the end of the file 
    4258  if it already exists or if the existing file is to be overwritten. 
    4259  This attribute is optional, the default value is  
     5680Defines 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. 
     5682 The default value is  
    42605683\begin_inset Flex Strong 
    42615684status collapsed 
     
    42735696 
    42745697\begin_layout Subsection* 
    4275 compression_level:  
     5698compression_level (optional):  
    42765699\emph on 
    42775700integer 
     
    42875710 
    42885711\begin_layout Standard 
    4289 Define whether the fields should be compressed using NetCDF-4 built-in compressi 
    4290 on by default. 
     5712Defines whether the fields should be compressed using NetCDF-4 built-in 
     5713 compression by default. 
    42915714 The compression level must range from 0 to 9. 
    4292  An higher compression level means a better compression at the cost of using 
     5715 A higher compression level means a better compression at the cost of using 
    42935716 more processing power. 
    4294  This attribute is optional, the default value is  
     5717 The default value is  
    42955718\begin_inset Flex Strong 
    42965719status collapsed 
     
    43085731 
    43095732\begin_layout Subsection* 
    4310 time_counter:  
    4311 \emph on 
    4312 enumeration { centered, instant, record, none } 
     5733time_counter (optional):  
     5734\emph on 
     5735enumeration {centered, instant, record, exclusive, centered_exclusive, instant_e 
     5736xclusive, none} 
    43135737\end_layout 
    43145738 
     
    43225746 
    43235747\begin_layout Standard 
    4324 Define how the  
     5748Defines how the  
    43255749\begin_inset Quotes eld 
    43265750\end_inset 
     
    43305754\end_inset 
    43315755 
    4332  variable will be outputted: 
     5756 variable will be output: 
    43335757\end_layout 
    43345758 
     
    43405764\series default 
    43415765\emph default 
    4342 : use centered times 
     5766: use centered times (default option for all field operations except for 
     5767 instant) 
    43435768\end_layout 
    43445769 
     
    43505775\series default 
    43515776\emph default 
    4352 : use instant times 
     5777: use instant times (default option for field operation  
     5778\series bold 
     5779instant 
     5780\series default 
     5781) 
    43535782\end_layout 
    43545783 
     
    43665795 
    43675796\series bold 
     5797\shape italic 
     5798centered_exclusive:  
     5799\series default 
     5800\shape default 
     5801do not include centered times into an output file 
     5802\end_layout 
     5803 
     5804\begin_layout Itemize 
     5805 
     5806\series bold 
     5807\shape italic 
     5808\emph on 
     5809instant_ 
     5810\emph default 
     5811exclusive:  
     5812\series default 
     5813\shape default 
     5814do not include instant times into an output file 
     5815\end_layout 
     5816 
     5817\begin_layout Itemize 
     5818 
     5819\series bold 
     5820\shape italic 
     5821exclusive:  
     5822\series default 
     5823\shape default 
     5824include neither instant times nor centered times into an output file 
     5825\end_layout 
     5826 
     5827\begin_layout Itemize 
     5828 
     5829\series bold 
    43685830\emph on 
    43695831none 
     
    43745836 
    43755837\begin_layout Standard 
    4376 This attribute is optional, the default value is  
     5838The default value is  
    43775839\series bold 
    43785840\emph on 
     
    43845846 
    43855847\begin_layout Subsection* 
    4386 time_counter_name:  
     5848time_counter_name (optional):  
    43875849\emph on 
    43885850string 
     
    43985860 
    43995861\begin_layout Standard 
    4400 Define the name of the time counter. 
    4401  This attribute is optional. 
    4402 \end_layout 
    4403  
    4404 \begin_layout Subsection* 
    4405 timeseries:  
    4406 \emph on 
    4407 enumeration { none, only, both, exclusive } 
     5862Define the name of a time counter. 
     5863\end_layout 
     5864 
     5865\begin_layout Subsection* 
     5866timeseries (optional):  
     5867\emph on 
     5868enumeration {none, only, both, exclusive} 
    44085869\end_layout 
    44095870 
     
    44175878 
    44185879\begin_layout Standard 
    4419 Define whether the timeseries must be outputted: 
     5880Defines whether the timeseries must be output: 
    44205881\end_layout 
    44215882 
     
    44275888\series default 
    44285889\emph default 
    4429 : no timeseries are outputted, only the regular file 
     5890: no timeseries is outputted, only the regular file 
    44305891\end_layout 
    44315892 
     
    44375898\series default 
    44385899\emph default 
    4439 : only the timeseries are outputted, the regular file is not created 
     5900: only the timeseries is outputted, the regular file is not created 
    44405901\end_layout 
    44415902 
     
    44575918\series default 
    44585919\emph default 
    4459 : the timeseries are outputted and a regular file is created with only the 
    4460  fields which were not marked for output as a timeserie (if any). 
    4461 \end_layout 
    4462  
    4463 \begin_layout Standard 
    4464 This attribute is optional, the default value is  
     5920: the timeseries is outputted and a regular file is created with only the 
     5921 fields which were not marked for output as a timeseries (if any). 
     5922\end_layout 
     5923 
     5924\begin_layout Standard 
     5925The default value is  
    44655926\series bold 
    44665927\emph on 
     
    44725933 
    44735934\begin_layout Subsection* 
    4474 ts_prefix:  
     5935ts_prefix (optional):  
    44755936\emph on 
    44765937string 
     
    44865947 
    44875948\begin_layout Standard 
    4488 Define the prefix to use for the name of the timeseries files. 
    4489  This attribute is optional, by default the file  
    4490 \series bold 
    4491 name 
    4492 \series default 
    4493  will be used. 
    4494 \end_layout 
    4495  
    4496 \begin_layout Subsection* 
    4497 record_offset:  
     5949Defines the prefix to use for the name of the timeseries files. 
     5950 By default the file name will be used. 
     5951\end_layout 
     5952 
     5953\begin_layout Subsection* 
     5954time_units (optional):  
     5955\emph on 
     5956enumeration {seconds, days} 
     5957\end_layout 
     5958 
     5959\begin_layout Standard 
     5960Fortran: 
     5961\end_layout 
     5962 
     5963\begin_layout LyX-Code 
     5964CHARACTER(LEN=*) :: time_units 
     5965\end_layout 
     5966 
     5967\begin_layout Subsection* 
     5968record_offset (optional):  
    44985969\emph on 
    44995970integer 
     
    45095980 
    45105981\begin_layout Standard 
    4511 Define offset of record from the beginning record. 
    4512  This attribute is optional, by default, its value is 0. 
     5982Defines the offset of a record from the beginning record. 
     5983 The default value is 0. 
     5984\end_layout 
     5985 
     5986\begin_layout Subsection* 
     5987cyclic (optional):  
     5988\emph on 
     5989bool 
     5990\end_layout 
     5991 
     5992\begin_layout Standard 
     5993Fortran: 
     5994\end_layout 
     5995 
     5996\begin_layout LyX-Code 
     5997LOGICAL :: cyclic 
     5998\end_layout 
     5999 
     6000\begin_layout Standard 
     6001If the option is activated for fields to be read, then upon reaching the 
     6002 last time record, reading will continue  
     6003\begin_inset Quotes eld 
     6004\end_inset 
     6005 
     6006cycle 
     6007\begin_inset Quotes erd 
     6008\end_inset 
     6009 
     6010 at the first time record. 
     6011 The default value is false. 
     6012\end_layout 
     6013 
     6014\begin_layout Subsection* 
     6015time_stamp_name (optional):  
     6016\begin_inset Flex Emph 
     6017status collapsed 
     6018 
     6019\begin_layout Plain Layout 
     6020string 
     6021\end_layout 
     6022 
     6023\end_inset 
     6024 
     6025 
     6026\end_layout 
     6027 
     6028\begin_layout Standard 
     6029Fortran:  
     6030\end_layout 
     6031 
     6032\begin_layout LyX-Code 
     6033CHARACTER(LEN=*) :: time_stamp_name 
     6034\end_layout 
     6035 
     6036\begin_layout Standard 
     6037Defines the timestamp name of the date and time when the program was executed 
     6038 which will be written into an output file. 
     6039 The default value is  
     6040\begin_inset Quotes eld 
     6041\end_inset 
     6042 
     6043timeStamp 
     6044\begin_inset Quotes erd 
     6045\end_inset 
     6046 
     6047. 
     6048\end_layout 
     6049 
     6050\begin_layout Subsection* 
     6051time_stamp_format (optional):  
     6052\begin_inset Flex Emph 
     6053status collapsed 
     6054 
     6055\begin_layout Plain Layout 
     6056string 
     6057\end_layout 
     6058 
     6059\end_inset 
     6060 
     6061 
     6062\end_layout 
     6063 
     6064\begin_layout Standard 
     6065Fortran:  
     6066\end_layout 
     6067 
     6068\begin_layout LyX-Code 
     6069CHARACTER(LEN=*) :: time_stamp_format 
     6070\end_layout 
     6071 
     6072\begin_layout Standard 
     6073Defines the timestamp format of the date and time when the program was executed 
     6074 to be written into an output file. 
     6075 It can contain any character. 
     6076  
     6077\emph on 
     6078 
     6079\begin_inset Flex Code 
     6080status collapsed 
     6081 
     6082\begin_layout Plain Layout 
     6083%Y 
     6084\end_layout 
     6085 
     6086\end_inset 
     6087 
     6088 
     6089\emph default 
     6090 will be replaced by the 4-digit year (4 digits), while  
     6091\emph on 
     6092 
     6093\begin_inset Flex Code 
     6094status collapsed 
     6095 
     6096\begin_layout Plain Layout 
     6097%y 
     6098\end_layout 
     6099 
     6100\end_inset 
     6101 
     6102 
     6103\emph default 
     6104 will be replaced by the 2-digit year. 
     6105  
     6106\begin_inset Flex Code 
     6107status collapsed 
     6108 
     6109\begin_layout Plain Layout 
     6110%m 
     6111\end_layout 
     6112 
     6113\end_inset 
     6114 
     6115 will be by the 2-digit month, while %b will be replaced by the 3-character 
     6116 month. 
     6117  
     6118\begin_inset Flex Code 
     6119status collapsed 
     6120 
     6121\begin_layout Plain Layout 
     6122%d 
     6123\end_layout 
     6124 
     6125\end_inset 
     6126 
     6127 will be replaced by the day (2 char),  
     6128\begin_inset Flex Code 
     6129status collapsed 
     6130 
     6131\begin_layout Plain Layout 
     6132%H 
     6133\end_layout 
     6134 
     6135\end_inset 
     6136 
     6137 by the hour (2 char),  
     6138\begin_inset Flex Code 
     6139status collapsed 
     6140 
     6141\begin_layout Plain Layout 
     6142%M 
     6143\end_layout 
     6144 
     6145\end_inset 
     6146 
     6147 by the minute (2 char),  
     6148\begin_inset Flex Code 
     6149status collapsed 
     6150 
     6151\begin_layout Plain Layout 
     6152%S 
     6153\end_layout 
     6154 
     6155\end_inset 
     6156 
     6157 by the number of seconds,  
     6158\begin_inset Flex Code 
     6159status collapsed 
     6160 
     6161\begin_layout Plain Layout 
     6162%D 
     6163\end_layout 
     6164 
     6165\end_inset 
     6166 
     6167 by the date in the MM/DD/YY format. 
     6168\end_layout 
     6169 
     6170\begin_layout Subsection* 
     6171uuid_name (optional):  
     6172\begin_inset Flex Emph 
     6173status collapsed 
     6174 
     6175\begin_layout Plain Layout 
     6176string 
     6177\end_layout 
     6178 
     6179\end_inset 
     6180 
     6181 
     6182\end_layout 
     6183 
     6184\begin_layout Standard 
     6185Fortran:  
     6186\end_layout 
     6187 
     6188\begin_layout LyX-Code 
     6189CHARACTER(LEN=*) :: uuid_name 
     6190\end_layout 
     6191 
     6192\begin_layout Standard 
     6193Defines the name of file's UUID. 
     6194\end_layout 
     6195 
     6196\begin_layout Subsection* 
     6197uuid_format (optional):  
     6198\begin_inset Flex Emph 
     6199status collapsed 
     6200 
     6201\begin_layout Plain Layout 
     6202string 
     6203\end_layout 
     6204 
     6205\end_inset 
     6206 
     6207 
     6208\end_layout 
     6209 
     6210\begin_layout Standard 
     6211Fortran:  
     6212\end_layout 
     6213 
     6214\begin_layout LyX-Code 
     6215CHARACTER(LEN=*) :: uuid_format 
     6216\end_layout 
     6217 
     6218\begin_layout Standard 
     6219Defines the format of file's UUID. 
     6220\end_layout 
     6221 
     6222\begin_layout Subsection* 
     6223comment (optional):  
     6224\begin_inset Flex Emph 
     6225status collapsed 
     6226 
     6227\begin_layout Plain Layout 
     6228string 
     6229\end_layout 
     6230 
     6231\end_inset 
     6232 
     6233 
     6234\end_layout 
     6235 
     6236\begin_layout Standard 
     6237Fortran:  
     6238\end_layout 
     6239 
     6240\begin_layout LyX-Code 
     6241CHARACTER(LEN=*) :: comment 
     6242\end_layout 
     6243 
     6244\begin_layout Standard 
     6245Allows a user to set a comment. 
    45136246\end_layout 
    45146247 
     
    45186251 
    45196252\begin_layout Subsection 
     6253reduce_scalar_to_scalar 
     6254\end_layout 
     6255 
     6256\begin_layout Subsection* 
     6257operation (mandatory):  
     6258\emph on 
     6259enumeration {min, max, sum, average} 
     6260\end_layout 
     6261 
     6262\begin_layout Standard 
     6263Fortran: 
     6264\end_layout 
     6265 
     6266\begin_layout LyX-Code 
     6267CHARACTER(LEN=*) :: operation 
     6268\end_layout 
     6269 
     6270\begin_layout Standard 
     6271Defines a reduction operation performed on a scalar across model processes. 
     6272 (It is analogous to MPI_Allreduce.) 
     6273\end_layout 
     6274 
     6275\begin_layout Subsection 
     6276extract_axis_to_scalar 
     6277\end_layout 
     6278 
     6279\begin_layout Subsection* 
     6280position:  
     6281\emph on 
     6282integer 
     6283\end_layout 
     6284 
     6285\begin_layout Standard 
     6286Fortran:  
     6287\end_layout 
     6288 
     6289\begin_layout LyX-Code 
     6290INTEGER :: position 
     6291\end_layout 
     6292 
     6293\begin_layout Standard 
     6294Global index of a point on an axis to be extracted into a scalar. 
     6295\end_layout 
     6296 
     6297\begin_layout Standard 
     6298 
     6299\end_layout 
     6300 
     6301\begin_layout Subsection 
    45206302interpolate_axis 
    45216303\end_layout 
    45226304 
    45236305\begin_layout Subsection* 
    4524 type:  
     6306type (optional):  
    45256307\emph on 
    45266308string 
     
    45366318 
    45376319\begin_layout Standard 
    4538 Define the type of interpolation on an axis. 
    4539  This attribute is optional. 
    4540 \end_layout 
    4541  
    4542 \begin_layout Subsection* 
    4543 order:  
     6320Defines the interpolation type on an axis. 
     6321 For now only polynomial interpolation is available. 
     6322\end_layout 
     6323 
     6324\begin_layout Subsection* 
     6325order (optional):  
    45446326\emph on 
    45456327integer 
     
    45556337 
    45566338\begin_layout Standard 
    4557 Define a order of interpolation. 
    4558  This attribute is optional. 
     6339Defines the order of interpolation. 
    45596340 The default value is 2. 
    45606341\end_layout 
    45616342 
     6343\begin_layout Subsection* 
     6344coordinate (optional):  
     6345\emph on 
     6346string 
     6347\end_layout 
     6348 
     6349\begin_layout Standard 
     6350Fortran: 
     6351\end_layout 
     6352 
     6353\begin_layout LyX-Code 
     6354CHARACTER(LEN=*) :: coordinate 
     6355\end_layout 
     6356 
     6357\begin_layout Standard 
     6358Defines the coordinate associated with an axis on which interpolation will 
     6359 be performed. 
     6360\end_layout 
     6361 
    45626362\begin_layout Subsection 
    4563 inverse_axis 
     6363reduce_axis_to_axis 
     6364\end_layout 
     6365 
     6366\begin_layout Subsection* 
     6367operation (mandatory):  
     6368\emph on 
     6369enumeration {min, max, sum, average} 
     6370\end_layout 
     6371 
     6372\begin_layout Standard 
     6373Fortran: 
     6374\end_layout 
     6375 
     6376\begin_layout LyX-Code 
     6377CHARACTER(LEN=*) :: operation 
     6378\end_layout 
     6379 
     6380\begin_layout Standard 
     6381Defines a reduction operation performed on an axis across model processes. 
     6382 (It is analogous to MPI_Allreduce.) 
     6383\end_layout 
     6384 
     6385\begin_layout Subsection 
     6386reduce_axis_to_scalar 
     6387\end_layout 
     6388 
     6389\begin_layout Standard 
     6390Reduces data defined on an axis into a scalar value. 
     6391\end_layout 
     6392 
     6393\begin_layout Subsection* 
     6394operation (mandatory):  
     6395\emph on 
     6396enumeration {min, max, sum, average} 
     6397\end_layout 
     6398 
     6399\begin_layout Standard 
     6400Fortran: 
     6401\end_layout 
     6402 
     6403\begin_layout LyX-Code 
     6404CHARACTER(LEN=*) :: operation 
    45646405\end_layout 
    45656406 
     
    45696410 
    45706411\begin_layout Subsection* 
    4571 begin:  
     6412begin (optional):  
    45726413\begin_inset Flex Emph 
    45736414status collapsed 
     
    45916432 
    45926433\begin_layout Standard 
    4593 Define the begining index of the zoomed region on global axis. 
    4594  This attribute is optional. 
    4595  This must be an integer between  
     6434Defines the beginning index of a zoomed region on a global axis. 
     6435 The attribute value should be an integer between  
    45966436\begin_inset Flex Strong 
    45976437status collapsed 
     
    46096449\begin_layout Plain Layout 
    46106450ni_glo-1 
    4611 \end_layout 
    4612  
    4613 \end_inset 
    4614  
    4615  of associated axis. 
    4616  If not specified the default value is  
    4617 \begin_inset Flex Strong 
    4618 status collapsed 
    4619  
    4620 \begin_layout Plain Layout 
    4621 0 
    4622 \end_layout 
    4623  
    4624 \end_inset 
    4625  
    4626 . 
    4627 \end_layout 
    4628  
    4629 \begin_layout Subsection* 
    4630 n:  
    4631 \begin_inset Flex Emph 
    4632 status collapsed 
    4633  
    4634 \begin_layout Plain Layout 
    4635 integer 
    4636 \end_layout 
    4637  
    4638 \end_inset 
    4639  
    4640  
    4641 \end_layout 
    4642  
    4643 \begin_layout Standard 
    4644 Fortran: 
    4645 \end_layout 
    4646  
    4647 \begin_layout LyX-Code 
    4648 INTEGER :: n 
    4649 \end_layout 
    4650  
    4651 \begin_layout Standard 
    4652 Define the size of zoomed region on global axis. 
    4653  This attribute is optional. 
    4654  This must be an integer between  
    4655 \begin_inset Flex Strong 
    4656 status collapsed 
    4657  
    4658 \begin_layout Plain Layout 
    4659 1 
    4660 \end_layout 
    4661  
    4662 \end_inset 
    4663  
    4664 and  
    4665 \begin_inset Flex Strong 
    4666 status collapsed 
    4667  
    4668 \begin_layout Plain Layout 
    4669 nj_glo 
    46706451\end_layout 
    46716452 
     
    46786459 
    46796460\begin_layout Plain Layout 
     64610 
     6462\end_layout 
     6463 
     6464\end_inset 
     6465 
     6466. 
     6467\end_layout 
     6468 
     6469\begin_layout Subsection* 
     6470n (optional):  
     6471\begin_inset Flex Emph 
     6472status collapsed 
     6473 
     6474\begin_layout Plain Layout 
     6475integer 
     6476\end_layout 
     6477 
     6478\end_inset 
     6479 
     6480 
     6481\end_layout 
     6482 
     6483\begin_layout Standard 
     6484Fortran: 
     6485\end_layout 
     6486 
     6487\begin_layout LyX-Code 
     6488INTEGER :: n 
     6489\end_layout 
     6490 
     6491\begin_layout Standard 
     6492Defines the size of a zoomed region on a global axis. 
     6493 The attribute value should be an integer between  
     6494\begin_inset Flex Strong 
     6495status collapsed 
     6496 
     6497\begin_layout Plain Layout 
     64981 
     6499\end_layout 
     6500 
     6501\end_inset 
     6502 
     6503and  
     6504\begin_inset Flex Strong 
     6505status collapsed 
     6506 
     6507\begin_layout Plain Layout 
    46806508nj_glo 
    46816509\end_layout 
     
    46846512 
    46856513 of the associated axis. 
     6514 If not specified the default value is  
     6515\begin_inset Flex Strong 
     6516status collapsed 
     6517 
     6518\begin_layout Plain Layout 
     6519nj_glo 
     6520\end_layout 
     6521 
     6522\end_inset 
     6523 
     6524 of the associated axis. 
     6525\end_layout 
     6526 
     6527\begin_layout Subsection 
     6528compute_connectivity_domain 
     6529\end_layout 
     6530 
     6531\begin_layout Subsection* 
     6532n_neighbor:  
     6533\begin_inset Flex Emph 
     6534status collapsed 
     6535 
     6536\begin_layout Plain Layout 
     65371D-array of integer 
     6538\end_layout 
     6539 
     6540\end_inset 
     6541 
     6542 
     6543\end_layout 
     6544 
     6545\begin_layout Standard 
     6546Fortran:  
     6547\end_layout 
     6548 
     6549\begin_layout LyX-Code 
     6550INTEGER :: n_neighbor(:) 
     6551\end_layout 
     6552 
     6553\begin_layout Subsection* 
     6554local_neighbor:  
     6555\begin_inset Flex Emph 
     6556status collapsed 
     6557 
     6558\begin_layout Plain Layout 
     65592D-array of integer 
     6560\end_layout 
     6561 
     6562\end_inset 
     6563 
     6564 
     6565\end_layout 
     6566 
     6567\begin_layout Standard 
     6568Fortran:  
     6569\end_layout 
     6570 
     6571\begin_layout LyX-Code 
     6572INTEGER :: local_neighbor(:,:) 
     6573\end_layout 
     6574 
     6575\begin_layout Subsection* 
     6576n_neighbor_max:  
     6577\begin_inset Flex Emph 
     6578status collapsed 
     6579 
     6580\begin_layout Plain Layout 
     6581integer 
     6582\end_layout 
     6583 
     6584\end_inset 
     6585 
     6586 
     6587\end_layout 
     6588 
     6589\begin_layout Standard 
     6590Fortran: 
     6591\end_layout 
     6592 
     6593\begin_layout LyX-Code 
     6594INTEGER :: n_neighbor_max 
     6595\end_layout 
     6596 
     6597\begin_layout Subsection 
     6598extract_domain_to_axis 
     6599\end_layout 
     6600 
     6601\begin_layout Subsection* 
     6602position (optional):  
     6603\emph on 
     6604integer 
     6605\end_layout 
     6606 
     6607\begin_layout Standard 
     6608Fortran:  
     6609\end_layout 
     6610 
     6611\begin_layout LyX-Code 
     6612INTEGER :: position 
     6613\end_layout 
     6614 
     6615\begin_layout Standard 
     6616Defines the index on a domain starting which an axis will be extracted along 
     6617 the direction specified with the  
     6618\series bold 
     6619direction 
     6620\series default 
     6621 attribute. 
     6622\end_layout 
     6623 
     6624\begin_layout Subsection* 
     6625direction (mandatory):  
     6626\emph on 
     6627enumeration {iDir, jDir} 
     6628\end_layout 
     6629 
     6630\begin_layout Standard 
     6631Fortran: 
     6632\end_layout 
     6633 
     6634\begin_layout LyX-Code 
     6635CHARACTER(LEN=*) :: direction 
     6636\end_layout 
     6637 
     6638\begin_layout Standard 
     6639Defines the domain dimension along which an axis will be extracted. 
    46866640\end_layout 
    46876641 
     
    46916645 
    46926646\begin_layout Subsection* 
    4693 file:  
     6647file (optional):  
    46946648\emph on 
    46956649string 
     
    47056659 
    47066660\begin_layout Standard 
    4707 Define the file which contains the weight value to interpolate from domain 
     6661Define a file which contains the weight values for interpolation from domain 
    47086662 source to domain destination. 
    4709  This attribute is optional. 
    47106663 If not specified, the internal interpolation module will be used. 
    47116664\end_layout 
    47126665 
    47136666\begin_layout Subsection* 
     6667order (optional):  
     6668\emph on 
     6669integer 
     6670\end_layout 
     6671 
     6672\begin_layout Standard 
     6673Fortran:  
     6674\end_layout 
     6675 
     6676\begin_layout LyX-Code 
     6677INTEGER :: order 
     6678\end_layout 
     6679 
     6680\begin_layout Standard 
     6681Defines the order of interpolation. 
     6682 This attribute is only for internal interpolation module. 
     6683 The default value is 2. 
     6684\end_layout 
     6685 
     6686\begin_layout Subsection 
     6687reduce_domain_to_axis 
     6688\end_layout 
     6689 
     6690\begin_layout Subsection* 
     6691direction:  
     6692\emph on 
     6693enumeration {iDir, jDir} 
     6694\end_layout 
     6695 
     6696\begin_layout Standard 
     6697Fortran: 
     6698\end_layout 
     6699 
     6700\begin_layout LyX-Code 
     6701CHARACTER(LEN=*) :: direction 
     6702\end_layout 
     6703 
     6704\begin_layout Standard 
     6705Defines the domain dimension along which a reduction of the domain into 
     6706 an axis will be performed. 
     6707\end_layout 
     6708 
     6709\begin_layout Subsection* 
     6710operation (mandatory):  
     6711\emph on 
     6712enumeration {min, max, sum, average} 
     6713\end_layout 
     6714 
     6715\begin_layout Standard 
     6716Fortran: 
     6717\end_layout 
     6718 
     6719\begin_layout LyX-Code 
     6720CHARACTER(LEN=*) :: operation 
     6721\end_layout 
     6722 
     6723\begin_layout Subsection* 
     6724local:  
     6725\emph on 
     6726bool 
     6727\end_layout 
     6728 
     6729\begin_layout Standard 
     6730Fortran: 
     6731\end_layout 
     6732 
     6733\begin_layout LyX-Code 
     6734LOGICAL :: local 
     6735\end_layout 
     6736 
     6737\begin_layout Standard 
     6738Defines whether the reduction should be performed locally on data owned 
     6739 by each process. 
     6740\end_layout 
     6741 
     6742\begin_layout Subsection 
     6743reduce_domain_to_scalar 
     6744\end_layout 
     6745 
     6746\begin_layout Standard 
     6747Reduces data defined on a domain into a scalar value. 
     6748\end_layout 
     6749 
     6750\begin_layout Subsection* 
     6751operation (mandatory):  
     6752\emph on 
     6753enumeration {min, max, sum, average} 
     6754\end_layout 
     6755 
     6756\begin_layout Standard 
     6757Fortran: 
     6758\end_layout 
     6759 
     6760\begin_layout LyX-Code 
     6761CHARACTER(LEN=*) :: operation 
     6762\end_layout 
     6763 
     6764\begin_layout Subsection* 
     6765local:  
     6766\emph on 
     6767bool 
     6768\end_layout 
     6769 
     6770\begin_layout Standard 
     6771Fortran: 
     6772\end_layout 
     6773 
     6774\begin_layout LyX-Code 
     6775LOGICAL :: local 
     6776\end_layout 
     6777 
     6778\begin_layout Standard 
     6779Defines whether the reduction should be performed locally on data owned 
     6780 by each process. 
     6781\end_layout 
     6782 
     6783\begin_layout Subsection 
     6784reorder_domain 
     6785\end_layout 
     6786 
     6787\begin_layout Subsection* 
     6788invert_lat (optional):  
     6789\emph on 
     6790bool 
     6791\end_layout 
     6792 
     6793\begin_layout Standard 
     6794Fortran: 
     6795\end_layout 
     6796 
     6797\begin_layout LyX-Code 
     6798LOGICAL :: invert_lat 
     6799\end_layout 
     6800 
     6801\begin_layout Standard 
     6802Defines whether the latitude should be inverted. 
     6803 The default value is false. 
     6804\end_layout 
     6805 
     6806\begin_layout Subsection* 
     6807shift_lon_fraction (optional):  
     6808\begin_inset Flex Emph 
     6809status collapsed 
     6810 
     6811\begin_layout Plain Layout 
     6812double 
     6813\end_layout 
     6814 
     6815\end_inset 
     6816 
     6817 
     6818\end_layout 
     6819 
     6820\begin_layout Standard 
     6821Fortran:  
     6822\end_layout 
     6823 
     6824\begin_layout LyX-Code 
     6825DOUBLE PRECISION :: shift_lon_fraction 
     6826\end_layout 
     6827 
     6828\begin_layout Standard 
     6829Defines the longitude offset. 
     6830 The value of the parameter represents a fraction of  
     6831\series bold 
     6832ni_glo 
     6833\series default 
     6834. 
     6835\end_layout 
     6836 
     6837\begin_layout Subsection* 
     6838min_lon (optional):  
     6839\begin_inset Flex Emph 
     6840status collapsed 
     6841 
     6842\begin_layout Plain Layout 
     6843double 
     6844\end_layout 
     6845 
     6846\end_inset 
     6847 
     6848 
     6849\end_layout 
     6850 
     6851\begin_layout Standard 
     6852Fortran:  
     6853\end_layout 
     6854 
     6855\begin_layout LyX-Code 
     6856DOUBLE PRECISION :: min_lon 
     6857\end_layout 
     6858 
     6859\begin_layout Standard 
     6860If both,  
     6861\series bold 
     6862min_lon 
     6863\series default 
     6864 and  
     6865\series bold 
     6866max_lon 
     6867\series default 
     6868, are defined, a domain will be reordered with latitude values starting 
     6869 from  
     6870\series bold 
     6871min_lon 
     6872\series default 
     6873 and ending at  
     6874\series bold 
     6875max_lon 
     6876\series default 
     6877. 
     6878\end_layout 
     6879 
     6880\begin_layout Subsection* 
     6881max_lon (optional):  
     6882\begin_inset Flex Emph 
     6883status collapsed 
     6884 
     6885\begin_layout Plain Layout 
     6886double 
     6887\end_layout 
     6888 
     6889\end_inset 
     6890 
     6891 
     6892\end_layout 
     6893 
     6894\begin_layout Standard 
     6895Fortran:  
     6896\end_layout 
     6897 
     6898\begin_layout LyX-Code 
     6899DOUBLE PRECISION :: max_lon 
     6900\end_layout 
     6901 
     6902\begin_layout Standard 
     6903If both,  
     6904\series bold 
     6905min_lon 
     6906\series default 
     6907 and  
     6908\series bold 
     6909max_lon 
     6910\series default 
     6911, are defined, a domain will be reordered with latitude values starting 
     6912 from  
     6913\series bold 
     6914min_lon 
     6915\series default 
     6916 and ending at  
     6917\series bold 
     6918max_lon 
     6919\series default 
     6920. 
     6921\end_layout 
     6922 
     6923\begin_layout Subsection 
     6924expand_domain 
     6925\end_layout 
     6926 
     6927\begin_layout Subsection* 
    47146928order:  
    4715 \emph on 
     6929\begin_inset Flex Emph 
     6930status collapsed 
     6931 
     6932\begin_layout Plain Layout 
    47166933integer 
    47176934\end_layout 
    47186935 
    4719 \begin_layout Standard 
    4720 Fortran:  
     6936\end_inset 
     6937 
     6938 
     6939\end_layout 
     6940 
     6941\begin_layout Standard 
     6942Fortran: 
    47216943\end_layout 
    47226944 
     
    47256947\end_layout 
    47266948 
    4727 \begin_layout Standard 
    4728 Define a order of interpolation. 
    4729  This attribute is only for internal interoplation module. 
    4730  This attribute is optional. 
    4731  The default value is 2. 
     6949\begin_layout Subsection* 
     6950type (optional):  
     6951\emph on 
     6952enumeration {node, edge} 
     6953\end_layout 
     6954 
     6955\begin_layout Standard 
     6956Fortran: 
     6957\end_layout 
     6958 
     6959\begin_layout LyX-Code 
     6960CHARACTER(LEN=*) :: type 
     6961\end_layout 
     6962 
     6963\begin_layout Standard 
     6964Defines whether the node or edge connectivity should be calculated for the 
     6965 expanded domain. 
     6966\end_layout 
     6967 
     6968\begin_layout Subsection* 
     6969i_periodic (optional):  
     6970\emph on 
     6971bool 
     6972\end_layout 
     6973 
     6974\begin_layout Standard 
     6975Fortran: 
     6976\end_layout 
     6977 
     6978\begin_layout LyX-Code 
     6979LOGICAL :: i_periodic 
     6980\end_layout 
     6981 
     6982\begin_layout Standard 
     6983If the attribute value is true, values of fields defined on the expanded 
     6984 domain will be duplicated from those of the original domain periodically 
     6985 along the first dimension. 
     6986 The default value is false (masked values on the expanded domain). 
     6987\end_layout 
     6988 
     6989\begin_layout Subsection* 
     6990j_periodic (optional):  
     6991\emph on 
     6992bool 
     6993\end_layout 
     6994 
     6995\begin_layout Standard 
     6996Fortran: 
     6997\end_layout 
     6998 
     6999\begin_layout LyX-Code 
     7000LOGICAL :: j_periodic 
     7001\end_layout 
     7002 
     7003\begin_layout Standard 
     7004If the attribute value is true, values of fields defined on the expanded 
     7005 domain will be duplicated from those of the original domain periodically 
     7006 along the second dimension. 
     7007 The default value is false (masked values on the expanded domain). 
    47327008\end_layout 
    47337009 
     
    47377013 
    47387014\begin_layout Subsection* 
    4739 ibegin:  
     7015ibegin (optional):  
    47407016\begin_inset Flex Emph 
    47417017status collapsed 
     
    47597035 
    47607036\begin_layout Standard 
    4761 Define the begining index of the zoomed region on the first dimension of 
    4762  the global domain. 
    4763  This attribute is optional. 
     7037Defines the beginning index of the zoomed region on the first dimension 
     7038 of the global domain. 
    47647039 This must be an integer between  
    47657040\begin_inset Flex Strong 
     
    47947069 
    47957070. 
    4796 \end_layout 
    4797  
    4798 \begin_layout Subsection* 
    4799 ni:  
     7071 Note that if one of the zoom attributes (ibegin, ni, jbegin or nj) is defined 
     7072 then all the rest should be specified by a user as well. 
     7073\end_layout 
     7074 
     7075\begin_layout Subsection* 
     7076ni (optional):  
    48007077\begin_inset Flex Emph 
    48017078status collapsed 
     
    48207097\begin_layout Standard 
    48217098Define the size of zoomed region on the first dimension of the global domain. 
    4822  This attribute is optional. 
    48237099 This must be an integer between  
    48247100\begin_inset Flex Strong 
     
    48537129 
    48547130 of the dimension of domain. 
    4855 \end_layout 
    4856  
    4857 \begin_layout Subsection* 
    4858 jbegin:  
     7131 Note that if one of the zoom attributes (ibegin, ni, jbegin or nj) is defined 
     7132 then all the rest should be specified by a user as well. 
     7133\end_layout 
     7134 
     7135\begin_layout Subsection* 
     7136jbegin (optional):  
    48597137\begin_inset Flex Emph 
    48607138status collapsed 
     
    48787156 
    48797157\begin_layout Standard 
    4880 Define the begining index of the zoomed region on the second dimension of 
    4881  the global domain. 
    4882  This attribute is optional. 
     7158Define the beginning index of the zoomed region on the second dimension 
     7159 of the global domain. 
    48837160 This must be an integer between  
    48847161\begin_inset Flex Strong 
     
    49137190 
    49147191. 
    4915 \end_layout 
    4916  
    4917 \begin_layout Subsection* 
    4918 nj:  
     7192 Note that if one of the zoom attributes (ibegin, ni, jbegin or nj) is defined 
     7193 then all the rest should be specified by a user as well. 
     7194\end_layout 
     7195 
     7196\begin_layout Subsection* 
     7197nj (optional):  
    49197198\begin_inset Flex Emph 
    49207199status collapsed 
     
    49397218\begin_layout Standard 
    49407219Define the size of zoomed region on the second dimension of the global domain. 
    4941  This attribute is optional. 
    4942  This must be an integer between  
     7220 The attribute value should be an integer between  
    49437221\begin_inset Flex Strong 
    49447222status collapsed 
     
    49727250 
    49737251 of the dimension of domain. 
     7252 Note that if one of the zoom attributes (ibegin, ni, jbegin or nj) is defined 
     7253 then all the rest should be specified by a user as well. 
    49747254\end_layout 
    49757255 
     
    49787258\end_layout 
    49797259 
    4980 \begin_layout Standard 
    4981  
     7260\begin_layout Subsection* 
     7261lon_start (optional):  
     7262\begin_inset Flex Emph 
     7263status collapsed 
     7264 
     7265\begin_layout Plain Layout 
     7266double 
     7267\end_layout 
     7268 
     7269\end_inset 
     7270 
     7271 
     7272\end_layout 
     7273 
     7274\begin_layout Standard 
     7275Fortran:  
     7276\end_layout 
     7277 
     7278\begin_layout LyX-Code 
     7279DOUBLE PRECISION :: lon_start 
     7280\end_layout 
     7281 
     7282\begin_layout Standard 
     7283Along with  
     7284\series bold 
     7285lon_end 
     7286\series default 
     7287, the attribute defines the longitude range of a generated domain. 
     7288\end_layout 
     7289 
     7290\begin_layout Subsection* 
     7291lon_end (optional):  
     7292\begin_inset Flex Emph 
     7293status collapsed 
     7294 
     7295\begin_layout Plain Layout 
     7296double 
     7297\end_layout 
     7298 
     7299\end_inset 
     7300 
     7301 
     7302\end_layout 
     7303 
     7304\begin_layout Standard 
     7305Fortran:  
     7306\end_layout 
     7307 
     7308\begin_layout LyX-Code 
     7309DOUBLE PRECISION :: lon_end 
     7310\end_layout 
     7311 
     7312\begin_layout Standard 
     7313Along with  
     7314\series bold 
     7315lon_start 
     7316\series default 
     7317, the attribute defines the longitude range of a generated domain. 
     7318\end_layout 
     7319 
     7320\begin_layout Subsection* 
     7321lat_start (optional):  
     7322\begin_inset Flex Emph 
     7323status collapsed 
     7324 
     7325\begin_layout Plain Layout 
     7326double 
     7327\end_layout 
     7328 
     7329\end_inset 
     7330 
     7331 
     7332\end_layout 
     7333 
     7334\begin_layout Standard 
     7335Fortran:  
     7336\end_layout 
     7337 
     7338\begin_layout LyX-Code 
     7339DOUBLE PRECISION :: lat_start 
     7340\end_layout 
     7341 
     7342\begin_layout Standard 
     7343Along with  
     7344\series bold 
     7345lat_end 
     7346\series default 
     7347, the attribute defines the latitude range of a generated domain. 
     7348\end_layout 
     7349 
     7350\begin_layout Subsection* 
     7351lat_end (optional):  
     7352\begin_inset Flex Emph 
     7353status collapsed 
     7354 
     7355\begin_layout Plain Layout 
     7356double 
     7357\end_layout 
     7358 
     7359\end_inset 
     7360 
     7361 
     7362\end_layout 
     7363 
     7364\begin_layout Standard 
     7365Fortran:  
     7366\end_layout 
     7367 
     7368\begin_layout LyX-Code 
     7369DOUBLE PRECISION :: lat_end 
     7370\end_layout 
     7371 
     7372\begin_layout Standard 
     7373Along with  
     7374\series bold 
     7375lat_start 
     7376\series default 
     7377, the attribute defines the latitude range of a generated domain. 
     7378\end_layout 
     7379 
     7380\begin_layout Subsection* 
     7381bounds_lon_start:  
     7382\begin_inset Flex Emph 
     7383status collapsed 
     7384 
     7385\begin_layout Plain Layout 
     7386double 
     7387\end_layout 
     7388 
     7389\end_inset 
     7390 
     7391 
     7392\end_layout 
     7393 
     7394\begin_layout Standard 
     7395Fortran:  
     7396\end_layout 
     7397 
     7398\begin_layout LyX-Code 
     7399DOUBLE PRECISION :: bounds_lon_start 
     7400\end_layout 
     7401 
     7402\begin_layout Standard 
     7403Attributes  
     7404\series bold 
     7405bounds_lon_start 
     7406\series default 
     7407 and  
     7408\series bold 
     7409bounds_lon_start 
     7410\series default 
     7411 set the longitude range of a generated domain. 
     7412 If both sets,  
     7413\series bold 
     7414(lon_start, lon_end) 
     7415\series default 
     7416 and  
     7417\series bold 
     7418(bounds_lon_start, bounds_lon_end) 
     7419\series default 
     7420, are specified then the bound attributes will be ignored. 
     7421\end_layout 
     7422 
     7423\begin_layout Subsection* 
     7424bounds_lon_end:  
     7425\begin_inset Flex Emph 
     7426status collapsed 
     7427 
     7428\begin_layout Plain Layout 
     7429double 
     7430\end_layout 
     7431 
     7432\end_inset 
     7433 
     7434 
     7435\end_layout 
     7436 
     7437\begin_layout Standard 
     7438Fortran:  
     7439\end_layout 
     7440 
     7441\begin_layout LyX-Code 
     7442DOUBLE PRECISION :: bounds_lon_end 
     7443\end_layout 
     7444 
     7445\begin_layout Standard 
     7446Attributes  
     7447\series bold 
     7448bounds_lon_start 
     7449\series default 
     7450 and  
     7451\series bold 
     7452bounds_lon_start 
     7453\series default 
     7454 set the longitude range of a generated domain. 
     7455 If both sets,  
     7456\series bold 
     7457(lon_start, lon_end) 
     7458\series default 
     7459 and  
     7460\series bold 
     7461(bounds_lon_start, bounds_lon_end) 
     7462\series default 
     7463, are specified then the bound attributes will be ignored. 
     7464\end_layout 
     7465 
     7466\begin_layout Subsection* 
     7467bounds_lat_start:  
     7468\begin_inset Flex Emph 
     7469status collapsed 
     7470 
     7471\begin_layout Plain Layout 
     7472double 
     7473\end_layout 
     7474 
     7475\end_inset 
     7476 
     7477 
     7478\end_layout 
     7479 
     7480\begin_layout Standard 
     7481Fortran:  
     7482\end_layout 
     7483 
     7484\begin_layout LyX-Code 
     7485DOUBLE PRECISION :: bounds_lat_start 
     7486\end_layout 
     7487 
     7488\begin_layout Standard 
     7489Attributes  
     7490\series bold 
     7491bounds_lat_start 
     7492\series default 
     7493 and  
     7494\series bold 
     7495bounds_lat_start 
     7496\series default 
     7497 set the latitude range of a generated domain. 
     7498 If both sets,  
     7499\series bold 
     7500(lat_start, lat_end) 
     7501\series default 
     7502 and  
     7503\series bold 
     7504(bounds_lat_start, bounds_lat_end) 
     7505\series default 
     7506, are specified then the bound attributes will be ignored. 
     7507\end_layout 
     7508 
     7509\begin_layout Subsection* 
     7510bounds_lat_end:  
     7511\begin_inset Flex Emph 
     7512status collapsed 
     7513 
     7514\begin_layout Plain Layout 
     7515double 
     7516\end_layout 
     7517 
     7518\end_inset 
     7519 
     7520 
     7521\end_layout 
     7522 
     7523\begin_layout Standard 
     7524Fortran:  
     7525\end_layout 
     7526 
     7527\begin_layout LyX-Code 
     7528DOUBLE PRECISION :: bounds_lat_end 
     7529\end_layout 
     7530 
     7531\begin_layout Standard 
     7532Attributes  
     7533\series bold 
     7534bounds_lat_start 
     7535\series default 
     7536 and  
     7537\series bold 
     7538bounds_lat_start 
     7539\series default 
     7540 set the latitude range of a generated domain. 
     7541 If both sets,  
     7542\series bold 
     7543(lat_start, lat_end) 
     7544\series default 
     7545 and  
     7546\series bold 
     7547(bounds_lat_start, bounds_lat_end) 
     7548\series default 
     7549, are specified then the bound attributes will be ignored. 
    49827550\end_layout 
    49837551 
     
    55218089 
    55228090\begin_layout Standard 
    5523 This set of subroutines enable the models to interact, complete or query 
     8091This set of subroutines enables the models to interact, complete or query 
    55248092 the XML tree data base. 
    55258093 New elements or group of elements can be added as child in the tree, attributes 
    55268094 of the elements can be set or query. 
    5527  The type of element actually available are: context, axis, domain, grid, 
     8095 The type of elements currently available are: context, axis, domain, grid, 
    55288096 field, variable and file. 
    55298097 An element can be identified by a string or by an handle associated to 
     
    57028270 
    57038271\begin_layout Standard 
    5704 where element is one of the existing element or group of element. 
     8272where element is one of the existing elements or group of elements. 
    57058273\end_layout 
    57068274 
     
    57408308 
    57418309\begin_layout Standard 
    5742 This subroutine return the handle of the specified element identified by 
     8310This subroutine returns the handle of the specified element identified by 
    57438311 its string. 
    5744  The element must be existing otherwise it raise an error. 
     8312 The element must be existing otherwise an error is raised. 
    57458313\end_layout 
    57468314 
     
    57628330 
    57638331\begin_layout Standard 
    5764 where element is one of the existing element or group of element. 
     8332where element is one of the existing elements or group of elements. 
    57658333\end_layout 
    57668334 
     
    57878355 
    57888356\begin_layout Standard 
    5789 This function return .TRUE. 
    5790  if the element defined by the string identifier id is existing in the data 
    5791  base, otherwise it return .FALSE. 
     8357This function returns .TRUE. 
     8358 if the element defined by the string identifier  
     8359\begin_inset Quotes eld 
     8360\end_inset 
     8361 
     8362id 
     8363\begin_inset Quotes erd 
     8364\end_inset 
     8365 
     8366 exists in the data base, otherwise it returns .FALSE. 
    57928367 . 
    57938368\end_layout 
     
    58188393 
    58198394\begin_layout Standard 
    5820 where element is one of the existing element or group of element. 
     8395where element is one of the existing elements or element groups. 
    58218396\end_layout 
    58228397 
     
    58698444 
    58708445\begin_layout Standard 
    5871 This subroutine add a child to an existing parent element. 
     8446This subroutine adds a child to an existing parent element. 
    58728447 The identifier of the child, if existing, can be specified optionally. 
    5873  All group elements can contains child of the same kind, provided generic 
     8448 All group elements can contain child of the same type, provided generic 
    58748449 inheritance. 
    5875  Some elements can contains children of an other kind for a specific behaviour. 
    5876  File element may contains field_group, field, variable and variable_group 
     8450 Some elements can contain children of another type for a specific behavior. 
     8451 File element may contain field_group, field, variable and variable_group 
    58778452 child elements. 
    5878  Field elements may contains variable_group of variable child element. 
    5879 \end_layout 
    5880  
    5881 \begin_layout Subsection* 
    5882 Query if a value of an element attributes is defined (by handle) 
     8453 Field elements may contain variable_group of variable child element. 
     8454\end_layout 
     8455 
     8456\begin_layout Subsection* 
     8457Query if the value of an element attribute is defined (by handle) 
    58838458\end_layout 
    58848459 
     
    59098484 
    59108485\begin_layout Standard 
    5911 where element is one of the existing element or group of element. 
     8486where element is one of the existing elements or element groups. 
    59128487 attribute_x is describing in the chapter dedicated to the attribute description. 
    59138488\end_layout 
     
    59488523 
    59498524\begin_layout Standard 
    5950 This subroutine my be used to query if one or more attributes of an element 
     8525This subroutine can be used to query if one or more attributes of an element 
    59518526 have a defined value. 
    59528527 The list of attributes and their type are described in a specific chapter 
     
    59858560 
    59868561\begin_layout Standard 
    5987 where element is one of the existing element or group of element. 
     8562where element is one of the existing elements or element groups. 
    59888563 attribute_x is describing in the chapter dedicated to the attribute description. 
    59898564\end_layout 
     
    60248599 
    60258600\begin_layout Standard 
    6026 This subroutine my be used to query if one or more attributes of an element 
     8601This subroutine can be used to query if one or more attributes of an element 
    60278602 have a defined value. 
    60288603 The list of available attributes and their type are described in a specific 
     
    60618636 
    60628637\begin_layout Standard 
    6063 where element is one of the existing element or group of element. 
     8638where element is one of the existing elements or element groups. 
    60648639 attribute_x and attribute_type_x are describing in the chapter dedicated 
    60658640 to the attribute description. 
     
    61018676 
    61028677\begin_layout Standard 
    6103 This subroutine my be used to set one or more attribute to an element defined 
    6104  by its handle. 
    6105  The list of available attributes and their type are described in a specific 
    6106  chapter of the documentation. 
     8678This subroutine can be used to set one or more attributes of an element 
     8679 defined by its handle. 
     8680 The list of available attributes and their types are described in corresponding 
     8681 chapters of the documentation. 
    61078682  
    61088683\end_layout 
     
    61388713 
    61398714\begin_layout Standard 
    6140 where element is one of the existing element or group of element. 
     8715where element is one of the existing elements or element groups. 
     8716 The attributes attribute_x and attribute_type_x are described in corresponding 
     8717 chapters. 
     8718\end_layout 
     8719 
     8720\begin_layout Subsubsection* 
     8721Arguments: 
     8722\end_layout 
     8723 
     8724\begin_layout Itemize 
     8725\begin_inset Flex Code 
     8726status collapsed 
     8727 
     8728\begin_layout Plain Layout 
     8729id 
     8730\end_layout 
     8731 
     8732\end_inset 
     8733 
     8734: string identifier. 
     8735\end_layout 
     8736 
     8737\begin_layout Itemize 
     8738\begin_inset Flex Code 
     8739status collapsed 
     8740 
     8741\begin_layout Plain Layout 
     8742attr_x 
     8743\end_layout 
     8744 
     8745\end_inset 
     8746 
     8747: value of the attribute to be set. 
     8748\end_layout 
     8749 
     8750\begin_layout Subsubsection* 
     8751Description: 
     8752\end_layout 
     8753 
     8754\begin_layout Standard 
     8755This subroutine can be used to set one or more attributes of an element 
     8756 defined by its string id. 
     8757 The list of available attributes and their type are described in corresponding 
     8758 chapters of the documentation. 
     8759\end_layout 
     8760 
     8761\begin_layout Subsection* 
     8762Getting element attributes value (by handle) 
     8763\end_layout 
     8764 
     8765\begin_layout Subsubsection* 
     8766Synopsis: 
     8767\end_layout 
     8768 
     8769\begin_layout LyX-Code 
     8770SUBROUTINE xios_get_attr(handle, attr_1=attribute_1, attr_2=attribute_2, 
     8771 ...) 
     8772\end_layout 
     8773 
     8774\begin_layout LyX-Code 
     8775TYPE(xios_element)         , INTENT(IN) :: handle 
     8776\end_layout 
     8777 
     8778\begin_layout LyX-Code 
     8779attribute_type_1, OPTIONAL  , INTENT(OUT) :: attr_1 
     8780\end_layout 
     8781 
     8782\begin_layout LyX-Code 
     8783attribute_type_2, OPTIONAL  , INTENT(OUT) :: attr_2 
     8784\end_layout 
     8785 
     8786\begin_layout LyX-Code 
     8787.... 
     8788\end_layout 
     8789 
     8790\begin_layout Standard 
     8791where element is one of the existing elements or element groups. 
    61418792 attribute_x and attribute_type_x are describing in the chapter dedicated 
    61428793 to the attribute description. 
     
    61528803 
    61538804\begin_layout Plain Layout 
    6154 id 
    6155 \end_layout 
    6156  
    6157 \end_inset 
    6158  
    6159 : string identifier. 
     8805handle 
     8806\end_layout 
     8807 
     8808\end_inset 
     8809 
     8810: element handle. 
    61608811\end_layout 
    61618812 
     
    61708821\end_inset 
    61718822 
    6172 : value of the attribute to be set. 
     8823: value of the attribute to be get. 
    61738824\end_layout 
    61748825 
     
    61788829 
    61798830\begin_layout Standard 
    6180 This subroutine my be used to set one or more attribute to an element defined 
    6181  by its string id. 
    6182  The list of available attributes and their type are described in a specific 
    6183  chapter of the documentation. 
    6184 \end_layout 
    6185  
    6186 \begin_layout Subsection* 
    6187 Getting element attributes value (by handle) 
    6188 \end_layout 
    6189  
    6190 \begin_layout Subsubsection* 
    6191 Synopsis: 
    6192 \end_layout 
    6193  
    6194 \begin_layout LyX-Code 
    6195 SUBROUTINE xios_get_attr(handle, attr_1=attribute_1, attr_2=attribute_2, 
    6196  ...) 
    6197 \end_layout 
    6198  
    6199 \begin_layout LyX-Code 
    6200 TYPE(xios_element)         , INTENT(IN) :: handle 
    6201 \end_layout 
    6202  
    6203 \begin_layout LyX-Code 
    6204 attribute_type_1, OPTIONAL  , INTENT(OUT) :: attr_1 
    6205 \end_layout 
    6206  
    6207 \begin_layout LyX-Code 
    6208 attribute_type_2, OPTIONAL  , INTENT(OUT) :: attr_2 
    6209 \end_layout 
    6210  
    6211 \begin_layout LyX-Code 
    6212 .... 
    6213 \end_layout 
    6214  
    6215 \begin_layout Standard 
    6216 where element is one of the existing element or group of element. 
    6217  attribute_x and attribute_type_x are describing in the chapter dedicated 
    6218  to the attribute description. 
    6219 \end_layout 
    6220  
    6221 \begin_layout Subsubsection* 
    6222 Arguments: 
    6223 \end_layout 
    6224  
    6225 \begin_layout Itemize 
    6226 \begin_inset Flex Code 
    6227 status collapsed 
    6228  
    6229 \begin_layout Plain Layout 
    6230 handle 
    6231 \end_layout 
    6232  
    6233 \end_inset 
    6234  
    6235 : element handle. 
    6236 \end_layout 
    6237  
    6238 \begin_layout Itemize 
    6239 \begin_inset Flex Code 
    6240 status collapsed 
    6241  
    6242 \begin_layout Plain Layout 
    6243 attr_x 
    6244 \end_layout 
    6245  
    6246 \end_inset 
    6247  
    6248 : value of the attribute to be get. 
    6249 \end_layout 
    6250  
    6251 \begin_layout Subsubsection* 
    6252 Description: 
    6253 \end_layout 
    6254  
    6255 \begin_layout Standard 
    6256 This subroutine my be used to get one or more attribute value of an element 
     8831This subroutine can be used to get one or more attribute value of an element 
    62578832 defined by its handle. 
    62588833 All attributes in the arguments list must be defined. 
     
    62928867 
    62938868\begin_layout Standard 
    6294 where element is one of the existing element or group of element. 
     8869where element is one of the existing elements or element groups. 
    62958870 attribute_x is describing in the chapter dedicated to the attribute description. 
    62968871\end_layout 
     
    63318906 
    63328907\begin_layout Standard 
    6333 This subroutine my be used to get one or more attribute value of an element 
     8908This subroutine can be used to get one or more attribute value of an element 
    63348909 defined by its handle. 
    63358910 All attributes in the arguments list must have a defined value. 
     
    63398914 
    63408915\begin_layout Section* 
    6341 Interface relative to context management 
     8916Context management interface 
    63428917\end_layout 
    63438918 
     
    63978972 
    63988973\begin_layout Standard 
    6399 This subroutine initialize a context identified by  
     8974This subroutine initializes a context identified by  
    64008975\begin_inset Flex Code 
    64018976status collapsed 
     
    64599034 
    64609035\begin_layout Standard 
    6461 This subroutine must be call to close a context, before the  
     9036This subroutine must be called to close a context before the  
    64629037\begin_inset Flex Code 
    64639038status collapsed 
     
    64709045 
    64719046 call. 
    6472  It waits until that all pending request sent to the servers will be processed 
    6473  and the opened files will be closed. 
     9047 It waits until that all pending requests sent to the servers will be processed 
     9048 and all opened files will be closed. 
    64749049\end_layout 
    64759050 
     
    65429117\begin_layout Standard 
    65439118These subroutines set the current active context. 
    6544  All xios calls after will refer to this active context. 
    6545  If only one context is defined, it is automatically set as the active context. 
     9119 All following XIOS calls will refer to this active context. 
     9120 If only one context is defined, it will be set automatically as the active 
     9121 context. 
    65469122  
    65479123\end_layout 
     
    65729148 
    65739149\begin_layout Standard 
    6574 This subroutine must be call when all definitions of a context is finished 
     9150This subroutine must be called when all definitions of a context are finished 
    65759151 at the end of the initialization and before entering to the time loop. 
    65769152 A lot of operations are performed internally (inheritance, grid definition, 
     
    65819157 
    65829158\begin_layout Section* 
    6583 Interface relative to calendar management 
     9159Calendar management interface 
    65849160\end_layout 
    65859161 
     
    74189994 
    74199995\begin_layout Section* 
    7420 Interface relative to duration handling 
     9996Duration handling interface 
    74219997\end_layout 
    74229998 
     
    798810564This function returns the number of seconds since the beginning of the day 
    798910565 for the specified date, based on the calendar of the current context. 
    7990  It must not be used before the calendar was created. 
     10566 It should not be used before the calendar was created. 
    799110567\end_layout 
    799210568 
     
    803010606\begin_layout Standard 
    803110607This function returns the fraction of day corresponding to the specified 
    8032  date, based on the calendar of the current context. 
    8033  It must not be used before the calendar was created. 
     10608 date based on the calendar of the current context. 
     10609 It should not be used before the calendar was created. 
    803410610\end_layout 
    803510611 
  • XIOS/trunk/doc/XIOS_user_guide.lyx

    r1526 r1623  
    40514051\end_inset 
    40524052 
    4053 , field_A) 
     4053, field_B) 
    40544054\end_layout 
    40554055 
     
    40574057 
    40584058. 
     4059\end_layout 
     4060 
     4061\begin_layout Standard 
     4062XIOS also provides the means to define an expression in a Fortran code via 
     4063 the field attribute  
     4064\begin_inset Quotes eld 
     4065\end_inset 
     4066 
     4067expr 
     4068\begin_inset Quotes erd 
     4069\end_inset 
     4070 
     4071. 
     4072 The example above can rewritten as 
     4073\begin_inset listings 
     4074lstparams "language=XML,breaklines=true,tabsize=2,frame=tb,postbreak={\raisebox{0ex}[0ex][0ex]{\ensuremath{\rcurvearrowse\space}}}" 
     4075inline false 
     4076status open 
     4077 
     4078\begin_layout Plain Layout 
     4079 
     4080<?xml version="1.0"?> 
     4081\end_layout 
     4082 
     4083\begin_layout Plain Layout 
     4084 
     4085<simulation> 
     4086\end_layout 
     4087 
     4088\begin_layout Plain Layout 
     4089 
     4090        <context id="test"> 
     4091\end_layout 
     4092 
     4093\begin_layout Plain Layout 
     4094 
     4095                <calendar type="Gregorian" timestep="1h" /> 
     4096\end_layout 
     4097 
     4098\begin_layout Plain Layout 
     4099 
     4100\end_layout 
     4101 
     4102\begin_layout Plain Layout 
     4103 
     4104                <grid_definition> 
     4105\end_layout 
     4106 
     4107\begin_layout Plain Layout 
     4108 
     4109                        <grid id="grid_A"><!-- Definition ommited --></grid> 
     4110\end_layout 
     4111 
     4112\begin_layout Plain Layout 
     4113 
     4114                </grid_definition> 
     4115\end_layout 
     4116 
     4117\begin_layout Plain Layout 
     4118 
     4119\end_layout 
     4120 
     4121\begin_layout Plain Layout 
     4122 
     4123                <file_definition> 
     4124\end_layout 
     4125 
     4126\begin_layout Plain Layout 
     4127 
     4128                        <file name="output" output_freq="1d"> 
     4129\end_layout 
     4130 
     4131\begin_layout Plain Layout 
     4132 
     4133                        <field id="field_B" grid_ref="grid_A" operation="average"> 
     4134\end_layout 
     4135 
     4136\begin_layout Plain Layout 
     4137 
     4138                        <field id="field_C" field_ref="field_B"> 
     4139\end_layout 
     4140 
     4141\begin_layout Plain Layout 
     4142 
     4143                        </file> 
     4144\end_layout 
     4145 
     4146\begin_layout Plain Layout 
     4147 
     4148                </file_definition> 
     4149\end_layout 
     4150 
     4151\begin_layout Plain Layout 
     4152 
     4153        </context> 
     4154\end_layout 
     4155 
     4156\begin_layout Plain Layout 
     4157 
     4158</simulation> 
     4159\end_layout 
     4160 
     4161\end_inset 
     4162 
     4163 
     4164\end_layout 
     4165 
     4166\begin_layout Standard 
     4167while the two expressions can be specified with the following calls:  
     4168\begin_inset Flex Code 
     4169status open 
     4170 
     4171\begin_layout Plain Layout 
     4172xios_set_field_attr( 
     4173\begin_inset Quotes eld 
     4174\end_inset 
     4175 
     4176field_B 
     4177\begin_inset Quotes erd 
     4178\end_inset 
     4179 
     4180, expr= 
     4181\begin_inset Quotes erd 
     4182\end_inset 
     4183 
     4184@this + 273.15 
     4185\begin_inset Quotes erd 
     4186\end_inset 
     4187 
     4188 
     4189\end_layout 
     4190 
     4191\end_inset 
     4192 
     4193 and  
     4194\begin_inset Flex Code 
     4195status open 
     4196 
     4197\begin_layout Plain Layout 
     4198xios_set_field_attr( 
     4199\begin_inset Quotes eld 
     4200\end_inset 
     4201 
     4202field_C 
     4203\begin_inset Quotes erd 
     4204\end_inset 
     4205 
     4206, expr= 
     4207\begin_inset Quotes erd 
     4208\end_inset 
     4209 
     4210log10(field_B) 
     4211\begin_inset Quotes erd 
     4212\end_inset 
     4213 
     4214 
     4215\end_layout 
     4216 
     4217\end_inset 
     4218 
     4219. 
     4220  
    40594221\end_layout 
    40604222 
     
    50065168\begin_layout Standard 
    50075169Some of XIOS behaviors can be configured using options. 
    5008  Those options must be expressed as variables in a specific context whose 
     5170 Those options must be exprhessed as variables in a specific context whose 
    50095171  
    50105172\series bold 
     
    51005262 
    51015263\begin_layout Standard 
    5102 To improve I/O performance and to be able to use HDF5 compression with the 
    5103   
    5104 \series bold 
    5105 \emph on 
    5106  
    5107 \begin_inset Quotes eld 
    5108 \end_inset 
    5109  
    5110 multiple_file 
    5111 \begin_inset Quotes erd 
    5112 \end_inset 
    5113  
    5114  
    5115 \series default 
    5116 \emph default 
    5117  mode, it is possible to separate servers into two levels: intermediaries 
    5118  (level one) and writers (level two). 
    5119  A single MPI communicator will be created for the intermediaries, while 
    5120  multiple communicators will be created for the writers according to the 
    5121  number of  
    5122 \begin_inset Quotes eld 
    5123 \end_inset 
    5124  
    5125 pools 
    5126 \begin_inset Quotes erd 
    5127 \end_inset 
    5128  
    5129  which can be set by a user. 
     5264To improve I/O performance, it is possible to separate servers into two 
     5265 levels: intermediaries (level one) and writers (level two). 
    51305266 Level-one servers will receive data from clients and will redistribute 
    5131  it to be sent to pools of level-two servers whilst level-two servers will 
    5132  do the I/O (important: for now level-two servers only do writing data). 
    5133  Secondary servers can be launched by means of three parameters: 
     5267 and send the data to subsets of level-two servers (called “pools”), whilst 
     5268 level-two servers will do the I/O. 
     5269 Each file is written by only one pool. 
     5270 If one process is assigned per pool (which is the default option), the 
     5271 I/O is sequential and HDF5 compression can be used even in the “multiple_file” 
     5272 mode. 
     5273 Level-two servers can be launched and controlled by means of three parameters: 
    51345274\end_layout 
    51355275 
     
    52835423 
    52845424\begin_layout Standard 
    5285 Note that with one server per pool, the I/O is actually sequential and thus 
    5286  the use of HDF5 compression is possible. 
    5287   
    5288 \end_layout 
    5289  
    5290 \begin_layout Standard 
    52915425By default file distribution among server-two pools is optimized for bandwidth. 
    52925426 An alternative way of distributing files is possible in order to minimize 
     
    54385572\begin_inset Formula  
    54395573\[ 
    5440 {\scriptstyle used\_size\;=\;\min\left(minimum\_buffer\_size,\; detected\_size\;\times\; buffer\_size\_factor\right)} 
     5574{\scriptstyle used\_size\;=\;\min\left(minimum\_buffer\_size,\;detected\_size\;\times\;buffer\_size\_factor\right)} 
    54415575\] 
    54425576 
Note: See TracChangeset for help on using the changeset viewer.