Changeset 797


Ignore:
Timestamp:
11/26/15 10:56:17 (8 years ago)
Author:
mhnguyen
Message:

Updating User guide and reference doc

Location:
XIOS/trunk/doc
Files:
5 edited

Legend:

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

    r714 r797  
    10031003 
    10041004\begin_layout Subsection* 
    1005 size:  
     1005n_glo:  
    10061006\begin_inset Flex Emph 
    10071007status collapsed 
     
    10211021 
    10221022\begin_layout LyX-Code 
    1023 INTEGER :: size 
    1024 \end_layout 
    1025  
    1026 \begin_layout Standard 
    1027 Define the size of the axis. 
     1023INTEGER :: n_glo 
     1024\end_layout 
     1025 
     1026\begin_layout Standard 
     1027Define the global size of the axis. 
    10281028 This attribute is mandatory. 
    10291029\end_layout 
    10301030 
    10311031\begin_layout Subsection* 
    1032 zoom_begin:  
     1032begin:  
    10331033\begin_inset Flex Emph 
    10341034status collapsed 
     
    10481048 
    10491049\begin_layout LyX-Code 
    1050 INTEGER :: zoom_begin 
    1051 \end_layout 
    1052  
    1053 \begin_layout Standard 
    1054 Define the the beginning of the zoom. 
    1055  This must be an index between 1 and  
    1056 \begin_inset Flex Strong 
    1057 status collapsed 
    1058  
    1059 \begin_layout Plain Layout 
    1060 size 
     1050INTEGER :: begin 
     1051\end_layout 
     1052 
     1053\begin_layout Standard 
     1054Define the the beginning index of the local domain. 
     1055 This attribute is optional. 
     1056 This must be an index between 0 and  
     1057\begin_inset Flex Strong 
     1058status collapsed 
     1059 
     1060\begin_layout Plain Layout 
     1061n_glo-1 
    10611062\end_layout 
    10621063 
     
    10641065 
    10651066. 
    1066  If not specified the default value is 1. 
    1067  It must also be evaluated from  
    1068 \begin_inset Flex Strong 
    1069 status collapsed 
    1070  
    1071 \begin_layout Plain Layout 
    1072 zoom_end 
    1073 \end_layout 
    1074  
    1075 \end_inset 
    1076  
    1077  and  
    1078 \begin_inset Flex Strong 
    1079 status collapsed 
    1080  
    1081 \begin_layout Plain Layout 
    1082 zoom_size 
    1083 \end_layout 
    1084  
    1085 \end_inset 
    1086  
    1087  if these are specified. 
    1088 \end_layout 
    1089  
    1090 \begin_layout Subsection* 
    1091 zoom_end:  
     1067 If not specified the default value is 0. 
     1068\end_layout 
     1069 
     1070\begin_layout Subsection* 
     1071n:  
    10921072\begin_inset Flex Emph 
    10931073status collapsed 
     
    11071087 
    11081088\begin_layout LyX-Code 
    1109 INTEGER :: zoom_end 
    1110 \end_layout 
    1111  
    1112 \begin_layout Standard 
    1113 Define the the end of the zoom. 
    1114  This must be an index between 1 and  
    1115 \begin_inset Flex Strong 
    1116 status collapsed 
    1117  
    1118 \begin_layout Plain Layout 
    1119 size 
     1089INTEGER :: zoom_size 
     1090\end_layout 
     1091 
     1092\begin_layout Standard 
     1093Define the the local size of the axis. 
     1094 This attribute is optional. 
     1095 This must be an integer between 1 and  
     1096\begin_inset Flex Strong 
     1097status collapsed 
     1098 
     1099\begin_layout Plain Layout 
     1100n_glo 
    11201101\end_layout 
    11211102 
     
    11281109 
    11291110\begin_layout Plain Layout 
    1130 size 
     1111n_glo 
    11311112\end_layout 
    11321113 
     
    11341115 
    11351116. 
    1136  It must also be evaluated from  
    1137 \begin_inset Flex Strong 
    1138 status collapsed 
    1139  
    1140 \begin_layout Plain Layout 
    1141 zoom_begin 
    1142 \end_layout 
    1143  
    1144 \end_inset 
    1145  
    1146  and  
    1147 \begin_inset Flex Strong 
    1148 status collapsed 
    1149  
    1150 \begin_layout Plain Layout 
    1151 zoom_size 
    1152 \end_layout 
    1153  
    1154 \end_inset 
    1155  
    1156  if these are specified. 
    1157 \end_layout 
    1158  
    1159 \begin_layout Subsection* 
    1160 zoom_size:  
    1161 \begin_inset Flex Emph 
    1162 status collapsed 
    1163  
    1164 \begin_layout Plain Layout 
    1165 integer 
    1166 \end_layout 
    1167  
    1168 \end_inset 
    1169  
    1170  
    1171 \end_layout 
    1172  
    1173 \begin_layout Standard 
    1174 Fortran: 
    1175 \end_layout 
    1176  
    1177 \begin_layout LyX-Code 
    1178 INTEGER :: zoom_size 
    1179 \end_layout 
    1180  
    1181 \begin_layout Standard 
    1182 Define the the size of the zoom. 
    1183  This must be an integer between 1 and  
    1184 \begin_inset Flex Strong 
    1185 status collapsed 
    1186  
    1187 \begin_layout Plain Layout 
    1188 size 
    1189 \end_layout 
    1190  
    1191 \end_inset 
    1192  
    1193 . 
    1194  If not specified the default value is  
    1195 \begin_inset Flex Strong 
    1196 status collapsed 
    1197  
    1198 \begin_layout Plain Layout 
    1199 size 
    1200 \end_layout 
    1201  
    1202 \end_inset 
    1203  
    1204 . 
    1205  It must also be evaluated from  
    1206 \begin_inset Flex Strong 
    1207 status collapsed 
    1208  
    1209 \begin_layout Plain Layout 
    1210 zoom_begin 
    1211 \end_layout 
    1212  
    1213 \end_inset 
    1214  
    1215  and  
    1216 \begin_inset Flex Strong 
    1217 status collapsed 
    1218  
    1219 \begin_layout Plain Layout 
    1220 zoom_end 
    1221 \end_layout 
    1222  
    1223 \end_inset 
    1224  
    1225  if these are specified. 
     1117  
    12261118\end_layout 
    12271119 
     
    12991191Define the boundaries of each level of a the vertical axis. 
    13001192 The dimensions of the array must be  
    1301 \begin_inset Formula $2\times\textbf{size}$ 
     1193\begin_inset Formula $2\times n$ 
    13021194\end_inset 
    13031195 
    13041196. 
     1197\end_layout 
     1198 
     1199\begin_layout Subsection* 
     1200data_begin: 
     1201\emph on 
     1202 integer 
     1203\end_layout 
     1204 
     1205\begin_layout Standard 
     1206Fortran: 
     1207\end_layout 
     1208 
     1209\begin_layout LyX-Code 
     1210INTEGER :: data_begin 
     1211\end_layout 
     1212 
     1213\begin_layout Standard 
     1214Define the beginning index of the field data for the axis. 
     1215 This attribute is an offset regarding the local axis, so the value can 
     1216 be negative. 
     1217 A negative value indicates that only some valid part of the data will extracted 
     1218, for example in the case of a ghost cell. 
     1219 A positive value indicates that the local domain is greater than the data 
     1220 stored in memory. 
     1221 A 0-value means that the local domain matches the data in memory. 
     1222 This attribute is optional and the default value is 0. 
     1223 Otherwise  
     1224\begin_inset Flex Strong 
     1225status collapsed 
     1226 
     1227\begin_layout Plain Layout 
     1228data_begin 
     1229\end_layout 
     1230 
     1231\end_inset 
     1232 
     1233 and  
     1234\begin_inset Flex Strong 
     1235status collapsed 
     1236 
     1237\begin_layout Plain Layout 
     1238data_n 
     1239\end_layout 
     1240 
     1241\end_inset 
     1242 
     1243 must be defined together. 
     1244\end_layout 
     1245 
     1246\begin_layout Subsection* 
     1247data_n:  
     1248\emph on 
     1249integer 
     1250\end_layout 
     1251 
     1252\begin_layout Standard 
     1253Fortran: 
     1254\end_layout 
     1255 
     1256\begin_layout LyX-Code 
     1257INTEGER :: data_n 
     1258\end_layout 
     1259 
     1260\begin_layout Standard 
     1261Define the size of the field data for the first axis. 
     1262 This attribute is optional and the default value is  
     1263\begin_inset Flex Strong 
     1264status collapsed 
     1265 
     1266\begin_layout Plain Layout 
     1267n 
     1268\end_layout 
     1269 
     1270\end_inset 
     1271 
     1272. 
     1273 Otherwise  
     1274\begin_inset Flex Strong 
     1275status collapsed 
     1276 
     1277\begin_layout Plain Layout 
     1278data_begin 
     1279\end_layout 
     1280 
     1281\end_inset 
     1282 
     1283 and  
     1284\begin_inset Flex Strong 
     1285status collapsed 
     1286 
     1287\begin_layout Plain Layout 
     1288data_n 
     1289\end_layout 
     1290 
     1291\end_inset 
     1292 
     1293 must be defined together. 
     1294\end_layout 
     1295 
     1296\begin_layout Subsection* 
     1297data_index:  
     1298\emph on 
     1299integer 
     1300\end_layout 
     1301 
     1302\begin_layout Standard 
     1303Fortran: 
     1304\end_layout 
     1305 
     1306\begin_layout LyX-Code 
     1307INTEGER :: data_index 
     1308\end_layout 
     1309 
     1310\begin_layout Standard 
     1311In 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* 
     1316mask:  
     1317\emph on 
     13181D-array of bool 
     1319\end_layout 
     1320 
     1321\begin_layout Standard 
     1322Fortran: 
     1323\end_layout 
     1324 
     1325\begin_layout LyX-Code 
     1326LOGICAL :: mask(:) 
     1327\end_layout 
     1328 
     1329\begin_layout Standard 
     1330Define the mask of the local axis. 
     1331 The masked value will be replaced by the value of the field attribute  
     1332\begin_inset Flex Strong 
     1333status collapsed 
     1334 
     1335\begin_layout Plain Layout 
     1336default_value 
     1337\end_layout 
     1338 
     1339\end_inset 
     1340 
     1341 in the output file. 
     1342\end_layout 
     1343 
     1344\begin_layout Subsection* 
     1345n_distributed_partition:  
     1346\emph on 
     1347integer 
     1348\end_layout 
     1349 
     1350\begin_layout Standard 
     1351Fortran: 
     1352\end_layout 
     1353 
     1354\begin_layout LyX-Code 
     1355INTEGER :: n_distributed_partition 
     1356\end_layout 
     1357 
     1358\begin_layout Standard 
     1359Define the number of local axis in case axis is auto-generated. 
     1360 This attribute is optional and the default value is  
     1361\begin_inset Flex Strong 
     1362status collapsed 
     1363 
     1364\begin_layout Plain Layout 
     13651 
     1366\end_layout 
     1367 
     1368\end_inset 
     1369 
     1370. 
     1371\end_layout 
     1372 
     1373\begin_layout Subsection* 
     1374positive:  
     1375\begin_inset Flex Emph 
     1376status collapsed 
     1377 
     1378\begin_layout Plain Layout 
     1379enumeration { up, down } 
     1380\end_layout 
     1381 
     1382\end_inset 
     1383 
     1384 
     1385\end_layout 
     1386 
     1387\begin_layout Standard 
     1388Fortran: 
     1389\end_layout 
     1390 
     1391\begin_layout LyX-Code 
     1392CHARACTER(LEN=*) :: positive 
     1393\end_layout 
     1394 
     1395\begin_layout Standard 
     1396Define the direction of vertical axis. 
     1397\end_layout 
     1398 
     1399\begin_layout Subsection* 
     1400axis_ref: string 
     1401\end_layout 
     1402 
     1403\begin_layout Standard 
     1404Fortran: 
     1405\end_layout 
     1406 
     1407\begin_layout LyX-Code 
     1408CHARACTER(LEN=*) :: axis_ref 
     1409\end_layout 
     1410 
     1411\begin_layout Standard 
     1412Define 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. 
    13051418\end_layout 
    13061419 
     
    13511464 
    13521465\begin_layout Subsection* 
     1466standard_name:  
     1467\begin_inset Flex Emph 
     1468status collapsed 
     1469 
     1470\begin_layout Plain Layout 
     1471string 
     1472\end_layout 
     1473 
     1474\end_inset 
     1475 
     1476 
     1477\end_layout 
     1478 
     1479\begin_layout Standard 
     1480Fortran:  
     1481\end_layout 
     1482 
     1483\begin_layout LyX-Code 
     1484CHARACTER(LEN=*) :: standard_name 
     1485\end_layout 
     1486 
     1487\begin_layout Standard 
     1488Define the standard name of the domain, as it will appear in the metadata 
     1489 attached to the domain of the output file. 
     1490  
     1491\end_layout 
     1492 
     1493\begin_layout Subsection* 
     1494long_name:  
     1495\begin_inset Flex Emph 
     1496status collapsed 
     1497 
     1498\begin_layout Plain Layout 
     1499string 
     1500\end_layout 
     1501 
     1502\end_inset 
     1503 
     1504 
     1505\end_layout 
     1506 
     1507\begin_layout Standard 
     1508Fortran:  
     1509\end_layout 
     1510 
     1511\begin_layout LyX-Code 
     1512CHARACTER(LEN=*) :: long_name 
     1513\end_layout 
     1514 
     1515\begin_layout Standard 
     1516Define the long name of the domain, as it will appear in the metadata attached 
     1517 to the domain of the output file. 
     1518  
     1519\end_layout 
     1520 
     1521\begin_layout Subsection* 
    13531522type:  
    13541523\begin_inset Flex Emph 
     
    13561525 
    13571526\begin_layout Plain Layout 
    1358 enumeration { regular, curvilinear, unstructured } 
     1527enumeration { rectilinear, curvilinear, unstructured } 
    13591528\end_layout 
    13601529 
     
    14311600 
    14321601\begin_layout Subsection* 
     1602ibegin:  
     1603\begin_inset Flex Emph 
     1604status collapsed 
     1605 
     1606\begin_layout Plain Layout 
     1607integer 
     1608\end_layout 
     1609 
     1610\end_inset 
     1611 
     1612 
     1613\end_layout 
     1614 
     1615\begin_layout Standard 
     1616Fortran: 
     1617\end_layout 
     1618 
     1619\begin_layout LyX-Code 
     1620INTEGER :: ibegin 
     1621\end_layout 
     1622 
     1623\begin_layout Standard 
     1624Define the begining index of the first dimension of the local domain. 
     1625 This attribute is optional. 
     1626 This must be an integer between  
     1627\begin_inset Flex Strong 
     1628status collapsed 
     1629 
     1630\begin_layout Plain Layout 
     16310 
     1632\end_layout 
     1633 
     1634\end_inset 
     1635 
     1636 and  
     1637\begin_inset Flex Strong 
     1638status collapsed 
     1639 
     1640\begin_layout Plain Layout 
     1641ni_glo-1 
     1642\end_layout 
     1643 
     1644\end_inset 
     1645 
     1646. 
     1647 If not specified the default value is  
     1648\begin_inset Flex Strong 
     1649status collapsed 
     1650 
     1651\begin_layout Plain Layout 
     16520 
     1653\end_layout 
     1654 
     1655\end_inset 
     1656 
     1657. 
     1658\end_layout 
     1659 
     1660\begin_layout Subsection* 
    14331661ni:  
    14341662\begin_inset Flex Emph 
     
    14541682\begin_layout Standard 
    14551683Define the first dimension of the local domain. 
    1456  This attribute may be also computed from  
    1457 \begin_inset Flex Strong 
    1458 status collapsed 
    1459  
    1460 \begin_layout Plain Layout 
    1461 ibegin 
     1684 This attribute is optional. 
     1685 This must be an integer between  
     1686\begin_inset Flex Strong 
     1687status collapsed 
     1688 
     1689\begin_layout Plain Layout 
     16901 
     1691\end_layout 
     1692 
     1693\end_inset 
     1694 
     1695and  
     1696\begin_inset Flex Strong 
     1697status collapsed 
     1698 
     1699\begin_layout Plain Layout 
     1700ni_glo 
     1701\end_layout 
     1702 
     1703\end_inset 
     1704 
     1705. 
     1706 If not specified the default value is  
     1707\begin_inset Flex Strong 
     1708status collapsed 
     1709 
     1710\begin_layout Plain Layout 
     1711ni_glo 
     1712\end_layout 
     1713 
     1714\end_inset 
     1715 
     1716. 
     1717\end_layout 
     1718 
     1719\begin_layout Subsection* 
     1720jbegin:  
     1721\begin_inset Flex Emph 
     1722status collapsed 
     1723 
     1724\begin_layout Plain Layout 
     1725integer 
     1726\end_layout 
     1727 
     1728\end_inset 
     1729 
     1730 
     1731\end_layout 
     1732 
     1733\begin_layout Standard 
     1734Fortran: 
     1735\end_layout 
     1736 
     1737\begin_layout LyX-Code 
     1738INTEGER :: jbegin 
     1739\end_layout 
     1740 
     1741\begin_layout Standard 
     1742Define the beginning index of the second dimension of the local domain. 
     1743 This attribute is optional. 
     1744 This must be an integer between  
     1745\begin_inset Flex Strong 
     1746status collapsed 
     1747 
     1748\begin_layout Plain Layout 
     17490 
    14621750\end_layout 
    14631751 
     
    14691757 
    14701758\begin_layout Plain Layout 
    1471 iend 
    1472 \end_layout 
    1473  
    1474 \end_inset 
    1475  
    1476  attribute value, so this attribute is optional. 
    1477  But, if defined, a consistent value must be supplied. 
    1478 \end_layout 
    1479  
    1480 \begin_layout Standard 
    1481 \begin_inset Formula $ni=iend-ibegin+1$ 
    1482 \end_inset 
    1483  
    1484  
    1485 \end_layout 
    1486  
    1487 \begin_layout Standard 
    1488 \begin_inset Formula $1\leq ibegin\leq iend\leq ni\_glo$ 
    1489 \end_inset 
    1490  
    1491  
    1492 \end_layout 
    1493  
    1494 \begin_layout Subsection* 
    1495 ibegin:  
    1496 \begin_inset Flex Emph 
    1497 status collapsed 
    1498  
    1499 \begin_layout Plain Layout 
    1500 integer 
    1501 \end_layout 
    1502  
    1503 \end_inset 
    1504  
    1505  
    1506 \end_layout 
    1507  
    1508 \begin_layout Standard 
    1509 Fortran: 
    1510 \end_layout 
    1511  
    1512 \begin_layout LyX-Code 
    1513 INTEGER :: ibegin 
    1514 \end_layout 
    1515  
    1516 \begin_layout Standard 
    1517 Define the begining index of the first dimension of the local domain. 
    1518  This attribute may be also computed from  
    1519 \begin_inset Flex Strong 
    1520 status collapsed 
    1521  
    1522 \begin_layout Plain Layout 
    1523 ni 
    1524 \end_layout 
    1525  
    1526 \end_inset 
    1527  
    1528  and  
    1529 \begin_inset Flex Strong 
    1530 status collapsed 
    1531  
    1532 \begin_layout Plain Layout 
    1533 iend 
    1534 \end_layout 
    1535  
    1536 \end_inset 
    1537  
    1538  attribute values, so this attribute is optional. 
    1539  But, if defined, a consistent value must be supplied. 
    1540 \end_layout 
    1541  
    1542 \begin_layout Standard 
    1543 \begin_inset Formula $ibegin=iend-ni+1$ 
    1544 \end_inset 
    1545  
    1546  
    1547 \end_layout 
    1548  
    1549 \begin_layout Standard 
    1550 \begin_inset Formula $1\leq ibegin\leq iend\leq ni\_glo$ 
    1551 \end_inset 
    1552  
    1553  
    1554 \end_layout 
    1555  
    1556 \begin_layout Subsection* 
    1557 iend:  
    1558 \begin_inset Flex Emph 
    1559 status collapsed 
    1560  
    1561 \begin_layout Plain Layout 
    1562 integer 
    1563 \end_layout 
    1564  
    1565 \end_inset 
    1566  
    1567  
    1568 \end_layout 
    1569  
    1570 \begin_layout Standard 
    1571 Fortran: 
    1572 \end_layout 
    1573  
    1574 \begin_layout LyX-Code 
    1575 INTEGER :: iend 
    1576 \end_layout 
    1577  
    1578 \begin_layout Standard 
    1579 Define the end index of the first dimension of the local domain. 
    1580  This attribute may be also computed from  
    1581 \begin_inset Flex Strong 
    1582 status collapsed 
    1583  
    1584 \begin_layout Plain Layout 
    1585 ni 
    1586 \end_layout 
    1587  
    1588 \end_inset 
    1589  
    1590  and  
    1591 \begin_inset Flex Strong 
    1592 status collapsed 
    1593  
    1594 \begin_layout Plain Layout 
    1595 ibegin 
    1596 \end_layout 
    1597  
    1598 \end_inset 
    1599  
    1600  attribute values, so this attribute is optional. 
    1601  But, if defined, a consistent value must be supplied. 
    1602 \end_layout 
    1603  
    1604 \begin_layout Standard 
    1605 \begin_inset Formula $iend=ibegin+ni-1$ 
    1606 \end_inset 
    1607  
    1608  
    1609 \end_layout 
    1610  
    1611 \begin_layout Standard 
    1612 \begin_inset Formula $1\leq ibegin\leq iend\leq ni\_glo$ 
    1613 \end_inset 
    1614  
    1615  
     1759nj_glo-1 
     1760\end_layout 
     1761 
     1762\end_inset 
     1763 
     1764. 
     1765 If not specified the default value is  
     1766\begin_inset Flex Strong 
     1767status collapsed 
     1768 
     1769\begin_layout Plain Layout 
     17700 
     1771\end_layout 
     1772 
     1773\end_inset 
     1774 
     1775. 
    16161776\end_layout 
    16171777 
     
    16401800\begin_layout Standard 
    16411801Define the second dimension of the local domain. 
    1642  This attribute may be also computed from  
    1643 \begin_inset Flex Strong 
    1644 status collapsed 
    1645  
    1646 \begin_layout Plain Layout 
    1647 jbegin 
    1648 \end_layout 
    1649  
    1650 \end_inset 
    1651  
    1652  and  
    1653 \begin_inset Flex Strong 
    1654 status collapsed 
    1655  
    1656 \begin_layout Plain Layout 
    1657 jend 
    1658 \end_layout 
    1659  
    1660 \end_inset 
    1661  
    1662  attribute values, so this attribute is optional. 
    1663  But, if defined, a consistent value must be supplied. 
    1664 \end_layout 
    1665  
    1666 \begin_layout Standard 
    1667 \begin_inset Formula $nj=jend-jbegin+1$ 
    1668 \end_inset 
    1669  
    1670  
    1671 \end_layout 
    1672  
    1673 \begin_layout Standard 
    1674 \begin_inset Formula $1\leq jbegin\leq jend\leq nj\_glo$ 
    1675 \end_inset 
    1676  
    1677  
    1678 \end_layout 
    1679  
    1680 \begin_layout Subsection* 
    1681 jbegin:  
    1682 \begin_inset Flex Emph 
    1683 status collapsed 
    1684  
    1685 \begin_layout Plain Layout 
    1686 integer 
    1687 \end_layout 
    1688  
    1689 \end_inset 
    1690  
    1691  
    1692 \end_layout 
    1693  
    1694 \begin_layout Standard 
    1695 Fortran: 
    1696 \end_layout 
    1697  
    1698 \begin_layout LyX-Code 
    1699 INTEGER :: jbegin 
    1700 \end_layout 
    1701  
    1702 \begin_layout Standard 
    1703 Define the beginning index of the second dimension of the local domain. 
    1704  This attribute may be also computed from  
    1705 \begin_inset Flex Strong 
    1706 status collapsed 
    1707  
    1708 \begin_layout Plain Layout 
    1709 nj 
    1710 \end_layout 
    1711  
    1712 \end_inset 
    1713  
    1714  and  
    1715 \begin_inset Flex Strong 
    1716 status collapsed 
    1717  
    1718 \begin_layout Plain Layout 
    1719 jend 
    1720 \end_layout 
    1721  
    1722 \end_inset 
    1723  
    1724  attribute values, so this attribute is optional. 
    1725  But, if defined, a consistent value must be supplied. 
    1726 \end_layout 
    1727  
    1728 \begin_layout Standard 
    1729 \begin_inset Formula $jbegin=jend-nj+1$ 
    1730 \end_inset 
    1731  
    1732  
    1733 \end_layout 
    1734  
    1735 \begin_layout Standard 
    1736 \begin_inset Formula $1\leq jbegin\leq jend\leq nj\_glo$ 
    1737 \end_inset 
    1738  
    1739  
    1740 \end_layout 
    1741  
    1742 \begin_layout Subsection* 
    1743 jend:  
    1744 \begin_inset Flex Emph 
    1745 status collapsed 
    1746  
    1747 \begin_layout Plain Layout 
    1748 integer 
    1749 \end_layout 
    1750  
    1751 \end_inset 
    1752  
    1753  
    1754 \end_layout 
    1755  
    1756 \begin_layout Standard 
    1757 Fortran: 
    1758 \end_layout 
    1759  
    1760 \begin_layout LyX-Code 
    1761 INTEGER :: jend 
    1762 \end_layout 
    1763  
    1764 \begin_layout Standard 
    1765 Define the ending index of the second dimension of the local domain. 
    1766  This attribute may be also computed from  
    1767 \begin_inset Flex Strong 
    1768 status collapsed 
    1769  
    1770 \begin_layout Plain Layout 
    1771 nj 
    1772 \end_layout 
    1773  
    1774 \end_inset 
    1775  
    1776  and  
    1777 \begin_inset Flex Strong 
    1778 status collapsed 
    1779  
    1780 \begin_layout Plain Layout 
    1781 jbegin 
    1782 \end_layout 
    1783  
    1784 \end_inset 
    1785  
    1786  attribute values, so this attribute is optional. 
    1787  But, if defined, a consistent value must be supplied. 
    1788 \end_layout 
    1789  
    1790 \begin_layout Standard 
    1791 \begin_inset Formula $jend=jbegin+nj-1$ 
    1792 \end_inset 
    1793  
    1794  
    1795 \end_layout 
    1796  
    1797 \begin_layout Standard 
    1798 \begin_inset Formula $1\leq jbegin\leq jend\leq nj\_glo$ 
    1799 \end_inset 
    1800  
    1801  
    1802 \end_layout 
    1803  
    1804 \begin_layout Subsection* 
    1805 zoom_ni:  
    1806 \emph on 
    1807 integer 
    1808 \end_layout 
    1809  
    1810 \begin_layout Standard 
    1811 Fortran: 
    1812 \end_layout 
    1813  
    1814 \begin_layout LyX-Code 
    1815 INTEGER :: zoom_ni 
    1816 \end_layout 
    1817  
    1818 \begin_layout Standard 
    1819 Define the size of the zoom on the first dimension on the global domain. 
    18201802 This attribute is optional. 
    1821  The default value is  
    1822 \begin_inset Flex Strong 
    1823 status collapsed 
    1824  
    1825 \begin_layout Plain Layout 
    1826 ni 
     1803 This must be an integer between  
     1804\begin_inset Flex Strong 
     1805status collapsed 
     1806 
     1807\begin_layout Plain Layout 
     18081 
     1809\end_layout 
     1810 
     1811\end_inset 
     1812 
     1813and  
     1814\begin_inset Flex Strong 
     1815status collapsed 
     1816 
     1817\begin_layout Plain Layout 
     1818nj_glo 
    18271819\end_layout 
    18281820 
     
    18301822 
    18311823. 
    1832 \end_layout 
    1833  
    1834 \begin_layout Standard 
    1835 \begin_inset Formula $1\leq zoom\_ni\leq ni$ 
    1836 \end_inset 
    1837  
    1838  
    1839 \end_layout 
    1840  
    1841 \begin_layout Subsection* 
    1842 zoom_ibegin:  
    1843 \emph on 
    1844 integer 
    1845 \end_layout 
    1846  
    1847 \begin_layout Standard 
    1848 Fortran 
    1849 \end_layout 
    1850  
    1851 \begin_layout LyX-Code 
    1852 INTEGER :: zoom_ibegin 
    1853 \end_layout 
    1854  
    1855 \begin_layout Standard 
    1856 Define the beginning index on the first dimension of the zoom for the global 
    1857  domain. 
    1858  This attribute is optional. 
    1859  The default value is 
    1860 \begin_inset Flex Strong 
    1861 status collapsed 
    1862  
    1863 \begin_layout Plain Layout 
    1864 1 
     1824 If not specified the default value is  
     1825\begin_inset Flex Strong 
     1826status collapsed 
     1827 
     1828\begin_layout Plain Layout 
     1829nj_glo 
    18651830\end_layout 
    18661831 
     
    18711836 
    18721837\begin_layout Subsection* 
    1873 zoom_nj:  
    1874 \emph on 
    1875 integer 
    1876 \end_layout 
    1877  
    1878 \begin_layout Standard 
    1879 Fortran: 
    1880 \end_layout 
    1881  
    1882 \begin_layout LyX-Code 
    1883 INTEGER :: zoom_nj 
    1884 \end_layout 
    1885  
    1886 \begin_layout Standard 
    1887 Define the size of the zoom on the second dimension for the global domain. 
    1888  This attribute is optional. 
    1889  The default value is 
    1890 \begin_inset Flex Strong 
    1891 status collapsed 
    1892  
    1893 \begin_layout Plain Layout 
    1894 nj 
    1895 \end_layout 
    1896  
    1897 \end_inset 
    1898  
    1899 . 
    1900 \end_layout 
    1901  
    1902 \begin_layout Standard 
    1903 \begin_inset Formula $1\leq zoom\_ni\leq ni$ 
    1904 \end_inset 
    1905  
    1906  
    1907 \end_layout 
    1908  
    1909 \begin_layout Subsection* 
    1910 zoom_jbegin:  
    1911 \emph on 
    1912 integer 
    1913 \end_layout 
    1914  
    1915 \begin_layout Standard 
    1916 Fortran: 
    1917 \end_layout 
    1918  
    1919 \begin_layout LyX-Code 
    1920 INTEGER :: zoom_jbegin 
    1921 \end_layout 
    1922  
    1923 \begin_layout Standard 
    1924 Define the beginning index on the second dimension of the zoom for the global 
    1925  domain. 
    1926  This attribute is optional. 
    1927  The default value is  
    1928 \begin_inset Flex Strong 
    1929 status collapsed 
    1930  
    1931 \begin_layout Plain Layout 
    1932 1 
    1933 \end_layout 
    1934  
    1935 \end_inset 
    1936  
    1937 . 
    1938 \end_layout 
    1939  
    1940 \begin_layout Subsection* 
    1941 mask:  
    1942 \emph on 
    1943 2D-array of bool 
    1944 \end_layout 
    1945  
    1946 \begin_layout Standard 
    1947 Fortran: 
    1948 \end_layout 
    1949  
    1950 \begin_layout LyX-Code 
    1951 LOGICAL :: mask(:,:) 
    1952 \end_layout 
    1953  
    1954 \begin_layout Standard 
    1955 Define the mask of the local domain. 
    1956  The masked value will be replaced by the value of the field attribute  
    1957 \begin_inset Flex Strong 
    1958 status collapsed 
    1959  
    1960 \begin_layout Plain Layout 
    1961 default_value 
    1962 \end_layout 
    1963  
    1964 \end_inset 
    1965  
    1966  in the output file. 
    1967 \end_layout 
    1968  
    1969 \begin_layout Subsection* 
    1970 lonvalue:  
     1838lonvalue_1d:  
    19711839\emph on 
    197218401D-array of double 
     
    20131881 
    20141882\begin_layout Subsection* 
    2015 latvalue:  
     1883lonvalue_2d:  
     1884\emph on 
     18852D-array of double 
     1886\end_layout 
     1887 
     1888\begin_layout Standard 
     1889Fortran: 
     1890\end_layout 
     1891 
     1892\begin_layout LyX-Code 
     1893DOUBLE PRECISION :: lonvalue(:,:) 
     1894\end_layout 
     1895 
     1896\begin_layout Standard 
     1897Define the value of the longitude on the local domain. 
     1898 For a cartesian and curvilinear grid, the size of the array will be  
     1899\begin_inset Flex Strong 
     1900status collapsed 
     1901 
     1902\begin_layout Plain Layout 
     1903ni 
     1904\begin_inset Formula $\times$ 
     1905\end_inset 
     1906 
     1907nj 
     1908\end_layout 
     1909 
     1910\end_inset 
     1911 
     1912. 
     1913 This attribute is mandatory. 
     1914 Only lonvalue_1d or lonvalue_2d can be defined. 
     1915\end_layout 
     1916 
     1917\begin_layout Subsection* 
     1918latvalue_1d:  
    20161919\emph on 
    201719201D-array of double 
     
    20481951 
    20491952\begin_layout Subsection* 
     1953latvalue_2d:  
     1954\emph on 
     19552D-array of double 
     1956\end_layout 
     1957 
     1958\begin_layout Standard 
     1959Fortran: 
     1960\end_layout 
     1961 
     1962\begin_layout LyX-Code 
     1963DOUBLE PRECISION :: latvalue(:,:) 
     1964\end_layout 
     1965 
     1966\begin_layout Standard 
     1967Define the value of the latitude on the local domain. 
     1968 For a cartesian and a curvilinear grid, the size of the array will be  
     1969\begin_inset Flex Strong 
     1970status collapsed 
     1971 
     1972\begin_layout Plain Layout 
     1973ni 
     1974\begin_inset Formula $\times$ 
     1975\end_inset 
     1976 
     1977nj 
     1978\end_layout 
     1979 
     1980\end_inset 
     1981 
     1982. 
     1983 This attribute is mandatory. 
     1984 Only latvalue_1d or latvalue_2d can be defined. 
     1985\end_layout 
     1986 
     1987\begin_layout Subsection* 
    20501988nvertex:  
    20511989\emph on 
     
    20682006 
    20692007\begin_layout Subsection* 
    2070 bounds_lon:  
    2071 \emph on 
    2072 1D-array of double 
    2073 \end_layout 
    2074  
    2075 \begin_layout Standard 
    2076 Fortran: 
    2077 \end_layout 
    2078  
    2079 \begin_layout LyX-Code 
    2080 DOUBLE PRECISION :: bounds_lon(:) 
     2008bounds_lon_1d:  
     2009\emph on 
     20102D-array of double 
     2011\end_layout 
     2012 
     2013\begin_layout Standard 
     2014Fortran: 
     2015\end_layout 
     2016 
     2017\begin_layout LyX-Code 
     2018DOUBLE PRECISION :: bounds_lon(:,:) 
    20812019\end_layout 
    20822020 
     
    20972035 
    20982036\begin_layout Subsection* 
    2099 bounds_lat:  
    2100 \emph on 
    2101 1D-array of double 
    2102 \end_layout 
    2103  
    2104 \begin_layout Standard 
    2105 Fortran: 
    2106 \end_layout 
    2107  
    2108 \begin_layout LyX-Code 
    2109 DOUBLE PRECISION :: bounds_lat(:) 
    2110 \end_layout 
    2111  
    2112 \begin_layout Standard 
    2113 Latitude value of the vertex of the cells. 
     2037bounds_lon_2d:  
     2038\emph on 
     20393D-array of double 
     2040\end_layout 
     2041 
     2042\begin_layout Standard 
     2043Fortran: 
     2044\end_layout 
     2045 
     2046\begin_layout LyX-Code 
     2047DOUBLE PRECISION :: bounds_lon(:,:,:) 
     2048\end_layout 
     2049 
     2050\begin_layout Standard 
     2051Longitude value of the vertex of the cells. 
    21142052\begin_inset Flex Strong 
    21152053status collapsed 
     
    21232061 attribute must also be defined. 
    21242062 This attribute is optional. 
     2063 This attribute is useful when lonvalue_2d is defined. 
     2064 Only bounds_lon_1d or bounds_lon_2d can be defined. 
     2065\end_layout 
     2066 
     2067\begin_layout Subsection* 
     2068bounds_lat_1d:  
     2069\emph on 
     20702D-array of double 
     2071\end_layout 
     2072 
     2073\begin_layout Standard 
     2074Fortran: 
     2075\end_layout 
     2076 
     2077\begin_layout LyX-Code 
     2078DOUBLE PRECISION :: bounds_lat(:,:) 
     2079\end_layout 
     2080 
     2081\begin_layout Standard 
     2082Latitude value of the vertex of the cells. 
     2083\begin_inset Flex Strong 
     2084status collapsed 
     2085 
     2086\begin_layout Plain Layout 
     2087nvertex 
     2088\end_layout 
     2089 
     2090\end_inset 
     2091 
     2092 attribute must also be defined. 
     2093 This attribute is optional. 
     2094\end_layout 
     2095 
     2096\begin_layout Subsection* 
     2097bounds_lat_2d:  
     2098\emph on 
     20993D-array of double 
     2100\end_layout 
     2101 
     2102\begin_layout Standard 
     2103Fortran: 
     2104\end_layout 
     2105 
     2106\begin_layout LyX-Code 
     2107DOUBLE PRECISION :: bounds_lat(:,:) 
     2108\end_layout 
     2109 
     2110\begin_layout Standard 
     2111Latitude value of the vertex of the cells. 
     2112\begin_inset Flex Strong 
     2113status collapsed 
     2114 
     2115\begin_layout Plain Layout 
     2116nvertex 
     2117\end_layout 
     2118 
     2119\end_inset 
     2120 
     2121 attribute must also be defined. 
     2122 This attribute is optional. 
     2123 This attribute is useful when latvalue_2d is defined. 
     2124 Only bounds_lat_1d or bounds_lat_2d can be defined. 
    21252125\end_layout 
    21262126 
     
    22292229 
    22302230 indicates that the horizontal layer is stored in a 2D array. 
    2231  This attribute is mandatory. 
     2231 This attribute is optional. 
     2232 The default value is  
     2233\begin_inset Flex Strong 
     2234status collapsed 
     2235 
     2236\begin_layout Plain Layout 
     22371 
     2238\end_layout 
     2239 
     2240\end_inset 
     2241 
     2242. 
    22322243\end_layout 
    22332244 
     
    24592470 
    24602471\begin_layout Subsection* 
    2461 data_n_index:  
    2462 \emph on 
    2463 integer 
    2464 \end_layout 
    2465  
    2466 \begin_layout Standard 
    2467 Fortran: 
    2468 \end_layout 
    2469  
    2470 \begin_layout LyX-Code 
    2471 INTEGER :: data_nindex 
    2472 \end_layout 
    2473  
    2474 \begin_layout Standard 
    2475 In case of a compressed horizontal domain, this attribute define the number 
    2476  of points stored in memory on the local domain. 
    2477 \end_layout 
    2478  
    2479 \begin_layout Subsection* 
    24802472data_i_index:  
    24812473\emph on 
     
    25362528 
    25372529. 
    2538  The size of the array must be  
    2539 \begin_inset Flex Strong 
    2540 status collapsed 
    2541  
    2542 \begin_layout Plain Layout 
    2543 data_nindex 
    2544 \end_layout 
    2545  
    2546 \end_inset 
    2547  
    2548 . 
     2530 This attribute is optional. 
     2531\end_layout 
     2532 
     2533\begin_layout Subsection* 
     2534mask_1d:  
     2535\emph on 
     25361D-array of bool 
     2537\end_layout 
     2538 
     2539\begin_layout Standard 
     2540Fortran: 
     2541\end_layout 
     2542 
     2543\begin_layout LyX-Code 
     2544LOGICAL :: mask(:) 
     2545\end_layout 
     2546 
     2547\begin_layout Standard 
     2548Define the 1-dimension mask of the local domain. 
     2549 The attribute is optional. 
     2550 By default, none value is masked. 
     2551 The masked value will be replaced by the value of the field attribute  
     2552\begin_inset Flex Strong 
     2553status collapsed 
     2554 
     2555\begin_layout Plain Layout 
     2556default_value 
     2557\end_layout 
     2558 
     2559\end_inset 
     2560 
     2561 in the output file. 
     2562 This value is useful in case a field is stored linearly in memory. 
     2563  
     2564\end_layout 
     2565 
     2566\begin_layout Subsection* 
     2567mask_2d:  
     2568\emph on 
     25692D-array of bool 
     2570\end_layout 
     2571 
     2572\begin_layout Standard 
     2573Fortran: 
     2574\end_layout 
     2575 
     2576\begin_layout LyX-Code 
     2577LOGICAL :: mask(:,:) 
     2578\end_layout 
     2579 
     2580\begin_layout Standard 
     2581Define the mask of the local domain. 
     2582 The attribute is optional. 
     2583 By default, none value is masked. 
     2584 The masked value will be replaced by the value of the field attribute  
     2585\begin_inset Flex Strong 
     2586status collapsed 
     2587 
     2588\begin_layout Plain Layout 
     2589default_value 
     2590\end_layout 
     2591 
     2592\end_inset 
     2593 
     2594 in the output file. 
     2595 Only mask_2d or mask_1d can be defined. 
     2596\end_layout 
     2597 
     2598\begin_layout Subsection* 
     2599domain_ref: string 
     2600\end_layout 
     2601 
     2602\begin_layout Standard 
     2603Fortran: 
     2604\end_layout 
     2605 
     2606\begin_layout LyX-Code 
     2607CHARACTER(LEN=*) :: domain_ref 
     2608\end_layout 
     2609 
     2610\begin_layout Standard 
     2611Define the reference of the domain. 
     2612 All attributes are inherited from the referenced domain with the classical 
     2613 inheritance mechanism. 
     2614 The value assigned to the referenced domain is transmitted to to current 
     2615 domain. 
    25492616 This attribute is optional. 
    25502617\end_layout 
     
    25732640 
    25742641\begin_layout Subsection* 
    2575 domain_ref: string 
    2576 \end_layout 
    2577  
    2578 \begin_layout Standard 
    2579 Fortran: 
    2580 \end_layout 
    2581  
    2582 \begin_layout LyX-Code 
    2583 CHARACTER(LEN=*) :: domain_ref 
    2584 \end_layout 
    2585  
    2586 \begin_layout Standard 
    2587 Define the horizontal domain reference of the grid. 
    2588  This attribute is mandatory. 
    2589 \end_layout 
    2590  
    2591 \begin_layout Subsection* 
    2592 axis_ref: string 
    2593 \end_layout 
    2594  
    2595 \begin_layout Standard 
    2596 Fortran: 
    2597 \end_layout 
    2598  
    2599 \begin_layout LyX-Code 
    2600 CHARACTER(LEN=*) :: axis_ref 
    2601 \end_layout 
    2602  
    2603 \begin_layout Standard 
    2604 Define the axis reference of the grid. 
    2605  This attribute is optional, if not defined, the grid will be considered 
    2606  as a 2-Dimensionnal grid without vertical layer. 
     2642description: string 
     2643\end_layout 
     2644 
     2645\begin_layout Standard 
     2646Fortran: 
     2647\end_layout 
     2648 
     2649\begin_layout LyX-Code 
     2650CHARACTER(LEN=*) :: description 
     2651\end_layout 
     2652 
     2653\begin_layout Standard 
     2654Define the description of the grid. 
     2655 This attribute is optional. 
    26072656\end_layout 
    26082657 
     
    26102659mask:  
    26112660\emph on 
     26611D-array of bool 
     2662\end_layout 
     2663 
     2664\begin_layout Standard 
     2665Fortran: 
     2666\end_layout 
     2667 
     2668\begin_layout LyX-Code 
     2669LOGICAL :: mask(:) 
     2670\end_layout 
     2671 
     2672\begin_layout Standard 
     2673Define the mask of the local 1-dimension grid. 
     2674 Masked value will be replaced by the value of the field attribute  
     2675\begin_inset Flex Strong 
     2676status collapsed 
     2677 
     2678\begin_layout Plain Layout 
     2679default_value 
     2680\end_layout 
     2681 
     2682\end_inset 
     2683 
     2684 in the output file. 
     2685 This attribute is optional. 
     2686 By default, none value is masked. 
     2687\end_layout 
     2688 
     2689\begin_layout Subsection* 
     2690mask:  
     2691\emph on 
     26922D-array of bool 
     2693\end_layout 
     2694 
     2695\begin_layout Standard 
     2696Fortran: 
     2697\end_layout 
     2698 
     2699\begin_layout LyX-Code 
     2700LOGICAL :: mask(:,:) 
     2701\end_layout 
     2702 
     2703\begin_layout Standard 
     2704Define the mask of the local 2-dimension grid. 
     2705 Masked value will be replaced by the value of the field attribute  
     2706\begin_inset Flex Strong 
     2707status collapsed 
     2708 
     2709\begin_layout Plain Layout 
     2710default_value 
     2711\end_layout 
     2712 
     2713\end_inset 
     2714 
     2715 in the output file. 
     2716 This attribute is optional. 
     2717 By default, none value is masked. 
     2718\end_layout 
     2719 
     2720\begin_layout Subsection* 
     2721mask:  
     2722\emph on 
    261227233D-array of bool 
    26132724\end_layout 
     
    26222733 
    26232734\begin_layout Standard 
    2624 Define the mask of the local grid. 
     2735Define the mask of the local 3-dimension grid. 
    26252736 Masked value will be replaced by the value of the field attribute  
    26262737\begin_inset Flex Strong 
     
    26342745 
    26352746 in the output file. 
     2747 This attribute is optional. 
     2748 By default, none value is masked. 
     2749 Only one mask can be defined. 
    26362750\end_layout 
    26372751 
     
    31733287 
    31743288\begin_layout Subsection* 
    3175 valid_min:  
     3289valid_max:  
    31763290\emph on 
    31773291double 
     
    31833297 
    31843298\begin_layout LyX-Code 
    3185 DOUBLE PRECISION :: valid_min 
     3299DOUBLE PRECISION :: valid_max 
    31863300\end_layout 
    31873301 
     
    37953909 
    37963910\begin_layout Subsection* 
    3797 type:  
    3798 \emph on 
    3799 mode { read, write } 
     3911mode:  
     3912\emph on 
     3913enumeration { read, write } 
    38003914\end_layout 
    38013915 
     
    42124326\series default 
    42134327 will be used. 
     4328\end_layout 
     4329 
     4330\begin_layout Section 
     4331Transformation attribute reference 
     4332\end_layout 
     4333 
     4334\begin_layout Subsection 
     4335interpolate_axis 
     4336\end_layout 
     4337 
     4338\begin_layout Subsection* 
     4339type:  
     4340\emph on 
     4341string 
     4342\end_layout 
     4343 
     4344\begin_layout Standard 
     4345Fortran: 
     4346\end_layout 
     4347 
     4348\begin_layout LyX-Code 
     4349CHARACTER(LEN=*) :: type 
     4350\end_layout 
     4351 
     4352\begin_layout Standard 
     4353Define the type of interpolation on an axis. 
     4354 This attribute is optional. 
     4355\end_layout 
     4356 
     4357\begin_layout Subsection* 
     4358order:  
     4359\emph on 
     4360integer 
     4361\end_layout 
     4362 
     4363\begin_layout Standard 
     4364Fortran:  
     4365\end_layout 
     4366 
     4367\begin_layout LyX-Code 
     4368INTEGER :: order 
     4369\end_layout 
     4370 
     4371\begin_layout Standard 
     4372Define a order of interpolation. 
     4373 This attribute is optional. 
     4374 The default value is 2. 
     4375\end_layout 
     4376 
     4377\begin_layout Subsection 
     4378inverse_axis 
     4379\end_layout 
     4380 
     4381\begin_layout Subsection 
     4382zoom_axis 
     4383\end_layout 
     4384 
     4385\begin_layout Subsection* 
     4386begin:  
     4387\begin_inset Flex Emph 
     4388status collapsed 
     4389 
     4390\begin_layout Plain Layout 
     4391integer 
     4392\end_layout 
     4393 
     4394\end_inset 
     4395 
     4396 
     4397\end_layout 
     4398 
     4399\begin_layout Standard 
     4400Fortran: 
     4401\end_layout 
     4402 
     4403\begin_layout LyX-Code 
     4404INTEGER :: begin 
     4405\end_layout 
     4406 
     4407\begin_layout Standard 
     4408Define the begining index of the zoomed region on global axis. 
     4409 This attribute is optional. 
     4410 This must be an integer between  
     4411\begin_inset Flex Strong 
     4412status collapsed 
     4413 
     4414\begin_layout Plain Layout 
     44150 
     4416\end_layout 
     4417 
     4418\end_inset 
     4419 
     4420 and  
     4421\begin_inset Flex Strong 
     4422status collapsed 
     4423 
     4424\begin_layout Plain Layout 
     4425ni_glo-1 
     4426\end_layout 
     4427 
     4428\end_inset 
     4429 
     4430 of associated axis. 
     4431 If not specified the default value is  
     4432\begin_inset Flex Strong 
     4433status collapsed 
     4434 
     4435\begin_layout Plain Layout 
     44360 
     4437\end_layout 
     4438 
     4439\end_inset 
     4440 
     4441. 
     4442\end_layout 
     4443 
     4444\begin_layout Subsection* 
     4445n:  
     4446\begin_inset Flex Emph 
     4447status collapsed 
     4448 
     4449\begin_layout Plain Layout 
     4450integer 
     4451\end_layout 
     4452 
     4453\end_inset 
     4454 
     4455 
     4456\end_layout 
     4457 
     4458\begin_layout Standard 
     4459Fortran: 
     4460\end_layout 
     4461 
     4462\begin_layout LyX-Code 
     4463INTEGER :: n 
     4464\end_layout 
     4465 
     4466\begin_layout Standard 
     4467Define the size of zoomed region on global axis. 
     4468 This attribute is optional. 
     4469 This must be an integer between  
     4470\begin_inset Flex Strong 
     4471status collapsed 
     4472 
     4473\begin_layout Plain Layout 
     44741 
     4475\end_layout 
     4476 
     4477\end_inset 
     4478 
     4479and  
     4480\begin_inset Flex Strong 
     4481status collapsed 
     4482 
     4483\begin_layout Plain Layout 
     4484nj_glo 
     4485\end_layout 
     4486 
     4487\end_inset 
     4488 
     4489 of the associated axis. 
     4490 If not specified the default value is  
     4491\begin_inset Flex Strong 
     4492status collapsed 
     4493 
     4494\begin_layout Plain Layout 
     4495nj_glo 
     4496\end_layout 
     4497 
     4498\end_inset 
     4499 
     4500 of the associated axis. 
     4501\end_layout 
     4502 
     4503\begin_layout Subsection 
     4504interpolate_domain 
     4505\end_layout 
     4506 
     4507\begin_layout Subsection* 
     4508file:  
     4509\emph on 
     4510string 
     4511\end_layout 
     4512 
     4513\begin_layout Standard 
     4514Fortran: 
     4515\end_layout 
     4516 
     4517\begin_layout LyX-Code 
     4518CHARACTER(LEN=*) :: type 
     4519\end_layout 
     4520 
     4521\begin_layout Standard 
     4522Define the file which contains the weight value to interpolate from domain 
     4523 source to domain destination. 
     4524 This attribute is optional. 
     4525 If not specified, the internal interpolation module will be used. 
     4526\end_layout 
     4527 
     4528\begin_layout Subsection* 
     4529order:  
     4530\emph on 
     4531integer 
     4532\end_layout 
     4533 
     4534\begin_layout Standard 
     4535Fortran:  
     4536\end_layout 
     4537 
     4538\begin_layout LyX-Code 
     4539INTEGER :: order 
     4540\end_layout 
     4541 
     4542\begin_layout Standard 
     4543Define a order of interpolation. 
     4544 This attribute is only for internal interoplation module. 
     4545 This attribute is optional. 
     4546 The default value is 2. 
     4547\end_layout 
     4548 
     4549\begin_layout Subsection 
     4550zoom_domain 
     4551\end_layout 
     4552 
     4553\begin_layout Subsection* 
     4554ibegin:  
     4555\begin_inset Flex Emph 
     4556status collapsed 
     4557 
     4558\begin_layout Plain Layout 
     4559integer 
     4560\end_layout 
     4561 
     4562\end_inset 
     4563 
     4564 
     4565\end_layout 
     4566 
     4567\begin_layout Standard 
     4568Fortran: 
     4569\end_layout 
     4570 
     4571\begin_layout LyX-Code 
     4572INTEGER :: ibegin 
     4573\end_layout 
     4574 
     4575\begin_layout Standard 
     4576Define the begining index of the zoomed region on the first dimension of 
     4577 the global domain. 
     4578 This attribute is optional. 
     4579 This must be an integer between  
     4580\begin_inset Flex Strong 
     4581status collapsed 
     4582 
     4583\begin_layout Plain Layout 
     45840 
     4585\end_layout 
     4586 
     4587\end_inset 
     4588 
     4589 and  
     4590\begin_inset Flex Strong 
     4591status collapsed 
     4592 
     4593\begin_layout Plain Layout 
     4594ni_glo-1 
     4595\end_layout 
     4596 
     4597\end_inset 
     4598 
     4599 of the associated dimension of domain. 
     4600 If not specified the default value is  
     4601\begin_inset Flex Strong 
     4602status collapsed 
     4603 
     4604\begin_layout Plain Layout 
     46050 
     4606\end_layout 
     4607 
     4608\end_inset 
     4609 
     4610. 
     4611\end_layout 
     4612 
     4613\begin_layout Subsection* 
     4614ni:  
     4615\begin_inset Flex Emph 
     4616status collapsed 
     4617 
     4618\begin_layout Plain Layout 
     4619integer 
     4620\end_layout 
     4621 
     4622\end_inset 
     4623 
     4624 
     4625\end_layout 
     4626 
     4627\begin_layout Standard 
     4628Fortran: 
     4629\end_layout 
     4630 
     4631\begin_layout LyX-Code 
     4632INTEGER :: ni 
     4633\end_layout 
     4634 
     4635\begin_layout Standard 
     4636Define the size of zoomed region on the first dimension of the global domain. 
     4637 This attribute is optional. 
     4638 This must be an integer between  
     4639\begin_inset Flex Strong 
     4640status collapsed 
     4641 
     4642\begin_layout Plain Layout 
     46431 
     4644\end_layout 
     4645 
     4646\end_inset 
     4647 
     4648and  
     4649\begin_inset Flex Strong 
     4650status collapsed 
     4651 
     4652\begin_layout Plain Layout 
     4653ni_glo 
     4654\end_layout 
     4655 
     4656\end_inset 
     4657 
     4658 of the associated dimension of domain. 
     4659 If not specified the default value is  
     4660\begin_inset Flex Strong 
     4661status collapsed 
     4662 
     4663\begin_layout Plain Layout 
     4664ni_glo 
     4665\end_layout 
     4666 
     4667\end_inset 
     4668 
     4669 of the dimension of domain. 
     4670\end_layout 
     4671 
     4672\begin_layout Subsection* 
     4673jbegin:  
     4674\begin_inset Flex Emph 
     4675status collapsed 
     4676 
     4677\begin_layout Plain Layout 
     4678integer 
     4679\end_layout 
     4680 
     4681\end_inset 
     4682 
     4683 
     4684\end_layout 
     4685 
     4686\begin_layout Standard 
     4687Fortran: 
     4688\end_layout 
     4689 
     4690\begin_layout LyX-Code 
     4691INTEGER :: jbegin 
     4692\end_layout 
     4693 
     4694\begin_layout Standard 
     4695Define the begining index of the zoomed region on the second dimension of 
     4696 the global domain. 
     4697 This attribute is optional. 
     4698 This must be an integer between  
     4699\begin_inset Flex Strong 
     4700status collapsed 
     4701 
     4702\begin_layout Plain Layout 
     47030 
     4704\end_layout 
     4705 
     4706\end_inset 
     4707 
     4708 and  
     4709\begin_inset Flex Strong 
     4710status collapsed 
     4711 
     4712\begin_layout Plain Layout 
     4713nj_glo-1 
     4714\end_layout 
     4715 
     4716\end_inset 
     4717 
     4718 of the associated dimension of domain. 
     4719 If not specified the default value is  
     4720\begin_inset Flex Strong 
     4721status collapsed 
     4722 
     4723\begin_layout Plain Layout 
     47240 
     4725\end_layout 
     4726 
     4727\end_inset 
     4728 
     4729. 
     4730\end_layout 
     4731 
     4732\begin_layout Subsection* 
     4733nj:  
     4734\begin_inset Flex Emph 
     4735status collapsed 
     4736 
     4737\begin_layout Plain Layout 
     4738integer 
     4739\end_layout 
     4740 
     4741\end_inset 
     4742 
     4743 
     4744\end_layout 
     4745 
     4746\begin_layout Standard 
     4747Fortran: 
     4748\end_layout 
     4749 
     4750\begin_layout LyX-Code 
     4751INTEGER :: nj 
     4752\end_layout 
     4753 
     4754\begin_layout Standard 
     4755Define the size of zoomed region on the second dimension of the global domain. 
     4756 This attribute is optional. 
     4757 This must be an integer between  
     4758\begin_inset Flex Strong 
     4759status collapsed 
     4760 
     4761\begin_layout Plain Layout 
     47621 
     4763\end_layout 
     4764 
     4765\end_inset 
     4766 
     4767and  
     4768\begin_inset Flex Strong 
     4769status collapsed 
     4770 
     4771\begin_layout Plain Layout 
     4772nj_glo 
     4773\end_layout 
     4774 
     4775\end_inset 
     4776 
     4777 of the associated dimension of domain. 
     4778 If not specified the default value is  
     4779\begin_inset Flex Strong 
     4780status collapsed 
     4781 
     4782\begin_layout Plain Layout 
     4783nj_glo 
     4784\end_layout 
     4785 
     4786\end_inset 
     4787 
     4788 of the dimension of domain. 
     4789\end_layout 
     4790 
     4791\begin_layout Subsection 
     4792generate_rectilinear_domain 
     4793\end_layout 
     4794 
     4795\begin_layout Standard 
     4796 
    42144797\end_layout 
    42154798 
  • XIOS/trunk/doc/inputs/user/Axis.lyx

    r669 r797  
    287287\end_layout 
    288288 
     289\begin_layout Itemize 
     290inverse_axis: Inverse an axis 
     291\end_layout 
     292 
    289293\begin_layout Standard 
    290294It is not difficult to define a transformation: Include type of transformation 
     
    315319\begin_layout Plain Layout 
    316320 
    317    <zoom_axis zoom_begin="1" zoom_size="3"/> 
     321   <zoom_axis zoom_begin="1" zoom_n="3"/> 
    318322\end_layout 
    319323 
     
    334338 
    335339\begin_layout Standard 
    336 The concrete example above says many things: the axis named axis_A_zoom 
    337  is transformed from axis name axis_A with a zoom activity. 
     340The concrete example is translated as: the axis named axis_A_zoom is transformed 
     341 from axis name axis_A with a zoom activity. 
    338342 The detailed attributes of zoom_axis can be found in reference document, 
    339343 but simply it contains the begining and size of zoomed region. 
  • XIOS/trunk/doc/inputs/user/Domain.lyx

    r669 r797  
    321321\end_layout 
    322322 
     323\begin_layout Itemize 
     324generate_rectilinear_domain: auto generating, distributing a rectilinear 
     325 domain then filling all mandatory attributes. 
     326\end_layout 
     327 
    323328\begin_layout Standard 
    324329It is not difficult to define a transformation: Include type of transformation 
     
    368373 
    369374\begin_layout Standard 
    370 The concrete example above says many things: a domain named domain_A_zoom 
     375The concrete example above tells many things: a domain named domain_A_zoom 
    371376 is transformed from domain name domain_A with a zoom activity. 
     377 The domain_A_zoom is the zoomed region of domain_A. 
    372378 The detailed attributes of zoom_domain can be found in reference document, 
    373379 but simply it contains the begining and size of zoomed region. 
     
    475481 
    476482\begin_layout Standard 
    477 Although xml is helpful to define several configurations, it can not be 
    478  used to customize attributes of domain. 
     483Although xml is helpful to define several configurations, it is not convenient 
     484 to customize attributes of domain. 
    479485 So it's the turn of Fortran interface. 
    480486\end_layout 
     
    772778 In case of one-dimensional data, it is only necessary to determine data_ibegin 
    773779 and data_ni. 
    774  Although the valid data must be inside a domain, it is not neccessary for 
    775  data to have same size as domain. 
     780 Although the valid data must be inside a local domain, it is not neccessary 
     781 for data to have same size as local domain. 
    776782 In fact, data can have larger size than domain on each dimension, this 
    777783 is often the case of  
     
    844850\end_inset 
    845851 
    846 , local domain occupies the center of the global domain, whereas real data 
     852, local domain occupies the center of the global domain, where real data 
    847853 fill up a larger region. 
    848854 Only data inside the local domain, represented by blue cells, are valid. 
     
    938944 
    939945\begin_layout Standard 
    940 With the same domain_A, we can have longitude and latitude by calling: 
     946With the same domain_A, we can set longitude and latitude values by calling: 
    941947\end_layout 
    942948 
Note: See TracChangeset for help on using the changeset viewer.