Changeset 1623
- Timestamp:
- 12/11/18 17:58:35 (6 years ago)
- Location:
- XIOS/trunk/doc
- Files:
-
- 4 edited
Legend:
- Unmodified
- Added
- Removed
-
XIOS/trunk/doc/XIOS_reference_guide.lyx
r821 r1623 10 10 \maintain_unincluded_children false 11 11 \language english 12 \language_package default12 \language_package auto 13 13 \inputencoding auto 14 14 \fontencoding global … … 99 99 100 100 \begin_layout Plain Layout 101 enumeration { Gregorian, Julian, D360, AllLeap, NoLeap, user_defined}101 enumeration {Gregorian, Julian, D360, AllLeap, NoLeap, user_defined} 102 102 \end_layout 103 103 … … 272 272 273 273 \begin_layout Standard 274 Define the time origin of thetime axis.275 It will appear as metadata attached to the time axis in theoutput file.274 Define the time origin of a time axis. 275 It will appear as metadata attached to the time axis in an output file. 276 276 This attribute is optional, the default value is 277 277 \begin_inset Flex Emph … … 441 441 442 442 \begin_layout Standard 443 Define the duration of a day , in seconds,when using a custom calendar.443 Define the duration of a day in seconds when using a custom calendar. 444 444 This attribute is mandatory if the calendar 445 445 \series bold … … 677 677 \series default 678 678 attribute is used, otherwise it must not be defined. 679 The default behavio ur is not to have any leap year.679 The default behavior is not to have any leap year. 680 680 If defined, this attribute must comply with the following constraint: 681 681 \begin_inset Formula $1\leq leap\_year\_month\leq size(month\_lengths)$ … … 758 758 \series default 759 759 attribute is used, otherwise it must not be defined. 760 The default behavio ur is not to have any leap year, i.e.760 The default behavior is not to have any leap year, i.e. 761 761 the default value is 762 762 \begin_inset Formula $\mathbf{0}$ … … 886 886 887 887 \begin_layout Section 888 Scalar attribute reference 889 \end_layout 890 891 \begin_layout Subsection* 892 name (optional): 893 \begin_inset Flex Emph 894 status collapsed 895 896 \begin_layout Plain Layout 897 string 898 \end_layout 899 900 \end_inset 901 902 903 \end_layout 904 905 \begin_layout Standard 906 Fortran: 907 \end_layout 908 909 \begin_layout LyX-Code 910 CHARACTER(LEN=*) :: name 911 \end_layout 912 913 \begin_layout Standard 914 Defines 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* 922 standard_name (optional): 923 \begin_inset Flex Emph 924 status collapsed 925 926 \begin_layout Plain Layout 927 string 928 \end_layout 929 930 \end_inset 931 932 933 \end_layout 934 935 \begin_layout Standard 936 Fortran: 937 \end_layout 938 939 \begin_layout LyX-Code 940 CHARACTER(LEN=*) :: standard_name 941 \end_layout 942 943 \begin_layout Standard 944 Defines 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* 950 long_name (optional): 951 \begin_inset Flex Emph 952 status collapsed 953 954 \begin_layout Plain Layout 955 string 956 \end_layout 957 958 \end_inset 959 960 961 \end_layout 962 963 \begin_layout Standard 964 Fortran: 965 \end_layout 966 967 \begin_layout LyX-Code 968 CHARACTER(LEN=*) :: long_name 969 \end_layout 970 971 \begin_layout Standard 972 Defines 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* 978 unit (optional): 979 \begin_inset Flex Emph 980 status collapsed 981 982 \begin_layout Plain Layout 983 string 984 \end_layout 985 986 \end_inset 987 988 989 \end_layout 990 991 \begin_layout Standard 992 Fortran: 993 \end_layout 994 995 \begin_layout LyX-Code 996 CHARACTER(LEN=*) :: unit 997 \end_layout 998 999 \begin_layout Standard 1000 Defines 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* 1005 value (optional): 1006 \begin_inset Flex Emph 1007 status collapsed 1008 1009 \begin_layout Plain Layout 1010 double 1011 \end_layout 1012 1013 \end_inset 1014 1015 1016 \end_layout 1017 1018 \begin_layout Standard 1019 Fortran: 1020 \end_layout 1021 1022 \begin_layout LyX-Code 1023 DOUBLE PRECISION :: value 1024 \end_layout 1025 1026 \begin_layout Standard 1027 Defines 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* 1033 bounds (optional): 1034 \begin_inset Flex Emph 1035 status collapsed 1036 1037 \begin_layout Plain Layout 1038 1D-array of double 1039 \end_layout 1040 1041 \end_inset 1042 1043 1044 \end_layout 1045 1046 \begin_layout Standard 1047 Fortran: 1048 \end_layout 1049 1050 \begin_layout LyX-Code 1051 DOUBLE PRECISION :: bounds(:) 1052 \end_layout 1053 1054 \begin_layout Standard 1055 Defines (two) scalar boundaries. 1056 The array size must should be equal to 2. 1057 \end_layout 1058 1059 \begin_layout Subsection* 1060 bounds_name (optional): 1061 \begin_inset Flex Emph 1062 status collapsed 1063 1064 \begin_layout Plain Layout 1065 string 1066 \end_layout 1067 1068 \end_inset 1069 1070 1071 \end_layout 1072 1073 \begin_layout Standard 1074 Fortran: 1075 \end_layout 1076 1077 \begin_layout LyX-Code 1078 CHARACTER(LEN=*) :: bounds_name 1079 \end_layout 1080 1081 \begin_layout Standard 1082 Defines 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* 1088 prec (optional): 1089 \emph on 1090 integer 1091 \end_layout 1092 1093 \begin_layout Standard 1094 Fortran: 1095 \end_layout 1096 1097 \begin_layout LyX-Code 1098 INTEGER :: prec 1099 \end_layout 1100 1101 \begin_layout Standard 1102 Defines 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* 1110 label (optional): 1111 \begin_inset Flex Emph 1112 status collapsed 1113 1114 \begin_layout Plain Layout 1115 string 1116 \end_layout 1117 1118 \end_inset 1119 1120 1121 \end_layout 1122 1123 \begin_layout Standard 1124 Fortran: 1125 \end_layout 1126 1127 \begin_layout LyX-Code 1128 CHARACTER(LEN=*) :: label 1129 \end_layout 1130 1131 \begin_layout Standard 1132 Defines 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* 1138 scalar_ref (optional): string 1139 \end_layout 1140 1141 \begin_layout Standard 1142 Fortran: 1143 \end_layout 1144 1145 \begin_layout LyX-Code 1146 CHARACTER(LEN=*) :: scalar_ref 1147 \end_layout 1148 1149 \begin_layout Standard 1150 Defines 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* 1158 positive (optional): 1159 \begin_inset Flex Emph 1160 status collapsed 1161 1162 \begin_layout Plain Layout 1163 enumeration {up, down} 1164 \end_layout 1165 1166 \end_inset 1167 1168 1169 \end_layout 1170 1171 \begin_layout Standard 1172 Fortran: 1173 \end_layout 1174 1175 \begin_layout LyX-Code 1176 CHARACTER(LEN=*) :: positive 1177 \end_layout 1178 1179 \begin_layout Standard 1180 Defines the positive direction for fields representing height or depth. 1181 \end_layout 1182 1183 \begin_layout Subsection* 1184 axis_type (optional): 1185 \begin_inset Flex Emph 1186 status collapsed 1187 1188 \begin_layout Plain Layout 1189 enumeration {X, Y, Z, T} 1190 \end_layout 1191 1192 \end_inset 1193 1194 1195 \end_layout 1196 1197 \begin_layout Standard 1198 Fortran: 1199 \end_layout 1200 1201 \begin_layout LyX-Code 1202 CHARACTER(LEN=*) :: axis_type 1203 \end_layout 1204 1205 \begin_layout Standard 1206 Defines 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 1214 X: 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 1225 Y 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 1238 Z 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 1250 T: 1251 \series default 1252 \shape default 1253 time axis. 1254 \end_layout 1255 1256 \begin_layout Subsection* 1257 comment: 1258 \begin_inset Flex Emph 1259 status collapsed 1260 1261 \begin_layout Plain Layout 1262 string 1263 \end_layout 1264 1265 \end_inset 1266 1267 1268 \end_layout 1269 1270 \begin_layout Standard 1271 Fortran: 1272 \end_layout 1273 1274 \begin_layout LyX-Code 1275 CHARACTER(LEN=*) :: comment 1276 \end_layout 1277 1278 \begin_layout Standard 1279 Allows a user to set a comment. 1280 1281 \end_layout 1282 1283 \begin_layout Section 888 1284 Axis attribute reference 889 1285 \end_layout 890 1286 891 1287 \begin_layout Subsection* 892 name :1288 name (optional): 893 1289 \begin_inset Flex Emph 894 1290 status collapsed … … 912 1308 913 1309 \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. 1310 Defines 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. 918 1315 919 1316 \end_layout 920 1317 921 1318 \begin_layout Subsection* 922 standard_name :1319 standard_name (optional): 923 1320 \begin_inset Flex Emph 924 1321 status collapsed … … 942 1339 943 1340 \begin_layout Standard 944 Define the standard name of the vertical axis, as it will appear in the945 metadata attached to the axis of theoutput file.1341 Defines the standard name of a vertical axis as it will appear in the axis' 1342 metadata in an output file. 946 1343 947 1344 \end_layout 948 1345 949 1346 \begin_layout Subsection* 950 long_name :1347 long_name (optional): 951 1348 \begin_inset Flex Emph 952 1349 status collapsed … … 970 1367 971 1368 \begin_layout Standard 972 Define the long name of the vertical axis, as it will appear in the metadata973 attached to the axis of theoutput file.1369 Defines the long name of a vertical axis as it will appear in the axis' 1370 metadata in an output file. 974 1371 975 1372 \end_layout 976 1373 977 1374 \begin_layout Subsection* 978 unit :1375 unit (optional): 979 1376 \begin_inset Flex Emph 980 1377 status collapsed … … 998 1395 999 1396 \begin_layout Standard 1000 Define the unit of the axis as it will appear in the metadata attached to1001 the axis in theoutput file.1002 \end_layout 1003 1004 \begin_layout Subsection* 1005 n_glo:1397 Defines 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* 1402 dim_name (optional): 1006 1403 \begin_inset Flex Emph 1007 1404 status collapsed 1008 1405 1009 1406 \begin_layout Plain Layout 1407 string 1408 \end_layout 1409 1410 \end_inset 1411 1412 1413 \end_layout 1414 1415 \begin_layout Standard 1416 Fortran: 1417 \end_layout 1418 1419 \begin_layout LyX-Code 1420 CHARACTER(LEN=*) :: dim_name 1421 \end_layout 1422 1423 \begin_layout Standard 1424 Defines the name of axis dimension as it will appear in the file's metadata. 1425 \end_layout 1426 1427 \begin_layout Subsection* 1428 formula (optional): 1429 \begin_inset Flex Emph 1430 status collapsed 1431 1432 \begin_layout Plain Layout 1433 string 1434 \end_layout 1435 1436 \end_inset 1437 1438 1439 \end_layout 1440 1441 \begin_layout Standard 1442 Fortran: 1443 \end_layout 1444 1445 \begin_layout LyX-Code 1446 CHARACTER(LEN=*) :: formula 1447 \end_layout 1448 1449 \begin_layout Standard 1450 Adds the formula attribute to a parametric vertical axis. 1451 \end_layout 1452 1453 \begin_layout Subsection* 1454 formula_term (optional): 1455 \begin_inset Flex Emph 1456 status collapsed 1457 1458 \begin_layout Plain Layout 1459 string 1460 \end_layout 1461 1462 \end_inset 1463 1464 1465 \end_layout 1466 1467 \begin_layout Standard 1468 Fortran: 1469 \end_layout 1470 1471 \begin_layout LyX-Code 1472 CHARACTER(LEN=*) :: formula_term 1473 \end_layout 1474 1475 \begin_layout Standard 1476 Adds the formula terms attribute to a parametric vertical axis. 1477 \end_layout 1478 1479 \begin_layout Subsection* 1480 formula_bounds (optional): 1481 \begin_inset Flex Emph 1482 status collapsed 1483 1484 \begin_layout Plain Layout 1485 string 1486 \end_layout 1487 1488 \end_inset 1489 1490 1491 \end_layout 1492 1493 \begin_layout Standard 1494 Fortran: 1495 \end_layout 1496 1497 \begin_layout LyX-Code 1498 CHARACTER(LEN=*) :: formula_bounds 1499 \end_layout 1500 1501 \begin_layout Standard 1502 Adds the formula attribute to the bounds of a parametric vertical axis. 1503 The attribute is mandatory if the 1504 \begin_inset Flex Strong 1505 status collapsed 1506 1507 \begin_layout Plain Layout 1508 formula 1509 \end_layout 1510 1511 \end_inset 1512 1513 attribute is defined for the axis. 1514 \end_layout 1515 1516 \begin_layout Subsection* 1517 formula_term_bounds (optional): 1518 \begin_inset Flex Emph 1519 status collapsed 1520 1521 \begin_layout Plain Layout 1522 string 1523 \end_layout 1524 1525 \end_inset 1526 1527 1528 \end_layout 1529 1530 \begin_layout Standard 1531 Fortran: 1532 \end_layout 1533 1534 \begin_layout LyX-Code 1535 CHARACTER(LEN=*) :: formula_term_bounds 1536 \end_layout 1537 1538 \begin_layout Standard 1539 Adds the formula terms attribute to the bounds of a parametric vertical 1540 axis. 1541 The attribute is mandatory if the 1542 \begin_inset Flex Strong 1543 status collapsed 1544 1545 \begin_layout Plain Layout 1546 formula 1547 \end_layout 1548 1549 \end_inset 1550 1551 attribute is defined for the axis. 1552 \end_layout 1553 1554 \begin_layout Subsection* 1555 n_glo (mandatory): 1556 \begin_inset Flex Emph 1557 status collapsed 1558 1559 \begin_layout Plain Layout 1010 1560 integer 1011 1561 \end_layout … … 1025 1575 1026 1576 \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: 1577 Defines the global size of an axis. 1578 \end_layout 1579 1580 \begin_layout Subsection* 1581 begin (optional): 1033 1582 \begin_inset Flex Emph 1034 1583 status collapsed … … 1052 1601 1053 1602 \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 1603 Defines the beginning index of the local domain. 1604 It can take value between 0 and 1057 1605 \begin_inset Flex Strong 1058 1606 status collapsed … … 1069 1617 1070 1618 \begin_layout Subsection* 1071 n :1619 n (optional): 1072 1620 \begin_inset Flex Emph 1073 1621 status collapsed … … 1091 1639 1092 1640 \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 1641 Defines the local size of an axis. 1642 It can take value between 0 and 1096 1643 \begin_inset Flex Strong 1097 1644 status collapsed … … 1115 1662 1116 1663 . 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 1673 index 1674 \series default 1675 \shape default 1676 . 1677 \end_layout 1678 1679 \begin_layout Subsection* 1680 index (optional): 1122 1681 \begin_inset Flex Emph 1123 1682 status collapsed … … 1137 1696 1138 1697 \begin_layout LyX-Code 1698 DOUBLE PRECISION :: index(:) 1699 \end_layout 1700 1701 \begin_layout Standard 1702 Defines 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 1705 status collapsed 1706 1707 \begin_layout Plain Layout 1708 n 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 1723 index 1724 \series default 1725 \shape default 1726 . 1727 \end_layout 1728 1729 \begin_layout Subsection* 1730 value (optional): 1731 \begin_inset Flex Emph 1732 status collapsed 1733 1734 \begin_layout Plain Layout 1735 1D-array of double 1736 \end_layout 1737 1738 \end_inset 1739 1740 1741 \end_layout 1742 1743 \begin_layout Standard 1744 Fortran: 1745 \end_layout 1746 1747 \begin_layout LyX-Code 1139 1748 DOUBLE PRECISION :: value(:) 1140 1749 \end_layout 1141 1750 1142 1751 \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 1752 Defines 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 1755 status collapsed 1756 1757 \begin_layout Plain Layout 1758 n 1161 1759 \end_layout 1162 1760 … … 1164 1762 1165 1763 . 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* 1769 bounds (optional): 1170 1770 \begin_inset Flex Emph 1171 1771 status collapsed … … 1185 1785 1186 1786 \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 thevertical axis.1787 DOUBLE PRECISION :: bounds(:,:) 1788 \end_layout 1789 1790 \begin_layout Standard 1791 Defines the boundaries of each level of a vertical axis. 1192 1792 The dimensions of the array must be 1193 1793 \begin_inset Formula $2\times n$ … … 1198 1798 1199 1799 \begin_layout Subsection* 1200 data_begin: 1800 bounds_name (optional): 1801 \begin_inset Flex Emph 1802 status collapsed 1803 1804 \begin_layout Plain Layout 1805 string 1806 \end_layout 1807 1808 \end_inset 1809 1810 1811 \end_layout 1812 1813 \begin_layout Standard 1814 Fortran: 1815 \end_layout 1816 1817 \begin_layout LyX-Code 1818 CHARACTER(LEN=*) :: bounds_name 1819 \end_layout 1820 1821 \begin_layout Standard 1822 Defines 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* 1828 prec (optional): 1829 \emph on 1830 integer 1831 \end_layout 1832 1833 \begin_layout Standard 1834 Fortran: 1835 \end_layout 1836 1837 \begin_layout LyX-Code 1838 INTEGER :: prec 1839 \end_layout 1840 1841 \begin_layout Standard 1842 Defines 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* 1850 label (optional): 1851 \begin_inset Flex Emph 1852 status collapsed 1853 1854 \begin_layout Plain Layout 1855 string 1856 \end_layout 1857 1858 \end_inset 1859 1860 1861 \end_layout 1862 1863 \begin_layout Standard 1864 Fortran: 1865 \end_layout 1866 1867 \begin_layout LyX-Code 1868 CHARACTER, ALLOCATABLE :: label(:) 1869 \end_layout 1870 1871 \begin_layout Standard 1872 Defines 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 1875 status collapsed 1876 1877 \begin_layout Plain Layout 1878 n 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* 1889 data_begin (optional): 1201 1890 \emph on 1202 1891 integer … … 1212 1901 1213 1902 \begin_layout Standard 1214 Define the beginning index of the field data for the axis.1215 Th is attribute is an offset regardingthe local axis, so the value can1903 Defines 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 1216 1905 be negative. 1217 1906 A negative value indicates that only some valid part of the data will extracted … … 1219 1908 A positive value indicates that the local domain is greater than the data 1220 1909 stored in memory. 1221 A0-value means that the local domain matches the data in memory.1222 Th is attribute is optional and the default value is 0.1223 Otherwise1910 The 0-value means that the local domain matches the data in memory. 1911 The default value is 0. 1912 The attributes 1224 1913 \begin_inset Flex Strong 1225 1914 status collapsed … … 1245 1934 1246 1935 \begin_layout Subsection* 1247 data_n :1936 data_n (optional): 1248 1937 \emph on 1249 1938 integer … … 1259 1948 1260 1949 \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 1950 Defines 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 1263 1953 \begin_inset Flex Strong 1264 1954 status collapsed … … 1271 1961 1272 1962 . 1273 Otherwise1963 The attributes 1274 1964 \begin_inset Flex Strong 1275 1965 status collapsed … … 1295 1985 1296 1986 \begin_layout Subsection* 1297 data_index :1987 data_index (optional): 1298 1988 \emph on 1299 1989 integer … … 1309 1999 1310 2000 \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: 2001 In 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 2005 status collapsed 2006 2007 \begin_layout Plain Layout 2008 data_n 2009 \end_layout 2010 2011 \end_inset 2012 2013 . 2014 For example, for a local axis of size 2015 \begin_inset Flex Strong 2016 status collapsed 2017 2018 \begin_layout Plain Layout 2019 n=3 2020 \end_layout 2021 2022 \end_inset 2023 2024 and local data size of 2025 \begin_inset Flex Strong 2026 status collapsed 2027 2028 \begin_layout Plain Layout 2029 data_n=5 2030 \end_layout 2031 2032 \end_inset 2033 2034 , if 2035 \begin_inset Flex Strong 2036 status collapsed 2037 2038 \begin_layout Plain Layout 2039 data_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* 2049 mask (optional): 1317 2050 \emph on 1318 2051 1D-array of bool … … 1328 2061 1329 2062 \begin_layout Standard 1330 Define the mask of the local axis.2063 Defines the mask of the local axis. 1331 2064 The masked value will be replaced by the value of the field attribute 1332 2065 \begin_inset Flex Strong … … 1339 2072 \end_inset 1340 2073 1341 in theoutput 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* 2078 n_distributed_partition (optional): 1346 2079 \emph on 1347 2080 integer … … 1357 2090 1358 2091 \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 2092 Defines the number of local axes in case if the axis is generated automatically 2093 by XIOS. 2094 The default value is 1361 2095 \begin_inset Flex Strong 1362 2096 status collapsed … … 1372 2106 1373 2107 \begin_layout Subsection* 1374 positive: 2108 axis_ref (optional): string 2109 \end_layout 2110 2111 \begin_layout Standard 2112 Fortran: 2113 \end_layout 2114 2115 \begin_layout LyX-Code 2116 CHARACTER(LEN=*) :: axis_ref 2117 \end_layout 2118 2119 \begin_layout Standard 2120 Defines 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* 2128 positive (optional): 1375 2129 \begin_inset Flex Emph 1376 2130 status collapsed 1377 2131 1378 2132 \begin_layout Plain Layout 1379 enumeration { up, down}2133 enumeration {up, down} 1380 2134 \end_layout 1381 2135 … … 1394 2148 1395 2149 \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: 2150 Defines the positive direction for fields representing height or depth. 2151 \end_layout 2152 2153 \begin_layout Subsection* 2154 axis_type (optional): 1422 2155 \begin_inset Flex Emph 1423 2156 status collapsed 1424 2157 1425 2158 \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 . 2159 enumeration {X, Y, Z, T} 2160 \end_layout 2161 2162 \end_inset 2163 2164 2165 \end_layout 2166 2167 \begin_layout Standard 2168 Fortran: 2169 \end_layout 2170 2171 \begin_layout LyX-Code 2172 CHARACTER(LEN=*) :: axis_type 2173 \end_layout 2174 2175 \begin_layout Standard 2176 Defines 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 2184 X: 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 2195 Y 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 2208 Z 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 2220 T: 2221 \series default 2222 \shape default 2223 time axis. 2224 \end_layout 2225 2226 \begin_layout Subsection* 2227 comment (optional): 2228 \begin_inset Flex Emph 2229 status collapsed 2230 2231 \begin_layout Plain Layout 2232 string 2233 \end_layout 2234 2235 \end_inset 2236 2237 2238 \end_layout 2239 2240 \begin_layout Standard 2241 Fortran: 2242 \end_layout 2243 2244 \begin_layout LyX-Code 2245 CHARACTER(LEN=*) :: comment 2246 \end_layout 2247 2248 \begin_layout Standard 2249 Allows a user to set a comment. 2250 1455 2251 \end_layout 1456 2252 … … 1460 2256 1461 2257 \begin_layout Subsection* 1462 name :2258 name (optional): 1463 2259 \begin_inset Flex Emph 1464 2260 status collapsed … … 1482 2278 1483 2279 \begin_layout Standard 1484 Define the name of thehorizontal domain.2280 Defines the name of a horizontal domain. 1485 2281 This attribute may be used in case of multiple domains defined in the same 1486 2282 file. … … 1497 2293 attribute will be suffixed to the longitude and latitude dimensions and 1498 2294 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* 2299 standard_name (optional): 1504 2300 \begin_inset Flex Emph 1505 2301 status collapsed … … 1523 2319 1524 2320 \begin_layout Standard 1525 Define the standard name of the domain, as it will appear in the metadata1526 attached to the domain of theoutput file.2321 Defines the standard name of a domain as it will appear in the domain's 2322 metadata in an output file. 1527 2323 1528 2324 \end_layout 1529 2325 1530 2326 \begin_layout Subsection* 1531 long_name :2327 long_name (optional): 1532 2328 \begin_inset Flex Emph 1533 2329 status collapsed … … 1551 2347 1552 2348 \begin_layout Standard 1553 Define the long name of the domain, as it will appear in the metadata attached1554 to the domain of theoutput file.2349 Defines the long name of a domain as it will appear in the domain's metadata 2350 in an output file. 1555 2351 1556 2352 \end_layout 1557 2353 1558 2354 \begin_layout Subsection* 1559 type :2355 type (mandatory): 1560 2356 \begin_inset Flex Emph 1561 2357 status collapsed 1562 2358 1563 2359 \begin_layout Plain Layout 1564 enumeration { rectilinear, curvilinear, unstructured}2360 enumeration {rectilinear, curvilinear, unstructured, gaussian} 1565 2361 \end_layout 1566 2362 … … 1579 2375 1580 2376 \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: 2377 Defines the type of a grid. 2378 \end_layout 2379 2380 \begin_layout Subsection* 2381 dim_i_name (optional): 1587 2382 \begin_inset Flex Emph 1588 2383 status collapsed 1589 2384 1590 2385 \begin_layout Plain Layout 2386 string 2387 \end_layout 2388 2389 \end_inset 2390 2391 2392 \end_layout 2393 2394 \begin_layout Standard 2395 Fortran: 2396 \end_layout 2397 2398 \begin_layout LyX-Code 2399 CHARACTER(LEN=*) :: dim_i_name 2400 \end_layout 2401 2402 \begin_layout Standard 2403 Defines 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* 2408 dim_j_name (optional): 2409 \begin_inset Flex Emph 2410 status collapsed 2411 2412 \begin_layout Plain Layout 2413 string 2414 \end_layout 2415 2416 \end_inset 2417 2418 2419 \end_layout 2420 2421 \begin_layout Standard 2422 Fortran: 2423 \end_layout 2424 2425 \begin_layout LyX-Code 2426 CHARACTER(LEN=*) :: dim_j_name 2427 \end_layout 2428 2429 \begin_layout Standard 2430 Defines the name of the second domain dimension as it will appear in file's 2431 metadata. 2432 \end_layout 2433 2434 \begin_layout Subsection* 2435 ni_glo (mandatory): 2436 \begin_inset Flex Emph 2437 status collapsed 2438 2439 \begin_layout Plain Layout 1591 2440 integer 1592 2441 \end_layout … … 1606 2455 1607 2456 \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: 2457 Defines the size of the first dimension of the global domain. 2458 \end_layout 2459 2460 \begin_layout Subsection* 2461 nj_glo (mandatory): 1614 2462 \begin_inset Flex Emph 1615 2463 status collapsed … … 1633 2481 1634 2482 \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: 2483 Defines the size of the second dimension of the global domain. 2484 \end_layout 2485 2486 \begin_layout Subsection* 2487 ibegin (optional): 1641 2488 \begin_inset Flex Emph 1642 2489 status collapsed … … 1660 2507 1661 2508 \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 2509 Defines the beginning index of the first dimension of a local domain. 2510 The attribute takes value between 1665 2511 \begin_inset Flex Strong 1666 2512 status collapsed … … 1697 2543 1698 2544 \begin_layout Subsection* 1699 ni :2545 ni (optional): 1700 2546 \begin_inset Flex Emph 1701 2547 status collapsed … … 1719 2565 1720 2566 \begin_layout Standard 1721 Define the first dimension of the local domain. 1722 This attribute is optional. 1723 This must be an integer between 2567 Defines the size of the first dimension of a local domain. 2568 The attribute takes value between 1724 2569 \begin_inset Flex Strong 1725 2570 status collapsed … … 1756 2601 1757 2602 \begin_layout Subsection* 1758 jbegin :2603 jbegin (optional): 1759 2604 \begin_inset Flex Emph 1760 2605 status collapsed … … 1778 2623 1779 2624 \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 2625 Defines the beginning index of the second dimension of a local domain. 2626 The attribute takes value between 1783 2627 \begin_inset Flex Strong 1784 2628 status collapsed … … 1815 2659 1816 2660 \begin_layout Subsection* 1817 nj :2661 nj (optional): 1818 2662 \begin_inset Flex Emph 1819 2663 status collapsed … … 1837 2681 1838 2682 \begin_layout Standard 1839 Define the second dimension of the local domain. 1840 This attribute is optional. 1841 This must be an integer between 2683 Defines the size of the second dimension of a local domain. 2684 he attribute takes value between 1842 2685 \begin_inset Flex Strong 1843 2686 status collapsed … … 1874 2717 1875 2718 \begin_layout Subsection* 1876 lonvalue_1d :2719 lonvalue_1d (optional): 1877 2720 \emph on 1878 2721 1D-array of double … … 1888 2731 1889 2732 \begin_layout Standard 1890 Define the value of the longitude on thelocal domain.1891 For a cartesian grid, the size of the array willbe2733 Defines the longitude values of a local domain. 2734 For a cartesian grid, the array size should be 1892 2735 \begin_inset Flex Strong 1893 2736 status collapsed … … 1900 2743 1901 2744 . 1902 For a curvilinear grid, the size of the array willbe2745 For a curvilinear grid, the array size should be 1903 2746 \begin_inset Flex Strong 1904 2747 status collapsed … … 1915 2758 1916 2759 . 1917 This attribute is optional. 1918 \end_layout 1919 1920 \begin_layout Subsection* 1921 lonvalue_2d: 2760 \end_layout 2761 2762 \begin_layout Subsection* 2763 lonvalue_2d (optional): 1922 2764 \emph on 1923 2765 2D-array of double … … 1933 2775 1934 2776 \begin_layout Standard 1935 Define the value of the longitude on thelocal domain.1936 For a cartesian and curvilinear grid, the size of the array willbe2777 Defines the longitude values of a local domain. 2778 For cartesian and curvilinear grids the array size should be 1937 2779 \begin_inset Flex Strong 1938 2780 status collapsed … … 1949 2791 1950 2792 . 1951 This attribute is mandatory.1952 2793 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* 2799 latvalue_1d (optional): 1957 2800 \emph on 1958 2801 1D-array of double … … 1968 2811 1969 2812 \begin_layout Standard 1970 Define the value of the latitude on thelocal domain.2813 Defines the latitude values of a local domain. 1971 2814 For a cartesian grid, the size of the array will be nj. 1972 2815 For a curvilinear grid, the size of the array will be … … 1985 2828 1986 2829 . 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* 2834 latvalue_2d (optional): 1992 2835 \emph on 1993 2836 2D-array of double … … 2003 2846 2004 2847 \begin_layout Standard 2005 Define the value of the latitude on thelocal domain.2006 For a cartesian and a curvilinear grid, the size of the array willbe2848 Defines the latitude values of a local domain. 2849 For cartesian and curvilinear grids the array size should be 2007 2850 \begin_inset Flex Strong 2008 2851 status collapsed … … 2019 2862 2020 2863 . 2021 This attribute is mandatory.2022 2864 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* 2870 lon_name (optional): 2871 \begin_inset Flex Emph 2872 status collapsed 2873 2874 \begin_layout Plain Layout 2875 string 2876 \end_layout 2877 2878 \end_inset 2879 2880 2881 \end_layout 2882 2883 \begin_layout Standard 2884 Fortran: 2885 \end_layout 2886 2887 \begin_layout LyX-Code 2888 CHARACTER(LEN=*) :: lon_name 2889 \end_layout 2890 2891 \begin_layout Standard 2892 Defines the longitude name as it will appear in an output file. 2893 \end_layout 2894 2895 \begin_layout Subsection* 2896 lat_name (optional): 2897 \begin_inset Flex Emph 2898 status collapsed 2899 2900 \begin_layout Plain Layout 2901 string 2902 \end_layout 2903 2904 \end_inset 2905 2906 2907 \end_layout 2908 2909 \begin_layout Standard 2910 Fortran: 2911 \end_layout 2912 2913 \begin_layout LyX-Code 2914 CHARACTER(LEN=*) :: lat_name 2915 \end_layout 2916 2917 \begin_layout Standard 2918 Defines the latitude name as it will appear in an output file. 2919 \end_layout 2920 2921 \begin_layout Subsection* 2922 nvertex (optional): 2027 2923 \emph on 2028 2924 integer … … 2038 2934 2039 2935 \begin_layout Standard 2040 Define the the maximum number of vertices for a cell.2041 Th is 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 :2936 Defines 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* 2942 bounds_lon_1d (optional): 2047 2943 \emph on 2048 2944 2D-array of double … … 2058 2954 2059 2955 \begin_layout Standard 2060 Longitude value of the vertex of the cells. 2956 Defines the longitude values of domain vertexes. 2957 The attribute 2061 2958 \begin_inset Flex Strong 2062 2959 status collapsed … … 2068 2965 \end_inset 2069 2966 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* 2976 bounds_lon_2d (optional): 2076 2977 \emph on 2077 2978 3D-array of double … … 2087 2988 2088 2989 \begin_layout Standard 2089 Longitude value of the vertex of the cells. 2990 Defines the longitude values of domain vertexes. 2991 The attribute 2090 2992 \begin_inset Flex Strong 2091 2993 status collapsed … … 2097 2999 \end_inset 2098 3000 2099 attribute must also be defined. 2100 This attribute is optional. 3001 must be also defined. 2101 3002 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* 3012 bounds_lat_1d (optional): 2107 3013 \emph on 2108 3014 2D-array of double … … 2118 3024 2119 3025 \begin_layout Standard 2120 Latitude value of the vertex of the cells. 3026 Defines the latitude values of domain vertexes. 3027 The attribute 2121 3028 \begin_inset Flex Strong 2122 3029 status collapsed … … 2128 3035 \end_inset 2129 3036 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* 3046 bounds_lat_2d (optional): 2136 3047 \emph on 2137 3048 3D-array of double … … 2147 3058 2148 3059 \begin_layout Standard 2149 Latitude value of the vertex of the cells. 3060 Defines the latitude values of domain vertexes. 3061 The attribute 2150 3062 \begin_inset Flex Strong 2151 3063 status collapsed … … 2157 3069 \end_inset 2158 3070 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* 3082 bounds_lon_name (optional): 3083 \begin_inset Flex Emph 3084 status collapsed 3085 3086 \begin_layout Plain Layout 3087 string 3088 \end_layout 3089 3090 \end_inset 3091 3092 3093 \end_layout 3094 3095 \begin_layout Standard 3096 Fortran: 3097 \end_layout 3098 3099 \begin_layout LyX-Code 3100 CHARACTER(LEN=*) :: lon_name 3101 \end_layout 3102 3103 \begin_layout Standard 3104 Defines the longitude name of domain vertexes as it will appear in an output 3105 file. 3106 \end_layout 3107 3108 \begin_layout Subsection* 3109 bounds_lat_name (optional): 3110 \begin_inset Flex Emph 3111 status collapsed 3112 3113 \begin_layout Plain Layout 3114 string 3115 \end_layout 3116 3117 \end_inset 3118 3119 3120 \end_layout 3121 3122 \begin_layout Standard 3123 Fortran: 3124 \end_layout 3125 3126 \begin_layout LyX-Code 3127 CHARACTER(LEN=*) :: lat_name 3128 \end_layout 3129 3130 \begin_layout Standard 3131 Defines the latitude name of domain vertexes as it will appear in an output 3132 file. 3133 \end_layout 3134 3135 \begin_layout Subsection* 3136 area (optional): 2167 3137 \emph on 2168 3138 2D-array of double … … 2178 3148 2179 3149 \begin_layout Standard 2180 Area of thecells.3150 The area of cells. 2181 3151 The size of the array must be 2182 3152 \begin_inset Flex Strong … … 2194 3164 2195 3165 . 2196 This attribute is optional. 2197 \end_layout 2198 2199 \begin_layout Subsection* 2200 data_dim: 3166 \end_layout 3167 3168 \begin_layout Subsection* 3169 prec (optional): 2201 3170 \emph on 2202 3171 integer … … 2208 3177 2209 3178 \begin_layout LyX-Code 3179 INTEGER :: prec 3180 \end_layout 3181 3182 \begin_layout Standard 3183 Defines the precision in bytes of domain attributes. 3184 Available values are: 2 (integer), 4 (float single precision) and 8 (float 3185 double precision). 3186 The default value of 8. 3187 \end_layout 3188 3189 \begin_layout Subsection* 3190 data_dim (optional): 3191 \emph on 3192 integer 3193 \end_layout 3194 3195 \begin_layout Standard 3196 Fortran: 3197 \end_layout 3198 3199 \begin_layout LyX-Code 2210 3200 INTEGER :: datadim 2211 3201 \end_layout 2212 3202 2213 3203 \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 3204 Defines how a field is stored on memory for the client code. 3205 The value can be either 2226 3206 \begin_inset Flex Strong 2227 3207 status collapsed … … 2244 3224 2245 3225 . 2246 Avalue of3226 The value of 2247 3227 \begin_inset Flex Strong 2248 3228 status collapsed … … 2254 3234 \end_inset 2255 3235 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 2259 3238 \begin_inset Flex Strong 2260 3239 status collapsed … … 2266 3245 \end_inset 2267 3246 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. 2270 3248 The default value is 2271 3249 \begin_inset Flex Strong … … 2282 3260 2283 3261 \begin_layout Subsection* 2284 data_ibegin :3262 data_ibegin (optional): 2285 3263 \emph on 2286 3264 integer … … 2296 3274 2297 3275 \begin_layout Standard 2298 Define the beginning index of thefield data for the first dimension.2299 This attribute is an offset re garding the local domain, so the value can2300 be negative.3276 Defines 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. 2301 3279 A negative value indicates that only some valid part of the data will extracted 2302 3280 , for example in the case of a ghost cell. … … 2304 3282 stored in memory. 2305 3283 A 0-value means that the local domain matches the data in memory. 2306 Th is attribute is optional and the default value is 0.2307 Otherwise3284 The default value is 0. 3285 The attributes 2308 3286 \begin_inset Flex Strong 2309 3287 status collapsed … … 2329 3307 2330 3308 \begin_layout Subsection* 2331 data_ni :3309 data_ni (optional): 2332 3310 \emph on 2333 3311 integer … … 2343 3321 2344 3322 \begin_layout Standard 2345 Define the size of thefield data for the first dimension.2346 Th is attribute is optional and the default value is3323 Defines the size of field data for the first dimension. 3324 The default value is 2347 3325 \begin_inset Flex Strong 2348 3326 status collapsed … … 2355 3333 2356 3334 . 2357 Otherwise3335 The attributes 2358 3336 \begin_inset Flex Strong 2359 3337 status collapsed … … 2379 3357 2380 3358 \begin_layout Subsection* 2381 data_jbegin :3359 data_jbegin (optional): 2382 3360 \emph on 2383 3361 integer … … 2393 3371 2394 3372 \begin_layout Standard 2395 Define the beginning index of thefield data for the second dimension.2396 Th is attribute is takeaccount only if3373 Defines the beginning index of field data for the second dimension. 3374 The attribute is taken into account only if 2397 3375 \begin_inset Flex Strong 2398 3376 status collapsed … … 2405 3383 2406 3384 . 2407 Th is attribute is an offset regardingthe local domain, so the value can3385 The attribute is an offset relative to the local domain, so the value can 2408 3386 be negative. 2409 3387 A negative value indicate that only some valid part of the data will extracted, … … 2411 3389 A positive value indicate that the local domain is greater than the data 2412 3390 stored in memory. 2413 A 0-value means that the local domain matchthe data in memory.2414 Th is attribute is optional and the default value is3391 The 0-value means that the local domain matches the data in memory. 3392 The default value is 2415 3393 \begin_inset Flex Strong 2416 3394 status collapsed … … 2423 3401 2424 3402 . 2425 Otherwise3403 The attributes 2426 3404 \begin_inset Flex Strong 2427 3405 status collapsed … … 2447 3425 2448 3426 \begin_layout Subsection* 2449 data_nj :3427 data_nj (optional): 2450 3428 \emph on 2451 3429 integer … … 2461 3439 2462 3440 \begin_layout Standard 2463 Define the size of thefield data for the second dimension.2464 Th isattribute is taken account only if3441 Defines the size of field data for the second dimension. 3442 The attribute is taken account only if 2465 3443 \begin_inset Flex Strong 2466 3444 status collapsed … … 2473 3451 2474 3452 . 2475 Th is attribute is optional and the default value is3453 The default value is 2476 3454 \begin_inset Flex Strong 2477 3455 status collapsed … … 2484 3462 2485 3463 . 2486 Otherwise3464 The attributes 2487 3465 \begin_inset Flex Strong 2488 3466 status collapsed … … 2508 3486 2509 3487 \begin_layout Subsection* 2510 data_i_index :3488 data_i_index (optional): 2511 3489 \emph on 2512 3490 1D-array of integer … … 2522 3500 2523 3501 \begin_layout Standard 2524 In case of a compressed horizontal domain, define the indexation the indexation2525 of the data forthe first dimension.2526 The size of the arraymust be2527 \begin_inset Flex Strong 2528 status collapsed 2529 2530 \begin_layout Plain Layout 2531 data_n index3502 In 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 3506 status collapsed 3507 3508 \begin_layout Plain Layout 3509 data_n 2532 3510 \end_layout 2533 3511 … … 2535 3513 2536 3514 . 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* 3518 data_j_index (optional): 2542 3519 \emph on 2543 3520 1D-array of integer … … 2553 3530 2554 3531 \begin_layout Standard 2555 In case of a compressed horizontal domain, define the indexation the indexation2556 of the data forthe second dimension.2557 Th isis meaningful only if3532 In case of a compressed horizontal domain, defines the data indexation for 3533 the second dimension. 3534 The attribute is meaningful only if 2558 3535 \begin_inset Flex Strong 2559 3536 status collapsed … … 2566 3543 2567 3544 . 2568 This attribute is optional. 2569 \end_layout 2570 2571 \begin_layout Subsection* 2572 mask_1d: 3545 \end_layout 3546 3547 \begin_layout Subsection* 3548 mask_1d (optional): 2573 3549 \emph on 2574 3550 1D-array of bool … … 2584 3560 2585 3561 \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. 3562 Defines the 1D mask of a local domain. 2589 3563 The masked value will be replaced by the value of the field attribute 2590 3564 \begin_inset Flex Strong … … 2597 3571 \end_inset 2598 3572 2599 in theoutput file.3573 in an output file. 2600 3574 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* 3579 mask_2d (optional): 2606 3580 \emph on 2607 3581 2D-array of bool … … 2617 3591 2618 3592 \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 3593 Defines the 2D mask of a local domain. 3594 The masked values will be replaced by the value of the field attribute 3595 2623 3596 \begin_inset Flex Strong 2624 3597 status collapsed … … 2630 3603 \end_inset 2631 3604 2632 in the output file. 3605 in an output file. 3606 By default, none of the values are masked. 2633 3607 Only mask_2d or mask_1d can be defined. 2634 3608 \end_layout 2635 3609 2636 3610 \begin_layout Subsection* 2637 domain_ref : string3611 domain_ref (optional): string 2638 3612 \end_layout 2639 3613 … … 2647 3621 2648 3622 \begin_layout Standard 2649 Define the reference of thedomain.3623 Defines the reference to a domain. 2650 3624 All attributes are inherited from the referenced domain with the classic 2651 3625 inheritance mechanism. 2652 3626 The value assigned to the referenced domain is transmitted to to current 2653 3627 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* 3631 i_index (optional): 2659 3632 \begin_inset Flex Emph 2660 3633 status collapsed … … 2678 3651 2679 3652 \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 3653 Defines 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 2684 3656 \begin_inset Flex Strong 2685 3657 status collapsed … … 2695 3667 2696 3668 \begin_layout Subsection* 2697 j_index :3669 j_index (optional): 2698 3670 \begin_inset Flex Emph 2699 3671 status collapsed … … 2717 3689 2718 3690 \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 3691 Defines 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 2723 3694 \begin_inset Flex Strong 2724 3695 status collapsed … … 2731 3702 2732 3703 . 3704 \end_layout 3705 3706 \begin_layout Subsection* 3707 comment (optional): 3708 \begin_inset Flex Emph 3709 status collapsed 3710 3711 \begin_layout Plain Layout 3712 string 3713 \end_layout 3714 3715 \end_inset 3716 3717 3718 \end_layout 3719 3720 \begin_layout Standard 3721 Fortran: 3722 \end_layout 3723 3724 \begin_layout LyX-Code 3725 CHARACTER(LEN=*) :: comment 3726 \end_layout 3727 3728 \begin_layout Standard 3729 Allows a user to set a comment. 2733 3730 \end_layout 2734 3731 … … 2738 3735 2739 3736 \begin_layout Subsection* 2740 name : string3737 name (optional): string 2741 3738 \end_layout 2742 3739 … … 2750 3747 2751 3748 \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 3749 Defines the name of a grid. 3750 \end_layout 3751 3752 \begin_layout Subsection* 3753 description (optional): string 2759 3754 \end_layout 2760 3755 … … 2768 3763 2769 3764 \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: 3765 Defines the descriptions of a grid. 3766 \end_layout 3767 3768 \begin_layout Subsection* 3769 mask_1d (optional): 2776 3770 \emph on 2777 3771 1D-array of bool … … 2787 3781 2788 3782 \begin_layout Standard 2789 Define the mask of the local 1-dimensiongrid.2790 Masked value will be replaced by the value of the field attribute3783 Defines the mask of a local 1D grid. 3784 Masked values will be replaced by the value of the field attribute 2791 3785 \begin_inset Flex Strong 2792 3786 status collapsed … … 2798 3792 \end_inset 2799 3793 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* 3799 mask_2d (optional): 2807 3800 \emph on 2808 3801 2D-array of bool … … 2818 3811 2819 3812 \begin_layout Standard 2820 Define the mask of the local 2-dimensiongrid.2821 Masked value will be replaced by the value of the field attribute3813 Defines the mask of a local 2D grid. 3814 Masked values will be replaced by the value of the field attribute 2822 3815 \begin_inset Flex Strong 2823 3816 status collapsed … … 2829 3822 \end_inset 2830 3823 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* 3829 mask_3d (optional): 2838 3830 \emph on 2839 3831 3D-array of bool … … 2849 3841 2850 3842 \begin_layout Standard 2851 Define the mask of the local 3-dimensiongrid.2852 Masked value will be replaced by the value of the field attribute3843 Define the mask of a local 3D grid. 3844 Masked values will be replaced by the value of the field attribute 2853 3845 \begin_inset Flex Strong 2854 3846 status collapsed … … 2860 3852 \end_inset 2861 3853 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* 3859 mask_4d (optional): 3860 \emph on 3861 4D-array of bool 3862 \end_layout 3863 3864 \begin_layout Standard 3865 Fortran: 3866 \end_layout 3867 3868 \begin_layout LyX-Code 3869 LOGICAL :: mask_4d(:,:,:) 3870 \end_layout 3871 3872 \begin_layout Standard 3873 Define 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 3876 status collapsed 3877 3878 \begin_layout Plain Layout 3879 default_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* 3889 mask_5d (optional): 3890 \emph on 3891 5D-array of bool 3892 \end_layout 3893 3894 \begin_layout Standard 3895 Fortran: 3896 \end_layout 3897 3898 \begin_layout LyX-Code 3899 LOGICAL :: mask_5d(:,:,:) 3900 \end_layout 3901 3902 \begin_layout Standard 3903 Define 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 3906 status collapsed 3907 3908 \begin_layout Plain Layout 3909 default_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* 3919 mask_6d (optional): 3920 \emph on 3921 6D-array of bool 3922 \end_layout 3923 3924 \begin_layout Standard 3925 Fortran: 3926 \end_layout 3927 3928 \begin_layout LyX-Code 3929 LOGICAL :: mask_6d(:,:,:) 3930 \end_layout 3931 3932 \begin_layout Standard 3933 Define 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 3936 status collapsed 3937 3938 \begin_layout Plain Layout 3939 default_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* 3949 mask_7d (optional): 3950 \emph on 3951 7D-array of bool 3952 \end_layout 3953 3954 \begin_layout Standard 3955 Fortran: 3956 \end_layout 3957 3958 \begin_layout LyX-Code 3959 LOGICAL :: mask_7d(:,:,:) 3960 \end_layout 3961 3962 \begin_layout Standard 3963 Define 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 3966 status collapsed 3967 3968 \begin_layout Plain Layout 3969 default_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* 3979 comment (optional): 3980 \begin_inset Flex Emph 3981 status collapsed 3982 3983 \begin_layout Plain Layout 3984 string 3985 \end_layout 3986 3987 \end_inset 3988 3989 3990 \end_layout 3991 3992 \begin_layout Standard 3993 Fortran: 3994 \end_layout 3995 3996 \begin_layout LyX-Code 3997 CHARACTER(LEN=*) :: comment 3998 \end_layout 3999 4000 \begin_layout Standard 4001 Allows a user to set a comment. 2866 4002 \end_layout 2867 4003 … … 2871 4007 2872 4008 \begin_layout Subsection* 2873 name :4009 name (optional): 2874 4010 \emph on 2875 4011 string … … 2885 4021 2886 4022 \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. 4023 Defines the name of a field as it will appear in an output file. 2899 4024 If not present, the identifier 2900 4025 \begin_inset Flex Strong … … 2911 4036 2912 4037 \begin_layout Subsection* 2913 standard_name :4038 standard_name (optional): 2914 4039 \emph on 2915 4040 string … … 2925 4050 2926 4051 \begin_layout Standard 2927 Define the4052 Defines the 2928 4053 \begin_inset Flex Strong 2929 4054 status collapsed … … 2936 4061 2937 4062 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* 4066 long_name (optional): 2943 4067 \emph on 2944 4068 string … … 2954 4078 2955 4079 \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: 4080 Defines the long name as it will appear in the metadata of an output file. 4081 \end_layout 4082 4083 \begin_layout Subsection* 4084 expr (optional): 2972 4085 \emph on 2973 4086 string … … 2979 4092 2980 4093 \begin_layout LyX-Code 4094 CHARACTER(LEN=*) :: expr 4095 \end_layout 4096 4097 \begin_layout Standard 4098 Defines the expression for arithmetic or time-integration operations performed 4099 on a field. 4100 For example if 4101 \series bold 4102 expr= 4103 \begin_inset Quotes erd 4104 \end_inset 4105 4106 sqrt(@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 4115 temp 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* 4122 unit (optional): 4123 \emph on 4124 string 4125 \end_layout 4126 4127 \begin_layout Standard 4128 Fortran: 4129 \end_layout 4130 4131 \begin_layout LyX-Code 2981 4132 CHARACTER(LEN=*) :: unit 2982 4133 \end_layout 2983 4134 2984 4135 \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 } 4136 Defines the unit of a field. 4137 \end_layout 4138 4139 \begin_layout Subsection* 4140 operation (mandatory): enumeration 4141 \emph on 4142 {once, instant, average, maximum, minimum, accumulate} 3003 4143 \end_layout 3004 4144 … … 3012 4152 3013 4153 \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: 4154 Defines the temporal operation applied to a field. 4155 \end_layout 4156 4157 \begin_layout Subsection* 4158 freq_op (optional): 3020 4159 \emph on 3021 4160 duration … … 3031 4170 3032 4171 \begin_layout Standard 3033 Define the frequency of the sampling for the temporal operation, so a field3034 value will be used for temporal averaging every4172 Defines the sampling frequency of a temporal operation, so that field values 4173 will be used for temporal sampling at frequency 3035 4174 \begin_inset Flex Strong 3036 4175 status collapsed … … 3042 4181 \end_inset 3043 4182 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 4187 status collapsed 4188 4189 \begin_layout Plain Layout 4190 output_freq 4191 \end_layout 4192 4193 \end_inset 4194 4195 for 4196 \begin_inset Flex Strong 4197 status collapsed 4198 4199 \begin_layout Plain Layout 4200 instant 4201 \end_layout 4202 4203 \end_inset 4204 4205 operations and 3048 4206 \begin_inset Flex Strong 3049 4207 status collapsed … … 3055 4213 \end_inset 3056 4214 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* 4219 freq_offset (optional): 3062 4220 \emph on 3063 4221 duration … … 3073 4231 3074 4232 \begin_layout Standard 3075 Define the offset when4233 Defines the offset when 3076 4234 \begin_inset Flex Strong 3077 4235 status collapsed … … 3084 4242 3085 4243 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 4246 0 4247 \series default 4248 and 4249 \begin_inset Flex Strong 4250 status collapsed 4251 4252 \begin_layout Plain Layout 4253 freq_op 4254 \end_layout 4255 4256 \end_inset 4257 4258 . 4259 The default value is 4260 \begin_inset Flex Strong 4261 status collapsed 4262 4263 \begin_layout Plain Layout 4264 freq_op - 1ts 4265 \end_layout 4266 4267 \end_inset 4268 4269 for fields in the 4270 \begin_inset Flex Strong 4271 status collapsed 4272 4273 \begin_layout Plain Layout 4274 write 4275 \end_layout 4276 4277 \end_inset 4278 4279 mode and 4280 \series bold 4281 0 4282 \series default 4283 for fields in the 4284 \begin_inset Flex Strong 4285 status collapsed 4286 4287 \begin_layout Plain Layout 4288 read 4289 \end_layout 4290 4291 \end_inset 4292 4293 mode. 4294 \end_layout 4295 4296 \begin_layout Subsection* 4297 level (optional): 3108 4298 \emph on 3109 4299 integer … … 3119 4309 3120 4310 \begin_layout Standard 3121 Define the level of output of thefield.3122 Afield will be output only if the file attribute4311 Defines the output level of a field. 4312 The field will be output only if the file attribute 3123 4313 \begin_inset Flex Strong 3124 4314 status collapsed … … 3135 4325 3136 4326 . 3137 Th is attribute is optional, the default value is4327 The default value is 3138 4328 \begin_inset Flex Strong 3139 4329 status collapsed … … 3149 4339 3150 4340 \begin_layout Subsection* 3151 prec :4341 prec (optional): 3152 4342 \emph on 3153 4343 integer … … 3163 4353 3164 4354 \begin_layout Standard 3165 Define the precision in byteof a field in an output file.3166 Available value are: 2 (integer), 4 (float single precision) and 8 (float4355 Defines the precision in bytes of a field in an output file. 4356 Available values are: 2 (integer), 4 (float single precision) and 8 (float 3167 4357 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* 4362 enabled (optional): 3172 4363 \emph on 3173 4364 bool … … 3183 4374 3184 4375 \begin_layout Standard 3185 Define if a field must be output or not.3186 Th is attribute is optional, the default value is4376 Defines if a field must be output or not. 4377 The default value is 3187 4378 \begin_inset Flex Strong 3188 4379 status collapsed … … 3198 4389 3199 4390 \begin_layout Subsection* 3200 read_access:4391 check_if_active (optional): 3201 4392 \emph on 3202 4393 bool … … 3208 4399 3209 4400 \begin_layout LyX-Code 4401 LOGICAL :: check_if_active 4402 \end_layout 4403 4404 \begin_layout Standard 4405 Sets 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* 4413 read_access (optional): 4414 \emph on 4415 bool 4416 \end_layout 4417 4418 \begin_layout Standard 4419 Fortran: 4420 \end_layout 4421 4422 \begin_layout LyX-Code 3210 4423 LOGICAL :: read_access 3211 4424 \end_layout 3212 4425 3213 4426 \begin_layout Standard 3214 Define whether a field can be read from the model or not.3215 Th is attribute is optional, the default value is4427 Defines whether a field can be read from the model or not. 4428 The default value is 3216 4429 \begin_inset Flex Strong 3217 4430 status collapsed … … 3242 4455 3243 4456 \begin_layout Subsection* 3244 field_ref :4457 field_ref (optional): 3245 4458 \emph on 3246 4459 string … … 3256 4469 3257 4470 \begin_layout Standard 3258 Define afield reference.3259 All attributes are inherited from the referenced field afterthe classical4471 Defines the field reference. 4472 All attributes will be inherited from the referenced field via the classical 3260 4473 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* 4479 grid_ref (optional): 3268 4480 \emph on 3269 4481 string … … 3279 4491 3280 4492 \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: 4493 Defines the field grid. 4494 Note that only either 4495 \begin_inset Flex Strong 4496 status collapsed 4497 4498 \begin_layout Plain Layout 4499 grid_ref 4500 \end_layout 4501 4502 \end_inset 4503 4504 or a combination of 4505 \begin_inset Flex Strong 4506 status collapsed 4507 4508 \begin_layout Plain Layout 4509 domain_ref 4510 \end_layout 4511 4512 \end_inset 4513 4514 , 4515 \begin_inset Flex Strong 4516 status collapsed 4517 4518 \begin_layout Plain Layout 4519 scalar_ref 4520 \end_layout 4521 4522 \end_inset 4523 4524 or 4525 \begin_inset Flex Strong 4526 status collapsed 4527 4528 \begin_layout Plain Layout 4529 axis_ref 4530 \end_layout 4531 4532 \end_inset 4533 4534 can be specified. 4535 \end_layout 4536 4537 \begin_layout Subsection* 4538 domain_ref (optional): 3288 4539 \emph on 3289 4540 string … … 3299 4550 3300 4551 \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,4552 Defines the field domain. 4553 If the attribute is defined, the attribute 3303 4554 \begin_inset Flex Strong 3304 4555 status collapsed … … 3310 4561 \end_inset 3311 4562 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* 4567 axis_ref (optional): 3317 4568 \emph on 3318 4569 string … … 3328 4579 3329 4580 \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 4581 Defines an axis for the current field. 4582 If the attribute is defined, the attribute 3342 4583 \begin_inset Flex Strong 3343 4584 status collapsed … … 3349 4590 \end_inset 3350 4591 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* 4596 scalar_ref (optional): 3356 4597 \emph on 3357 4598 string … … 3363 4604 3364 4605 \begin_layout LyX-Code 4606 CHARACTER(LEN=*) :: scalar_ref 4607 \end_layout 4608 4609 \begin_layout Standard 4610 Defines a scalar domain for the current field. 4611 If the attribute is defined, the attribute 4612 \begin_inset Flex Strong 4613 status collapsed 4614 4615 \begin_layout Plain Layout 4616 grid_ref 4617 \end_layout 4618 4619 \end_inset 4620 4621 must not be specified. 4622 \end_layout 4623 4624 \begin_layout Subsection* 4625 grid_path (optional): 4626 \emph on 4627 string 4628 \end_layout 4629 4630 \begin_layout Standard 4631 Fortran: 4632 \end_layout 4633 4634 \begin_layout LyX-Code 3365 4635 CHARACTER(LEN=*) :: grid_path 3366 4636 \end_layout 3367 4637 3368 4638 \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: 4639 Defines the way operations pass from a grid to other grids. 4640 \end_layout 4641 4642 \begin_layout Subsection* 4643 default_value (optional): 3375 4644 \emph on 3376 4645 double … … 3386 4655 3387 4656 \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: 4657 Defines 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* 4663 valid_min (optional): 3397 4664 \emph on 3398 4665 double … … 3418 4685 \end_inset 3419 4686 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* 4691 valid_max (optional): 3425 4692 \emph on 3426 4693 double … … 3446 4713 \end_inset 3447 4714 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* 4719 detect_missing_value (optional): 3453 4720 \emph on 3454 4721 bool … … 3464 4731 3465 4732 \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: 4733 When XIOS detects a default value in a field, it does not take into account 4734 the value during arithmetic operations such as averaging, minimum, maximum, 4735 etc. 4736 \end_layout 4737 4738 \begin_layout Subsection* 4739 add_offset (optional): 3472 4740 \emph on 3473 4741 double … … 3483 4751 3484 4752 \begin_layout Standard 3485 Set the4753 Sets the 3486 4754 \begin_inset Flex Strong 3487 4755 status collapsed … … 3493 4761 \end_inset 3494 4762 3495 metadata CF attribute in theoutput file.4763 metadata CF attribute in an output file. 3496 4764 In output, the 3497 4765 \begin_inset Flex Strong … … 3504 4772 \end_inset 3505 4773 3506 value is subtracted tothe field values.4774 value will be subtracted from the field values. 3507 4775 \end_layout 3508 4776 … … 3522 4790 3523 4791 \begin_layout Standard 3524 Set the4792 Sets the 3525 4793 \begin_inset Flex Strong 3526 4794 status collapsed … … 3532 4800 \end_inset 3533 4801 3534 metadata CF attribute in theoutput file.3535 In output, the field values are divided by the4802 metadata CF attribute in an output file. 4803 In output, the field values will be divided by the 3536 4804 \begin_inset Flex Strong 3537 4805 status collapsed … … 3547 4815 3548 4816 \begin_layout Subsection* 3549 compression_level :4817 compression_level (optional): 3550 4818 \emph on 3551 4819 integer … … 3561 4829 3562 4830 \begin_layout Standard 3563 Define whether the field should be compressed using NetCDF-4 built-in compressio 3564 n. 4831 Defines whether a field should be compressed using NetCDF-4 built-in compression. 3565 4832 The compression level must range from 0 to 9. 3566 A nhigher compression level means a better compression at the cost of using4833 A higher compression level means a better compression at the cost of using 3567 4834 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 3570 4836 \series bold 3571 4837 compression_level … … 3575 4841 3576 4842 \begin_layout Subsection* 3577 indexed_output :4843 indexed_output (optional): 3578 4844 \emph on 3579 4845 bool … … 3589 4855 3590 4856 \begin_layout Standard 3591 Define whether the field data must be outputted as an indexed grid instead3592 ofa full grid whenever possible.3593 Th is attribute is optional, the default value is4857 Defines whether field data must be output as an indexed grid instead of 4858 a full grid whenever possible. 4859 The default value is 3594 4860 \series bold 3595 4861 \emph on … … 3601 4867 3602 4868 \begin_layout Subsection* 3603 ts_enabled :4869 ts_enabled (optional): 3604 4870 \emph on 3605 4871 bool … … 3615 4881 3616 4882 \begin_layout Standard 3617 Define whether the field can be outputted as a timeserie if requested.3618 Th is attribute is optional, the default value is4883 Defines whether a field can be output as a timeseries. 4884 The default value is 3619 4885 \series bold 3620 4886 \emph on … … 3626 4892 3627 4893 \begin_layout Subsection* 3628 ts_split_freq :4894 ts_split_freq (optional): 3629 4895 \emph on 3630 4896 duration … … 3640 4906 3641 4907 \begin_layout Standard 3642 Define the splitting frequency that should be used for the timeserieif4908 Defines the splitting frequency that should be used for a timeseries if 3643 4909 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 3646 4911 \series bold 3647 4912 split_freq … … 3650 4915 \end_layout 3651 4916 4917 \begin_layout Subsection* 4918 cell_methods (optional): 4919 \emph on 4920 string 4921 \end_layout 4922 4923 \begin_layout Standard 4924 Fortran: 4925 \end_layout 4926 4927 \begin_layout LyX-Code 4928 CHARACTER(LEN=*) :: cell_methods 4929 \end_layout 4930 4931 \begin_layout Standard 4932 Defines the cell methods field attribute. 4933 \end_layout 4934 4935 \begin_layout Subsection* 4936 cell_methods_mode (optional): enumeration 4937 \emph on 4938 {overwrite, prefix, suffix, none} 4939 \end_layout 4940 4941 \begin_layout Standard 4942 Fortran: 4943 \end_layout 4944 4945 \begin_layout LyX-Code 4946 CHARACTER(LEN=*) :: cell_methods_mode 4947 \end_layout 4948 4949 \begin_layout Standard 4950 Defines the cell methods mode of a field. 4951 \end_layout 4952 4953 \begin_layout Subsection* 4954 comment (optional): 4955 \begin_inset Flex Emph 4956 status collapsed 4957 4958 \begin_layout Plain Layout 4959 string 4960 \end_layout 4961 4962 \end_inset 4963 4964 4965 \end_layout 4966 4967 \begin_layout Standard 4968 Fortran: 4969 \end_layout 4970 4971 \begin_layout LyX-Code 4972 CHARACTER(LEN=*) :: comment 4973 \end_layout 4974 4975 \begin_layout Standard 4976 Allows a user to set a comment. 4977 \end_layout 4978 3652 4979 \begin_layout Section 3653 4980 Variable attribute reference … … 3655 4982 3656 4983 \begin_layout Subsection* 3657 name :4984 name (optional): 3658 4985 \emph on 3659 4986 string … … 3669 4996 3670 4997 \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 4998 Defines the name of a variable as it will appear in an output file. 4999 If not present, the variable 3684 5000 \begin_inset Flex Strong 3685 5001 status collapsed … … 3691 5007 \end_inset 3692 5008 3693 will be used instead.3694 \end_layout 3695 3696 \begin_layout Subsection* 3697 type : enumeration { bool, int, int32, int16, int64, float, double, string3698 }5009 will be used. 5010 \end_layout 5011 5012 \begin_layout Subsection* 5013 type (mandatory): enumeration {bool, int, int32, int16, int64, float, double, 5014 string} 3699 5015 \end_layout 3700 5016 … … 3708 5024 3709 5025 \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. 5026 Defines the type of a variable. 3721 5027 Note that the 3722 5028 \series bold … … 3732 5038 \emph default 3733 5039 . 3734 This attribute is mandatory. 5040 \end_layout 5041 5042 \begin_layout Subsection* 5043 ts_target (optional): enumeration {file, field, both, none} 5044 \end_layout 5045 5046 \begin_layout Standard 5047 Fortran: 5048 \end_layout 5049 5050 \begin_layout LyX-Code 5051 CHARACTER(LEN=*) :: ts_target 3735 5052 \end_layout 3736 5053 … … 3740 5057 3741 5058 \begin_layout Subsection* 3742 name :5059 name (mandatory): 3743 5060 \emph on 3744 5061 string … … 3754 5071 3755 5072 \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: 5073 Defines the name of a file. 5074 \end_layout 5075 5076 \begin_layout Subsection* 5077 description (optional): 3762 5078 \emph on 3763 5079 string … … 3773 5089 3774 5090 \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: 5091 Defines the description of a file. 5092 \end_layout 5093 5094 \begin_layout Subsection* 5095 name_suffix (optional): 3781 5096 \emph on 3782 5097 string … … 3792 5107 3793 5108 \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: 5109 Defines a suffix added to the file name. 5110 \end_layout 5111 5112 \begin_layout Subsection* 5113 min_digits (optional): 3800 5114 \emph on 3801 5115 integer … … 3811 5125 3812 5126 \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 5127 For the 5128 \series bold 5129 multiple_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 3816 5134 \begin_inset Flex Strong 3817 5135 status collapsed … … 3823 5141 \end_inset 3824 5142 5143 (no server rank suffix is added). 5144 \end_layout 5145 5146 \begin_layout Subsection* 5147 output_freq (mandatory): 5148 \emph on 5149 duration 5150 \end_layout 5151 5152 \begin_layout Standard 5153 Fortran: 5154 \end_layout 5155 5156 \begin_layout LyX-Code 5157 TYPE(xios_duration) :: output_freq 5158 \end_layout 5159 5160 \begin_layout Standard 5161 Defines the output frequency for the current file. 5162 \end_layout 5163 5164 \begin_layout Subsection* 5165 output_level (optional): 5166 \emph on 5167 integer 5168 \end_layout 5169 5170 \begin_layout Standard 5171 Fortran: 5172 \end_layout 5173 5174 \begin_layout LyX-Code 5175 INTEGER :: output_level 5176 \end_layout 5177 5178 \begin_layout Standard 5179 Defines the output level for all fields of the current file. 5180 The field is output only if the field attribute 5181 \series bold 5182 level 5183 \series default 5184 is less or equal to the file attribute 5185 \series bold 5186 output_level 5187 \series default 3825 5188 . 3826 5189 \end_layout 3827 5190 3828 5191 \begin_layout Subsection* 3829 output_freq:5192 sync_freq (optional): 3830 5193 \emph on 3831 5194 duration … … 3837 5200 3838 5201 \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: 5202 TYPE(xios_duration) :: sync_freq 5203 \end_layout 5204 5205 \begin_layout Standard 5206 Defines 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* 5212 split_freq (optional): 3872 5213 \emph on 3873 5214 duration … … 3879 5220 3880 5221 \begin_layout LyX-Code 3881 TYPE(xios_duration) :: sync_freq3882 \end_layout3883 3884 \begin_layout Standard3885 Define the frequency for flushing the current file onto disk.3886 It may result bad performance but data are wrote even if the file will3887 not be closed.3888 This attribute is optional.3889 \end_layout3890 3891 \begin_layout Subsection*3892 split_freq:3893 \emph on3894 duration3895 \end_layout3896 3897 \begin_layout Standard3898 Fortran:3899 \end_layout3900 3901 \begin_layout LyX-Code3902 5222 TYPE(xios_duration) :: split_freq 3903 5223 \end_layout 3904 5224 3905 5225 \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 5226 Defines 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 5229 status collapsed 5230 5231 \begin_layout Plain Layout 5232 3908 5233 \series bold 3909 name3910 \series default3911 (see3912 \begin_inset Flex Emph3913 status collapsed3914 3915 \begin_layout Plain Layout3916 3917 \series bold3918 5234 \emph on 3919 5235 split_freq_format … … 3923 5239 3924 5240 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* 5245 split_freq_format (optional): 3930 5246 \emph on 3931 5247 string … … 3941 5257 3942 5258 \begin_layout Standard 3943 Define the format of the split date suffixed to thefile.3944 Can contain any character,5259 Defines the format of the split date suffixed to a file. 5260 It can contain any character, 3945 5261 \emph on 3946 5262 … … 4027 5343 4028 5344 by the number of full days since the time origin. 4029 Th is attribute is optional and the default behavior is to create a suffix4030 with the date until the smallernon zero unit.5345 The default behavior is to create a suffix with the date until the smaller 5346 non zero unit. 4031 5347 For example, in one day split frequency, the hour, minute and second will 4032 5348 not appear in the suffix, only year, month and day. … … 4034 5350 4035 5351 \begin_layout Subsection* 4036 enabled: 5352 split_start_offset(optional): 5353 \emph on 5354 duration 5355 \end_layout 5356 5357 \begin_layout Standard 5358 Fortran: 5359 \end_layout 5360 5361 \begin_layout LyX-Code 5362 TYPE(xios_duration) :: split_start_offset 5363 \end_layout 5364 5365 \begin_layout Standard 5366 Defines the offset of file splitting. 5367 5368 \end_layout 5369 5370 \begin_layout Subsection* 5371 split_end_offset(optional): 5372 \emph on 5373 duration 5374 \end_layout 5375 5376 \begin_layout Standard 5377 Fortran: 5378 \end_layout 5379 5380 \begin_layout LyX-Code 5381 TYPE(xios_duration) :: split_end_offset 5382 \end_layout 5383 5384 \begin_layout Subsection* 5385 split_last_date (optional): 5386 \emph on 5387 string 5388 \end_layout 5389 5390 \begin_layout Standard 5391 Fortran: 5392 \end_layout 5393 5394 \begin_layout LyX-Code 5395 CHARACTER(LEN=*) :: split_last_date 5396 \end_layout 5397 5398 \begin_layout Subsection* 5399 enabled (optional): 4037 5400 \emph on 4038 5401 bool … … 4048 5411 4049 5412 \begin_layout Standard 4050 Define if a file must be written/read or not.4051 Th is attribute is optional, the default value is5413 Defines if a file must be written/read or not. 5414 The default value is 4052 5415 \begin_inset Flex Strong 4053 5416 status collapsed … … 4063 5426 4064 5427 \begin_layout Subsection* 4065 mode :4066 \emph on 4067 enumeration { read, write}5428 mode (optional): 5429 \emph on 5430 enumeration {read, write} 4068 5431 \end_layout 4069 5432 … … 4077 5440 4078 5441 \begin_layout Standard 4079 Define whether thefile will be read or written.4080 Th is attribute is optional, the default value is5442 Defines whether a file will be read or written. 5443 The default value is 4081 5444 \begin_inset Flex Strong 4082 5445 status collapsed … … 4092 5455 4093 5456 \begin_layout Subsection* 4094 type :4095 \emph on 4096 enumeration { one_file, multiple_file}5457 type (mandatory): 5458 \emph on 5459 enumeration {one_file, multiple_file} 4097 5460 \end_layout 4098 5461 … … 4106 5469 4107 5470 \begin_layout Standard 4108 Define the type of thefile:5471 Defines the type of a file: 4109 5472 \begin_inset Flex Strong 4110 5473 status collapsed … … 4131 5494 4132 5495 : 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* 5499 format (optional): 5500 \emph on 5501 enumeration {netcdf4, netcdf4_classic} 5502 \end_layout 5503 5504 \begin_layout Standard 5505 Fortran: 5506 \end_layout 5507 5508 \begin_layout LyX-Code 5509 CHARACTER(LEN=*) :: format 5510 \end_layout 5511 5512 \begin_layout Standard 5513 Define the format of a file: 4152 5514 \begin_inset Flex Strong 4153 5515 status collapsed … … 4178 5540 4179 5541 : the classic NetCDF format will be used. 4180 The attribute is optional, thedefault value is5542 The default value is 4181 5543 \series bold 4182 5544 \emph on … … 4210 5572 4211 5573 \begin_layout Subsection* 4212 par_access :4213 \emph on 4214 enumeration { collective, independent}5574 par_access (optional): 5575 \emph on 5576 enumeration {collective, independent} 4215 5577 \end_layout 4216 5578 … … 4224 5586 4225 5587 \begin_layout Standard 4226 For parallel writing, define which type of MPI calls will be used.4227 Th is attribute is optional, the default value is5588 For parallel writing, defines which type of MPI calls will be used. 5589 The default value is 4228 5590 \begin_inset Flex Strong 4229 5591 status collapsed … … 4241 5603 4242 5604 \begin_layout Subsection* 4243 append:5605 read_metadata_par (optional): 4244 5606 \emph on 4245 5607 bool … … 4251 5613 4252 5614 \begin_layout LyX-Code 5615 LOGICAL :: read_metadata_par 5616 \end_layout 5617 5618 \begin_layout Standard 5619 For 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* 5625 convention (optional): 5626 \emph on 5627 enumeration {CF, UGRID} 5628 \end_layout 5629 5630 \begin_layout Standard 5631 Fortran: 5632 \end_layout 5633 5634 \begin_layout LyX-Code 5635 CHARACTER(LEN=*) :: convention 5636 \end_layout 5637 5638 \begin_layout Standard 5639 Defines the file conventions. 5640 By default the CF conventions are followed. 5641 \end_layout 5642 5643 \begin_layout Subsection* 5644 convention_str (optional): 5645 \emph on 5646 string 5647 \end_layout 5648 5649 \begin_layout Standard 5650 Fortran: 5651 \end_layout 5652 5653 \begin_layout LyX-Code 5654 CHARACTER(LEN=*) :: convention_str 5655 \end_layout 5656 5657 \begin_layout Standard 5658 Defines the 5659 \series bold 5660 Conventions 5661 \series default 5662 attribute to be added to file global attributes. 5663 \end_layout 5664 5665 \begin_layout Subsection* 5666 append (optional): 5667 \emph on 5668 bool 5669 \end_layout 5670 5671 \begin_layout Standard 5672 Fortran: 5673 \end_layout 5674 5675 \begin_layout LyX-Code 4253 5676 LOGICAL :: append 4254 5677 \end_layout 4255 5678 4256 5679 \begin_layout Standard 4257 Define whether the output data is to be appended at the end of the file4258 if it alreadyexists or if the existing file is to be overwritten.4259 Th is attribute is optional, the default value is5680 Defines whether data is to be appended at the end of a file if it already 5681 exists or if the existing file is to be overwritten. 5682 The default value is 4260 5683 \begin_inset Flex Strong 4261 5684 status collapsed … … 4273 5696 4274 5697 \begin_layout Subsection* 4275 compression_level :5698 compression_level (optional): 4276 5699 \emph on 4277 5700 integer … … 4287 5710 4288 5711 \begin_layout Standard 4289 Define whether the fields should be compressed using NetCDF-4 built-in compressi4290 on by default.5712 Defines whether the fields should be compressed using NetCDF-4 built-in 5713 compression by default. 4291 5714 The compression level must range from 0 to 9. 4292 A nhigher compression level means a better compression at the cost of using5715 A higher compression level means a better compression at the cost of using 4293 5716 more processing power. 4294 Th is attribute is optional, the default value is5717 The default value is 4295 5718 \begin_inset Flex Strong 4296 5719 status collapsed … … 4308 5731 4309 5732 \begin_layout Subsection* 4310 time_counter: 4311 \emph on 4312 enumeration { centered, instant, record, none } 5733 time_counter (optional): 5734 \emph on 5735 enumeration {centered, instant, record, exclusive, centered_exclusive, instant_e 5736 xclusive, none} 4313 5737 \end_layout 4314 5738 … … 4322 5746 4323 5747 \begin_layout Standard 4324 Define how the5748 Defines how the 4325 5749 \begin_inset Quotes eld 4326 5750 \end_inset … … 4330 5754 \end_inset 4331 5755 4332 variable will be output ted:5756 variable will be output: 4333 5757 \end_layout 4334 5758 … … 4340 5764 \series default 4341 5765 \emph default 4342 : use centered times 5766 : use centered times (default option for all field operations except for 5767 instant) 4343 5768 \end_layout 4344 5769 … … 4350 5775 \series default 4351 5776 \emph default 4352 : use instant times 5777 : use instant times (default option for field operation 5778 \series bold 5779 instant 5780 \series default 5781 ) 4353 5782 \end_layout 4354 5783 … … 4366 5795 4367 5796 \series bold 5797 \shape italic 5798 centered_exclusive: 5799 \series default 5800 \shape default 5801 do 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 5809 instant_ 5810 \emph default 5811 exclusive: 5812 \series default 5813 \shape default 5814 do not include instant times into an output file 5815 \end_layout 5816 5817 \begin_layout Itemize 5818 5819 \series bold 5820 \shape italic 5821 exclusive: 5822 \series default 5823 \shape default 5824 include neither instant times nor centered times into an output file 5825 \end_layout 5826 5827 \begin_layout Itemize 5828 5829 \series bold 4368 5830 \emph on 4369 5831 none … … 4374 5836 4375 5837 \begin_layout Standard 4376 Th is attribute is optional, the default value is5838 The default value is 4377 5839 \series bold 4378 5840 \emph on … … 4384 5846 4385 5847 \begin_layout Subsection* 4386 time_counter_name :5848 time_counter_name (optional): 4387 5849 \emph on 4388 5850 string … … 4398 5860 4399 5861 \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 } 5862 Define the name of a time counter. 5863 \end_layout 5864 5865 \begin_layout Subsection* 5866 timeseries (optional): 5867 \emph on 5868 enumeration {none, only, both, exclusive} 4408 5869 \end_layout 4409 5870 … … 4417 5878 4418 5879 \begin_layout Standard 4419 Define whether the timeseries must be outputted:5880 Defines whether the timeseries must be output: 4420 5881 \end_layout 4421 5882 … … 4427 5888 \series default 4428 5889 \emph default 4429 : no timeseries areoutputted, only the regular file5890 : no timeseries is outputted, only the regular file 4430 5891 \end_layout 4431 5892 … … 4437 5898 \series default 4438 5899 \emph default 4439 : only the timeseries areoutputted, the regular file is not created5900 : only the timeseries is outputted, the regular file is not created 4440 5901 \end_layout 4441 5902 … … 4457 5918 \series default 4458 5919 \emph default 4459 : the timeseries areoutputted and a regular file is created with only the4460 fields which were not marked for output as a timeserie (if any).4461 \end_layout 4462 4463 \begin_layout Standard 4464 Th is attribute is optional, the default value is5920 : 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 5925 The default value is 4465 5926 \series bold 4466 5927 \emph on … … 4472 5933 4473 5934 \begin_layout Subsection* 4474 ts_prefix :5935 ts_prefix (optional): 4475 5936 \emph on 4476 5937 string … … 4486 5947 4487 5948 \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: 5949 Defines 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* 5954 time_units (optional): 5955 \emph on 5956 enumeration {seconds, days} 5957 \end_layout 5958 5959 \begin_layout Standard 5960 Fortran: 5961 \end_layout 5962 5963 \begin_layout LyX-Code 5964 CHARACTER(LEN=*) :: time_units 5965 \end_layout 5966 5967 \begin_layout Subsection* 5968 record_offset (optional): 4498 5969 \emph on 4499 5970 integer … … 4509 5980 4510 5981 \begin_layout Standard 4511 Define offset of record from the beginning record. 4512 This attribute is optional, by default, its value is 0. 5982 Defines the offset of a record from the beginning record. 5983 The default value is 0. 5984 \end_layout 5985 5986 \begin_layout Subsection* 5987 cyclic (optional): 5988 \emph on 5989 bool 5990 \end_layout 5991 5992 \begin_layout Standard 5993 Fortran: 5994 \end_layout 5995 5996 \begin_layout LyX-Code 5997 LOGICAL :: cyclic 5998 \end_layout 5999 6000 \begin_layout Standard 6001 If 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 6006 cycle 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* 6015 time_stamp_name (optional): 6016 \begin_inset Flex Emph 6017 status collapsed 6018 6019 \begin_layout Plain Layout 6020 string 6021 \end_layout 6022 6023 \end_inset 6024 6025 6026 \end_layout 6027 6028 \begin_layout Standard 6029 Fortran: 6030 \end_layout 6031 6032 \begin_layout LyX-Code 6033 CHARACTER(LEN=*) :: time_stamp_name 6034 \end_layout 6035 6036 \begin_layout Standard 6037 Defines 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 6043 timeStamp 6044 \begin_inset Quotes erd 6045 \end_inset 6046 6047 . 6048 \end_layout 6049 6050 \begin_layout Subsection* 6051 time_stamp_format (optional): 6052 \begin_inset Flex Emph 6053 status collapsed 6054 6055 \begin_layout Plain Layout 6056 string 6057 \end_layout 6058 6059 \end_inset 6060 6061 6062 \end_layout 6063 6064 \begin_layout Standard 6065 Fortran: 6066 \end_layout 6067 6068 \begin_layout LyX-Code 6069 CHARACTER(LEN=*) :: time_stamp_format 6070 \end_layout 6071 6072 \begin_layout Standard 6073 Defines 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 6080 status 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 6094 status 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 6107 status 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 6119 status 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 6129 status 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 6139 status 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 6149 status 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 6159 status 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* 6171 uuid_name (optional): 6172 \begin_inset Flex Emph 6173 status collapsed 6174 6175 \begin_layout Plain Layout 6176 string 6177 \end_layout 6178 6179 \end_inset 6180 6181 6182 \end_layout 6183 6184 \begin_layout Standard 6185 Fortran: 6186 \end_layout 6187 6188 \begin_layout LyX-Code 6189 CHARACTER(LEN=*) :: uuid_name 6190 \end_layout 6191 6192 \begin_layout Standard 6193 Defines the name of file's UUID. 6194 \end_layout 6195 6196 \begin_layout Subsection* 6197 uuid_format (optional): 6198 \begin_inset Flex Emph 6199 status collapsed 6200 6201 \begin_layout Plain Layout 6202 string 6203 \end_layout 6204 6205 \end_inset 6206 6207 6208 \end_layout 6209 6210 \begin_layout Standard 6211 Fortran: 6212 \end_layout 6213 6214 \begin_layout LyX-Code 6215 CHARACTER(LEN=*) :: uuid_format 6216 \end_layout 6217 6218 \begin_layout Standard 6219 Defines the format of file's UUID. 6220 \end_layout 6221 6222 \begin_layout Subsection* 6223 comment (optional): 6224 \begin_inset Flex Emph 6225 status collapsed 6226 6227 \begin_layout Plain Layout 6228 string 6229 \end_layout 6230 6231 \end_inset 6232 6233 6234 \end_layout 6235 6236 \begin_layout Standard 6237 Fortran: 6238 \end_layout 6239 6240 \begin_layout LyX-Code 6241 CHARACTER(LEN=*) :: comment 6242 \end_layout 6243 6244 \begin_layout Standard 6245 Allows a user to set a comment. 4513 6246 \end_layout 4514 6247 … … 4518 6251 4519 6252 \begin_layout Subsection 6253 reduce_scalar_to_scalar 6254 \end_layout 6255 6256 \begin_layout Subsection* 6257 operation (mandatory): 6258 \emph on 6259 enumeration {min, max, sum, average} 6260 \end_layout 6261 6262 \begin_layout Standard 6263 Fortran: 6264 \end_layout 6265 6266 \begin_layout LyX-Code 6267 CHARACTER(LEN=*) :: operation 6268 \end_layout 6269 6270 \begin_layout Standard 6271 Defines 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 6276 extract_axis_to_scalar 6277 \end_layout 6278 6279 \begin_layout Subsection* 6280 position: 6281 \emph on 6282 integer 6283 \end_layout 6284 6285 \begin_layout Standard 6286 Fortran: 6287 \end_layout 6288 6289 \begin_layout LyX-Code 6290 INTEGER :: position 6291 \end_layout 6292 6293 \begin_layout Standard 6294 Global 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 4520 6302 interpolate_axis 4521 6303 \end_layout 4522 6304 4523 6305 \begin_layout Subsection* 4524 type :6306 type (optional): 4525 6307 \emph on 4526 6308 string … … 4536 6318 4537 6319 \begin_layout Standard 4538 Define the type of interpolationon an axis.4539 This attribute is optional.4540 \end_layout 4541 4542 \begin_layout Subsection* 4543 order :6320 Defines the interpolation type on an axis. 6321 For now only polynomial interpolation is available. 6322 \end_layout 6323 6324 \begin_layout Subsection* 6325 order (optional): 4544 6326 \emph on 4545 6327 integer … … 4555 6337 4556 6338 \begin_layout Standard 4557 Define a order of interpolation. 4558 This attribute is optional. 6339 Defines the order of interpolation. 4559 6340 The default value is 2. 4560 6341 \end_layout 4561 6342 6343 \begin_layout Subsection* 6344 coordinate (optional): 6345 \emph on 6346 string 6347 \end_layout 6348 6349 \begin_layout Standard 6350 Fortran: 6351 \end_layout 6352 6353 \begin_layout LyX-Code 6354 CHARACTER(LEN=*) :: coordinate 6355 \end_layout 6356 6357 \begin_layout Standard 6358 Defines the coordinate associated with an axis on which interpolation will 6359 be performed. 6360 \end_layout 6361 4562 6362 \begin_layout Subsection 4563 inverse_axis 6363 reduce_axis_to_axis 6364 \end_layout 6365 6366 \begin_layout Subsection* 6367 operation (mandatory): 6368 \emph on 6369 enumeration {min, max, sum, average} 6370 \end_layout 6371 6372 \begin_layout Standard 6373 Fortran: 6374 \end_layout 6375 6376 \begin_layout LyX-Code 6377 CHARACTER(LEN=*) :: operation 6378 \end_layout 6379 6380 \begin_layout Standard 6381 Defines 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 6386 reduce_axis_to_scalar 6387 \end_layout 6388 6389 \begin_layout Standard 6390 Reduces data defined on an axis into a scalar value. 6391 \end_layout 6392 6393 \begin_layout Subsection* 6394 operation (mandatory): 6395 \emph on 6396 enumeration {min, max, sum, average} 6397 \end_layout 6398 6399 \begin_layout Standard 6400 Fortran: 6401 \end_layout 6402 6403 \begin_layout LyX-Code 6404 CHARACTER(LEN=*) :: operation 4564 6405 \end_layout 4565 6406 … … 4569 6410 4570 6411 \begin_layout Subsection* 4571 begin :6412 begin (optional): 4572 6413 \begin_inset Flex Emph 4573 6414 status collapsed … … 4591 6432 4592 6433 \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 6434 Defines the beginning index of a zoomed region on a global axis. 6435 The attribute value should be an integer between 4596 6436 \begin_inset Flex Strong 4597 6437 status collapsed … … 4609 6449 \begin_layout Plain Layout 4610 6450 ni_glo-1 4611 \end_layout4612 4613 \end_inset4614 4615 of associated axis.4616 If not specified the default value is4617 \begin_inset Flex Strong4618 status collapsed4619 4620 \begin_layout Plain Layout4621 04622 \end_layout4623 4624 \end_inset4625 4626 .4627 \end_layout4628 4629 \begin_layout Subsection*4630 n:4631 \begin_inset Flex Emph4632 status collapsed4633 4634 \begin_layout Plain Layout4635 integer4636 \end_layout4637 4638 \end_inset4639 4640 4641 \end_layout4642 4643 \begin_layout Standard4644 Fortran:4645 \end_layout4646 4647 \begin_layout LyX-Code4648 INTEGER :: n4649 \end_layout4650 4651 \begin_layout Standard4652 Define the size of zoomed region on global axis.4653 This attribute is optional.4654 This must be an integer between4655 \begin_inset Flex Strong4656 status collapsed4657 4658 \begin_layout Plain Layout4659 14660 \end_layout4661 4662 \end_inset4663 4664 and4665 \begin_inset Flex Strong4666 status collapsed4667 4668 \begin_layout Plain Layout4669 nj_glo4670 6451 \end_layout 4671 6452 … … 4678 6459 4679 6460 \begin_layout Plain Layout 6461 0 6462 \end_layout 6463 6464 \end_inset 6465 6466 . 6467 \end_layout 6468 6469 \begin_layout Subsection* 6470 n (optional): 6471 \begin_inset Flex Emph 6472 status collapsed 6473 6474 \begin_layout Plain Layout 6475 integer 6476 \end_layout 6477 6478 \end_inset 6479 6480 6481 \end_layout 6482 6483 \begin_layout Standard 6484 Fortran: 6485 \end_layout 6486 6487 \begin_layout LyX-Code 6488 INTEGER :: n 6489 \end_layout 6490 6491 \begin_layout Standard 6492 Defines the size of a zoomed region on a global axis. 6493 The attribute value should be an integer between 6494 \begin_inset Flex Strong 6495 status collapsed 6496 6497 \begin_layout Plain Layout 6498 1 6499 \end_layout 6500 6501 \end_inset 6502 6503 and 6504 \begin_inset Flex Strong 6505 status collapsed 6506 6507 \begin_layout Plain Layout 4680 6508 nj_glo 4681 6509 \end_layout … … 4684 6512 4685 6513 of the associated axis. 6514 If not specified the default value is 6515 \begin_inset Flex Strong 6516 status collapsed 6517 6518 \begin_layout Plain Layout 6519 nj_glo 6520 \end_layout 6521 6522 \end_inset 6523 6524 of the associated axis. 6525 \end_layout 6526 6527 \begin_layout Subsection 6528 compute_connectivity_domain 6529 \end_layout 6530 6531 \begin_layout Subsection* 6532 n_neighbor: 6533 \begin_inset Flex Emph 6534 status collapsed 6535 6536 \begin_layout Plain Layout 6537 1D-array of integer 6538 \end_layout 6539 6540 \end_inset 6541 6542 6543 \end_layout 6544 6545 \begin_layout Standard 6546 Fortran: 6547 \end_layout 6548 6549 \begin_layout LyX-Code 6550 INTEGER :: n_neighbor(:) 6551 \end_layout 6552 6553 \begin_layout Subsection* 6554 local_neighbor: 6555 \begin_inset Flex Emph 6556 status collapsed 6557 6558 \begin_layout Plain Layout 6559 2D-array of integer 6560 \end_layout 6561 6562 \end_inset 6563 6564 6565 \end_layout 6566 6567 \begin_layout Standard 6568 Fortran: 6569 \end_layout 6570 6571 \begin_layout LyX-Code 6572 INTEGER :: local_neighbor(:,:) 6573 \end_layout 6574 6575 \begin_layout Subsection* 6576 n_neighbor_max: 6577 \begin_inset Flex Emph 6578 status collapsed 6579 6580 \begin_layout Plain Layout 6581 integer 6582 \end_layout 6583 6584 \end_inset 6585 6586 6587 \end_layout 6588 6589 \begin_layout Standard 6590 Fortran: 6591 \end_layout 6592 6593 \begin_layout LyX-Code 6594 INTEGER :: n_neighbor_max 6595 \end_layout 6596 6597 \begin_layout Subsection 6598 extract_domain_to_axis 6599 \end_layout 6600 6601 \begin_layout Subsection* 6602 position (optional): 6603 \emph on 6604 integer 6605 \end_layout 6606 6607 \begin_layout Standard 6608 Fortran: 6609 \end_layout 6610 6611 \begin_layout LyX-Code 6612 INTEGER :: position 6613 \end_layout 6614 6615 \begin_layout Standard 6616 Defines the index on a domain starting which an axis will be extracted along 6617 the direction specified with the 6618 \series bold 6619 direction 6620 \series default 6621 attribute. 6622 \end_layout 6623 6624 \begin_layout Subsection* 6625 direction (mandatory): 6626 \emph on 6627 enumeration {iDir, jDir} 6628 \end_layout 6629 6630 \begin_layout Standard 6631 Fortran: 6632 \end_layout 6633 6634 \begin_layout LyX-Code 6635 CHARACTER(LEN=*) :: direction 6636 \end_layout 6637 6638 \begin_layout Standard 6639 Defines the domain dimension along which an axis will be extracted. 4686 6640 \end_layout 4687 6641 … … 4691 6645 4692 6646 \begin_layout Subsection* 4693 file :6647 file (optional): 4694 6648 \emph on 4695 6649 string … … 4705 6659 4706 6660 \begin_layout Standard 4707 Define the file which contains the weight value to interpolatefrom domain6661 Define a file which contains the weight values for interpolation from domain 4708 6662 source to domain destination. 4709 This attribute is optional.4710 6663 If not specified, the internal interpolation module will be used. 4711 6664 \end_layout 4712 6665 4713 6666 \begin_layout Subsection* 6667 order (optional): 6668 \emph on 6669 integer 6670 \end_layout 6671 6672 \begin_layout Standard 6673 Fortran: 6674 \end_layout 6675 6676 \begin_layout LyX-Code 6677 INTEGER :: order 6678 \end_layout 6679 6680 \begin_layout Standard 6681 Defines 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 6687 reduce_domain_to_axis 6688 \end_layout 6689 6690 \begin_layout Subsection* 6691 direction: 6692 \emph on 6693 enumeration {iDir, jDir} 6694 \end_layout 6695 6696 \begin_layout Standard 6697 Fortran: 6698 \end_layout 6699 6700 \begin_layout LyX-Code 6701 CHARACTER(LEN=*) :: direction 6702 \end_layout 6703 6704 \begin_layout Standard 6705 Defines 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* 6710 operation (mandatory): 6711 \emph on 6712 enumeration {min, max, sum, average} 6713 \end_layout 6714 6715 \begin_layout Standard 6716 Fortran: 6717 \end_layout 6718 6719 \begin_layout LyX-Code 6720 CHARACTER(LEN=*) :: operation 6721 \end_layout 6722 6723 \begin_layout Subsection* 6724 local: 6725 \emph on 6726 bool 6727 \end_layout 6728 6729 \begin_layout Standard 6730 Fortran: 6731 \end_layout 6732 6733 \begin_layout LyX-Code 6734 LOGICAL :: local 6735 \end_layout 6736 6737 \begin_layout Standard 6738 Defines whether the reduction should be performed locally on data owned 6739 by each process. 6740 \end_layout 6741 6742 \begin_layout Subsection 6743 reduce_domain_to_scalar 6744 \end_layout 6745 6746 \begin_layout Standard 6747 Reduces data defined on a domain into a scalar value. 6748 \end_layout 6749 6750 \begin_layout Subsection* 6751 operation (mandatory): 6752 \emph on 6753 enumeration {min, max, sum, average} 6754 \end_layout 6755 6756 \begin_layout Standard 6757 Fortran: 6758 \end_layout 6759 6760 \begin_layout LyX-Code 6761 CHARACTER(LEN=*) :: operation 6762 \end_layout 6763 6764 \begin_layout Subsection* 6765 local: 6766 \emph on 6767 bool 6768 \end_layout 6769 6770 \begin_layout Standard 6771 Fortran: 6772 \end_layout 6773 6774 \begin_layout LyX-Code 6775 LOGICAL :: local 6776 \end_layout 6777 6778 \begin_layout Standard 6779 Defines whether the reduction should be performed locally on data owned 6780 by each process. 6781 \end_layout 6782 6783 \begin_layout Subsection 6784 reorder_domain 6785 \end_layout 6786 6787 \begin_layout Subsection* 6788 invert_lat (optional): 6789 \emph on 6790 bool 6791 \end_layout 6792 6793 \begin_layout Standard 6794 Fortran: 6795 \end_layout 6796 6797 \begin_layout LyX-Code 6798 LOGICAL :: invert_lat 6799 \end_layout 6800 6801 \begin_layout Standard 6802 Defines whether the latitude should be inverted. 6803 The default value is false. 6804 \end_layout 6805 6806 \begin_layout Subsection* 6807 shift_lon_fraction (optional): 6808 \begin_inset Flex Emph 6809 status collapsed 6810 6811 \begin_layout Plain Layout 6812 double 6813 \end_layout 6814 6815 \end_inset 6816 6817 6818 \end_layout 6819 6820 \begin_layout Standard 6821 Fortran: 6822 \end_layout 6823 6824 \begin_layout LyX-Code 6825 DOUBLE PRECISION :: shift_lon_fraction 6826 \end_layout 6827 6828 \begin_layout Standard 6829 Defines the longitude offset. 6830 The value of the parameter represents a fraction of 6831 \series bold 6832 ni_glo 6833 \series default 6834 . 6835 \end_layout 6836 6837 \begin_layout Subsection* 6838 min_lon (optional): 6839 \begin_inset Flex Emph 6840 status collapsed 6841 6842 \begin_layout Plain Layout 6843 double 6844 \end_layout 6845 6846 \end_inset 6847 6848 6849 \end_layout 6850 6851 \begin_layout Standard 6852 Fortran: 6853 \end_layout 6854 6855 \begin_layout LyX-Code 6856 DOUBLE PRECISION :: min_lon 6857 \end_layout 6858 6859 \begin_layout Standard 6860 If both, 6861 \series bold 6862 min_lon 6863 \series default 6864 and 6865 \series bold 6866 max_lon 6867 \series default 6868 , are defined, a domain will be reordered with latitude values starting 6869 from 6870 \series bold 6871 min_lon 6872 \series default 6873 and ending at 6874 \series bold 6875 max_lon 6876 \series default 6877 . 6878 \end_layout 6879 6880 \begin_layout Subsection* 6881 max_lon (optional): 6882 \begin_inset Flex Emph 6883 status collapsed 6884 6885 \begin_layout Plain Layout 6886 double 6887 \end_layout 6888 6889 \end_inset 6890 6891 6892 \end_layout 6893 6894 \begin_layout Standard 6895 Fortran: 6896 \end_layout 6897 6898 \begin_layout LyX-Code 6899 DOUBLE PRECISION :: max_lon 6900 \end_layout 6901 6902 \begin_layout Standard 6903 If both, 6904 \series bold 6905 min_lon 6906 \series default 6907 and 6908 \series bold 6909 max_lon 6910 \series default 6911 , are defined, a domain will be reordered with latitude values starting 6912 from 6913 \series bold 6914 min_lon 6915 \series default 6916 and ending at 6917 \series bold 6918 max_lon 6919 \series default 6920 . 6921 \end_layout 6922 6923 \begin_layout Subsection 6924 expand_domain 6925 \end_layout 6926 6927 \begin_layout Subsection* 4714 6928 order: 4715 \emph on 6929 \begin_inset Flex Emph 6930 status collapsed 6931 6932 \begin_layout Plain Layout 4716 6933 integer 4717 6934 \end_layout 4718 6935 4719 \begin_layout Standard 4720 Fortran: 6936 \end_inset 6937 6938 6939 \end_layout 6940 6941 \begin_layout Standard 6942 Fortran: 4721 6943 \end_layout 4722 6944 … … 4725 6947 \end_layout 4726 6948 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* 6950 type (optional): 6951 \emph on 6952 enumeration {node, edge} 6953 \end_layout 6954 6955 \begin_layout Standard 6956 Fortran: 6957 \end_layout 6958 6959 \begin_layout LyX-Code 6960 CHARACTER(LEN=*) :: type 6961 \end_layout 6962 6963 \begin_layout Standard 6964 Defines whether the node or edge connectivity should be calculated for the 6965 expanded domain. 6966 \end_layout 6967 6968 \begin_layout Subsection* 6969 i_periodic (optional): 6970 \emph on 6971 bool 6972 \end_layout 6973 6974 \begin_layout Standard 6975 Fortran: 6976 \end_layout 6977 6978 \begin_layout LyX-Code 6979 LOGICAL :: i_periodic 6980 \end_layout 6981 6982 \begin_layout Standard 6983 If 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* 6990 j_periodic (optional): 6991 \emph on 6992 bool 6993 \end_layout 6994 6995 \begin_layout Standard 6996 Fortran: 6997 \end_layout 6998 6999 \begin_layout LyX-Code 7000 LOGICAL :: j_periodic 7001 \end_layout 7002 7003 \begin_layout Standard 7004 If 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). 4732 7008 \end_layout 4733 7009 … … 4737 7013 4738 7014 \begin_layout Subsection* 4739 ibegin :7015 ibegin (optional): 4740 7016 \begin_inset Flex Emph 4741 7017 status collapsed … … 4759 7035 4760 7036 \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. 7037 Defines the beginning index of the zoomed region on the first dimension 7038 of the global domain. 4764 7039 This must be an integer between 4765 7040 \begin_inset Flex Strong … … 4794 7069 4795 7070 . 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* 7076 ni (optional): 4800 7077 \begin_inset Flex Emph 4801 7078 status collapsed … … 4820 7097 \begin_layout Standard 4821 7098 Define the size of zoomed region on the first dimension of the global domain. 4822 This attribute is optional.4823 7099 This must be an integer between 4824 7100 \begin_inset Flex Strong … … 4853 7129 4854 7130 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* 7136 jbegin (optional): 4859 7137 \begin_inset Flex Emph 4860 7138 status collapsed … … 4878 7156 4879 7157 \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. 7158 Define the beginning index of the zoomed region on the second dimension 7159 of the global domain. 4883 7160 This must be an integer between 4884 7161 \begin_inset Flex Strong … … 4913 7190 4914 7191 . 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* 7197 nj (optional): 4919 7198 \begin_inset Flex Emph 4920 7199 status collapsed … … 4939 7218 \begin_layout Standard 4940 7219 Define 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 4943 7221 \begin_inset Flex Strong 4944 7222 status collapsed … … 4972 7250 4973 7251 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. 4974 7254 \end_layout 4975 7255 … … 4978 7258 \end_layout 4979 7259 4980 \begin_layout Standard 4981 7260 \begin_layout Subsection* 7261 lon_start (optional): 7262 \begin_inset Flex Emph 7263 status collapsed 7264 7265 \begin_layout Plain Layout 7266 double 7267 \end_layout 7268 7269 \end_inset 7270 7271 7272 \end_layout 7273 7274 \begin_layout Standard 7275 Fortran: 7276 \end_layout 7277 7278 \begin_layout LyX-Code 7279 DOUBLE PRECISION :: lon_start 7280 \end_layout 7281 7282 \begin_layout Standard 7283 Along with 7284 \series bold 7285 lon_end 7286 \series default 7287 , the attribute defines the longitude range of a generated domain. 7288 \end_layout 7289 7290 \begin_layout Subsection* 7291 lon_end (optional): 7292 \begin_inset Flex Emph 7293 status collapsed 7294 7295 \begin_layout Plain Layout 7296 double 7297 \end_layout 7298 7299 \end_inset 7300 7301 7302 \end_layout 7303 7304 \begin_layout Standard 7305 Fortran: 7306 \end_layout 7307 7308 \begin_layout LyX-Code 7309 DOUBLE PRECISION :: lon_end 7310 \end_layout 7311 7312 \begin_layout Standard 7313 Along with 7314 \series bold 7315 lon_start 7316 \series default 7317 , the attribute defines the longitude range of a generated domain. 7318 \end_layout 7319 7320 \begin_layout Subsection* 7321 lat_start (optional): 7322 \begin_inset Flex Emph 7323 status collapsed 7324 7325 \begin_layout Plain Layout 7326 double 7327 \end_layout 7328 7329 \end_inset 7330 7331 7332 \end_layout 7333 7334 \begin_layout Standard 7335 Fortran: 7336 \end_layout 7337 7338 \begin_layout LyX-Code 7339 DOUBLE PRECISION :: lat_start 7340 \end_layout 7341 7342 \begin_layout Standard 7343 Along with 7344 \series bold 7345 lat_end 7346 \series default 7347 , the attribute defines the latitude range of a generated domain. 7348 \end_layout 7349 7350 \begin_layout Subsection* 7351 lat_end (optional): 7352 \begin_inset Flex Emph 7353 status collapsed 7354 7355 \begin_layout Plain Layout 7356 double 7357 \end_layout 7358 7359 \end_inset 7360 7361 7362 \end_layout 7363 7364 \begin_layout Standard 7365 Fortran: 7366 \end_layout 7367 7368 \begin_layout LyX-Code 7369 DOUBLE PRECISION :: lat_end 7370 \end_layout 7371 7372 \begin_layout Standard 7373 Along with 7374 \series bold 7375 lat_start 7376 \series default 7377 , the attribute defines the latitude range of a generated domain. 7378 \end_layout 7379 7380 \begin_layout Subsection* 7381 bounds_lon_start: 7382 \begin_inset Flex Emph 7383 status collapsed 7384 7385 \begin_layout Plain Layout 7386 double 7387 \end_layout 7388 7389 \end_inset 7390 7391 7392 \end_layout 7393 7394 \begin_layout Standard 7395 Fortran: 7396 \end_layout 7397 7398 \begin_layout LyX-Code 7399 DOUBLE PRECISION :: bounds_lon_start 7400 \end_layout 7401 7402 \begin_layout Standard 7403 Attributes 7404 \series bold 7405 bounds_lon_start 7406 \series default 7407 and 7408 \series bold 7409 bounds_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* 7424 bounds_lon_end: 7425 \begin_inset Flex Emph 7426 status collapsed 7427 7428 \begin_layout Plain Layout 7429 double 7430 \end_layout 7431 7432 \end_inset 7433 7434 7435 \end_layout 7436 7437 \begin_layout Standard 7438 Fortran: 7439 \end_layout 7440 7441 \begin_layout LyX-Code 7442 DOUBLE PRECISION :: bounds_lon_end 7443 \end_layout 7444 7445 \begin_layout Standard 7446 Attributes 7447 \series bold 7448 bounds_lon_start 7449 \series default 7450 and 7451 \series bold 7452 bounds_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* 7467 bounds_lat_start: 7468 \begin_inset Flex Emph 7469 status collapsed 7470 7471 \begin_layout Plain Layout 7472 double 7473 \end_layout 7474 7475 \end_inset 7476 7477 7478 \end_layout 7479 7480 \begin_layout Standard 7481 Fortran: 7482 \end_layout 7483 7484 \begin_layout LyX-Code 7485 DOUBLE PRECISION :: bounds_lat_start 7486 \end_layout 7487 7488 \begin_layout Standard 7489 Attributes 7490 \series bold 7491 bounds_lat_start 7492 \series default 7493 and 7494 \series bold 7495 bounds_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* 7510 bounds_lat_end: 7511 \begin_inset Flex Emph 7512 status collapsed 7513 7514 \begin_layout Plain Layout 7515 double 7516 \end_layout 7517 7518 \end_inset 7519 7520 7521 \end_layout 7522 7523 \begin_layout Standard 7524 Fortran: 7525 \end_layout 7526 7527 \begin_layout LyX-Code 7528 DOUBLE PRECISION :: bounds_lat_end 7529 \end_layout 7530 7531 \begin_layout Standard 7532 Attributes 7533 \series bold 7534 bounds_lat_start 7535 \series default 7536 and 7537 \series bold 7538 bounds_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. 4982 7550 \end_layout 4983 7551 … … 5521 8089 5522 8090 \begin_layout Standard 5523 This set of subroutines enable the models to interact, complete or query8091 This set of subroutines enables the models to interact, complete or query 5524 8092 the XML tree data base. 5525 8093 New elements or group of elements can be added as child in the tree, attributes 5526 8094 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, 5528 8096 field, variable and file. 5529 8097 An element can be identified by a string or by an handle associated to … … 5702 8270 5703 8271 \begin_layout Standard 5704 where element is one of the existing element or group of element.8272 where element is one of the existing elements or group of elements. 5705 8273 \end_layout 5706 8274 … … 5740 8308 5741 8309 \begin_layout Standard 5742 This subroutine return the handle of the specified element identified by8310 This subroutine returns the handle of the specified element identified by 5743 8311 its string. 5744 The element must be existing otherwise it raise an error.8312 The element must be existing otherwise an error is raised. 5745 8313 \end_layout 5746 8314 … … 5762 8330 5763 8331 \begin_layout Standard 5764 where element is one of the existing element or group of element.8332 where element is one of the existing elements or group of elements. 5765 8333 \end_layout 5766 8334 … … 5787 8355 5788 8356 \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. 8357 This function returns .TRUE. 8358 if the element defined by the string identifier 8359 \begin_inset Quotes eld 8360 \end_inset 8361 8362 id 8363 \begin_inset Quotes erd 8364 \end_inset 8365 8366 exists in the data base, otherwise it returns .FALSE. 5792 8367 . 5793 8368 \end_layout … … 5818 8393 5819 8394 \begin_layout Standard 5820 where element is one of the existing element or group of element.8395 where element is one of the existing elements or element groups. 5821 8396 \end_layout 5822 8397 … … 5869 8444 5870 8445 \begin_layout Standard 5871 This subroutine add a child to an existing parent element.8446 This subroutine adds a child to an existing parent element. 5872 8447 The identifier of the child, if existing, can be specified optionally. 5873 All group elements can contain s child of the same kind, provided generic8448 All group elements can contain child of the same type, provided generic 5874 8449 inheritance. 5875 Some elements can contain s children of an other kind for a specific behaviour.5876 File element may contain sfield_group, field, variable and variable_group8450 Some elements can contain children of another type for a specific behavior. 8451 File element may contain field_group, field, variable and variable_group 5877 8452 child elements. 5878 Field elements may contain svariable_group of variable child element.5879 \end_layout 5880 5881 \begin_layout Subsection* 5882 Query if a value of an element attributesis defined (by handle)8453 Field elements may contain variable_group of variable child element. 8454 \end_layout 8455 8456 \begin_layout Subsection* 8457 Query if the value of an element attribute is defined (by handle) 5883 8458 \end_layout 5884 8459 … … 5909 8484 5910 8485 \begin_layout Standard 5911 where element is one of the existing element or group of element.8486 where element is one of the existing elements or element groups. 5912 8487 attribute_x is describing in the chapter dedicated to the attribute description. 5913 8488 \end_layout … … 5948 8523 5949 8524 \begin_layout Standard 5950 This subroutine mybe used to query if one or more attributes of an element8525 This subroutine can be used to query if one or more attributes of an element 5951 8526 have a defined value. 5952 8527 The list of attributes and their type are described in a specific chapter … … 5985 8560 5986 8561 \begin_layout Standard 5987 where element is one of the existing element or group of element.8562 where element is one of the existing elements or element groups. 5988 8563 attribute_x is describing in the chapter dedicated to the attribute description. 5989 8564 \end_layout … … 6024 8599 6025 8600 \begin_layout Standard 6026 This subroutine mybe used to query if one or more attributes of an element8601 This subroutine can be used to query if one or more attributes of an element 6027 8602 have a defined value. 6028 8603 The list of available attributes and their type are described in a specific … … 6061 8636 6062 8637 \begin_layout Standard 6063 where element is one of the existing element or group of element.8638 where element is one of the existing elements or element groups. 6064 8639 attribute_x and attribute_type_x are describing in the chapter dedicated 6065 8640 to the attribute description. … … 6101 8676 6102 8677 \begin_layout Standard 6103 This subroutine my be used to set one or more attribute to an element defined6104 by its handle.6105 The list of available attributes and their type are described in a specific6106 chapter of the documentation.8678 This 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. 6107 8682 6108 8683 \end_layout … … 6138 8713 6139 8714 \begin_layout Standard 6140 where element is one of the existing element or group of element. 8715 where 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* 8721 Arguments: 8722 \end_layout 8723 8724 \begin_layout Itemize 8725 \begin_inset Flex Code 8726 status collapsed 8727 8728 \begin_layout Plain Layout 8729 id 8730 \end_layout 8731 8732 \end_inset 8733 8734 : string identifier. 8735 \end_layout 8736 8737 \begin_layout Itemize 8738 \begin_inset Flex Code 8739 status collapsed 8740 8741 \begin_layout Plain Layout 8742 attr_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* 8751 Description: 8752 \end_layout 8753 8754 \begin_layout Standard 8755 This 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* 8762 Getting element attributes value (by handle) 8763 \end_layout 8764 8765 \begin_layout Subsubsection* 8766 Synopsis: 8767 \end_layout 8768 8769 \begin_layout LyX-Code 8770 SUBROUTINE xios_get_attr(handle, attr_1=attribute_1, attr_2=attribute_2, 8771 ...) 8772 \end_layout 8773 8774 \begin_layout LyX-Code 8775 TYPE(xios_element) , INTENT(IN) :: handle 8776 \end_layout 8777 8778 \begin_layout LyX-Code 8779 attribute_type_1, OPTIONAL , INTENT(OUT) :: attr_1 8780 \end_layout 8781 8782 \begin_layout LyX-Code 8783 attribute_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 8791 where element is one of the existing elements or element groups. 6141 8792 attribute_x and attribute_type_x are describing in the chapter dedicated 6142 8793 to the attribute description. … … 6152 8803 6153 8804 \begin_layout Plain Layout 6154 id 6155 \end_layout 6156 6157 \end_inset 6158 6159 : string identifier.8805 handle 8806 \end_layout 8807 8808 \end_inset 8809 8810 : element handle. 6160 8811 \end_layout 6161 8812 … … 6170 8821 \end_inset 6171 8822 6172 : value of the attribute to be set.8823 : value of the attribute to be get. 6173 8824 \end_layout 6174 8825 … … 6178 8829 6179 8830 \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 8831 This subroutine can be used to get one or more attribute value of an element 6257 8832 defined by its handle. 6258 8833 All attributes in the arguments list must be defined. … … 6292 8867 6293 8868 \begin_layout Standard 6294 where element is one of the existing element or group of element.8869 where element is one of the existing elements or element groups. 6295 8870 attribute_x is describing in the chapter dedicated to the attribute description. 6296 8871 \end_layout … … 6331 8906 6332 8907 \begin_layout Standard 6333 This subroutine mybe used to get one or more attribute value of an element8908 This subroutine can be used to get one or more attribute value of an element 6334 8909 defined by its handle. 6335 8910 All attributes in the arguments list must have a defined value. … … 6339 8914 6340 8915 \begin_layout Section* 6341 Interface relative to context management 8916 Context management interface 6342 8917 \end_layout 6343 8918 … … 6397 8972 6398 8973 \begin_layout Standard 6399 This subroutine initialize a context identified by8974 This subroutine initializes a context identified by 6400 8975 \begin_inset Flex Code 6401 8976 status collapsed … … 6459 9034 6460 9035 \begin_layout Standard 6461 This subroutine must be call to close a context,before the9036 This subroutine must be called to close a context before the 6462 9037 \begin_inset Flex Code 6463 9038 status collapsed … … 6470 9045 6471 9046 call. 6472 It waits until that all pending request sent to the servers will be processed6473 and theopened 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. 6474 9049 \end_layout 6475 9050 … … 6542 9117 \begin_layout Standard 6543 9118 These 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. 6546 9122 6547 9123 \end_layout … … 6572 9148 6573 9149 \begin_layout Standard 6574 This subroutine must be call when all definitions of a context isfinished9150 This subroutine must be called when all definitions of a context are finished 6575 9151 at the end of the initialization and before entering to the time loop. 6576 9152 A lot of operations are performed internally (inheritance, grid definition, … … 6581 9157 6582 9158 \begin_layout Section* 6583 Interface relative to calendar management 9159 Calendar management interface 6584 9160 \end_layout 6585 9161 … … 7418 9994 7419 9995 \begin_layout Section* 7420 Interface relative to duration handling 9996 Duration handling interface 7421 9997 \end_layout 7422 9998 … … 7988 10564 This function returns the number of seconds since the beginning of the day 7989 10565 for the specified date, based on the calendar of the current context. 7990 It mustnot be used before the calendar was created.10566 It should not be used before the calendar was created. 7991 10567 \end_layout 7992 10568 … … 8030 10606 \begin_layout Standard 8031 10607 This function returns the fraction of day corresponding to the specified 8032 date ,based on the calendar of the current context.8033 It mustnot 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. 8034 10610 \end_layout 8035 10611 -
XIOS/trunk/doc/XIOS_user_guide.lyx
r1526 r1623 4051 4051 \end_inset 4052 4052 4053 , field_ A)4053 , field_B) 4054 4054 \end_layout 4055 4055 … … 4057 4057 4058 4058 . 4059 \end_layout 4060 4061 \begin_layout Standard 4062 XIOS 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 4067 expr 4068 \begin_inset Quotes erd 4069 \end_inset 4070 4071 . 4072 The example above can rewritten as 4073 \begin_inset listings 4074 lstparams "language=XML,breaklines=true,tabsize=2,frame=tb,postbreak={\raisebox{0ex}[0ex][0ex]{\ensuremath{\rcurvearrowse\space}}}" 4075 inline false 4076 status 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 4167 while the two expressions can be specified with the following calls: 4168 \begin_inset Flex Code 4169 status open 4170 4171 \begin_layout Plain Layout 4172 xios_set_field_attr( 4173 \begin_inset Quotes eld 4174 \end_inset 4175 4176 field_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 4195 status open 4196 4197 \begin_layout Plain Layout 4198 xios_set_field_attr( 4199 \begin_inset Quotes eld 4200 \end_inset 4201 4202 field_C 4203 \begin_inset Quotes erd 4204 \end_inset 4205 4206 , expr= 4207 \begin_inset Quotes erd 4208 \end_inset 4209 4210 log10(field_B) 4211 \begin_inset Quotes erd 4212 \end_inset 4213 4214 4215 \end_layout 4216 4217 \end_inset 4218 4219 . 4220 4059 4221 \end_layout 4060 4222 … … 5006 5168 \begin_layout Standard 5007 5169 Some of XIOS behaviors can be configured using options. 5008 Those options must be expr essed as variables in a specific context whose5170 Those options must be exprhessed as variables in a specific context whose 5009 5171 5010 5172 \series bold … … 5100 5262 5101 5263 \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. 5264 To improve I/O performance, it is possible to separate servers into two 5265 levels: intermediaries (level one) and writers (level two). 5130 5266 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: 5134 5274 \end_layout 5135 5275 … … 5283 5423 5284 5424 \begin_layout Standard 5285 Note that with one server per pool, the I/O is actually sequential and thus5286 the use of HDF5 compression is possible.5287 5288 \end_layout5289 5290 \begin_layout Standard5291 5425 By default file distribution among server-two pools is optimized for bandwidth. 5292 5426 An alternative way of distributing files is possible in order to minimize … … 5438 5572 \begin_inset Formula 5439 5573 \[ 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)} 5441 5575 \] 5442 5576
Note: See TracChangeset
for help on using the changeset viewer.