[3d993d]: exodus / cbind / include / exodusII.h  Maximize  Restore  History

Download this file

1729 lines (1466 with data), 65.2 kB

   1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
/*
* Copyright (c) 2005 Sandia Corporation. Under the terms of Contract
* DE-AC04-94AL85000 with Sandia Corporation, the U.S. Governement
* retains certain rights in this software.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* * Neither the name of Sandia Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
/*****************************************************************************
*
* exodusII.h - Exodus II API include file
*
*****************************************************************************/
#ifndef EXODUS_II_HDR
#define EXODUS_II_HDR
#include "netcdf.h"
#include <stddef.h>
#include <stdlib.h>
#include <stdint.h>
#ifndef NC_INT64
#error "NetCDF version 4.1.2 or later is required."
#endif
/* EXODUS II version number */
#define EX_API_VERS 5.21f
#define EX_API_VERS_NODOT 521
#define EX_VERS EX_API_VERS
#define NEMESIS_API_VERSION EX_API_VERS
#define NEMESIS_API_VERSION_NODOT EX_API_VERS_NODOT
#define NEMESIS_FILE_VERSION 2.6
/*
* need following extern if this include file is used in a C++
* program, to keep the C++ compiler from mangling the function names.
*/
#ifdef __cplusplus
extern "C" {
#endif
/*
* The following are miscellaneous constants used in the EXODUS II
* API. They should already be defined, but are left over from the
* old days...
*/
#ifndef TRUE
#define TRUE -1
#endif
#ifndef FALSE
#define FALSE 0
#endif
/**
* \defgroup FileVars Variables controlling the file creation mode.
*@{
*/
/* Modes for ex_open */
#define EX_READ 0x0000 /**< ex_open(): open file for reading (default) */
#define EX_WRITE 0x0001 /**< ex_open(): open existing file for appending. */
#define EX_NOCLOBBER 0x0004 /**< Don't overwrite existing database, default */
#define EX_CLOBBER 0x0008 /**< Overwrite existing database if it exists */
#define EX_NORMAL_MODEL 0x0010 /**< disable mods that permit storage of larger models */
#define EX_LARGE_MODEL 0x0020 /**< enable mods that permit storage of larger models */
#define EX_NETCDF4 0x0040 /**< use the hdf5-based netcdf4 output */
#define EX_NOSHARE 0x0080 /**< Do not open netcdf file in "share" mode */
#define EX_SHARE 0x0100 /**< Do open netcdf file in "share" mode */
#define EX_NOCLASSIC 0x0200 /**< Do not force netcdf to classic mode in netcdf4 mode */
/* Need to distinguish between storage on database (DB in name) and
passed through the API functions (API in name).
*/
#define EX_MAPS_INT64_DB 0x0400 /**< All maps (id, order, ...) store int64_t values */
#define EX_IDS_INT64_DB 0x0800 /**< All entity ids (sets, blocks, maps) are int64_t values */
#define EX_BULK_INT64_DB 0x1000 /**< All integer bulk data (local indices, counts, maps); not ids */
#define EX_ALL_INT64_DB (EX_MAPS_INT64_DB|EX_IDS_INT64_DB|EX_BULK_INT64_DB) /**< All of the above... */
#define EX_MAPS_INT64_API 0x2000 /**< All maps (id, order, ...) store int64_t values */
#define EX_IDS_INT64_API 0x4000 /**< All entity ids (sets, blocks, maps) are int64_t values */
#define EX_BULK_INT64_API 0x8000 /**< All integer bulk data (local indices, counts, maps); not ids */
#define EX_INQ_INT64_API 0x10000 /**< Integers passed to/from ex_inquire are int64_t */
#define EX_ALL_INT64_API (EX_MAPS_INT64_API|EX_IDS_INT64_API|EX_BULK_INT64_API|EX_INQ_INT64_API) /**< All of the above... */
/*@}*/
/*! \sa ex_inquire() */
enum ex_inquiry {
EX_INQ_FILE_TYPE = 1, /**< inquire EXODUS II file type*/
EX_INQ_API_VERS = 2, /**< inquire API version number */
EX_INQ_DB_VERS = 3, /**< inquire database version number */
EX_INQ_TITLE = 4, /**< inquire database title */
EX_INQ_DIM = 5, /**< inquire number of dimensions */
EX_INQ_NODES = 6, /**< inquire number of nodes */
EX_INQ_ELEM = 7, /**< inquire number of elements */
EX_INQ_ELEM_BLK = 8, /**< inquire number of element blocks */
EX_INQ_NODE_SETS = 9, /**< inquire number of node sets*/
EX_INQ_NS_NODE_LEN = 10, /**< inquire length of node set node list */
EX_INQ_SIDE_SETS = 11, /**< inquire number of side sets*/
EX_INQ_SS_NODE_LEN = 12, /**< inquire length of side set node list */
EX_INQ_SS_ELEM_LEN = 13, /**< inquire length of side set element list */
EX_INQ_QA = 14, /**< inquire number of QA records */
EX_INQ_INFO = 15, /**< inquire number of info records */
EX_INQ_TIME = 16, /**< inquire number of time steps in the database */
EX_INQ_EB_PROP = 17, /**< inquire number of element block properties */
EX_INQ_NS_PROP = 18, /**< inquire number of node set properties */
EX_INQ_SS_PROP = 19, /**< inquire number of side set properties */
EX_INQ_NS_DF_LEN = 20, /**< inquire length of node set distribution factor list*/
EX_INQ_SS_DF_LEN = 21, /**< inquire length of side set distribution factor list*/
EX_INQ_LIB_VERS = 22, /**< inquire API Lib vers number*/
EX_INQ_EM_PROP = 23, /**< inquire number of element map properties */
EX_INQ_NM_PROP = 24, /**< inquire number of node map properties */
EX_INQ_ELEM_MAP = 25, /**< inquire number of element maps */
EX_INQ_NODE_MAP = 26, /**< inquire number of node maps*/
EX_INQ_EDGE = 27, /**< inquire number of edges */
EX_INQ_EDGE_BLK = 28, /**< inquire number of edge blocks */
EX_INQ_EDGE_SETS = 29, /**< inquire number of edge sets */
EX_INQ_ES_LEN = 30, /**< inquire length of concat edge set edge list */
EX_INQ_ES_DF_LEN = 31, /**< inquire length of concat edge set dist factor list*/
EX_INQ_EDGE_PROP = 32, /**< inquire number of properties stored per edge block */
EX_INQ_ES_PROP = 33, /**< inquire number of properties stored per edge set */
EX_INQ_FACE = 34, /**< inquire number of faces */
EX_INQ_FACE_BLK = 35, /**< inquire number of face blocks */
EX_INQ_FACE_SETS = 36, /**< inquire number of face sets */
EX_INQ_FS_LEN = 37, /**< inquire length of concat face set face list */
EX_INQ_FS_DF_LEN = 38, /**< inquire length of concat face set dist factor list*/
EX_INQ_FACE_PROP = 39, /**< inquire number of properties stored per face block */
EX_INQ_FS_PROP = 40, /**< inquire number of properties stored per face set */
EX_INQ_ELEM_SETS = 41, /**< inquire number of element sets */
EX_INQ_ELS_LEN = 42, /**< inquire length of concat element set element list */
EX_INQ_ELS_DF_LEN = 43, /**< inquire length of concat element set dist factor list*/
EX_INQ_ELS_PROP = 44, /**< inquire number of properties stored per elem set */
EX_INQ_EDGE_MAP = 45, /**< inquire number of edge maps */
EX_INQ_FACE_MAP = 46, /**< inquire number of face maps */
EX_INQ_COORD_FRAMES = 47, /**< inquire number of coordinate frames */
EX_INQ_DB_MAX_ALLOWED_NAME_LENGTH = 48, /**< inquire size of MAX_NAME_LENGTH dimension on database */
EX_INQ_DB_MAX_USED_NAME_LENGTH = 49, /**< inquire size of MAX_NAME_LENGTH dimension on database */
EX_INQ_MAX_READ_NAME_LENGTH = 50, /**< inquire client-specified max size of returned names */
EX_INQ_INVALID = -1};
typedef enum ex_inquiry ex_inquiry;
/* Options */
/**
* \defgroup FileOptions Variables controlling the compression, name size, and integer size.
*@{
*/
/* Modes for ex_open */
/*! \sa ex_set_option() */
enum ex_option_type {
EX_OPT_MAX_NAME_LENGTH = 1,
EX_OPT_COMPRESSION_TYPE, /* Currently not used. GZip by default */
EX_OPT_COMPRESSION_LEVEL, /* 0 (disabled/fastest) ... 9 (best/slowest) */
EX_OPT_COMPRESSION_SHUFFLE, /* 0 (disabled); 1 (enabled) */
EX_OPT_INTEGER_SIZE_API, /* See *_INT64_* values above */
EX_OPT_INTEGER_SIZE_DB /* (query only) */
};
typedef enum ex_option_type ex_option_type;
/*@}*/
enum ex_entity_type {
EX_NODAL = 14, /**< nodal "block" for variables*/
EX_NODE_BLOCK = 14, /**< alias for EX_NODAL */
EX_NODE_SET = 2, /**< node set property code */
EX_EDGE_BLOCK = 6, /**< edge block property code */
EX_EDGE_SET = 7, /**< edge set property code */
EX_FACE_BLOCK = 8, /**< face block property code */
EX_FACE_SET = 9, /**< face set property code */
EX_ELEM_BLOCK = 1, /**< element block property code*/
EX_ELEM_SET = 10, /**< face set property code */
EX_SIDE_SET = 3, /**< side set property code */
EX_ELEM_MAP = 4, /**< element map property code */
EX_NODE_MAP = 5, /**< node map property code */
EX_EDGE_MAP = 11, /**< edge map property code */
EX_FACE_MAP = 12, /**< face map property code */
EX_GLOBAL = 13, /**< global "block" for variables*/
EX_COORDINATE = 15, /**< kluge so some internal wrapper functions work */
EX_INVALID = -1};
typedef enum ex_entity_type ex_entity_type;
/**
* ex_opts() function codes - codes are OR'ed into exopts
*/
enum ex_options {
EX_DEFAULT = 0,
EX_VERBOSE = 1, /**< verbose mode message flag */
EX_DEBUG = 2, /**< debug mode def */
EX_ABORT = 4 /**< abort mode flag def */
};
typedef enum ex_options ex_options;
/** The value used to indicate that an entity (block, nset, sset)
has not had its id set to a valid value
*/
#define EX_INVALID_ID -1
/**
* \defgroup StringLengths maximum string lengths;
* constants that are used as netcdf dimensions must be of type long
* @{
*/
/** Maximum length of QA record, element type name */
#define MAX_STR_LENGTH 32L
/** Maximum length of an entity name, attribute name, variable name */
#define MAX_NAME_LENGTH MAX_STR_LENGTH
/** Maximum length of the database title or an information record */
#define MAX_LINE_LENGTH 80L
/** Maximum length of an error message passed to ex_err() function. Typically, internal use only */
#define MAX_ERR_LENGTH 256
/* @} */
/** Specifies that this argument is the id of an entity: element block, nodeset, sideset, ... */
typedef int64_t ex_entity_id;
/** The mechanism for passing double/float and int/int64_t both use a
void*; to avoid some confusion as to whether a function takes an
integer or a float/double, the following typedef is used for the
integer argument
*/
typedef void void_int;
/**
* \defgroup APIStructs Structures used by external API functions.
* @{
*/
typedef struct ex_init_params {
char title[MAX_LINE_LENGTH + 1];
int64_t num_dim;
int64_t num_nodes;
int64_t num_edge;
int64_t num_edge_blk;
int64_t num_face;
int64_t num_face_blk;
int64_t num_elem;
int64_t num_elem_blk;
int64_t num_node_sets;
int64_t num_edge_sets;
int64_t num_face_sets;
int64_t num_side_sets;
int64_t num_elem_sets;
int64_t num_node_maps;
int64_t num_edge_maps;
int64_t num_face_maps;
int64_t num_elem_maps;
} ex_init_params;
typedef struct ex_block {
int64_t id;
ex_entity_type type;
char topology[MAX_STR_LENGTH+1];
int64_t num_entry;
int64_t num_nodes_per_entry;
int64_t num_edges_per_entry;
int64_t num_faces_per_entry;
int64_t num_attribute;
} ex_block;
typedef struct ex_set {
int64_t id;
ex_entity_type type;
int64_t num_entry;
int64_t num_distribution_factor;
void_int* entry_list;
void_int* extra_list;
void* distribution_factor_list;
} ex_set;
typedef struct ex_block_params {
void_int* edge_blk_id;
char** edge_type;
int* num_edge_this_blk;
int* num_nodes_per_edge;
int* num_attr_edge;
void_int* face_blk_id;
char** face_type;
int* num_face_this_blk;
int* num_nodes_per_face;
int* num_attr_face;
void_int* elem_blk_id;
char** elem_type;
int* num_elem_this_blk;
int* num_nodes_per_elem;
int* num_edges_per_elem;
int* num_faces_per_elem;
int* num_attr_elem;
int define_maps;
} ex_block_params;
typedef struct ex_set_specs {
void_int* sets_ids;
void_int* num_entries_per_set;
void_int* num_dist_per_set;
void_int* sets_entry_index;
void_int* sets_dist_index;
void_int* sets_entry_list;
void_int* sets_extra_list;
void* sets_dist_fact;
} ex_set_specs;
typedef struct ex_var_params {
int num_glob;
int num_node;
int num_edge;
int* edge_var_tab;
int num_face;
int* face_var_tab;
int num_elem;
int* elem_var_tab;
int num_nset;
int* nset_var_tab;
int num_eset;
int* eset_var_tab;
int num_fset;
int* fset_var_tab;
int num_sset;
int* sset_var_tab;
int num_elset;
int* elset_var_tab;
} ex_var_params;
/* @} */
#ifndef EXODUS_EXPORT
#define EXODUS_EXPORT extern
#endif /* EXODUS_EXPORT */
/* routines for file initialization i/o */
EXODUS_EXPORT int ex_close (int exoid);
EXODUS_EXPORT int ex_copy (int in_exoid, int out_exoid);
#define ex_create(path, mode, comp_ws, io_ws) ex_create_int(path, mode, comp_ws, io_ws, EX_API_VERS_NODOT)
EXODUS_EXPORT int ex_create_int (const char *path, int cmode, int *comp_ws, int *io_ws, int my_version);
EXODUS_EXPORT int ex_get_all_times (int exoid,
void *time_values);
EXODUS_EXPORT int ex_get_coord_names (int exoid,
char **coord_names);
EXODUS_EXPORT int ex_get_coord (int exoid,
void *x_coor,
void *y_coor,
void *z_coor);
EXODUS_EXPORT int ex_get_n_coord (int exoid,
int64_t start_node_num,
int64_t num_nodes,
void *x_coor,
void *y_coor,
void *z_coor);
EXODUS_EXPORT int ex_get_ids (int exoid,
ex_entity_type obj_type,
void_int *ids);
EXODUS_EXPORT int ex_get_coordinate_frames(int exoid,
int *nframes,
void_int *cf_ids,
void* pt_coordinates,
char* tags);
EXODUS_EXPORT int ex_get_glob_vars (int exoid,
int time_step,
int num_glob_vars,
void *glob_var_vals);
EXODUS_EXPORT int ex_get_glob_var_time (int exoid,
int glob_var_index,
int beg_time_step,
int end_time_step,
void *glob_var_vals);
EXODUS_EXPORT int ex_get_info (int exoid, char **info);
EXODUS_EXPORT int ex_put_init_ext (int exoid, const ex_init_params *param);
EXODUS_EXPORT int ex_get_init_ext (int exoid, ex_init_params *param);
EXODUS_EXPORT int ex_get_init (int exoid,
char *title,
void_int *num_dim,
void_int *num_nodes,
void_int *num_elem,
void_int *num_elem_blk,
void_int *num_node_sets,
void_int *num_side_sets);
EXODUS_EXPORT int ex_put_init (int exoid,
const char *title,
int64_t num_dim,
int64_t num_nodes,
int64_t num_elem,
int64_t num_elem_blk,
int64_t num_node_sets,
int64_t num_side_sets);
EXODUS_EXPORT int ex_get_map_param (int exoid,
int *num_node_maps,
int *num_elem_maps);
EXODUS_EXPORT int ex_get_name (int exoid,
ex_entity_type obj_type,
ex_entity_id entity_id,
char *name);
EXODUS_EXPORT int ex_get_names (int exoid,
ex_entity_type obj_type,
char **names);
EXODUS_EXPORT int ex_get_nset_var_tab (int exoid,
int num_nodesets,
int num_nset_var,
int *nset_var_tab);
EXODUS_EXPORT int ex_get_n_nodal_var (int exoid,
int time_step,
int nodal_var_index,
int64_t start_node,
int64_t num_nodes,
void *nodal_var_vals);
EXODUS_EXPORT int ex_get_prop_array (int exoid,
ex_entity_type obj_type,
const char *prop_name,
void_int *values);
EXODUS_EXPORT int ex_get_prop (int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
const char *prop_name,
void_int *value);
EXODUS_EXPORT int ex_get_partial_num_map (int exoid,
ex_entity_type map_type,
ex_entity_id map_id,
int64_t ent_start,
int64_t ent_count,
void_int *elem_map);
EXODUS_EXPORT int ex_get_prop_names (int exoid,
ex_entity_type obj_type,
char **prop_names);
EXODUS_EXPORT int ex_get_qa (int exoid,
char *qa_record[][4]);
EXODUS_EXPORT int ex_get_time (int exoid,
int time_step,
void *time_value);
EXODUS_EXPORT int ex_get_variable_names (int exoid,
ex_entity_type obj_type,
int num_vars,
char *var_names[]);
EXODUS_EXPORT int ex_get_variable_name (int exoid,
ex_entity_type obj_type,
int var_num,
char *var_name);
EXODUS_EXPORT int ex_get_variable_param (int exoid,
ex_entity_type obj_type,
int *num_vars);
EXODUS_EXPORT int ex_get_object_truth_vector (int exoid,
ex_entity_type var_type,
ex_entity_id object_id,
int num_var,
int *var_vector);
EXODUS_EXPORT int ex_get_truth_table (int exoid,
ex_entity_type obj_type,
int num_blk,
int num_var,
int *var_tab);
#define ex_open(path, mode, comp_ws, io_ws, version) ex_open_int(path, mode, comp_ws, io_ws, version, EX_API_VERS_NODOT)
EXODUS_EXPORT int ex_open_int (const char *path,
int mode,
int *comp_ws,
int *io_ws,
float *version, int my_version);
EXODUS_EXPORT int ex_put_attr_param (int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int num_attrs);
EXODUS_EXPORT int ex_get_attr_param (int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int *num_attrs);
EXODUS_EXPORT int ex_put_all_var_param (int exoid,
int num_g, int num_n,
int num_e, int *elem_var_tab,
int num_m, int *nset_var_tab,
int num_s, int *sset_var_tab);
EXODUS_EXPORT int ex_put_concat_elem_block (int exoid,
const void_int* elem_blk_id,
char *elem_type[],
const void_int* num_elem_this_blk,
const void_int* num_nodes_per_elem,
const void_int* num_attr,
int define_maps);
EXODUS_EXPORT int ex_put_coord_names (int exoid,
char *coord_names[]);
EXODUS_EXPORT int ex_put_coord (int exoid,
const void *x_coor,
const void *y_coor,
const void *z_coor);
EXODUS_EXPORT int ex_put_n_coord (int exoid,
int64_t start_node_num,
int64_t num_nodes,
const void *x_coor,
const void *y_coor,
const void *z_coor);
EXODUS_EXPORT int ex_put_id_map(int exoid,
ex_entity_type obj_type,
const void_int *map);
EXODUS_EXPORT int ex_put_partial_id_map(int exoid,
ex_entity_type obj_type,
int64_t start_entity_num,
int64_t num_entities,
const void_int *map);
EXODUS_EXPORT int ex_put_n_elem_num_map (int exoid,
int64_t start_ent,
int64_t num_ents,
const void_int *map);
EXODUS_EXPORT int ex_put_n_node_num_map (int exoid,
int64_t start_ent,
int64_t num_ents,
const void_int *map);
EXODUS_EXPORT int ex_get_id_map(int exoid,
ex_entity_type obj_type,
void_int *map);
EXODUS_EXPORT int ex_put_coordinate_frames(int exoid,
int nframes,
const void_int *cf_ids,
void* pt_coordinates,
const char* tags);
EXODUS_EXPORT int ex_put_info (int exoid,
int num_info,
char *info[]);
EXODUS_EXPORT int ex_put_map_param (int exoid,
int num_node_maps,
int num_elem_maps);
EXODUS_EXPORT int ex_put_name (int exoid,
ex_entity_type obj_type,
ex_entity_id entity_id,
const char *name);
EXODUS_EXPORT int ex_put_names (int exoid,
ex_entity_type obj_type,
char *names[]);
EXODUS_EXPORT int ex_put_n_one_attr( int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int64_t start_num,
int64_t num_ent,
int attrib_index,
const void *attrib );
EXODUS_EXPORT int ex_put_prop (int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
const char *prop_name,
ex_entity_id value);
EXODUS_EXPORT int ex_put_prop_array (int exoid,
ex_entity_type obj_type,
const char *prop_name,
const void_int *values);
EXODUS_EXPORT int ex_put_prop_names (int exoid,
ex_entity_type obj_type,
int num_props,
char **prop_names);
EXODUS_EXPORT int ex_put_qa (int exoid,
int num_qa_records,
char* qa_record[][4]);
EXODUS_EXPORT int ex_put_time (int exoid,
int time_step,
const void *time_value);
EXODUS_EXPORT int ex_put_variable_name (int exoid,
ex_entity_type obj_type,
int var_num,
const char *var_name);
EXODUS_EXPORT int ex_put_variable_names (int exoid,
ex_entity_type obj_type,
int num_vars,
char* var_names[]);
EXODUS_EXPORT int ex_put_variable_param (int exoid,
ex_entity_type obj_type,
int num_vars);
EXODUS_EXPORT int ex_put_truth_table (int exoid,
ex_entity_type obj_type,
int num_blk,
int num_var,
int *var_tab);
EXODUS_EXPORT int ex_update (int exoid);
EXODUS_EXPORT int ex_get_num_props (int exoid, ex_entity_type obj_type);
EXODUS_EXPORT int ex_large_model(int exoid);
EXODUS_EXPORT size_t ex_header_size(int exoid);
EXODUS_EXPORT void ex_err(const char *module_name, const char *message, int err_num);
EXODUS_EXPORT void ex_get_err(const char** msg, const char** func, int* errcode);
EXODUS_EXPORT void ex_opts(int options);
EXODUS_EXPORT int ex_inquire(int exoid, int inquiry, void_int*, float*, char*);
EXODUS_EXPORT int64_t ex_inquire_int(int exoid, int inquiry);
EXODUS_EXPORT int ex_int64_status(int exoid);
EXODUS_EXPORT int ex_set_int64_status(int exoid, int mode);
/** Note that the max name length setting is global at this time; not specific
* to a particular database; however, the exoid option is passed to give
* flexibility in the future to implement this on a database-by-database basis.
*/
EXODUS_EXPORT int ex_set_max_name_length(int exoid, int length);
EXODUS_EXPORT int ex_set_option(int exoid, ex_option_type option, int option_value);
/* Write Node Edge Face or Element Number Map */
EXODUS_EXPORT int ex_put_num_map(int exoid,
ex_entity_type map_type,
ex_entity_id map_id,
const void_int *map);
/* Read Number Map */
EXODUS_EXPORT int ex_get_num_map(int exoid,
ex_entity_type map_type,
ex_entity_id map_id,
void_int *map);
/* Write Edge Face or Element Block Parameters */
EXODUS_EXPORT int ex_put_block(int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
const char *entry_descrip,
int64_t num_entries_this_blk,
int64_t num_nodes_per_entry,
int64_t num_edges_per_entry,
int64_t num_faces_per_entry,
int64_t num_attr_per_entry);
/*! \deprecated Use ex_get_block_param() */
EXODUS_EXPORT int ex_get_block(int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
char *elem_type,
void_int *num_entries_this_blk,
void_int *num_nodes_per_entry,
void_int *num_edges_per_entry,
void_int *num_faces_per_entry,
void_int *num_attr_per_entry);
/* Read Edge Face or Element Block Parameters */
EXODUS_EXPORT int ex_get_block_param(int exoid,
ex_block *block);
EXODUS_EXPORT int ex_put_block_param(int exoid,
const ex_block block);
/* Write All Edge Face and Element Block Parameters */
EXODUS_EXPORT int ex_put_concat_all_blocks(int exoid,
const ex_block_params *param);
EXODUS_EXPORT int ex_put_entity_count_per_polyhedra(int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
const int *entity_counts);
EXODUS_EXPORT int ex_get_entity_count_per_polyhedra(int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
int *entity_counts);
/* Write Edge Face or Element Block Connectivity */
EXODUS_EXPORT int ex_put_conn(int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
const void_int *node_conn,
const void_int *elem_edge_conn,
const void_int *elem_face_conn);
/* Read Edge Face or Element Block Connectivity */
EXODUS_EXPORT int ex_get_conn(int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
void_int *nodeconn,
void_int *edgeconn,
void_int *faceconn);
/* Read Partial Edge Face or Element Block Connectivity */
EXODUS_EXPORT int ex_get_n_conn(int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
int64_t start_num,
int64_t num_ent,
void_int *nodeconn,
void_int *edgeconn,
void_int *faceconn);
/* Write Edge Face or Element Block Attributes */
EXODUS_EXPORT int ex_put_attr(int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
const void *attrib);
/* Read Edge Face or Element Block Attributes */
EXODUS_EXPORT int ex_get_attr(int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
void *attrib);
/* Write One Edge Face or Element Block Attribute */
EXODUS_EXPORT int ex_put_one_attr(int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int attrib_index,
const void *attrib);
/* Read One Edge Face or Element Block Attribute */
EXODUS_EXPORT int ex_get_one_attr(int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int attrib_index,
void *attrib);
/* Read One Edge Face or Element Block Attribute */
EXODUS_EXPORT int ex_get_n_one_attr(int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int64_t start_num,
int64_t num_ent,
int attrib_index,
void *attrib);
/* Write Edge Face or Element Block Attribute Names */
EXODUS_EXPORT int ex_put_attr_names(int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
char **names);
/* Read Edge Face or Element Block Attribute Names */
EXODUS_EXPORT int ex_get_attr_names(int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
char **names);
/* Write Node Edge Face or Side Set Parameters */
EXODUS_EXPORT int ex_put_set_param(int exoid,
ex_entity_type set_type,
ex_entity_id set_id,
int64_t num_entries_in_set,
int64_t num_dist_fact_in_set);
/* Read Node Edge Face or Side Set Parameters */
EXODUS_EXPORT int ex_get_set_param(int exoid,
ex_entity_type set_type,
ex_entity_id set_id,
void_int *num_entry_in_set,
void_int *num_dist_fact_in_set);
/* Write a Node Edge Face or Side Set */
EXODUS_EXPORT int ex_put_set(int exoid,
ex_entity_type set_type,
ex_entity_id set_id,
const void_int *set_entry_list,
const void_int *set_extra_list);
/* Read a Node Edge Face or Side Set */
EXODUS_EXPORT int ex_get_set(int exoid,
ex_entity_type set_type,
ex_entity_id set_id,
void_int *set_entry_list,
void_int *set_extra_list);
/* Write Node Edge Face or Side Set Distribution Factors */
EXODUS_EXPORT int ex_put_set_dist_fact(int exoid,
ex_entity_type set_type,
ex_entity_id set_id,
const void *set_dist_fact);
/* Read Node Edge Face or Side Set Distribution Factors */
EXODUS_EXPORT int ex_get_set_dist_fact(int exoid,
ex_entity_type set_type,
ex_entity_id set_id,
void *set_dist_fact);
/* Write Concatenated Node Edge Face or Side Sets */
EXODUS_EXPORT int ex_put_concat_sets(int exoid,
ex_entity_type set_type,
const struct ex_set_specs *set_specs);
/* Read Concatenated Node Edge Face or Side Sets */
EXODUS_EXPORT int ex_get_concat_sets(int exoid,
ex_entity_type set_type,
struct ex_set_specs *set_specs);
/* Write Concatenated Node Edge Face or Side Sets */
EXODUS_EXPORT int ex_put_sets(int exoid,
size_t set_count,
const struct ex_set *sets);
/* Read Concatenated Node Edge Face or Side Sets */
EXODUS_EXPORT int ex_get_sets(int exoid,
size_t set_count,
struct ex_set *sets);
/* (MODIFIED) Write All Results Variables Parameters */
EXODUS_EXPORT int ex_put_all_var_param_ext(int exoid,
const ex_var_params *vp);
/* Write Edge Face or Element Variable Values on Blocks or Sets at a Time Step */
EXODUS_EXPORT int ex_put_var(int exoid,
int time_step,
ex_entity_type var_type,
int var_index,
ex_entity_id obj_id,
int64_t num_entries_this_obj,
const void *var_vals);
/* Write Partial Edge Face or Element Variable Values on Blocks or Sets at a Time Step */
EXODUS_EXPORT int ex_put_n_var(int exoid,
int time_step,
ex_entity_type var_type,
int var_index,
ex_entity_id obj_id,
int64_t start_index,
int64_t num_entities,
const void *var_vals);
/* Read Edge Face or Element Variable Values Defined On Blocks or Sets at a Time Step */
EXODUS_EXPORT int ex_get_var(int exoid,
int time_step,
ex_entity_type var_type,
int var_index,
ex_entity_id obj_id,
int64_t num_entry_this_obj,
void *var_vals);
/* Read Partial Edge Face or Element Variable Values on Blocks or Sets at a Time Step */
EXODUS_EXPORT int ex_get_n_var(int exoid,
int time_step,
ex_entity_type var_type,
int var_index,
ex_entity_id obj_id,
int64_t start_index,
int64_t num_entities,
void *var_vals);
EXODUS_EXPORT int ex_get_n_elem_var (int exoid,
int time_step,
int elem_var_index,
ex_entity_id elem_blk_id,
int64_t num_elem_this_blk,
int64_t start_elem_num,
int64_t num_elem,
void *elem_var_vals);
/* Read Edge Face or Element Variable Values Defined On Blocks or Sets Through Time */
EXODUS_EXPORT int ex_get_var_time(int exoid,
ex_entity_type var_type,
int var_index,
int64_t id,
int beg_time_step,
int end_time_step,
void *var_vals);
EXODUS_EXPORT int ex_cvt_nodes_to_sides(int exoid,
void_int *num_elem_per_set,
void_int *num_nodes_per_set,
void_int *side_sets_elem_index,
void_int *side_sets_node_index,
void_int *side_sets_elem_list,
void_int *side_sets_node_list,
void_int *side_sets_side_list);
/* Can be replaced by ex_put_var ... */
EXODUS_EXPORT int ex_put_nodal_var (int exoid,
int time_step,
int nodal_var_index,
int64_t num_nodes,
const void *nodal_var_vals);
EXODUS_EXPORT int ex_put_n_nodal_var (int exoid,
int time_step,
int nodal_var_index,
int64_t start_node,
int64_t num_nodes,
const void *nodal_var_vals);
EXODUS_EXPORT int ex_get_partial_elem_map (int exoid,
ex_entity_id map_id,
int64_t ent_start,
int64_t ent_count,
void_int *elem_map);
EXODUS_EXPORT int ex_put_partial_elem_map (int exoid,
ex_entity_id map_id,
int64_t ent_start,
int64_t ent_count,
const void_int *elem_map);
EXODUS_EXPORT int ex_put_partial_num_map (int exoid,
ex_entity_type map_type,
ex_entity_id map_id,
int64_t ent_start,
int64_t ent_count,
const void_int *map);
EXODUS_EXPORT int ex_put_partial_set_dist_fact (int exoid,
ex_entity_type set_type,
ex_entity_id set_id,
int64_t offset,
int64_t num_to_put,
const void *set_dist_fact);
/* TODO */
EXODUS_EXPORT int ex_get_concat_side_set_node_count(int exoid,
int *side_set_node_cnt_list);
/* TODO */
EXODUS_EXPORT int ex_get_side_set_node_list_len(int exoid,
ex_entity_id side_set_id,
void_int *side_set_node_list_len);
/* TODO */
EXODUS_EXPORT int ex_get_side_set_node_count(int exoid,
ex_entity_id side_set_id,
int *side_set_node_cnt_list);
/* TODO */
EXODUS_EXPORT int ex_get_side_set_node_list(int exoid,
ex_entity_id side_set_id,
void_int *side_set_node_cnt_list,
void_int *side_set_node_list);
/* ========================================================================
Functions pulled from nemesis library and incorporated into exodus...
*/
/*=============================================================================
* Initial Information Routines
*===========================================================================*/
EXODUS_EXPORT int
ex_get_init_info(int exoid, /* NemesisI file ID */
int *num_proc, /* Number of processors */
int *num_proc_in_f, /* Number of procs in this file */
char *ftype
);
EXODUS_EXPORT int
ex_put_init_info(int exoid, /* NemesisI file ID */
int num_proc, /* Number of processors */
int num_proc_in_f, /* Number of procs in this file */
char *ftype
);
EXODUS_EXPORT int
ex_get_init_global(int exoid, /* NemesisI file ID */
void_int *num_nodes_g, /* Number of global FEM nodes */
void_int *num_elems_g, /* Number of global FEM elements */
void_int *num_elem_blks_g, /* Number of global elem blocks */
void_int *num_node_sets_g, /* Number of global node sets */
void_int *num_side_sets_g /* Number of global side sets */
);
EXODUS_EXPORT int
ex_put_init_global(int exoid, /* NemesisI file ID */
int64_t num_nodes_g, /* Number of global FEM nodes */
int64_t num_elems_g, /* Number of global FEM elements */
int64_t num_elem_blks_g, /* Number of global elem blocks */
int64_t num_node_sets_g, /* Number of global node sets */
int64_t num_side_sets_g /* Number of global side sets */
);
/*=============================================================================
* Loadbalance Parameter Routines
*===========================================================================*/
EXODUS_EXPORT int
ex_get_loadbal_param(int exoid, /* NetCDF/Exodus file ID */
void_int *num_int_nodes, /* Number of internal FEM nodes */
void_int *num_bor_nodes, /* Number of border FEM nodes */
void_int *num_ext_nodes, /* Number of external FEM nodes */
void_int *num_int_elems, /* Number of internal FEM elems */
void_int *num_bor_elems, /* Number of border FEM elems */
void_int *num_node_cmaps, /* Number of nodal comm maps */
void_int *num_elem_cmaps, /* Number of elemental comm maps */
int processor /* Processor ID */
);
EXODUS_EXPORT int
ex_put_loadbal_param(int exoid, /* NemesisI file ID */
int64_t num_int_nodes, /* Number of internal FEM nodes */
int64_t num_bor_nodes, /* Number of border FEM nodes */
int64_t num_ext_nodes, /* Number of external FEM nodes */
int64_t num_int_elems, /* Number of internal FEM elems */
int64_t num_bor_elems, /* Number of border FEM elems */
int64_t num_node_cmaps,/* Number of nodal comm maps */
int64_t num_elem_cmaps,/* Number of elemental comm maps */
int processor /* Processor ID */
);
EXODUS_EXPORT int
ex_put_loadbal_param_cc(int exoid, /* NetCDF/Exodus file ID */
void_int *num_int_nodes, /* Number of internal node IDs */
void_int *num_bor_nodes, /* Number of border node IDs */
void_int *num_ext_nodes, /* Number of external node IDs */
void_int *num_int_elems, /* Number of internal elem IDs */
void_int *num_bor_elems, /* Number of border elem IDs */
void_int *num_node_cmaps, /* Number of nodal comm maps */
void_int *num_elem_cmaps /* Number of elem comm maps */
);
/*=============================================================================
* NS, SS & EB Global Parameter Routines
*===========================================================================*/
EXODUS_EXPORT int
ex_get_ns_param_global(int exoid, /* NetCDF/Exodus file ID */
void_int *ns_ids_glob, /* Global IDs of node sets */
void_int *ns_n_cnt_glob, /* Count of nodes in node sets */
void_int *ns_df_cnt_glob /* Count of dist. factors in ns */
);
EXODUS_EXPORT int
ex_put_ns_param_global(int exoid, /* NemesisI file ID */
void_int *global_ids, /* Vector of global node-set IDs */
void_int *global_n_cnts, /* Vector of node counts in node-sets */
void_int *global_df_cnts /* Vector of dist factor counts in node-sets */
);
EXODUS_EXPORT int
ex_get_ss_param_global(int exoid, /* NetCDF/Exodus file ID */
void_int *ss_ids_glob, /* Global side-set IDs */
void_int *ss_s_cnt_glob, /* Global side count */
void_int *ss_df_cnt_glob /* Global dist. factor count */
);
EXODUS_EXPORT int
ex_put_ss_param_global(int exoid, /* NemesisI file ID */
void_int *global_ids, /* Vector of global side-set IDs */
void_int *global_el_cnts, /* Vector of element/side */
/* counts in each side set */
void_int *global_df_cnts /* Vector of dist. factor */
/* counts in each side set */
);
EXODUS_EXPORT int
ex_get_eb_info_global(int exoid, /* NemesisI file ID */
void_int *el_blk_ids, /* Vector of global element IDs */
void_int *el_blk_cnts /* Vector of global element counts */
);
EXODUS_EXPORT int
ex_put_eb_info_global(int exoid, /* NemesisI file ID */
void_int *el_blk_ids, /* Vector of global element IDs */
void_int *el_blk_cnts /* Vector of global element counts */
);
/*=============================================================================
* NS, SS & EB Subset Routines
*===========================================================================*/
EXODUS_EXPORT int
ex_get_n_side_set(int exoid, /* NetCDF/Exodus file ID */
ex_entity_id side_set_id, /* Side-set ID to read */
int64_t start_side_num, /* Starting element number */
int64_t num_sides, /* Number of sides to read */
void_int *side_set_elem_list, /* List of element IDs */
void_int *side_set_side_list /* List of side IDs */
);
EXODUS_EXPORT int
ex_put_n_side_set(int exoid, /* NetCDF/Exodus file ID */
ex_entity_id side_set_id, /* Side-set ID to write */
int64_t start_side_num, /* Starting element number */
int64_t num_sides, /* Number of sides to write */
const void_int *side_set_elem_list, /* List of element IDs */
const void_int *side_set_side_list /* List of side IDs */
);
EXODUS_EXPORT int
ex_get_n_side_set_df(int exoid, /* NetCDF/Exodus file ID */
ex_entity_id side_set_id, /* Side-set ID */
int64_t start_num, /* Starting df number */
int64_t num_df_to_get, /* Number of df's to read */
void *side_set_df /* Distribution factors */
);
EXODUS_EXPORT int
ex_put_n_side_set_df(int exoid, /* NetCDF/Exodus file ID */
ex_entity_id side_set_id, /* Side-set ID */
int64_t start_num, /* Starting df number */
int64_t num_df_to_get, /* Number of df's to write */
void *side_set_df /* Distribution factors */
);
EXODUS_EXPORT int
ex_get_n_node_set(int exoid, /* NetCDF/Exodus file ID */
ex_entity_id node_set_id, /* Node set ID */
int64_t start_node_num, /* Node index to start reading at */
int64_t num_node, /* Number of nodes to read */
void_int *node_set_node_list /* List of nodes in node set */
);
EXODUS_EXPORT int
ex_put_n_node_set(int exoid, /* NetCDF/Exodus file ID */
ex_entity_id node_set_id, /* Node set ID */
int64_t start_node_num, /* Node index to start writing at */
int64_t num_node, /* Number of nodes to write */
const void_int *node_set_node_list /* List of nodes in node set */
);
EXODUS_EXPORT int
ex_get_n_node_set_df(int exoid, /* NetCDF/Exodus file ID */
ex_entity_id node_set_id, /* Node-set ID */
int64_t start_num, /* Starting df number */
int64_t num_df_to_get, /* Number of df's to read */
void *node_set_df /* Distribution factors */
);
EXODUS_EXPORT int
ex_put_n_node_set_df(int exoid, /* NetCDF/Exodus file ID */
ex_entity_id node_set_id, /* Node-set ID */
int64_t start_num, /* Starting df number */
int64_t num_df_to_get, /* Number of df's to write */
void *node_set_df /* Distribution factors */
);
EXODUS_EXPORT int
ex_get_n_elem_conn (int exoid, /* NetCDF/Exodus file ID */
ex_entity_id elem_blk_id, /* Element block ID */
int64_t start_elem_num, /* Starting position to read from */
int64_t num_elems, /* Number of elements to read */
void_int *connect /* Connectivity vector */
);
EXODUS_EXPORT int
ex_put_n_elem_conn (int exoid, /* NetCDF/Exodus file ID */
ex_entity_id elem_blk_id, /* Element block ID */
int64_t start_elem_num, /* Starting position to write to */
int64_t num_elems, /* Number of elements to write */
const void_int *connect /* Connectivity vector */
);
EXODUS_EXPORT int
ex_get_n_elem_attr (int exoid, /* NetCDF/Exodus file ID */
ex_entity_id elem_blk_id, /* Element block ID */
int64_t start_elem_num, /* Starting position to read from */
int64_t num_elems, /* Number of elements to read */
void *attrib /* Attribute */
);
EXODUS_EXPORT int
ex_put_n_elem_attr (int exoid, /* NetCDF/Exodus file ID */
ex_entity_id elem_blk_id, /* Element block ID */
int64_t start_elem_num, /* Starting position to write to */
int64_t num_elems, /* Number of elements to write */
void *attrib /* Attribute */
);
EXODUS_EXPORT int
ex_get_elem_type(int exoid, /* NetCDF/Exodus file ID */
ex_entity_id elem_blk_id, /* Element block ID */
char *elem_type /* The name of the element type */
);
/*=============================================================================
* Variable Routines
*===========================================================================*/
EXODUS_EXPORT int
ex_put_elem_var_slab (int exoid, /* NetCDF/Exodus file ID */
int time_step, /* time index */
int elem_var_index, /* elemental variable index */
ex_entity_id elem_blk_id, /* elemental block id */
int64_t start_pos, /* Starting position to write to */
int64_t num_vals, /* Number of elements to write */
void *elem_var_vals /* variable values */
);
EXODUS_EXPORT int
ex_put_nodal_var_slab(int exoid, /* NetCDF/Exodus file ID */
int time_step, /* The time step index */
int nodal_var_index, /* Nodal variable index */
int64_t start_pos, /* Start position for write */
int64_t num_vals, /* Number of nodal variables */
void *nodal_var_vals /* Nodal variable values */
);
/*=============================================================================
* Number Map Routines
*===========================================================================*/
EXODUS_EXPORT int
ex_get_n_elem_num_map (int exoid, /* NetCDF/Exodus file ID */
int64_t start_ent, /* Starting position to read from */
int64_t num_ents, /* Number of elements to read */
void_int *elem_map /* element map numbers */
);
EXODUS_EXPORT int
ex_get_n_node_num_map(int exoid, /* NetCDF/Exodus file ID */
int64_t start_ent, /* starting node number */
int64_t num_ents, /* number of nodes to read */
void_int *node_map /* vector for node map */
);
EXODUS_EXPORT int
ex_get_processor_node_maps(int exoid, /* NetCDF/Exodus file ID */
void_int *node_mapi, /* Internal FEM node IDs */
void_int *node_mapb, /* Border FEM node IDs */
void_int *node_mape, /* External FEM node IDs */
int processor /* Processor IDs */
);
EXODUS_EXPORT int
ex_put_processor_node_maps(int exoid, /* NetCDF/Exodus file ID */
void_int *node_mapi, /* Internal FEM node IDs */
void_int *node_mapb, /* Border FEM node IDs */
void_int *node_mape, /* External FEM node IDs */
int processor /* This processor ID */
);
EXODUS_EXPORT int
ex_get_processor_elem_maps(int exoid, /* NetCDF/Exodus file ID */
void_int *elem_mapi, /* Internal element IDs */
void_int *elem_mapb, /* Border element IDs */
int processor /* Processor ID */
);
EXODUS_EXPORT int
ex_put_processor_elem_maps(int exoid, /* NetCDF/Exodus file ID */
void_int *elem_mapi, /* Internal FEM element IDs */
void_int *elem_mapb, /* Border FEM element IDs */
int processor /* This processor ID */
);
/*=============================================================================
* Communications Maps Routines
*===========================================================================*/
EXODUS_EXPORT int
ex_get_cmap_params(int exoid, /* NetCDF/Exodus file ID */
void_int *node_cmap_ids, /* Nodal comm. map IDs */
void_int *node_cmap_node_cnts, /* Number of nodes in each map */
void_int *elem_cmap_ids, /* Elemental comm. map IDs */
void_int *elem_cmap_elem_cnts, /* Number of elems in each map */
int processor /* This processor ID */
);
EXODUS_EXPORT int
ex_put_cmap_params(int exoid, /* NetCDF/Exodus file ID */
void_int *node_map_ids, /* Node map IDs */
void_int *node_map_node_cnts,/* Nodes in nodal comm */
void_int *elem_map_ids, /* Elem map IDs */
void_int *elem_map_elem_cnts,/* Elems in elemental comm */
int64_t processor /* This processor ID */
);
EXODUS_EXPORT int
ex_put_cmap_params_cc(int exoid, /* NetCDF/Exodus file ID */
void_int *node_map_ids, /* Node map IDs */
void_int *node_map_node_cnts, /* Nodes in nodal comm */
void_int *node_proc_ptrs, /* Pointer into array for */
/* node maps */
void_int *elem_map_ids, /* Elem map IDs */
void_int *elem_map_elem_cnts, /* Elems in elemental comm */
void_int *elem_proc_ptrs /* Pointer into array for */
/* elem maps */
);
EXODUS_EXPORT int
ex_get_node_cmap(int exoid, /* NetCDF/Exodus file ID */
ex_entity_id map_id, /* Map ID */
void_int *node_ids, /* FEM node IDs */
void_int *proc_ids, /* Processor IDs */
int processor /* This processor ID */
);
EXODUS_EXPORT int
ex_put_node_cmap(int exoid, /* NetCDF/Exodus file ID */
ex_entity_id map_id, /* Nodal comm map ID */
void_int *node_ids, /* FEM node IDs */
void_int *proc_ids, /* Processor IDs */
int processor /* This processor ID */
);
EXODUS_EXPORT int
ex_get_elem_cmap(int exoid, /* NetCDF/Exodus file ID */
ex_entity_id map_id, /* Elemental comm map ID */
void_int *elem_ids, /* Element IDs */
void_int *side_ids, /* Element side IDs */
void_int *proc_ids, /* Processor IDs */
int processor /* This processor ID */
);
EXODUS_EXPORT int
ex_put_elem_cmap(int exoid, /* NetCDF/Exodus file ID */
ex_entity_id map_id, /* Elemental comm map ID */
void_int *elem_ids, /* Vector of element IDs */
void_int *side_ids, /* Vector of side IDs */
void_int *proc_ids, /* Vector of processor IDs */
int processor /* This processor ID */
);
/* ========================================================================
* Deprecated functiona
*/
EXODUS_EXPORT int ex_get_nodal_var (int exoid,
int time_step,
int nodal_var_index,
int64_t num_nodes,
void *nodal_var_vals);
EXODUS_EXPORT int ex_get_nodal_var_time (int exoid,
int nodal_var_index,
int64_t node_number,
int beg_time_step,
int end_time_step,
void *nodal_var_vals);
/* Use ex_get_concat_sets() */
EXODUS_EXPORT int ex_get_concat_node_sets (int exoid,
void_int *node_set_ids,
void_int *num_nodes_per_set,
void_int *num_df_per_set,
void_int *node_sets_node_index,
void_int *node_sets_df_index,
void_int *node_sets_node_list,
void *node_sets_dist_fact);
EXODUS_EXPORT int ex_get_concat_side_sets (int exoid,
void_int *side_set_ids,
void_int *num_elem_per_set,
void_int *num_dist_per_set,
void_int *side_sets_elem_index,
void_int *side_sets_dist_index,
void_int *side_sets_elem_list,
void_int *side_sets_side_list,
void *side_sets_dist_fact);
EXODUS_EXPORT int ex_get_elem_attr (int exoid,
ex_entity_id elem_blk_id,
void *attrib);
EXODUS_EXPORT int ex_get_elem_attr_names (int exoid,
ex_entity_id elem_blk_id,
char **names);
EXODUS_EXPORT int ex_get_elem_blk_ids (int exoid,
void_int *ids);
EXODUS_EXPORT int ex_get_elem_block (int exoid,
ex_entity_id elem_blk_id,
char *elem_type,
void_int *num_elem_this_blk,
void_int *num_nodes_per_elem,
void_int *num_attr);
EXODUS_EXPORT int ex_get_elem_conn (int exoid,
ex_entity_id elem_blk_id,
void_int *connect);
EXODUS_EXPORT int ex_get_elem_map (int exoid,
ex_entity_id map_id,
void_int *elem_map);
EXODUS_EXPORT int ex_get_elem_num_map (int exoid,
void_int *elem_map);
EXODUS_EXPORT int ex_get_elem_var (int exoid,
int time_step,
int elem_var_index,
ex_entity_id elem_blk_id,
int64_t num_elem_this_blk,
void *elem_var_vals);
EXODUS_EXPORT int ex_get_elem_var_tab (int exoid,
int num_elem_blk,
int num_elem_var,
int *elem_var_tab);
EXODUS_EXPORT int ex_get_elem_var_time (int exoid,
int elem_var_index,
int64_t elem_number,
int beg_time_step,
int end_time_step,
void *elem_var_vals);
EXODUS_EXPORT int ex_get_map (int exoid, void_int *elem_map);
EXODUS_EXPORT int ex_get_node_map (int exoid,
ex_entity_id map_id,
void_int *node_map);
EXODUS_EXPORT int ex_get_node_num_map (int exoid,
void_int *node_map);
EXODUS_EXPORT int ex_get_node_set_param (int exoid,
ex_entity_id node_set_id,
void_int *num_nodes_in_set,
void_int *num_df_in_set);
EXODUS_EXPORT int ex_get_node_set (int exoid,
ex_entity_id node_set_id,
void_int *node_set_node_list);
EXODUS_EXPORT int ex_get_node_set_dist_fact (int exoid,
ex_entity_id node_set_id,
void *node_set_dist_fact);
EXODUS_EXPORT int ex_get_node_set_ids (int exoid,
void_int *ids);
EXODUS_EXPORT int ex_get_nset_var_tab (int exoid,
int num_nodesets,
int num_nset_var,
int *nset_var_tab);
EXODUS_EXPORT int ex_get_nset_var (int exoid,
int time_step,
int nset_var_index,
ex_entity_id nset_id,
int64_t num_node_this_nset,
void *nset_var_vals);
EXODUS_EXPORT int ex_get_one_elem_attr (int exoid,
ex_entity_id elem_blk_id,
int attrib_index,
void *attrib);
EXODUS_EXPORT int ex_get_side_set (int exoid,
ex_entity_id side_set_id,
void_int *side_set_elem_list,
void_int *side_set_side_list);
EXODUS_EXPORT int ex_get_side_set_dist_fact (int exoid,
ex_entity_id side_set_id,
void *side_set_dist_fact);
EXODUS_EXPORT int ex_get_side_set_ids (int exoid,
void_int *ids);
EXODUS_EXPORT int ex_get_side_set_param (int exoid,
ex_entity_id side_set_id,
void_int *num_side_in_set,
void_int *num_dist_fact_in_set);
EXODUS_EXPORT int ex_get_sset_var (int exoid,
int time_step,
int sset_var_index,
ex_entity_id sset_id,
int64_t num_side_this_sset,
void *sset_var_vals);
EXODUS_EXPORT int ex_get_sset_var_tab (int exoid,
int num_sidesets,
int num_sset_var,
int *sset_var_tab);
EXODUS_EXPORT int ex_get_var_names (int exoid,
const char *var_type,
int num_vars,
char *var_names[]);
EXODUS_EXPORT int ex_get_var_name (int exoid,
const char *var_type,
int var_num,
char *var_name);
EXODUS_EXPORT int ex_get_var_param (int exoid,
const char *var_type,
int *num_vars);
EXODUS_EXPORT int ex_get_var_tab (int exoid,
const char *var_type,
int num_blk,
int num_var,
int *var_tab);
EXODUS_EXPORT int ex_put_concat_node_sets (int exoid,
void_int *node_set_ids,
void_int *num_nodes_per_set,
void_int *num_dist_per_set,
void_int *node_sets_node_index,
void_int *node_sets_df_index,
void_int *node_sets_node_list,
void *node_sets_dist_fact);
EXODUS_EXPORT int ex_put_concat_side_sets (int exoid,
void_int *side_set_ids,
void_int *num_elem_per_set,
void_int *num_dist_per_set,
void_int *side_sets_elem_index,
void_int *side_sets_dist_index,
void_int *side_sets_elem_list,
void_int *side_sets_side_list,
void *side_sets_dist_fact);
EXODUS_EXPORT int ex_put_concat_var_param (int exoid, int num_g, int num_n,
int num_e, int num_elem_blk, int *elem_var_tab);
EXODUS_EXPORT int ex_put_elem_attr_names(int exoid,
ex_entity_id elem_blk_id,
char *names[]);
EXODUS_EXPORT int ex_put_elem_attr (int exoid,
ex_entity_id elem_blk_id,
const void *attrib);
EXODUS_EXPORT int ex_put_elem_block (int exoid,
ex_entity_id elem_blk_id,
const char *elem_type,
int64_t num_elem_this_blk,
int64_t num_nodes_per_elem,
int64_t num_attr);
EXODUS_EXPORT int ex_put_elem_conn (int exoid,
ex_entity_id elem_blk_id,
const void_int *connect);
EXODUS_EXPORT int ex_put_elem_map (int exoid,
ex_entity_id map_id,
const void_int *elem_map);
EXODUS_EXPORT int ex_put_elem_num_map (int exoid,
const void_int *elem_map);
EXODUS_EXPORT int ex_put_elem_var (int exoid,
int time_step,
int elem_var_index,
ex_entity_id elem_blk_id,
int64_t num_elem_this_blk,
const void *elem_var_vals);
EXODUS_EXPORT int ex_put_elem_var_tab (int exoid,
int num_elem_blk,
int num_elem_var,
int *elem_var_tab);
EXODUS_EXPORT int ex_put_glob_vars (int exoid,
int time_step,
int num_glob_vars,
const void *glob_var_vals);
EXODUS_EXPORT int ex_put_map (int exoid,
const void_int *elem_map);
EXODUS_EXPORT int ex_put_node_map (int exoid,
ex_entity_id map_id,
const void_int *node_map);
EXODUS_EXPORT int ex_put_node_num_map (int exoid,
const void_int *node_map);
EXODUS_EXPORT int ex_put_node_set (int exoid,
ex_entity_id node_set_id,
const void_int *node_set_node_list);
EXODUS_EXPORT int ex_put_node_set_dist_fact (int exoid,
ex_entity_id node_set_id,
const void *node_set_dist_fact);
EXODUS_EXPORT int ex_put_node_set_param (int exoid,
ex_entity_id node_set_id,
int64_t num_nodes_in_set,
int64_t num_dist_in_set);
EXODUS_EXPORT int ex_put_nset_var (int exoid,
int time_step,
int nset_var_index,
ex_entity_id nset_id,
int64_t num_nodes_this_nset,
const void *nset_var_vals);
EXODUS_EXPORT int ex_put_nset_var_tab (int exoid,
int num_nset,
int num_nset_var,
int *nset_var_tab);
EXODUS_EXPORT int ex_put_one_elem_attr (int exoid,
ex_entity_id elem_blk_id,
int attrib_index,
const void *attrib);
EXODUS_EXPORT int ex_put_side_set (int exoid,
ex_entity_id side_set_id,
const void_int *side_set_elem_list,
const void_int *side_set_side_list);
EXODUS_EXPORT int ex_put_side_set_dist_fact (int exoid,
ex_entity_id side_set_id,
const void *side_set_dist_fact);
EXODUS_EXPORT int ex_put_side_set_param (int exoid,
ex_entity_id side_set_id,
int64_t num_side_in_set,
int64_t num_dist_fact_in_set);
EXODUS_EXPORT int ex_put_sset_var (int exoid,
int time_step,
int sset_var_index,
ex_entity_id sset_id,
int64_t num_faces_this_sset,
const void *sset_var_vals);
EXODUS_EXPORT int ex_put_sset_var_tab (int exoid,
int num_sset,
int num_sset_var,
int *sset_var_tab);
EXODUS_EXPORT int ex_put_var_name (int exoid,
const char *var_type,
int var_num,
const char *var_name);
EXODUS_EXPORT int ex_put_var_names (int exoid,
const char *var_type,
int num_vars,
char *var_names[]);
EXODUS_EXPORT int ex_put_var_param (int exoid,
const char *var_type,
int num_vars);
EXODUS_EXPORT int ex_put_var_tab (int exoid,
const char *var_type,
int num_blk,
int num_var,
int *var_tab);
/* End of Deprecated functions and their replacements
* ======================================================================== */
/* ERROR CODE DEFINITIONS AND STORAGE */
extern int exerrval; /**< shared error return value */
extern int exoptval; /**< error reporting flag (default is quiet) */
char* ex_name_of_object(ex_entity_type obj_type);
ex_entity_type ex_var_type_to_ex_entity_type(char var_type);
/* Should be internal use only, but was in external include file for
nemesis and some codes are using the function
*/
int ex_get_idx(int neid, /* NetCDF/Exodus file ID */
const char *ne_var_name, /* Nemesis index variable name */
int64_t *index, /* array of length 2 to hold results */
int pos /* position of this proc/cmap in index */
);
#ifdef __cplusplus
} /* close brackets on extern "C" declaration */
#endif
/**
* \defgroup ErrorReturnCodes Exodus error return codes - exerrval return values
* @{
*/
#define EX_MEMFAIL 1000 /**< memory allocation failure flag def */
#define EX_BADFILEMODE 1001 /**< bad file mode def */
#define EX_BADFILEID 1002 /**< bad file id def */
#define EX_WRONGFILETYPE 1003 /**< wrong file type for function */
#define EX_LOOKUPFAIL 1004 /**< id table lookup failed */
#define EX_BADPARAM 1005 /**< bad parameter passed */
#define EX_MSG -1000 /**< message print code - no error implied */
#define EX_PRTLASTMSG -1001 /**< print last error message msg code */
#define EX_NULLENTITY -1006 /**< null entity found */
/* @} */
#endif