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
|
/*--------------------------------------------------------------*/
/* Prototype Header file for EnSight External Reader */
/* DSO Library Routines */
/* */
/* intended to be included from global_extern.h only */
/*--------------------------------------------------------------*/
/* *************************************************************
* Copyright 1998 Computational Engineering International, Inc.
* All Rights Reserved.
*
* Restricted Rights Legend
*
* Use, duplication, or disclosure of this
* software and its documentation by the
* Government is subject to restrictions as
* set forth in subdivision [(b)(3)(ii)] of
* the Rights in Technical Data and Computer
* Software clause at 52.227-7013.
* *************************************************************
*/
#ifndef GLOBAL_EXTERN_PROTO_H
#define GLOBAL_EXTERN_PROTO_H
#include <stdio.h>
#ifdef WIN32
#define W32IMPORT __declspec( dllimport )
#define W32EXPORT __declspec( dllexport )
#else
#define W32IMPORT extern
#define W32EXPORT extern
#endif
/*----------------------
* Same in All Versions
*----------------------*/
W32EXPORT int
USERD_get_number_of_model_parts( void );
W32EXPORT int
USERD_get_block_coords_by_component(int block_number,
int which_component,
float *coord_array);
W32EXPORT int
USERD_get_block_iblanking(int block_number,
int *iblank_array);
W32EXPORT int
USERD_get_block_scalar_values(int block_number,
int which_scalar,
float *scalar_array);
W32EXPORT int
USERD_get_block_vector_values_by_component(int block_number,
int which_vector,
int which_component,
float *vector_array);
W32EXPORT int
USERD_get_name_of_reader(char reader_name[Z_MAX_USERD_NAME],
int *two_fields);
/*
* This mechanism is used to mark the fact that a given
* reader cannot be unloaded. We set this by default for
* C++ based readers as there are known issues with unloading
* a C++ DLL on certain platforms (Linux).
*/
W32EXPORT int
USERD_reader_unloadable(void);
#ifdef __cplusplus
/*
* Define a macro that defines the cpp function as part of the
* USERD_get_name_of_reader declaration
*/
#ifndef NO_AUTO_UNLOADABLE_CODE
#if defined(LINUX) || defined(SGI)
#define USERD_get_name_of_reader \
USERD_reader_unloadable(void) { return(0); } \
int USERD_get_name_of_reader
#endif
#endif
#endif
W32EXPORT int
USERD_get_reader_descrip(char descrip[Z_MAXFILENP]);
W32EXPORT int
USERD_set_filenames(char filename_1[],
char filename_2[],
char the_path[],
int swapbytes);
W32EXPORT int
USERD_get_number_of_files_in_dataset( void );
W32EXPORT int
USERD_get_dataset_query_file_info(Z_QFILES *qfiles);
W32EXPORT int
USERD_get_changing_geometry_status( void );
W32EXPORT int
USERD_get_node_label_status( void );
W32EXPORT int
USERD_get_element_label_status( void );
W32EXPORT int
USERD_get_number_of_variables( void );
W32EXPORT void
USERD_stop_part_building( void );
W32EXPORT int
USERD_bkup(FILE *archive_file,
int backup_type);
/* -----------------------------------
* Optional routine allows getting data
* from the reader to modify server/client behavior
* ------------------------------------ */
W32EXPORT int
USERD_get_extra_data(int *target,
int *nints, int *nflts, int *nchrs,
int *pints, float *pflts, char *pchrs);
/* ----------------------------
* Extra "Before" GUI stuff available for all versions of API
* Note: this API suite is entirely optional...
* --------------------------- */
W32EXPORT void USERD_get_extra_gui_numbers(
int *num_Toggles,
int *num_pulldowns,
int *num_fields
);
W32EXPORT int USERD_get_extra_gui_defaults(
char **toggle_Title, /* [num_toggles][Z_LEN_GUI_TITLE_STR] */
int *toggle_default_status, /* [num_toggles] */
char **pulldown_Title, /* [num_pulldowns][Z_LEN_GUI_TITLE_STR] */
int *pulldown_number_in_list, /* [num_pulldowns] */
int *pulldown_default_selection, /* [num_pulldowns] */
char ***pulldown_item_strings, /* [num_pulldowns][Z_MAX_NUM_GUI_PULL_ITEMS][Z_LEN_GUI_PULL_STR] */
char **field_Title, /* [num_fields][Z_LEN_GUI_TITLE_STR] */
char **field_user_string /* [num_fields][Z_LEN_GUI_FIELD_STR] */
);
W32EXPORT void USERD_set_extra_gui_data(
int *toggle, /* [num_toggle] */
int *pulldown, /* [num_pulldown] */
char **field_text /* [num_fields][Z_LEN_GUI_FIELD_STR] */
);
/* ----------------------------
* Extra "After" GUI stuff available for all versions of API
* Note: this API suite is entirely optional...
* --------------------------- */
W32EXPORT void USERD_get_var_extract_gui_numbers(
int *num_Toggles,
int *num_pulldowns,
int *num_fields
);
W32EXPORT int USERD_get_var_extract_gui_defaults(
char **toggle_Title, /* [num_toggles][Z_LEN_GUI_TITLE_STR] */
int *toggle_default_status, /* [num_toggles] */
char **pulldown_Title, /* [num_pulldowns][Z_LEN_GUI_TITLE_STR] */
int *pulldown_number_in_list, /* [num_pulldowns] */
int *pulldown_default_selection, /* [num_pulldowns] */
char ***pulldown_item_strings, /* [num_pulldowns][Z_MAX_NUM_GUI_PULL_ITEMS][Z_LEN_GUI_PULL_STR] */
char **field_Title, /* [num_fields][Z_LEN_GUI_TITLE_STR] */
char **field_user_string /* [num_fields][Z_LEN_GUI_FIELD_STR] */
);
W32EXPORT void USERD_set_var_extract_gui_data(
int *toggle, /* [num_toggle] */
int *pulldown, /* [num_pulldown] */
char **field_text /* [num_fields][Z_LEN_GUI_FIELD_STR] */ );
/* --------------------
* xy-query data routines
* -------------------- */
W32EXPORT int USERD_get_num_xy_queries(void);
W32EXPORT int USERD_get_xy_query_info(
int query_num,
char *query_name,
char *query_xtitle,
char *query_ytitle,
int *query_num_pairs);
W32EXPORT int USERD_get_xy_query_data(
int query_num,
int num_vals,
float *x_vals,
float *y_vals);
/* This routine added so the reader can know if we are at the "right" side of
* an interval - namely, interpolation between steps is being done in EnSight
* (It can be in any version of EnSight)
*----------------------------------------------------------------------------*/
W32EXPORT void
USERD_set_right_side( void );
/*---------------------------------------------
* Routines that get the geometry in buffers,
* used for Unstructured Auto Distribute
* (Optional)
*---------------------------------------------*/
W32EXPORT int
USERD_get_part_coords_in_buffers(int part_number,
float **coord_array,
int first,
int n_beg,
int n_end,
int buffer_size,
int *num_returned);
W32EXPORT int
USERD_get_part_node_ids_in_buffers(int part_number,
int *nodeid_array,
int first,
int n_beg,
int n_end,
int buffer_size,
int *num_returned);
W32EXPORT int
USERD_get_part_elements_by_type_in_buffers(int part_number,
int element_type,
int **conn_array,
int first,
int e_beg,
int e_end,
int buffer_size,
int *num_returned);
W32EXPORT int
USERD_get_part_element_ids_by_type_in_buffers(int part_number,
int element_type,
int *elemid_array,
int first,
int e_beg,
int e_end,
int buffer_size,
int *num_returned);
W32EXPORT int
USERD_get_var_by_component_in_buffers(int which_variable,
int which_part,
int var_type,
int which_type,
int imag_data,
int component,
float *var_array,
int first,
int ne_beg,
int ne_end,
int buffer_size,
int leftside,
int *num_returned);
W32EXPORT int
USERD_get_nsided_conn_in_buffers(int part_number,
int *num_nodes_per_elem_array,
int *nsided_conn_array,
int first,
int e_beg,
int e_end,
int buffer_size,
int *num_returned);
W32EXPORT int
USERD_get_nfaced_conn_in_buffers(int part_number,
int *nfaced_fpe_arrray,
int *nfaced_npf_arrray,
int *nfaced_conn_array,
int first,
int e_beg,
int e_end,
int buffer_size,
int *num_returned);
/*-----------------------
* For Version 1.000 Only
*-----------------------*/
#if defined USERD_API_100
W32EXPORT int
USERD_get_number_of_global_nodes( void );
W32EXPORT int
USERD_get_global_coords(CRD *coord_array);
W32EXPORT int
USERD_get_global_node_ids(int *nodeid_array);
W32EXPORT int
USERD_get_element_connectivities_for_part(int part_number,
int **conn_array[Z_MAXTYPE]);
W32EXPORT int
USERD_get_element_ids_for_part(int part_number,
int *elemid_array[Z_MAXTYPE]);
W32EXPORT int
USERD_get_vector_values(int which_vector,
int which_part,
int which_type,
float *vector_array);
W32EXPORT int
USERD_get_part_build_info(int *part_id,
int *part_types,
char *part_descriptions[Z_BUFL],
int *number_of_elements[Z_MAXTYPE],
int *ijk_dimensions[3],
int *iblanking_options[6]);
W32EXPORT int
USERD_get_scalar_values(int which_scalar,
int which_part,
int which_type,
float *scalar_array);
W32EXPORT int
USERD_get_variable_info(char **var_description,
char **var_filename,
int *var_type,
int *var_classify);
W32EXPORT int
USERD_get_description_lines(int which_type,
int which_var,
char line1[Z_BUFL],
char line2[Z_BUFL]);
W32EXPORT int
USERD_get_variable_value_at_specific(int which_var,
int which_node_or_elem,
int which_part,
int which_elem_type,
int time_step,
float values[3]);
W32EXPORT float
USERD_get_constant_value(int which_var);
W32EXPORT int
USERD_get_solution_times(float *solution_times);
W32EXPORT void
USERD_set_time_step(int time_step);
W32EXPORT int
USERD_get_number_of_time_steps(void);
#endif
/*----------------------
* New For Version 2.000
*----------------------*/
#if !defined USERD_API_100
W32EXPORT int
USERD_get_part_coords(int part_number,
float **coord_array);
W32EXPORT int
USERD_get_part_node_ids(int part_number,
int *nodeid_array);
W32EXPORT int
USERD_get_part_elements_by_type(int part_number,
int element_type,
int **conn_array);
W32EXPORT int
USERD_get_part_element_ids_by_type(int part_number,
int element_type,
int *elemid_array);
W32EXPORT int
USERD_get_reader_version(char version_number[Z_MAX_USERD_NAME]);
W32EXPORT int
USERD_get_reader_release(char version_number[Z_MAX_USERD_NAME]);
W32EXPORT int
USERD_get_var_by_component(int which_variable,
int which_part,
int var_type,
int which_type,
int complex,
int component,
float *var_array);
W32EXPORT int
USERD_get_maxsize_info(int *max_number_of_nodes,
int *max_number_of_elements[Z_MAXTYPE],
int *max_ijk_dimensions[3]);
W32EXPORT void
USERD_exit_routine( void );
W32EXPORT int
USERD_get_gold_variable_info(char **var_description,
char **var_filename,
int *var_type,
int *var_classify,
int *var_complex,
char **var_ifilename,
float *var_freq,
int *var_contran,
int *var_timeset);
W32EXPORT int
USERD_get_model_extents( float extents[6] );
W32EXPORT int
USERD_get_descrip_lines(int which_type,
int which_var,
int imag_data,
char line1[Z_BUFL],
char line2[Z_BUFL]);
W32EXPORT int
USERD_get_var_value_at_specific(int which_var,
int which_node_or_elem,
int which_part,
int which_elem_type,
int time_step,
float values[3],
int imag_data);
W32EXPORT float
USERD_get_constant_val(int which_var, int imag_data);
W32EXPORT int
USERD_get_geom_timeset_number(void);
W32EXPORT int
USERD_get_number_of_timesets(void);
W32EXPORT int
USERD_get_timeset_description(int timeset_number,
char timeset_description[Z_BUFL]);
W32EXPORT int
USERD_get_sol_times(int timeset_number,
float *solution_times);
W32EXPORT void
USERD_set_time_set_and_step(int timeset_number,
int time_step);
W32EXPORT int
USERD_get_num_of_time_steps(int timeset_number);
W32EXPORT int
USERD_get_border_availability(int part_number,
int number_of_elements[Z_MAXTYPE]);
W32EXPORT int
USERD_get_border_elements_by_type(int part_number,
int element_type,
int **conn_array,
short *parent_element_type,
int *parent_element_num);
W32EXPORT void
USERD_set_server_number(int serv_num,
int tot_servs);
#endif
/*----------------------
* New For Version 2.010
*----------------------*/
#if defined USERD_API_201 || defined USERD_API_202 || defined USERD_API_203 || defined USERD_API_204 || defined USERD_API_205 || defined USERD_API_206 || defined USERD_API_207 || defined USERD_API_208 || defined USERD_API_209 || defined USERD_API_210
W32EXPORT int
USERD_get_ghosts_in_model_flag( void );
W32EXPORT int
USERD_get_ghosts_in_block_flag(int block_number);
W32EXPORT int
USERD_get_block_ghost_flags(int block_number,
int *ghost_flags);
#endif
/*--------------------------
* Modified at Version 2.030
*--------------------------*/
#if defined USERD_API_200 || defined USERD_API_201 || defined USERD_API_202
W32EXPORT int
USERD_get_gold_part_build_info(int *part_id,
int *part_types,
char *part_descriptions[Z_BUFL],
int *number_of_nodes,
int *number_of_elements[Z_MAXTYPE],
int *ijk_dimensions[3],
int *iblanking_options[6]);
#endif
#if defined USERD_API_203 || defined USERD_API_204 || defined USERD_API_205 || defined USERD_API_206 || defined USERD_API_207 || defined USERD_API_208 || defined USERD_API_209 || defined USERD_API_210
W32EXPORT int
USERD_get_gold_part_build_info(int *part_id,
int *part_types,
char *part_descriptions[Z_BUFL],
int *number_of_nodes,
int *number_of_elements[Z_MAXTYPE],
int *ijk_dimensions[9],
int *iblanking_options[6]);
#endif
/*----------------------
* New For Version 2.030
*----------------------*/
#if defined USERD_API_203 || defined USERD_API_204 || defined USERD_API_205 || defined USERD_API_206 || defined USERD_API_207 || defined USERD_API_208 || defined USERD_API_209 || defined USERD_API_210
W32EXPORT int
USERD_get_number_of_material_sets( void );
W32EXPORT int
USERD_get_matf_set_info(int *mat_set_ids,
char **mat_set_name);
W32EXPORT int
USERD_get_number_of_materials( int set_index );
W32EXPORT int
USERD_get_matf_var_info(int set_index,
int *mat_ids,
char **mat_desc);
W32EXPORT int
USERD_size_matf_data(int set_index,
int part_id,
int wtyp,
int mat_type,
int *matf_size );
W32EXPORT int
USERD_load_matf_data( int set_index,
int part_id,
int wtyp,
int mat_type,
int *ids_list,
float *val_list );
W32EXPORT int
USERD_get_nsided_conn( int part_number,
int *nsided_conn_array );
W32EXPORT int
USERD_get_nfaced_nodes_per_face( int part_number,
int *nfaced_npf_array );
W32EXPORT int
USERD_get_nfaced_conn( int part_number,
int *nfaced_conn_array );
#endif
/*----------------------
* New For Version 2.040
*----------------------*/
#if defined USERD_API_204 || defined USERD_API_205 || defined USERD_API_206 || defined USERD_API_207 || defined USERD_API_208 || defined USERD_API_209 || defined USERD_API_210
W32EXPORT int
USERD_get_uns_failed_params(
char *fail_var_name, /* variable name to be used in failure
must be scalar, per elem */
float *threshold_val1, /* number to compare for failure */
float *threshold_val2, /* number to compare for failure */
int *threshold_operator1, /* Z_GREATER_THAN, Z_LESS_THAN,
Z_EQUAL_TO */
int *threshold_operator2, /* Z_GREATER_THAN, Z_LESS_THAN,
Z_EQUAL_TO */
int *logic_criteria2
);
#endif
/*----------------------
** New For Version 2.050
**----------------------*/
#if defined USERD_API_205 || defined USERD_API_206 || defined USERD_API_207 || defined USERD_API_208 || defined USERD_API_209 || defined USERD_API_210
W32EXPORT int
USERD_get_number_of_species( int set_index );
W32EXPORT int
USERD_get_matsp_info(int set_index,
int *sp_ids,
char **sp_desc,
int *sppermatcnt,
int *sppermatlis);
W32EXPORT int
USERD_rigidbody_existence( void );
#endif
/*--------------------------------------------
* New at 2.05, but modified for Version 2.080
*-------------------------------------------- */
#if defined USERD_API_205 || defined USERD_API_206 || defined USERD_API_207
W32EXPORT int
USERD_rigidbody_values(int part_number,
float values[10]);
#endif
#if defined USERD_API_208 || defined USERD_API_209 || defined USERD_API_210
W32EXPORT int
USERD_rigidbody_values(int part_number,
float values[14]);
#endif
/*----------------------
** New For Version 2.060
**----------------------*/
#if defined USERD_API_206 || defined USERD_API_207 || defined USERD_API_208 || defined USERD_API_209 || defined USERD_API_210
W32EXPORT int
USERD_get_structured_reader_cinching( void );
W32EXPORT int
USERD_set_block_range_and_stride(int file_pn,
int mini, int maxi, int stepi,
int minj, int maxj, int stepj,
int mink, int maxk, int stepk);
#endif
/*----------------------
** New For Version 2.070
**----------------------*/
#if defined USERD_API_207 || defined USERD_API_208 || defined USERD_API_209 || defined USERD_API_210
/* non-optional functions go here */
#endif
/* This is optional; defaults to 'Set file' and 'Set results' if not
* defined. If 'two_fields' is true, then both labels must have a
* non-NULL string otherwise the defaults will be used.
*/
W32EXPORT void
USERD_set_filename_button_labels(char filename_label_1[Z_MAX_USERD_NAME],
char filename_label_2[Z_MAX_USERD_NAME]);
/* This is optional; defaults to TRUE if not defined. */
W32EXPORT int
USERD_prefer_auto_distribute(void);
/*----------------------
** New For Version 2.090
**----------------------*/
#if defined USERD_API_209 || defined USERD_API_210
/* non-optional functions go here */
#endif
/* These are optional */
W32EXPORT int
USERD_get_vglyph_counts(int *num_vglyph_vectors,
int *num_vglyph_timelines);
W32EXPORT int
USERD_get_vglyph_timeline_info(int vtl,
int *id,
int *numtimes,
int *before,
int *amidst,
int *after);
W32EXPORT int
USERD_get_vglyph_timeline_times(int vtl,
float *times);
W32EXPORT int
USERD_get_vglyph_vector_info(int vg,
int *id,
char *description,
int *type,
int *time_condition,
int *time_line,
int *part,
int *nidloc,
int *eidloc);
W32EXPORT int
USERD_get_vglyph_vector_values(int vg,
float **values);
W32EXPORT int
USERD_get_vglyph_vector_xyzloc(int vg,
float **xyzloc);
/*----------------------
** New For Version 2.100
**----------------------*/
#if defined USERD_API_210
W32EXPORT int
USERD_get_mat_scalars_desc(int set_index,
char **mesv_desc);
#endif
/* These are optional */
W32EXPORT int
USERD_get_matf_set_type(int set_index);
/* special, optional functions */
W32EXPORT void
USERD_reset_routine(void);
/*--------------------------------------------------------------------*/
#endif /*GLOBAL_EXTERN_PROTO_H*/
|
