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
|
/*
* Copyright (c) 1998 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.
*
*/
/****************************************************************************
* This file contains prototypes for the functions found in the NEMESIS
* library.
****************************************************************************/
#ifndef _NE_NEMESIS_H
#define _NE_NEMESIS_H
#ifdef __cplusplus
extern "C" {
#endif
#ifndef EXODUS_II_HDR
#include <stdint.h>
/** 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;
#endif
/*=============================================================================
* Initial Information Routines
*===========================================================================*/
extern int
ne_get_init_info(int neid, /* NemesisI file ID */
int *num_proc, /* Number of processors */
int *num_proc_in_f, /* Number of procs in this file */
char *ftype
);
extern int
ne_put_init_info(int neid, /* NemesisI file ID */
int num_proc, /* Number of processors */
int num_proc_in_f, /* Number of procs in this file */
char *ftype
);
extern int
ne_get_init_global(int neid, /* 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 */
);
extern int
ne_put_init_global(int neid, /* 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 */
);
extern int
ne_put_version(int neid);
/*=============================================================================
* Loadbalance Parameter Routines
*===========================================================================*/
extern int
ne_get_loadbal_param(int neid, /* 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 */
);
extern int
ne_put_loadbal_param(int neid, /* 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 */
);
extern int
ne_put_loadbal_param_cc(int neid, /* 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
*===========================================================================*/
extern int
ne_get_ns_param_global(int neid, /* 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 */
);
extern int
ne_put_ns_param_global(int neid, /* 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 */
);
extern int
ne_get_ss_param_global(int neid, /* 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 */
);
extern int
ne_put_ss_param_global(int neid, /* 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 */
);
extern int
ne_get_eb_info_global(int neid, /* NemesisI file ID */
void_int *el_blk_ids, /* Vector of global element IDs */
void_int *el_blk_cnts /* Vector of global element counts */
);
extern int
ne_put_eb_info_global(int neid, /* 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
*===========================================================================*/
extern int
ne_get_n_side_set(int neid, /* 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 */
);
extern int
ne_put_n_side_set(int neid, /* 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 */
);
extern int
ne_get_n_side_set_df(int neid, /* 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 */
);
extern int
ne_put_n_side_set_df(int neid, /* 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 */
);
extern int
ne_get_n_node_set(int neid, /* 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 */
);
extern int
ne_put_n_node_set(int neid, /* 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 */
);
extern int
ne_get_n_node_set_df(int neid, /* 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 */
);
extern int
ne_put_n_node_set_df(int neid, /* 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 */
);
extern int
ne_get_n_coord(int neid, /* NetCDF/Exodus file ID */
int64_t start_node_num, /* Starting position to read from */
int64_t num_nodes, /* Number of coords to read */
void *x_coor, /* Vector of X coordinates */
void *y_coor, /* Vector of Y coordinates */
void *z_coor /* Vector of Z coordinates */
);
extern int
ne_put_n_coord(int neid, /* NetCDF/Exodus file ID */
int64_t start_node_num, /* Starting position to write to */
int64_t num_nodes, /* Number of coords to write */
void *x_coor, /* Vector of X coordinates */
void *y_coor, /* Vector of Y coordinates */
void *z_coor /* Vector of Z coordinates */
);
extern int
ne_get_n_elem_conn (int neid, /* 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 */
);
extern int
ne_put_n_elem_conn (int neid, /* 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 */
);
extern int
ne_get_n_elem_attr (int neid, /* 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 */
);
extern int
ne_put_n_elem_attr (int neid, /* 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 */
);
extern int
ne_get_elem_type(int neid, /* NetCDF/Exodus file ID */
ex_entity_id elem_blk_id, /* Element block ID */
char *elem_type /* The name of the element type */
);
/*=============================================================================
* Variable Routines
*===========================================================================*/
extern int
ne_get_n_elem_var (int neid, /* 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 num_elem_this_blk, /* number of elements in block */
int64_t start_elem_num, /* Starting position for read */
int64_t num_elem, /* Number of elements to read */
void *elem_var_vals /* variable values */
);
extern int
ne_put_elem_var_slab (int neid, /* 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 */
);
extern int
ne_get_n_nodal_var(int neid, /* NetCDF/Exodus file ID */
int time_step, /* whole time step number */
int nodal_var_index, /* index of desired nodal var */
int64_t start_node_num, /* starting node number */
int64_t num_nodes, /* number of nodes to read */
void *nodal_vars /* array of nodal var values */
);
extern int
ne_put_nodal_var_slab(int neid, /* 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
*===========================================================================*/
extern int
ne_get_n_elem_num_map (int neid, /* 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 */
);
extern int
ne_put_n_elem_num_map (int neid, /* NetCDF/Exodus file ID */
int64_t start_ent, /* Starting position to read from */
int64_t num_ents, /* Number of elements to read */
const void_int *elem_map /* element map numbers */
);
extern int
ne_get_n_node_num_map(int neid, /* 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 */
);
extern int
ne_put_n_node_num_map(int neid, /* NetCDF/Exodus file ID */
int64_t start_ent, /* starting node number */
int64_t num_ents, /* number of nodes to read */
const void_int *node_map /* vector for node map */
);
extern int
ne_get_node_map(int neid, /* 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 */
);
extern int
ne_put_node_map(int neid, /* 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 */
);
extern int
ne_get_elem_map(int neid, /* NetCDF/Exodus file ID */
void_int *elem_mapi, /* Internal element IDs */
void_int *elem_mapb, /* Border element IDs */
int processor /* Processor ID */
);
extern int
ne_put_elem_map(int neid, /* 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
*===========================================================================*/
extern int
ne_get_cmap_params(int neid, /* 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 */
);
extern int
ne_put_cmap_params(int neid, /* 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 */
);
extern int
ne_put_cmap_params_cc(int neid, /* 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 */
);
extern int
ne_get_node_cmap(int neid, /* 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 */
);
extern int
ne_put_node_cmap(int neid, /* 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 */
);
extern int
ne_get_elem_cmap(int neid, /* 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 */
);
extern int
ne_put_elem_cmap(int neid, /* 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 */
);
/* Should be internal use only, but was in external include file for
nemesis and some codes are using the function
*/
int ne_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
}
#endif
#endif /* _NE_NEMESIS_H */
|
