Interface Manual

ANSYS EnSight Interface Manual
ANSYS, Inc. Release 2020 R1

Southpointe January 2020
2600 ANSYS Drive
Canonsburg, PA 15317 ANSYS, Inc. and
ansysinfo@ansys.com ANSYS Europe,
Ltd. are UL
http://www.ansys.com registered ISO
(T) 724-746-3304 9001: 2015
(F) 724-514-9494 companies.
Copyright and Trademark Information
© 2020 ANSYS, Inc. Unauthorized use, distribution or duplication is prohibited.
ANSYS, ANSYS Workbench, AUTODYN, CFX, FLUENT and any and all ANSYS, Inc. brand, product, service and feature
names, logos and slogans are registered trademarks or trademarks of ANSYS, Inc. or its subsidiaries located in the
United States or other countries. ICEM CFD is a trademark used by ANSYS, Inc. under license. CFX is a trademark
of Sony Corporation in Japan. All other brand, product, service and feature names or trademarks are the property
of their respective owners. FLEXlm and FLEXnet are trademarks of Flexera Software LLC.
Disclaimer Notice
THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE SECRETS AND ARE CONFID-
ENTIAL AND PROPRIETARY PRODUCTS OF ANSYS, INC., ITS SUBSIDIARIES, OR LICENSORS. The software products
and documentation are furnished by ANSYS, Inc., its subsidiaries, or affiliates under a software license agreement
that contains provisions concerning non-disclosure, copying, length and nature of use, compliance with exporting
laws, warranties, disclaimers, limitations of liability, and remedies, and other provisions. The software products
and documentation may be used, disclosed, transferred, or copied only in accordance with the terms and conditions
of that software license agreement.
ANSYS, Inc. and ANSYS Europe, Ltd. are UL registered ISO 9001: 2015 companies.
U.S. Government Rights
For U.S. Government users, except as specifically granted by the ANSYS, Inc. software license agreement, the use,
duplication, or disclosure by the United States Government is subject to restrictions stated in the ANSYS, Inc.
software license agreement and FAR 12.212 (for non-DOD licenses).
Third-Party Software
See the legal information in the product help files for the complete Legal Notice for ANSYS proprietary software
and third-party software. If you are unable to access the Legal Notice, contact ANSYS, Inc.
Published in the U.S.A.

Table of Contents
1. Overview ................................................................................................................................................. 1
1.1. User Defined Reader APIs .................................................................................................................. 1
1.2. How to Produce a User Defined Reader ............................................................................................. 3
1.3. User Defined Writers ......................................................................................................................... 8
1.4. User Defined Math Functions ............................................................................................................ 8
2. User Defined Reader Version 1.0 API ...................................................................................................... 9
2.1. Quick Index of Library Routines ......................................................................................................... 9
2.2. Order Routines are Called ................................................................................................................ 11
2.3. Detailed Specifications .................................................................................................................... 13
2.3.1. USERD_bkup .......................................................................................................................... 14
2.3.2. USERD_get_block_coords_by_component ............................................................................. 16
2.3.3. USERD_get_block_iblanking .................................................................................................. 16
2.3.4. USERD_get_block_scalar_values ............................................................................................ 17
2.3.5. USERD_get_block_vector_values_by_component .................................................................. 18
2.3.6. USERD_get_changing_geometry_status ................................................................................ 19
2.3.7. USERD_get_constant_value ................................................................................................... 19
2.3.8. USERD_get_dataset_query_file_info ...................................................................................... 19
2.3.9. USERD_get_description_lines ................................................................................................ 20
2.3.10. USERD_get_element_connectivities_for_part ....................................................................... 21
2.3.11. USERD_get_element_ids_for_part ........................................................................................ 22
2.3.12. USERD_get_element_label_status ........................................................................................ 22
2.3.13. USERD_get_extra_gui_defaults ............................................................................................ 23
2.3.14. USERD_get_extra_gui_numbers ........................................................................................... 24
2.3.15. USERD_get_global_coords ................................................................................................... 25
2.3.16. USERD_get_global_node_ids ............................................................................................... 26
2.3.17. USERD_get_name_of_reader ............................................................................................... 26
2.3.18. USERD_get_node_label_status ............................................................................................. 27
2.3.19. USERD_get_num_xy_queries ............................................................................................... 27
2.3.20. USERD_get_number_of_files_in_dataset .............................................................................. 28
2.3.21. USERD_get_number_of_global_nodes ................................................................................. 28
2.3.22. USERD_get_number_of_model_parts .................................................................................. 29
2.3.23. USERD_get_number_of_time_steps ..................................................................................... 29
2.3.24. USERD_get_number_of_variables ........................................................................................ 29
2.3.25. USERD_get_part_build_info ................................................................................................. 30
2.3.26. USERD_get_reader_descrip .................................................................................................. 32
2.3.27. USERD_get_reader_release .................................................................................................. 32
2.3.28. USERD_get_scalar_values ..................................................................................................... 33
2.3.29. USERD_get_solution_times .................................................................................................. 34
2.3.30. USERD_get_var_extract_gui_defaults ................................................................................... 34
2.3.31. USERD_get_var_extract_gui_numbers ................................................................................. 35
2.3.32. USERD_get_variable_info ..................................................................................................... 36
2.3.33. USERD_get_variable_value_at_specific ................................................................................ 37
2.3.34. USERD_get_vector_values .................................................................................................... 38
2.3.35. USERD_get_xy_query_data .................................................................................................. 40
2.3.36. USERD_get_xy_query_info ................................................................................................... 40
2.3.37. USERD_prefer_auto_distribute ............................................................................................. 41
2.3.38. USERD_set_extra_gui_data .................................................................................................. 41
2.3.39. USERD_set_filename_button_labels ..................................................................................... 42
2.3.40. USERD_set_filenames ........................................................................................................... 42
2.3.41. USERD_set_time_step .......................................................................................................... 43
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. iii
Interface Manual
2.3.42. USERD_set_var_extract_gui_data ......................................................................................... 43

2.3.43. USERD_get_max_time_steps ................................................................................................ 43
2.3.44. USERD_stop_part_building .................................................................................................. 44
3. User Defined Reader Version 2.0 API .................................................................................................... 45
3.1. Quick Index of 2.0 Library Routines .................................................................................................. 45
3.2. Order Routines Are Called ............................................................................................................... 49
3.3. Routine History ............................................................................................................................... 55
3.3.1. At Version 2.00 ....................................................................................................................... 57
3.3.2. At Version 2.01 ....................................................................................................................... 59
3.3.3. At Version 2.03 ....................................................................................................................... 59
3.3.4. At Version 2.04 ....................................................................................................................... 60
3.3.5. At Version 2.05 ....................................................................................................................... 60
3.3.6. At Version 2.06 ....................................................................................................................... 61
3.3.7. At Version 2.07 ....................................................................................................................... 61
3.3.8. At Version 2.08 ....................................................................................................................... 61
3.3.9. At Version 2.09 ....................................................................................................................... 63
3.3.10. At Version 2.10 ..................................................................................................................... 63
3.4. Detailed Specifications .................................................................................................................... 63
3.4.1. USERD_bkup .......................................................................................................................... 64
3.4.2. USERD_exit_routine ............................................................................................................... 66
3.4.3. USERD_get_block_coords_by_component ............................................................................. 66
3.4.4. USERD_get_block_iblanking .................................................................................................. 67
3.4.5. USERD_get_block_ghost_flags ............................................................................................... 67
3.4.6. USERD_get_border_availability .............................................................................................. 68
3.4.7. USERD_get_border_elements_by_type .................................................................................. 69
3.4.8. USERD_get_changing_geometry_status ................................................................................ 70
3.4.9. USERD_get_changing_geometry_status_per_part ................................................................. 71
3.4.10. USERD_get_constant_val ..................................................................................................... 71
3.4.11. USERD_get_dataset_query_file_info .................................................................................... 71
3.4.12. USERD_get_descrip_lines ..................................................................................................... 72
3.4.13. USERD_get_element_label_status ........................................................................................ 73
3.4.14. USERD_get_extra_gui_defaults ............................................................................................ 73
3.4.15. USERD_get_extra_gui_numbers ........................................................................................... 74
3.4.16. USERD_get_geom_timeset_number .................................................................................... 76
3.4.17. USERD_get_gold_part_build_info ........................................................................................ 76
3.4.18. USERD_get_gold_variable_info ............................................................................................ 81
3.4.19. USERD_get_ghosts_in_block_flag ........................................................................................ 83
3.4.20. USERD_get_ghosts_in_model_flag ....................................................................................... 84
3.4.21. USERD_get_matf_escalars_desc ........................................................................................... 84
3.4.22. USERD_get_matf_set_info .................................................................................................... 84
3.4.23. USERD_get_matf_set_type ................................................................................................... 85
3.4.24. USERD_get_matf_var_info ................................................................................................... 85
3.4.25. USERD_get_matsp_info ....................................................................................................... 86
3.4.26. USERD_get_max_time_steps ................................................................................................ 86
3.4.27. USERD_get_maxsize_info ..................................................................................................... 87
3.4.28. USERD_get_metadata .......................................................................................................... 89
3.4.29. USERD_get_model_extents .................................................................................................. 91
3.4.30. USERD_get_name_of_reader ............................................................................................... 91
3.4.31. USERD_get_nfaced_conn ..................................................................................................... 92
3.4.32. USERD_get_nfaced_conn_in_buffers .................................................................................... 94
3.4.33. USERD_get_nfaced_nodes_per_face .................................................................................... 98
3.4.34. USERD_get_node_label_status ........................................................................................... 100
iv of ANSYS, Inc. and its subsidiaries and affiliates.
Interface Manual
3.4.35. USERD_get_nsided_conn ................................................................................................... 101

3.4.36. USERD_get_nsided_conn_in_buffers .................................................................................. 103
3.4.37. USERD_get_num_of_time_steps ........................................................................................ 106
3.4.38. USERD_get_num_xy_queries ............................................................................................. 106
3.4.39. USERD_get_number_of_files_in_dataset ............................................................................ 107
3.4.40. USERD_get_number_of_material_sets ................................................................................ 107
3.4.41. USERD_get_number_of_materials ...................................................................................... 110
3.4.42. USERD_get_number_of_model_parts ................................................................................ 110
3.4.43. USERD_get_number_of_species ......................................................................................... 111
3.5. Converting a 1.0 API Reader to a 2.0 API Reader ............................................................................. 170
3.6. USERD Message Routines (Info, Error, Log, Etc.) ............................................................................... 175
4. User Defined Reader Version 3.0 API .................................................................................................. 177
4.1. Quick Index of 3.0 Library Routines ................................................................................................ 177
4.2. Order Routines Are Called API 3.0 .................................................................................................. 187
4.3. Overview Specifications ................................................................................................................ 190
4.4. Example Headers .......................................................................................................................... 191
4.5. API 3.0 Headers ............................................................................................................................. 191
4.5.1. User Defined test3 Reader .................................................................................................... 192
4.5.2. Reader API 3 Routines .......................................................................................................... 211
4.5.2.1. USERD_reader_open ................................................................................................... 211
4.5.2.2. USERD_get_name_of_reader ....................................................................................... 213
4.5.2.3. USERD_get_reader_descrip ......................................................................................... 213
4.5.2.4. USERD_get_reader_version ......................................................................................... 214
4.5.2.5. USERD_get_reader_release .......................................................................................... 214
4.5.2.6. USERD_reader_close ................................................................................................... 215
4.5.2.7. USERD_exit_routine .................................................................................................... 215
4.5.2.8. USERD_get_descrip_lines ............................................................................................ 215
4.5.2.9. USERD_attribute .......................................................................................................... 216
4.5.2.10. USERD_get_metadata ................................................................................................ 217
4.5.2.11. USERD_get_element_label_status ............................................................................. 219
4.5.2.12. USERD_get_node_label_status .................................................................................. 220
4.5.2.13. USERD_get_number_of_timesets .............................................................................. 220
4.5.2.14. USERD_get_timeset_description ................................................................................ 221
4.5.2.15. USERD_get_num_of_time_steps ................................................................................ 222
4.5.2.16. USERD_get_max_time_steps ..................................................................................... 223
4.5.2.17. USERD_get_sol_times ................................................................................................ 223
4.5.2.18. USERD_get_geom_timeset_number .......................................................................... 224
4.5.2.19. USERD_set_filenames ................................................................................................ 224
4.5.2.20. USERD_set_time_set_and_step ................................................................................. 225
4.5.2.21. USERD_get_number_of_model_parts ........................................................................ 225
4.5.2.22. USERD_get_part_info ................................................................................................ 226
4.5.2.23. USERD_get_geoms_in_part ....................................................................................... 227
4.5.2.24. USERD_get_geom_info ............................................................................................. 228
4.5.2.25. USERD_get_elemsets_in_geom ................................................................................. 228
4.5.2.26. USERD_get_unode_info ............................................................................................ 229
4.5.2.27. USERD_get_snode_info ............................................................................................. 229
4.5.2.28. USERD_get_snode_iblanking ..................................................................................... 231
4.5.2.29. USERD_get_node_coords .......................................................................................... 231
4.5.2.30. USERD_get_node_ids ................................................................................................ 232
4.5.2.31. USERD_get_uelem_info ............................................................................................. 233
4.5.2.32. USERD_get_uelem_faces_per_elem ........................................................................... 234
4.5.2.33. USERD_get_uelem_nodes_per_face .......................................................................... 235
of ANSYS, Inc. and its subsidiaries and affiliates. v
Interface Manual
4.5.2.34. USERD_get_uelem_conn ........................................................................................... 235

4.5.2.35. USERD_get_selem_info ............................................................................................. 237
4.5.2.36. USERD_get_selem_ghost_flags .................................................................................. 238
4.5.2.37. USERD_get_elem_ids ................................................................................................ 239
4.5.2.38. USERD_ get_num_xy_queries .................................................................................... 239
4.5.2.39. USERD_get_xy_query_info ....................................................................................... 239
4.5.2.40. USERD_get_xy_query_data ....................................................................................... 240
4.5.2.41. USERD_get_number_of_vars ..................................................................................... 240
4.5.2.42. USERD_get_var_info .................................................................................................. 241
4.5.2.43. USERD_get_node_var_info ........................................................................................ 242
4.5.2.44. USERD_get_node_var_values .................................................................................... 243
4.5.2.45. USERD_get_elem_var_info ........................................................................................ 243
4.5.2.46. USERD_get_elem_var_values ..................................................................................... 244
4.5.2.47. USERD_get_number_of_model_constants ................................................................. 245
4.5.2.48. USERD_get_model_constant_info ............................................................................. 245
4.5.2.49. USERD_get_model_constant_val ............................................................................... 246
4.5.2.50. USERD_get_constant_per_part_data ......................................................................... 246
4.5.2.51. USERD_get_extra_text ............................................................................................... 248
4.5.2.52. USERD_get_extra_gui_numbers ................................................................................ 248
4.5.2.53. USERD_get_extra_gui_defaults .................................................................................. 250
4.5.2.54. USERD_set_extra_gui_data ........................................................................................ 251
4.6. Converting a 2.0 API Reader to a 3.0 API READER ............................................................................ 252
4.7. API 3.0 Call Order for Major Routines ............................................................................................. 272
4.8. USERD Message Routines (Info, Error, Log, Etc.) ............................................................................... 294
5. User Defined Writer API ....................................................................................................................... 297
5.1. Directions For Writing Your Own UDW ........................................................................................... 298
5.2. Routine Detail Specifications ......................................................................................................... 302
6. User Defined Math Functions .............................................................................................................. 305
6.1. Detailed Routine Specifications ..................................................................................................... 305
6.2. Example ....................................................................................................................................... 308
7. EnSight Command Driver .................................................................................................................... 311
7.1. Query Capability ........................................................................................................................... 315
7.2. Routine Descriptions ..................................................................................................................... 337
8. EnSight Python Interpreter ................................................................................................................. 341
8.1. Python EnSight Module Interface .................................................................................................. 347
8.2. EnSight Object API ........................................................................................................................ 378
8.3. EnSight Extension Mechanism ....................................................................................................... 378
8.3.1. Startup Process .................................................................................................................... 378
8.3.2. Formal EnSight Extensions .................................................................................................... 379
8.3.3. Extension Base Classes ......................................................................................................... 380
8.4. Helper Modules ............................................................................................................................ 385
9. EnVe Module ....................................................................................................................................... 387
9.1. EnVe Extension Module Programming ........................................................................................... 388
9.2. EnVe Application ........................................................................................................................... 408
9.3. Helper Modules ............................................................................................................................ 416
vi of ANSYS, Inc. and its subsidiaries and affiliates.
Chapter 1: Overview
EnSight has user defined capability for data readers, data writers, and math functions. This capability
allows users to read and write data in custom ways, such as the handling of in-house data formats.
There also exists limited capability to produce custom math functions for the variable calculator.
1.1. User Defined Reader APIs

The user defined reader capability included in EnSight can allow otherwise unsupported structured or
unstructured data to be read. The user defined reader capability utilizes dynamic shared libraries con-
taining routines defined in this document but customized by you, the user, (or some third party). This
capability is available for all our supported architectures.
Two versions of this API are available.
User Starting with EnSight Version 6.0, the 1.0 API was made available. It was designed to
Defined be friendly to those producing it, but requires more manipulation internally in EnSight.
Reader It may be a little easier to produce readers using this format (especially if a global
Version coordinate array is a hallmark of your data format), but it requires more memory and
1.0 processing time. It also has been frozen in capability - so it does not contain many
API (p. 9) of the newer features.
Underlying Philosophy
API 1.0 deals with:
• global coordinate array and corresponding
• – global node id array
– global nodal variables
• for each part:
– local element connectivities (grouped by type) & corresponding
– local element ids
– local elemental variables
The element connectivities, within parts, reference the global coordinate array. If node
ids are provided, the element connectivities have to be in terms of the node ids. If
node ids are not provided, the connectivities are in terms of the (one-based) index
number of each node in the global coordinate array. Therefore, node ids are more
than labels - they are a part of the connectivity referencing scheme. Element ids are
purely labels.
of ANSYS, Inc. and its subsidiaries and affiliates. 1
Overview
This API was originally setup to try to make the interface to other codes as
straightforward as possible. Efficiency was not the major consideration.
EnSight must do a fair amount of work to get data provided in the manner described
above into the form that it uses internally. There is mapping that has to be setup and
maintained between the global arrays and the local part arrays so that updating over
time can be accomplished efficiently. There is hashing that is required in order to
deal efficiently with node ids.
All of this leads to a considerable amount of temporary memory and processing, in

order to get a model read into EnSight.
User The current 2.0 API is considerably more efficient, and was designed more with that
Defined in mind. It lends itself closely to the EnSight Gold format.
Reader
Version Underlying Philosophy
2.0
API (p. 45) API 2.0 deals with:
• for each part:
• part coordinates & corresponding
• part node ids
• part nodal variables
• part element connectivities (grouped by type) & corresponding
• part element ids
• part elemental variables
API 2.0 requires that the coordinates and corresponding nodal variables be provided
per part. This eliminates the global to local mapping with all its associated temporary
memory and processing time. The connectivity of the elements in each part reference
the node indices of its own (one-based) part coordinate array. The connectivity of
the elements do not reference the nodes according to node ids. Node ids (and element
ids) are purely labels for screen display and for query operations within EnSight. This
eliminates the need for node id hashing as a model is read.
The 2.0 API has been created for those needing more efficiency - both in terms of
memory use and speed. The increased efficiency is possible because data is requested
in a manner which more closely represents the way that EnSight stores and
manipulates information internally. The new API requests size information and allocates
the actual internal structures and arrays accordingly. Pointers to these arrays are
passed directly to you in the routines which gather data, therefore eliminating a
considerable amount of temporary memory (and allocation time) that is needed in
the 1.0 API. Depending on what you must do to get your data into the form required,
the memory savings and the speed improvement when loading models can be quite
significant!
Therefore, some of its advantages and new features are:
• Less memory, more efficient, and faster - as indicated above.
2 of ANSYS, Inc. and its subsidiaries and affiliates.
How to Produce a User Defined Reader
• Model extents can be provided directly, such that EnSight need not read all the coordinate
data at load time.
• Tensor and complex variables are supported
• Exit routine provided, for cleanup operations at close of EnSight
• Geometry and variables can be provided on different time lines (timesets).
• If your data format already provides boundary shell information, you can use it instead
of the border representation that EnSight would compute.
• Ghost cells (for both structured and unstructured data) are supported
• User specified node and/or element ids for structured parts are supported
• Material handling is supported
• Nsided and Nfaced elements are supported
• Structured ranges can be specified
• Failed elements is supported
• Material Species is supported
• Rigid Body values can be supplied from the reader.
• Reader can be allowed to deal with block min, max, and stride within itself - instead of
having EnSight deal with it.
User The 3.0 API is the preferred API for the future. The other two APIs are considered
Defined legacy APIs.
Reader
Version The 3.0 API includes all the capability of API as well as all of the efficiencies. It adds
3.0 a level of versatility in that each part can have multiple geometries. Each geometry
API (p. 177) has one nodeset and can have multiple element sets (each element set has only one
element type). This simplifies decomposition as each part can be decomposed into
multiple, independent geometries.
Variables are decomposed as well by geometry node set and element sets.
1.2. How to Produce a User Defined Reader

1. Write code for all pertinent routines in the library (Unless someone else has done this for you).
This is of course where the work is done by the user. The word pertinent is used because depending
on the nature of the data, some of the routines in the library may be dummy or optional routines.
The source code for a dummy_gold library and for various other working or sample libraries is
copied from the installation CD during installation. These will be located in directories under:
Overview
$CEI/ensight201/src/readers
Note:
The directory following CEI in the path could vary depending on the version of EnSight
installed.
Example 1.1: Basic API 3.0 Readers That Provide a Skeleton Example for a New Reader.
$CEI/ensight201/src/readers/test3 - structured and unstructured example

reader
$CEI/ensight201/src/readers/test3s - structured example reader
$CEI/ensight201/src/readers/test3u - unstructured example reader
Example 1.2: Sample Library Which Reads Unstructured Binary EnSight Gold Data (Version
2.08 API)
$CEI/ensight201/src/readers/ensight_gold
Example 1.3: Sample Library Which Reads C Binary, 3D, Static PLOT3D Data (Version 1.0 API)
$CEI/ensight201/src/readers/plot3d
You may find it useful to place the source code for the library you create in this readers area as well,
but you are not limited to this location.
The descriptions of each library routine contained in version 1.0 API, and version 2.0 API, along with
version 1.0 API, and version 2.0 API, as well other helps provided in this document, along with the
example libraries, should make it possible for you to produce code for your own data reader.
2. Produce the dynamic shared library.
This is a compiling and loading process which varies according to the type of machine you are on.
In the user-defined-reader source tree we have tried to isolate the machine dependent parts of the
build process using a set of files in the config directory. In this directory there is a configuration
file for each platform on which EnSight is supported. Before you can compile the installed readers
you should run the script called init in the config directory.
Example 1.4: For UNIX

cd config
./init linux_2.6_64
cd ..
make
If you are compiling for Windows, there are two options. If you have the Cygwin GNU utilities installed,
you can use GNU make as for UNIX. Otherwise, there is a script called makeall.cmd which will
build all of the readers using nmake. The Makefiles in each reader directory will work using either
make or nmake.
i.e. (WIN64 Cygwin) (using nmake)

cd config cd config
i.e. (WIN64 Cygwin) (using nmake)

sh init win64 cp win64 config
cd .. cd ..
make mkdir lib
makeall.cmd
If you have platform-specific portions of code in your reader, the build system defines a set of flags
which can be used within #ifdef ... #endif regions in your source, as shown in the table
below.
Because the readers are now dynamically opened by EnSight, you may have to include dependent
libraries on your link-line to avoid having unresolved symbols. If you are having problems with a
reader, start EnSight as ensight -readerdbg and you will get feedback on any problems en-
countered in loading a reader. If there are unresolved symbols, you need to find the library which
contains the missing symbols and link it into your reader by adding it to the example link commands
below.
If you choose to use a different build environment for your reader, you should take care to use
compatible compilation flags; perhaps use the following flags:
Machine OS Shared Library Name LD Command used in Makefile

Type Flag Produced
Linux -DLINUX libuserd-X.so ld -shared -o libuserd-X.so libuserd-X.o -lc
Mac -DMAC libuserd-X.bundle ld -bundle -twolevel_namespace
-multiply_defined -suppress -undefined
dynamic_lookup -o libuserd-X.so
libuserd-X.o
Once you have created your library, you should place it in a directory of your choice or in the
standard reader location: $CEI/ensight201/machines/$CEI_ARCH/lib_readers
For example, if you created a reader for mydata, you should create the reader libuserd-
mydata.so and place the file in your own reader directory (see point 3 below) or in the standard
location: $CEI/ensight201/machines/$CEI_ARCH/lib_readers/libuserd-mydata.so
3. By default EnSight will load all readers found in the directory: $CEI/ensight201/ma-
chines/$CEI_ARCH/lib_readers
Files with names libuserd-X.so (where X is a name unique to the reader) are assumed to be
user-defined readers.
There are two methods which can be used to supplement the default behavior.
a. A feature which is useful for site-level or user-level configuration is the optional environment variable
ENSIGHT20_READER (or legacy ENSIGHT10_READER). This variable directs EnSight to load all readers
in the specified reader directory (you should probably specify a full path) before loading the built-in
readers. If the same reader exists in both directories (as determined by the name returned by
USERD_get_name_of_reader(), NOT by the filename), the locally configured reader will take
precedence.
Overview
b. A useful feature for end-users is the use of the libuserd-devel reader. EnSight will search for a
reader named libuserd-devel.so (.DLL for Windows). This reader can exist anywhere in the library path
(see below) of the user. This is useful for an individual actively developing a reader because the existence
of a libuserd-devel library will take precedence over any other library which returns the same
name from USERD_get_name_of_reader().
As an example, a site may install commonly used readers in a common location, and users can set
the $ENSIGHT20_READER (or legacy $ENSIGHT10_READER variable to access them: setenv
ENSIGHT20_READER /usr/local/lib/ereaders
A user working on a new reader may compile the reader and place it in a directory specified by the
library path: cp libuserd-myreader.so ~/lib/libuserd-devel.so setenv <lib-
rarypath> ~/lib:$<librarypath>
The user is responsible for correctly configuring the library path variable in order to make use of
the libuserd-devel feature. The library environment variables used are:
Machine Type Environment Variable to Set

Linux LD_LIBRARY_PATH
Mac DYLD_LIBRARY_PATH
As always, ANSYS support is available if you need it.
4. Use the udr_checker tool for help in debugging your user-defined reader.
The udr_checker.c routine can be used to debug EnSight User-defined readers. It exists because
of the difficulty of debugging dynamic shared libraries when you don't have the source for the
calling program (EnSight).
If udr_checker.c is compiled and linked with your reader source code (including access to any
libraries needed, and the global_extern.h file), it will exercise most options of you reader, giving
feedback as it goes. The resulting executable can be debugged using your favorite debugger. And
if you have memory/bounds checking software (such as purify), you can (and should) run it with
this executable to make sure that you are not overwriting things. Readers that bash memory will
cause problems when run with EnSight!
You will note that the Makefile provided with the readers in the EnSight distribution have a checker
object. If you do a make checker instead of just a make, the checker executable will be produced.
You may need to modify these makefiles slightly if the locations of your reader files are different
than the normal.
Once the checker executable exists, you can run the checker program by simply invoking it:
> checker
And you will be prompted for the type of information that you provide in the EnSight Data Reader
dialog, namely:
The path
filename_1
[filename_2] - Only if your reader uses two fields
swapbytes flag
<toggle flags> - Only if your reader implements extra GUI
<pulldown flags> - one flag value per line
<field contents> - one field string per line
There are certain command line options that you can use to control some aspects of the checker
program. One of the more useful is the ability to provide the input just described in a file. This is
done in this fashion:
> checker -p <playfile>
And <playfile> would be a simple ascii file with 3 [0r 4] lines:
line 1: the path
line 2: filename_1
line 3: [filename_2] (if two_fields is TRUE)
line 3 or 4: 0 or 1, for swapbytes (0 is FALSE, 1 is TRUE)
remaining lines 0 or 1 for toggle disable enabled
one line for each toggle
0 - num_pulldown_values for pulldown choice
one line for each pulldown
strings
one line for each field
Example 1.5: Playfile for an EnSight Gold Reader Casefile (Entitled cube.play) Could Look
Something like the Following
/usr/local/bin/data/ens
cube.case
0
And you would invoke checker as:
> checker -p cube.play
Example 1.6: Playfile with Swapbytes 0, Two Enabled Toggles, Three Pulldowns with the Value
0 Chosen and a Single Field "Sample Field Value" Could Look Something like the Following
/mydirectory/subdir/
myfile
0
Overview
1
1
0
0
0
sample field value
Other command line arguments are:
-server_number For checking server number routines. If you use

this option, you will be prompted for the total
number of servers and the current server number.
These will then be used in the calls to the server
number routines.
-gts # For specifying the geometry timestep to test. The
default is step 0. The # is the (zero based) time
step to read for geometry.
-vts # For specifying the variable timestep to test. The
default is step 0. The # is the (zero based) time
step to read for variables. The # is the (zero based)
time step to read for variables.
1.3. User Defined Writers

Users can write (UDW) to generate arbitrary data files for EnSight parts and variables. The EnSight
server provides a UDW API that can be used to write out the currently selected parts in the EnSight
client part list, as well as the active variables, in a user defined format. The UDW API includes methods
to get, for example, node coordinates, element connectivity, ids, variable values, and time information.
A UDW can call any of the methods as it wants and create a data file(s) in any format desired. Additionally,
the UDW dialog in the EnSight client has a Parameter field that provides a mechanism for passing user
specified options to the UDW.
1.4. User Defined Math Functions

Users can write external variable calculator functions called (UDMF) that can be dynamically loaded by
EnSight. These functions appear in EnSight's calculator in the general function list and can be used just
as any other calculator function to derive new variables.
Chapter 2: User Defined Reader Version 1.0 API
This chapter will describe the EnSight User Defined Reader Version 1.0 API. Starting with EnSight Version
6.0, the 1.0 API has been available. It was designed to be friendly to those producing it (especially if a
global coordinate array is a hallmark of your data format).
It does, however, require more manipulation internally by EnSight, which may require more memory
and processing time. Thus, you may want to also consider the 2.0 API as described in User Defined
Reader Version 2.0 API (p. 45).
If you already have a working 1.0 API reader and are happy with it - there is probably no reason to
modify it to the 2.0 API unless you deal with large models and the memory use and load times are a
problem, or you need any of the additional capabilities that the 2.0 API provides.
If you are producing a new reader, you should consider which will work best for your needs.
Further discussion on the philosophical differences between the two API's can be found in User Defined
Reader APIs (p. 1).
If you wish to convert an existing 1.0 API reader to the 2.0 API, see Converting a 1.0 API Reader to a 2.0
API READER (p. 170).
The process for producing the dynamic shared library is described in How To Produce A User Defined
Reader (p. 3).
2.1. Quick Index of Library Routines

Routine Name Brief Description
Generally Needed for UNSTRUCTURED Data
USERD_get_element_connectivities_for_part (p. 21) part's element connectivities
USERD_get_element_ids_for_part (p. 22) part's element ids
USERD_get_global_coords (p. 25) global node coordinates
USERD_get_global_node_ids (p. 26) global node ids
USERD_get_number_of_global_nodes (p. 28) number of global nodes
USERD_get_scalar_values (p. 33) global scalar variables
USERD_get_vector_values (p. 38) global vector variables
Generally Needed for STRUCTURED (BLOCK) Data
USERD_get_block_coords_by_component (p. 16) block coordinates
USERD_get_block_iblanking (p. 16) block iblanking values
USERD_get_block_scalar_values (p. 17) block scalar variables
USERD_get_block_vector_values_by_component (p. 18)
block vector variables
Generally Needed for Either or Both Kinds of Data
User Defined Reader Version 1.0 API
Routine Name Brief Description

USERD_bkup (p. 14) read/write archive routine
USERD_get_changing_geometry_status (p. 19) changing geometry flag
USERD_get_constant_value (p. 19) constant variable's value
USERD_get_dataset_query_file_info (p. 19) info about each model file
USERD_get_description_lines (p. 20) file associated descrip lines
USERD_get_element_label_status (p. 22) element labels flag
USERD_get_name_of_reader (p. 26) name of reader for GUI
USERD_get_node_label_status (p. 27) node labels flag
USERD_get_number_of_files_in_dataset (p. 28) number of files in model
USERD_get_number_of_model_parts (p. 29) number of model parts
USERD_get_number_of_time_steps (p. 29) number of time steps
USERD_get_number_of_variables (p. 29) number of variables
USERD_get_part_build_info (p. 30) part type/descrip etc.
USERD_get_reader_descrip (p. 32) provide GUI more description (optional)
USERD_get_solution_times (p. 34) solution time values
USERD_get_variable_info (p. 36) variable type/descrip etc.
USERD_get_variable_value_at_specific (p. 37) node's or element's variable value over time
USERD_set_filenames (p. 42) filenames entered in GUI
USERD_set_time_step (p. 43) current time step
USERD_stop_part_building (p. 44) cleanup routine
Optional Routines Added for Later Releases of EnSight
USERD_get_extra_gui_defaults (p. 23) default values for the extra GUI members
USERD_get_extra_gui_numbers (p. 24) number of toggles, pulldowns and fields
USERD_get_num_xy_queries (p. 27) number of xy queries
USERD_get_reader_release (p. 32) release string of reader
USERD_get_var_extract_gui_defaults (p. 34) default values for the var_extract members
USERD_get_var_extract_gui_numbers (p. 35) number of toggles, pulldowns and fields
USERD_get_xy_query_data (p. 40) gets xy query xy values
USERD_get_xy_query_info (p. 40) gets xy query names, titles, num pairs, etc.
USERD_prefer_auto_distribute (p. 41) tells whether reader will distribute for SOS
USERD_set_extra_gui_data (p. 41) returns Extra GUI answers provided by user
USERD_set_filename_button_labels (p. 42) sets Get File button text
USERD_set_var_extract_gui_data (p. 43) returns var extract answers provided by user
USERD_set_var_extract_gui_data (p. 43) returns var extract answers provided by user
USERD_get_max_time_steps (p. 43) Maximum number of timesteps when dynamically
adding timesteps (e.g. if solution is ongoing)
USERD_get_var_by_component_given_coords (p. 139)get variable component value at a given coord
location
Order Routines are Called
2.2. Order Routines are Called

The various main operations are given basically in the order they will be performed. Within each oper-
ation, the order the routines will be called is given.
Called when library is loaded

1. Setting name in the graphical user interface, and specifying one or two input fields - called when
library is loaded.
USERD_get_name_of_reader (p. 26)
USERD_get_reader_descrip (p. 32) (optional)
USERD_prefer_auto_distribute (p. 41) (optional)
USERD_set_filename_button_labels (p. 42) (optional)
USERD_get_extra_gui_numbers (p. 24) (optional)
USERD_get_extra_gui_defaults (p. 23) (optional)
USERD_get_reader_release (p. 32) (optional)

Called once at initial data load when 'OK' pressed to load data
2. Setting filenames and getting time info
USERD_set_extra_gui_data (p. 41) (optional)
USERD_set_filenames (p. 42)
USERD_get_number_of_time_steps (p. 29)
USERD_get_solution_times (p. 34)
USERD_set_time_step (p. 43)
3. Gathering info for part builder
USERD_get_changing_geometry_status (p. 19)
USERD_get_node_label_status (p. 27)
USERD_get_element_label_status (p. 22)
USERD_get_number_of_files_in_dataset (p. 28)
USERD_get_dataset_query_file_info (p. 19)
USERD_get_description_lines (p. 20) (for geometry)
USERD_get_number_of_model_parts (p. 29)
USERD_get_part_build_info (p. 30)
USERD_get_number_of_global_nodes (p. 28)
USERD_get_global_coords (p. 25) (for model extents)
USERD_get_block_coords_by_component (p. 16) (for model extents)
4. Gathering Variable info
USERD_get_number_of_variables (p. 29)
USERD_get_variable_info (p. 36)
5. Part building (per part created)
USERD_get_global_coords (p. 25)
USERD_get_global_node_ids (p. 26)
USERD_get_element_connectivities_for_part (p. 21)
USERD_get_element_ids_for_part (p. 22)
USERD_get_block_iblanking (p. 16)
USERD_get_block_coords_by_component (p. 16)
USERD_stop_part_building (p. 44) (only once when part builder dialog is closed)
6. Loading variables
Calls for all constants at this point and not called again. (Nested loops, outer is over all
constants, inner is over all timesteps)
constants:
USERD_get_constant_value (p. 19)

Called when activated or when timestep changes
scalars:
USERD_get_description_lines (p. 20)
USERD_get_scalar_values (p. 33)
USERD_get_block_scalar_values (p. 17)
vectors:
USERD_get_description_lines (p. 20)
Detailed Specifications
USERD_get_vector_values (p. 38)

Called when timestep changes
7. Changing geometry
changing coords only:
changing connectivity:
USERD_get_part_build_info (p. 30)
USERD_get_global_node_ids (p. 26)
USERD_get_element_connectivities_for_part (p. 21)
USERD_get_element_ids_for_part (p. 22)

Called for node or element queries over time or at a specific node or element
8. Node or element queries over time
USERD_get_variable_value_at_specific (p. 37)
2.3. Detailed Specifications

Include files
The following header file is required in any file containing these library routines.
#include "global_extern.h"
And it references
#include "global_extern_proto.h"
Basis of arrays
Unless explicitly stated otherwise, all arrays are zero based - in true C fashion.
Global variables
You will generally need to have a few global variables which are shared by the various library routines.
The detailed specifications below have assumed the following are available. (Their names describe their
purpose, and they will be used in helping describe the details of the routines below).
static int Numparts_available = 0;

static int Num_unstructured_parts = 0;
static int Num_structured_blocks = 0;
/* Note: Numparts_available = Num_unstructured_parts + Num_structured_blocks */
static int Num_time_steps = 1;

static int Num_global_nodes = 0;
static int Num_variables = 0;
static int Num_dataset_files = 0;
static int Current_time_step = 0;
Dummy (or stub) routines
Those routines marked optional, need not be included in a reader. They are truly optional. All other
routines need to be included, but some can be dummy routines. As an example, if your data format
does not have structured data, then all the routines dealing with structured (block) parts can be dummy
routines.
The specifications for each routine in the API will now be given (routines are in alphabetical order):
2.3.1. USERD_bkup
/*--------------------------------------------------------------------
*
* Used in the archive process. Save or restore info relating to
* your user defined reader.
*
* (IN) archive_file = The archive file pointer
*
* (IN) backup_type = Z_SAVE_ARCHIVE for saving archive
* Z_REST_ARCHIVE for restoring archive
*
* returns: Z_OK if successful
* Z_ERR if not successful
*
* Notes:
* * Since EnSight's archive file is saved in binary form, it is
* suggested that you also do any writing to it or reading from it
* in binary.
*
* * You should archive any variables, that will be needed for
* future operations, that will not be read or computed again
* before they will be needed. These are typically global
* variables.
*
* * Make sure that the number of bytes that you write on a save and
* the number of bytes that you read on a restore are identical!!
*
* * And one last reminder. If any of the variables you save are
* allocated arrays, you must do the allocations before restoring
* into them.
*
* =================================
* * SPECIAL NOTE FOR WINDOWS ONLY:
* Because our current implementation under windows needs to open and close files
* from within the reader .dll, a special structure (named USERD_globals) needs to
* be defined in the global space of your reader. This structure needs to be defined
* like: ------ -----
*
* #ifdef WIN32 (which includes 32 bit and 64 bit windows)
* W32EXPORT struct _USERD_globals {
* char arch_filename[256];
* unsigned long arch_fileptr;
* } USERD_globals;
* #endif
*
* This structure will be bound when the reader .dll is loaded and will be used to
* store the archive file name and the current offset therein.
* Again for windows only, you need to ignore the archive_file pointer in the
* argument list and instead open and close the arch_filename file as well as keep
* the arch_fileptr offset current in this routine.
*
* So first define the USERD_globals structure at the beginning of your reader.
*
* Then, when an archive is saved, the following needs to be done in this routine:
* 1. open USERD_globals.arch_filename for appending (within #ifdef WIN32)
* 2. do your writes
* 3. close the file (within #ifdef WIN32)
*
* When an archive is restored, do the following in this routine:
* 1. open USERD_globals.arch_filename for reading,
* and fseek to USERD_globals.arch_fileptr offset (within #ifdef WIN32)
* 2. do your reads
* 3. save the new USERD_globals.arch_fileptr offset (using ftell),
* and close the file (within #ifdef WIN32)
*
* Here is some pseudo code to illustrate:
* ---------------------------------------
* switch(baskup_type) {
* case Z_SAVE_ARCHIVE:
*
* #ifdef WIN32
* archive_file = fopen(USERD_globals.arch_filename,"ab");
* #endif
*
* .
* .
* .
* #ifdef WIN32
* fclose(archive_file)
* #endif
*
* break;
*
* case Z_REST_ARCHIVE:
*
* #ifdef WIN32
* archive_file = fopen(USERD_globals.arch_filename,"rb");
* fseek(archive_file, USERD_globals.arch_fileptr, SEEK_SET);
* #endif
*
* .
* .
* .
*
* #ifdef WIN32
* USERD_globals.arch_fileptr = ftell(archive_file);
* #endif
*
* break;
* }
*
* And finally be aware of a current limitation of the
* Windows implementation of this routine:
* ---------------------------------------
* Because the structure uses a long for the file offset, the archive restore
* will not work when the offset to the information written in this routine
* is greater than 2 Gb, on 32 bit windows. On 64 bit windows there is no such
* limitation because the long is 64 bits.
*--------------------------------------------------------------------*/
int
USERD_bkup(FILE *archive_file,
int backup_type)
2.3.2. USERD_get_block_coords_by_component
/*--------------------------------------------------------------------
*
* Get the coordinates of a given block, component at a time
*
* (IN) block_number = The block number
*
* (1-based index of part table, namely:
*
* 1 ... Numparts_available.
*
* It is NOT the part_id label that is
* loaded in USERD_get_part_build_info)
*
* (IN) which_component = Z_COMPX if x component wanted
* = Z_COMPY if y component wanted
* = Z_COMPZ if z component wanted
*
* (OUT) coord_array = 1D array containing x,y, or z
* coordinate component of each node
*
* (Array will have been allocated
* i*j*k for the block long)
*
*
* Notes:
* * This will be based on Current_time_step
*
* * Not called unless Num_structured_blocks is > 0
*--------------------------------------------------------------------*/
int
USERD_get_block_coords_by_component(int block_number,
int which_component,
float *coord_array)
2.3.3. USERD_get_block_iblanking
/*--------------------------------------------------------------------
*
* Get the iblanking value at each node of a block - If Z_IBLANKED
*
*
*
*
*
* (OUT) iblank_array = 1D array containing iblank value
* for each node.
*

*
* possible values are: Z_EXT = exterior (outside)
* Z_INT = interior (inside)
* Z_BND = boundary
* Z_INTBND = internal boundary
* Z_SYM = symmetry plane
*
*
* Notes:
*
* * Not called unless Num_structured_blocks is > 0 and you have
* some iblanked blocks
*--------------------------------------------------------------------*/
int
USERD_get_block_iblanking(int block_number,
int *iblank_array)
2.3.4. USERD_get_block_scalar_values
/*--------------------------------------------------------------------
*
* if Z_PER_NODE:
* Get the values at each node of a block, for a given scalar
* variable.
*
* or if Z_PER_ELEM:
* Get the values at each element of a block, for a given scalar
* variable.
*
* (IN) block_number Since EnSight Version 7.4:
* --------------------------
* = The block number
*
*
*
*
* Prior to EnSight 7.4:
* ---------------------
* = The block id label
*
* It is the part_id label that was
* loaded in USERD_get_part_build_info
*
* It is NOT the 1-based index of the
* part table that is used in geometry routines.
*
* (IN) which_scalar = The variable "number" to get (1 ... Num_variables)
* (OUT) scalar_array = 1D array containing scalar values
* for each node or element.
*
* Array will have been allocated:
*
* if Z_PER_NODE:
* i*j*k for the block long
*
* if Z_PER_ELEM:
* (i-1)*(i-1)*(k-1) for the block long
*
*
* Notes:
*
* * Not called unless Num_structured_blocks is > 0,
* Num_variables is > 0, and there are some scalar type variables
*
* * The per_node or per_elem classification must be obtainable from the
* variable number (a var_classify array needs to be retained)
*--------------------------------------------------------------------*/
int
USERD_get_block_scalar_values(int block_number,
int which_scalar,
float *scalar_array)
2.3.5. USERD_get_block_vector_values_by_component
/*--------------------------------------------------------------------
* if Z_PER_NODE:
* Get the values at each node of a block, for a given vector
* variable, one component at a time.
*
* or if Z_PER_ELEM:
* Get the values at each element of a block, for a given vector
* variable, one component at a time.
*
* (IN) block_number Since EnSight Version 7.4:
* --------------------------
* = The block number
*
*
*
*
* Prior to EnSight 7.4:
* ---------------------
* = The block id label
*
* It is the part_id label that was
* loaded in USERD_get_part_build_info
*
* It is NOT the 1-based index of the
* part table that is used in geometry routines.
*
* (IN) which_vector = The variable "number" to get (1 ... Num_variables)
*
*
* (OUT) vector_array = 1D array containing vector
* component value for each node or element.
*
* Array will have been allocated:
*
* if Z_PER_NODE:
* i*j*k for the block long
*
* if Z_PER_ELEM:
* (i-1)*(i-1)*(k-1) for the block long
*
*
* Notes:
*
* * Not called unless Num_structured_blocks is > 0,

* Num_variables is > 0, and there are some vector type variables
*
*
*--------------------------------------------------------------------*/
int
USERD_get_block_vector_values_by_component(int block_number,
int which_vector,
float *vector_array)
2.3.6. USERD_get_changing_geometry_status
/*--------------------------------------------------------------------
*
* Gets the changing geometry status
*
* returns: Z_STATIC if geometry does not change
* Z_CHANGE_COORDS if changing coordinates only
* Z_CHANGE_CONN if changing connectivity
*
* Notes:
* * EnSight does not support changing number of parts, nor changing
* changing number of variables. But the coords and/or the
* connectivity of the parts can change.
*--------------------------------------------------------------------*/
int
USERD_get_changing_geometry_status( void )
2.3.7. USERD_get_constant_value
/*--------------------------------------------------------------------
*
* Get the value of a constant at a time step
*
* (IN) which_var = Which variable (this is the same
* implied variable
* number used in other
* functions.)
* (1 ... Num_variables)
*
* returns: value of the requested constant variable
*
* Notes:
*--------------------------------------------------------------------*/
float
USERD_get_constant_value(int which_var)
2.3.8. USERD_get_dataset_query_file_info
/*--------------------------------------------------------------------
*
* Get the information about files in the dataset. Used for the
* dataset query option.
*
* (OUT) qfiles = Structure containing information about each file
* of the dataset. The Z_QFILES structure is defined
* in the global_extern.h file
*
* (The structure will have been allocated
* Num_dataset_files long, with 10 description

* lines per file).
*
* qfiles[].name = The name of the file
* (Z_MAXFILENP is the dimensioned length
* of the name)
*
* qfiles[].sizeb = The number of bytes in the file
* (Typically obtained with a call to the
* "stat" system routine)
*
* qfiles[].timemod = The time the file was last modified
* (Z_MAXTIMLEN is the dimesioned length
* of this string)
*
* qfiles[].num_d_lines = The number of description lines you
* are providing from the file. Max = 10
*
* qfiles[].f_desc[] = The description line(s) per file,
* qfiles[].num_d_lines of them
* (Z_MAXFILENP is the allocated length of
* each line)
*
*
* Notes:
* * If Num_dataset_files is 0, this routine will not be called.
*--------------------------------------------------------------------*/
int
USERD_get_dataset_query_file_info(Z_QFILES *qfiles)
2.3.9. USERD_get_description_lines
/*--------------------------------------------------------------------
*
* Get two description lines associated with geometry per time step,
* or one description line associated with a variable per time step.
*
* (IN) which_type = Z_GEOM for geometry
* = Z_VARI for variable
*
* (IN) which_var = If it is a variable, which one.
* Ignored if geometry type.
*
* (OUT) line1 = The 1st geometry description line,
* or the variable description line.
*
* (OUT) line2 = The 2nd geometry description line
* Not used if variable type.
*
*
* Notes:
*
* * These are the lines EnSight can echo to the screen in
* annotation mode.
*--------------------------------------------------------------------*/
int
USERD_get_description_lines(int which_type,
int which_var,
char line1[Z_BUFL],
char line2[Z_BUFL])
2.3.10. USERD_get_element_connectivities_for_part
/*--------------------------------------------------------------------
* Gets the connectivities for the elements of a part
*
* (IN) part_number = The part number
*
*
*
* It is NOT the part_id label that
* is loaded in USERD_get_part_build_info)
*
* (OUT) conn_array = 3D array containing connectivity
* of each element of each type.
*
* Z_MAXTYPE by num_of_elements of
* each type by connectivity length
* of each type)
*
* ex) If num_of_elements[Z_TRI03] = 25
* num_of_elements[Z_QUA04] = 100
* num_of_elements[Z_HEX08] = 30
* as obtained in:
* USERD_get_part_build_info
*
* Then the allocated dimensions available
* for this routine will be:
* conn_array[Z_TRI03][25][3]
* conn_array[Z_QUA04][100][4]
* conn_array[Z_HEX08][30][8]
*
*
* Notes:
*
* * Not called unless Num_unstructured_parts is > 0
*
* The coord_array loaded in USERD_get_global_coords is zero-based,
* but within EnSight it will become a one-based array.
* Thus, coord_array[0] will be accessed by node 1 from the conn_array,
* coord_array[1] will be accessed by node 2 from the conn_array, etc.
* ex) Given a model of two triangles, you should load coord_array in
* USERD_get_global_coords as follows:
*
* node coordinates
* ---- -----------
* 4 --------- 3 1 coord_array[0].xyz[0] = 0.0
* |\ | coord_array[0].xyz[1] = 0.0
* | \ T2 | coord_array[0].xyz[2] = 0.0
* | \ |
* | \ | 2 coord_array[1].xyz[0] = 1.0
* | \ | coord_array[1].xyz[1] = 0.0
* | \ | coord_array[1].xyz[2] = 0.0
* | \ |
* | T1 \ | 3 coord_array[2].xyz[0] = 1.0
* | \| coord_array[2].xyz[1] = 1.6
* 1 --------- 2 coord_array[2].xyz[2] = 0.0
*
* 4 coord_array[3].xyz[0] = 0.0
* coord_array[3].xyz[1] = 1.6
*
*
* And conn_array here as follows:
*
* Triangle Connectivity
* -------- ------------
* T1 conn_array[Z_TRI03][0][0] = 1
* conn_array[Z_TRI03][0][1] = 2
*
*
*--------------------------------------------------------------------*/
int
USERD_get_element_connectivities_for_part(int part_number,
int **conn_array[Z_MAXTYPE])
2.3.11. USERD_get_element_ids_for_part
/*--------------------------------------------------------------------
*
* Gets the ids for the elements of a part
*
*
*
*
*
* (OUT) elemid_array = 2D array containing id of each
* element of each type.
*
* Z_MAXTYPE by num_of_elements of
* each type)
*
* ex) If num_of_elements[Z_TRI03] = 25
* num_of_elements[Z_QUA04] = 100
* num_of_elements[Z_HEX08] = 30
* as obtained in:
* USERD_get_part_build_info
*
* elemid_array[Z_TRI03][25]
* elemid_array[Z_QUA04][100]
* elemid_array[Z_HEX08][30]
*
*
* Notes:
*
* * Not called unless Num_unstructured_parts is > 0 and element
* label status is TRUE
*--------------------------------------------------------------------*/
int
USERD_get_element_ids_for_part(int part_number,
int *elemid_array[Z_MAXTYPE])
2.3.12. USERD_get_element_label_status
/*--------------------------------------------------------------------
*
* Answers the question as to whether element labels will be provided.
*
* returns: TRUE if element labels are available
* FALSE if no element labels
*
* Notes:
* * These are needed in order to do any element querying, or
* element labeling on-screen.
*
* For unstructured parts, you can read them from your file if
* available, or can assign them, etc. They need to be unique
* per part, and are often unique per model.
*
* USERD_get_element_ids_for_part is used to obtain the ids,
* on a part by part basis, if TRUE status is returned here.
*
* For structured parts, EnSight will assign ids if you return a
* status of TRUE here. You cannot assign them youself!!
*--------------------------------------------------------------------*/
int
USERD_get_element_label_status( void )
2.3.13. USERD_get_extra_gui_defaults
/*--------------------------------------------------------------------------
* <optional>
*--------------------------------------------------------------------------
*
* This routine defines the Titles, status, List choices, strings, etc that
* are fed up to the GUI.
*
* (OUT) toggle_Title = title for each toggle
* array dimension is
* [num_toggles] by [Z_LEN_GUI_TITLE_STR] long
*
* (OUT) toggle_default_status = Setting for each toggle (TRUE or FALSE)
* array dimension is [num_toggles] long
*
* (OUT) pulldown_Title = title for each pulldown
* [num_pulldowns] by [Z_LEN_GUI_TITLE_STR] long
*
* (OUT) pulldown_number_in_list = number of items in each pulldown
* array dimension is [num_pulldowns] long
*
* (OUT) pulldown_default_selection = item selection for each pulldown
*
* (OUT) pulldown_item_strings = pulldown item strings
* array is [num_pulldowns] by
* [Z_MAX_NUM_GUI_PULL_ITEMS] by
* [Z_LEN_GUI_PULL_STR] long
*
* (OUT) field_Title = title for each field
* [num_fields] by [Z_LEN_GUI_TITLE_STR] long
*
* (OUT) field_user_string = content of the field
*
*
* Notes:
* * The library is loaded, this routine is called,
* then the library is unloaded.
*
* * Do not define globals in this routine as when the library is unloaded,
* you'll lose them.
* ----------------------------------------------- */
int USERD_get_extra_gui_defaults(char **toggle_Title,
int *toggle_default_status,
char **pulldown_Title,
int *pulldown_number_in_list,
int *pulldown_default_selection,
char ***pulldown_item_strings,
char **field_Title,
char **field_user_string)
2.3.14. USERD_get_extra_gui_numbers
/*--------------------------------------------------------------------
* <optional>
* -------------------------------------------------------------------
*
* The Enhanced GUI routines are added to allow the user to customize a
* portion of the Data Reader dialog to pass in options to their user
* defined reader.
*
* This routine defines the numbers of toggles, pulldowns & fields
*
* (OUT) num_Toggles = number of toggles that will be provided
*
* (OUT) num_pulldowns = number of pulldowns that will be provided
*
* (OUT) num_fields = number of fields that will be provided
*
* Notes:
* * There are three routines that work together:
* USERD_get_extra_gui_numbers
* USERD_get_extra_gui_defaults (this one)
* USERD_set_extra_gui_data
*
* The existence of these routine indicates that
* you wish to add customize entries to the
* Data Reader dialog.
*
* If you don't want the extra GUI features,
* simply delete these routines, or change their
* names to something such as
* USERD_DISABLED_get_extra_gui_defaults
*
* The presence of these routines
* will ensure that EnSight will call them and
* use their data to modify the Data Reader dialog
* with some or all of the following:
* toggles, pulldown menu and fields.
*
* The user can then interact with the enhanced
* GUI and then send their choices to
*
* Therefore if USERD_get_extra_gui_numbers
* exists then the other two must exist.
*
* If none exist, then the GUI will be unchanged.
*
* Toggle data will return an integer
* TRUE if checked
* FALSE if unchecked
*
* Pulldown menu will return an integer representing
* the menu item selected
*
* Field will return a string Z_LEN_GUI_FIELD_STR long.
*
* If all the enhanced GUI features are enabled it
* might look something like this
*
*
*
* =====================================================
*
* [ ] Title 1
* [X] Title 3
* [X] Title 2
* [X] Title 4
*
* Pulldown Menu ->
* Menu Choice 1
* Menu Choice 2
* Menu Choice 3
*
* Data Field Title 1 ____________________________
*
* Data Field Title 2 ____________________________
*
* =====================================================
*
* * The following are defined in the global_extern.h
* Z_MAX_NUM_GUI_PULL_ITEMS max num GUI pulldowns
* Z_LEN_GUI_PULL_STR max length of GUI pulldown string
* Z_LEN_GUI_FIELD_STR max length of field string
* Z_LEN_GUI_TITLE_STR max length of title string
*
*
* you'll lose them.
*---------------------------------------------------------------------------*/
void USERD_get_extra_gui_numbers(int *num_Toggles,
int *num_pulldowns,
int *num_fields)
2.3.15. USERD_get_global_coords
/*--------------------------------------------------------------------
* Get the global coordinates
*
* (OUT) coord_array = 1D array of CRD structures,
* which contains x,y,z coordinates
* of each node.
*
* Num_global_nodes long)
*
* For reference, this structure (which is in global_extern) is:
*
* typedef struct {
* float xyz[3];
* }CRD;
*
*
*
* Notes:
*
*
* The coord_array is zero-based, but within EnSight it will become
* a one-based array.
* Thus, coord_array[0] will be accessed by node 1 from the conn_array,
* coord_array[1] will be accessed by node 2 from the conn_array, etc.
*
* ex) Given a model of two triangles, you should load coord_array as

* follows:
*
* node coordinates
* ---- -----------
* 4 --------- 3 1 coord_array[0].xyz[0] = 0.0
* |\ | coord_array[0].xyz[1] = 0.0
* | \ T2 | coord_array[0].xyz[2] = 0.0
* | \ |
* | \ | 2 coord_array[1].xyz[0] = 1.0
* | \ | coord_array[1].xyz[1] = 0.0
* | \ | coord_array[1].xyz[2] = 0.0
* | \ |
* | T1 \ | 3 coord_array[2].xyz[0] = 1.0
* | \| coord_array[2].xyz[1] = 1.6
* 1 --------- 2 coord_array[2].xyz[2] = 0.0
*
* 4 coord_array[3].xyz[0] = 0.0
*
*
* And conn_array in USERD_get_element_connectivities_for_part
* as follows:
*
* Triangle Connectivity
* -------- ------------
*
*
*--------------------------------------------------------------------*/
int
USERD_get_global_coords(CRD *coord_array)
2.3.16. USERD_get_global_node_ids
/*--------------------------------------------------------------------
*
* Get the global nodeids
*
* (OUT) nodeid_array = 1D array containing node ids of
* each node. The ids must be > 0
*
*
*
* Notes:
*
* * Not called unless Num_unstructured_parts is > 0 and
* node label status is TRUE
*--------------------------------------------------------------------*/
int
USERD_get_global_node_ids(int *nodeid_array)
2.3.17. USERD_get_name_of_reader
/*--------------------------------------------------------------------
*
* Gets the name of your user defined reader. The user interface will
* ask for this and include it in the available reader list.
*
* (OUT) reader_name = the name of the reader (data format)
* (max length is Z_MAX_USERD_NAME, which
* is 20)
*
* (OUT) *two_fields = FALSE if only one data field is
* required.
* TRUE if two data fields required
*
*
*
* Notes:
* * Always called. Provide a name for your custom reader format
*
* * If you don't want a custom reader to show up in the data dialog
* choices, return a name of "No_Custom"
*--------------------------------------------------------------------*/
int
USERD_get_name_of_reader(char reader_name[Z_MAX_USERD_NAME],
int *two_fields)
2.3.18. USERD_get_node_label_status
/*--------------------------------------------------------------------
*
* Answers the question as to whether node labels will be provided
*
* returns: TRUE if node labels are available
* FALSE if no node labels
*
* Notes:
* * These are needed in order to do any node querying, or node
* labeling on-screen .
*
* per part, and are often unique per model. They must also be
* positive numbers greater than zero.
*
* USERD_get_global_node_ids is used to obtain the ids, if the
* status returned here is TRUE.
*
* Also be aware that if you say node labels are available,
* the connectivity of elements must be according to these
* node ids.
*
* status of TRUE here. You cannot assign them yourself!!
*--------------------------------------------------------------------*/
int
USERD_get_node_label_status( void )
2.3.19. USERD_get_num_xy_queries
/*--------------------------------------------------------------------
* <optional>
*--------------------------------------------------------------------
*
* Get the total number of xy queries in the dataset.
*
* returns: the total number of xy queries in the dataset
*
* Notes:
* * You can be as complete as you want about this. If you don't
* care about xy queries, return a value of 0
* If you only want certain xy queries, you can just include them. But,
* you will need to supply the info and data USERD_get_xy_query_info
* and USERD_get_xy_query_data for each xy query you include here.
*--------------------------------------------------------------------*/
int
USERD_get_num_xy_queries( void )
2.3.20. USERD_get_number_of_files_in_dataset
/*--------------------------------------------------------------------
*
* Get the total number of files in the dataset. Used for the
*
* returns: the total number of files in the dataset
*
* Notes:
* care about the dataset query option, return a value of 0
* If you only want certain files, you can just include them. But,
* you will need to supply the info in USERD_get_dataset_query_file_info
* for each file you include here.
*
* * Num_dataset_files would be set here
*--------------------------------------------------------------------*/
int
USERD_get_number_of_files_in_dataset( void )
2.3.21. USERD_get_number_of_global_nodes
/*--------------------------------------------------------------------
*
* Gets the number of global nodes, used for unstructured parts
*
* returns: number of global nodes (>=0 if okay, <0 if problems)
*
* Notes:
*
* * For unstructured data:
* EnSight wants 1. A global array of nodes
* 2. Element connectivities by part, which
* reference the node numbers of the global
* node array.
* IMPORTANT:
* ---------
* If you provide node ids, then element connectivities
* must be in terms of the node ids. If you do not
* provide node ids, then element connectivities must be
* in terms of the index into the node array, but shifted
* to start at 1
*
*
* * Num_global_nodes would be set here
*--------------------------------------------------------------------*/
int
USERD_get_number_of_global_nodes( void )
2.3.22. USERD_get_number_of_model_parts
/*-------------------------------------------------------------------
*
* Gets the total number of unstructured and structured parts
* in the model, for which you can supply information.
*
* returns: num_parts (>0 if okay, <=0 if probs)
*
* Notes:
* * If going to have to read down through the parts in order to
* know how many, you may want to build a table of pointers to
* the various parts, so can easily get to particular parts in
* later processes. If you can simply read the number of parts
* at the head of the file, then you would probably not build the
* table at this time.
*
* * This routine would set Numparts_available, which is equal to
* Num_unstructured_parts + Num_structured_blocks.
*-------------------------------------------------------------------*/
int
USERD_get_number_of_model_parts( void )
2.3.23. USERD_get_number_of_time_steps
/*--------------------------------------------------------------------
*
* Get the number of time steps of data available.
*
* returns: number of time steps (>0 if okay, <=0 if problems).
*
* Notes:
* * This should be >= 1 1 indicates a static problem
* >1 indicates a transient problem
*
* * Num_time_steps would be set here
*
* SPECIAL NOTE: Normally this routine is called just once through the normal
* pipeline.
*
* However, if 1) a USERD_get_max_time_steps routine is implemented,
* and 2) the USERD_get_max_time_steps routine returns a
* value greater than 1,
* and 3) the user hits the GUI button that calls for time to
* be reloaded.
*
* Then this routine will be called again, indicating that it
* is being called for a reload purpose. Basically a
* "co-processing" purpose. Then this routine must also do
* the following:
*
* a) Go get the new current number of time steps.
* b) Ensure that when USERD_get_sol_times is called again,
* that the new solution times are included.
*--------------------------------------------------------------------*/
int
USERD_get_number_of_time_steps( void )
2.3.24. USERD_get_number_of_variables
/*--------------------------------------------------------------------
*
* Get the number of variables for which you will be providing info.
*
* returns: number of variables (includes constant, scalar, vector,

* and tensor types)
* >=0 if okay
* <0 if problem
*
* Notes:
* * Variable numbers, by which references will be made, are implied
* here. If you say there are 3 variables, the variable numbers
* will be 1, 2, and 3.
*
* * Num_variables would be set here
*--------------------------------------------------------------------*/
int
USERD_get_number_of_variables( void )
2.3.25. USERD_get_part_build_info
/*--------------------------------------------------------------------
*
* Gets the info needed for part building process
*
* (OUT) part_id = Array containing part ids for
* each of the model parts.
*
* IMPORTANT:
* Parts ids must be >= 1, because
* of the way the GUI uses them
*
* example: If Numparts_available = 3 (num_parts in the
* USERD_get_number_of_model_parts
* routine)
*
* table index part_id
* ----------- -------
* 1 13
* 2 57
* 3 125
*
* *******************************************
* Previous to version 7.4 of EnSight, there is
* an inconsistency in the way that parts are
* referenced in the arguments to various routines
* in this API. This inconsistency doesn't matter
* whenever your parts are 1,2,3,... And thus
* most of you have never noticed the problem.
*
* The ids provided here are the numbers by
* which the parts will be referred to in the
* GUI (if possible). Starting with EnSight
* version 7.4, they are treated only as labels
* in the GUI.
*
* Starting with EnSight 7.4, all routines which have "part_number",
* "block_number", or "which_part" as arguments - are expecting the
* table index (1,2,3).
*
* Prior to EnSight 7.4, the arguments "part_number", "block_number",
* or "which_part" refer to:
* the table index (1,2,3) for the following routines:
* USERD_get_element_connectivities_for_part
* USERD_get_element_ids_for_part
* USERD_get_block_coords_by_component
* USERD_get_block_iblanking
*
* but, to the part_id labels (12,57,125) for the following routines:
* USERD_get_scalar_values
* USERD_get_vector_values
* USERD_get_block_scalar_values
* USERD_get_block_vector_values_by_component
* USERD_get_variable_value_at_specific
* ********************************************
*
* Numparts_available long)
*
*
*
* (OUT) part_types = Array containing one of the
* following for each model part:
*
* Z_UNSTRUCTURED or
* Z_STRUCTURED or
* Z_IBLANKED
*
*
* (OUT) part_description = Array containing a description
* for each of the model parts
*
* Numparts_available by Z_BUFL long)
*
* (OUT) number_of_elements = 2D array containing number of
* each type of element for each
* unstructured model part.
* ------------
* Possible types are:
*
* Z_POINT = point
* Z_BAR02 = 2-noded bar
* Z_TRI03 = 3-noded triangle
* Z_QUA04 = 4-noded quadrilateral
* Z_TET04 = 4-noded tetrahedron
* Z_PYR05 = 5-noded pyramid
* Z_PEN06 = 6-noded pentahedron
* Z_HEX08 = 8-noded hexahedron
*
* (Ignored unless Z_UNSTRUCTURED type)
*
* Numparts_available by
* Z_MAXTYPE long)
*
* (OUT) ijk_dimensions = 2D array containing ijk dimensions
* for each structured model part.
* ----------
* (Ignored if Z_UNSTRUCTURED type)
*
* Numparts_available by 3 long)
*
* ijk_dimensions[][0] = I dimension
* ijk_dimensions[][1] = J dimension
* ijk_dimensions[][2] = K dimension
*
* (OUT) iblanking_options = 2D array containing iblanking
* options possible for each
* structured model part.
* ----------
* (Ignored unless Z_IBLANKED type)
*
*
* iblanking_options[][Z_EXT] = TRUE if external (outside)
* [][Z_INT] = TRUE if internal (inside)
* [][Z_BND] = TRUE if boundary
* [][Z_INTBND] = TRUE if internal boundary
* [][Z_SYM] = TRUE if symmetry surface
*
*
*
* Notes:
* * If you haven't built a table of pointers to the different parts,
* you might want to do so here as you gather the needed info.
*
*--------------------------------------------------------------------*/
int
USERD_get_part_build_info(int *part_id,
int *part_types,
char *part_description[Z_BUFL],
int *number_of_elements[Z_MAXTYPE],
int *ijk_dimensions[3],
int *iblanking_options[6])
2.3.26. USERD_get_reader_descrip
/*--------------------------------------------------------------------
* <optional>
*
* Gets the description of the reader, so gui can give more info
*
* (OUT) reader_descrip = the description of the reader
* (max length is MAXFILENP, which
* is 255)
*
*
* Notes:
* * OPTIONAL ROUTINE!
*--------------------------------------------------------------------*/
int
USERD_get_reader_descrip(char descrip[Z_MAXFILENP])
2.3.27. USERD_get_reader_release
/*--------------------------------------------------------------------
* <optional>
*
* Gets the release string for the reader.
*
* This release string is a free-format string which is for
* informational purposes only. It is often useful to increment
* the release number/letter to indicate a change in the reader.
* The given string will simply be output by the EnSight server
* when the reader is selected.
*
* (OUT) release_number = the release number of the reader
* is 20)
*
*
* Notes:
* * Called when the reader is selected for use.

*--------------------------------------------------------------------*/
int
USERD_get_reader_release(char version_number[Z_MAX_USERD_NAME])
2.3.28. USERD_get_scalar_values
/*--------------------------------------------------------------------
*
* if Z_PER_NODE:
* Get the values at each global node for a given scalar variable.
*
* or if Z_PER_ELEM:
* Get the values at each element of a specific part and type for a
* given scalar variable.
*
* (IN) which_scalar = The variable "number" to get
*
* (IN) which_part
*
* if Z_PER_NODE: Not used
*
* if Z_PER_ELEM: Since EnSight Version 7.4:
* --------------------------
* = The part number
*
*
*
*
*
* Prior to EnSight Version 7.4
* ----------------------------
* = The part id This is the part_id label loaded
* in USERD_get_part_build_info. It is
* NOT the part table index.
*
* (IN) which_type
*
*
* if Z_PER_ELEM: = The element type
*
* (OUT) scalar_array
*
* if Z_PER_NODE: = 1D array containing scalar values
* for each node.
*
*
* if Z_PER_ELEM: = 1d array containing scalar values for
* each element of a particular part & type.
*
* number_of_elements[which_part][which_type]
* long. See USERD_get_part_build_info)
*
*
* Notes:
*
* * Not called unless Num_unstructured_parts is > 0,
* Num_variables is > 0, and you have some scalar type variables

*
*
*--------------------------------------------------------------------*/
int
USERD_get_scalar_values(int which_scalar,
int which_part,
int which_type,
2.3.29. USERD_get_solution_times
/*--------------------------------------------------------------------
*
* Get the solution times associated with each time step.
*
* (OUT) solution_times = 1D array of solution times/time step
*
* Num_time_steps long)
*
*
* Notes:
* * These must be non-negative and increasing.
*--------------------------------------------------------------------*/
int
USERD_get_solution_times(float *solution_times)
2.3.30. USERD_get_var_extract_gui_defaults
/*--------------------------------------------------------------------------
* <optional>
*
* are fed up to the GUI for that after read situation. (It is very similar
* to the USERD_get_extra_gui_defaults routine, which occurs before the read)
*
*
*
*
*
*
*
*
*
*
* Notes:
*
* you'll lose them.
* ----------------------------------------------- */
int USERD_get_var_extract_gui_defaults(char **toggle_Title,
char **field_Title,
2.3.31. USERD_get_var_extract_gui_numbers
/*--------------------------------------------------------------------
* <optional>
*
* The Var_Extract GUI routines are added to allow the user to customize a
* extraction parameters for variable "after" the file has been read.
* These things can be modified and the variables will be updated/refreshed
* according to the new parameters.
* (It is similar to the USERD_get_extra_gui_numbers routine)
*
*
*
*
*
* Notes:
* USERD_get_var_extract_gui_numbers
* USERD_get_var_extract_gui_defaults
* USERD_set_var_extract_gui_data
*
* you wish to have the Var Extract capability.
*
* If you don't want the Var Extract GUI features,
* USERD_DISABLED_get_var_extract_gui_defaults
*
* use their data to modify the extraction parameters
*
* The user can then interact with the var extract portion of the
*
* Therefore if USERD_get_var_extract_gui_numbers
*
*
* TRUE if checked
*
*
*
*
*
* you'll lose them.
*-------------------------------------------------------------------------------*/
void USERD_get_var_extract_gui_numbers(int *num_Toggles,
int *num_pulldowns,
int *num_fields)
2.3.32. USERD_get_variable_info
/*--------------------------------------------------------------------
* Get the variable descriptions, types and filenames
*
* (OUT) var_description = Variable descriptions
*
* Num_variables by Z_BUFL long)
*
* variable description restrictions:
* ----------------------------------
* 1. Only first 19 characters used in EnSight.
* 2. Leading and trailing whitespace will be removed by EnSight.
* 3. Illegal characters will be replaced by underscores.
* 4. Thay may not start with a numeric digit.
* 4. No two variables may have the same description.
*
* (OUT) var_filename = Variable filenames
*
*
* (OUT) var_type = Variable type
*
* Num_variables long)
*
* types are: Z_CONSTANT
* Z_SCALAR
* Z_VECTOR
*
* (OUT) var_classify = Variable classification
*
*
* types are: Z_PER_NODE
* Z_PER_ELEM
*

*
* Notes:
* * The implied variable numbers apply, but be aware that the
* arrays are zero based.
* So for variable 1, will need to provide var_description[0]
* var_filename[0]
* var_type[0]
* var_classify[0]
*
* for variable 2, will need to provide var_description[1]
* var_filename[1]
* var_type[1]
* var_classify[1]
* etc.
*--------------------------------------------------------------------*/
int
USERD_get_variable_info(char **var_description,
char **var_filename,
int *var_type,
int *var_classify)
2.3.33. USERD_get_variable_value_at_specific
/*--------------------------------------------------------------------
* if Z_PER_NODE:
* Get the value of a particular variable at a particular node in a
* particular part at a particular time.
*
* or if Z_PER_ELEM:
* Get the value of a particular variable at a particular element of
* a particular type in a particular part at a particular time.
*
* (IN) which_var = Which variable (1 ... Num_variables)
*
* (IN) which_node_or_elem
*
* If Z_PER_NODE:
* = The node number. This is not the id, but is
* the index of the global node
* list (1 based), or the block's
* node list (1 based).
*
* Thus, coord_array[1]
* coord_array[2]
* coord_array[3]
* . |
* . |which_node_or_elem index
* . ----
*
*
* If Z_PER_ELEM:
* = The element number. This is not the id, but is
* the element number index
* of the number_of_element array
* (see USERD_get_part_build_info),
* or the block's element list
* (1 based).
*
* Thus, for which_part:
* conn_array[which_elem_type][0]
* . |
* . (which_node_or_elem - 1) index
* . ----
*
*
* (IN) which_part
*
* If Z_PER_NODE, or block part:
* = Not used
*
* If Z_PER_ELEM:
* Since EnSight Version 7.4:
* --------------------------
* = The part number
*
*
*
*
*
* ----------------------------
*
* (IN) which_elem_type
*
* = Not used
*
* If Z_PER_ELEM:
* = The element type. This is the element type index
* (see USERD_get_part_build_info)
*
* (IN) time_step = Time step to use (0 to Num_time_steps-1)
*
* (OUT) values = scalar or vector component value(s)
* values[0] = scalar or vector[0]
* values[1] = vector[1]
*
* Z_NOT_IMPLEMENTED if not implemented and want to use the slower,
* complete update method within EnSight.
*
* Notes:
* * This routine is used in node querys over time (or element querys over
* time for Z_PER_ELEM variables). If these operations are not critical
* to you, this can be a dummy routine.
*
*--------------------------------------------------------------------*/
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])
2.3.34. USERD_get_vector_values
/*--------------------------------------------------------------------
*
* if Z_PER_NODE:
* Get the values at each global node for a given vector variable.
*
* or if Z_PER_ELEM:
* Get the values at each element of a specific part and type for a
* given vector variable.
*
* (IN) which_vector = The variable "number" to get (1 ... Num_variables)
*
* (IN) which_part
*
*
* if Z_PER_ELEM: Since EnSight Version 7.4:
* --------------------------
* = The part number
*
*
*
*
*
* ----------------------------
*
* (IN) which_type
*
*
*
* (OUT) vector_array
*
* if Z_PER_NODE: = 1D array containing vector values
* for each node.
*
* 3 by Num_global_nodes long)
*
* Info stored in this fashion:
* vector_array[0] = xcomp of node 1
* vector_array[1] = ycomp of node 1
* vector_array[2] = zcomp of node 1
*
*
* etc.
*
* if Z_PER_ELEM: = 1d array containing vector values for
* each element of a particular part and type.
*
* 3 by number_of_elements[which_part][which_type]
* long. See USERD_get_part_build_info)
*
* vector_array[0] = xcomp of elem 1 (of part and type)
* vector_array[1] = ycomp of elem 1 "
* vector_array[2] = zcomp of elem 1 "
*
* vector_array[3] = xcomp of elem 2 "
*
* vector_array[6] = xcomp of elem 3 "

* etc.
*
*
* Notes:
*
* * Not called unless Num_unstructured_parts is > 0,
* Num_variables is > 0, and you have some vector type variables
*
*
*--------------------------------------------------------------------*/
int
USERD_get_vector_values(int which_vector,
int which_part,
int which_type,
2.3.35. USERD_get_xy_query_data
/*-----------------------------------------------------------------------------
* <optional>
*
* Gets the xy values for a particular xy_query
*
* (IN) query_num = query number (zero based)
* (0 to one less than the number of querys
* returned in USERD_get_num_xy_queries)
*
* (IN) num_vals = number of xy pairs in the query
*
* (OUT) xvals = array of x values
*
* (OUT) yvals = array of y values
*
* Z_ERR if a problem
*
* Notes:
*----------------------------------------------------------------------------*/
int USERD_get_xy_query_data(
int query_num,
int num_vals,
float *xvals,
float *yvals)
2.3.36. USERD_get_xy_query_info
/*----------------------------------------------------------------------------
* <optional>
*
* Gets name, axis titles, and number of xy pairs for a particular xy_query
*
*
* (OUT) query_name = Name for the xy query. (80 chars long)
*
* (OUT) query_xtitle = Title for x axis (80 chars long)
*
* (OUT) query_ytitle = Title for y axis (80 chars long)

*
* (OUT) query_num_pairs = number of xy pairs
*
*
* Notes:
*---------------------------------------------------------------------------*/
int USERD_get_xy_query_info(int query_num,
char *query_name,
char *query_xtitle,
char *query_ytitle,
int *query_num_pairs )
2.3.37. USERD_prefer_auto_distribute
/*--------------------------------------------------------------------
* <optional>
*
* Returns whether the reader will do its own partitioning for SOS
*
* returns: TRUE if reader prefers to do its own partitioning for SOS
* FALSE if EnSight will be asked to do the partitioning
* if an auto-distribute is specified
*
* Notes:
*-------------------------------------------------------------------*/
int
USERD_prefer_auto_distribute(void) {
2.3.38. USERD_set_extra_gui_data
/*----------------------------------------------------------------------------
* <optional>
*
* Receives the toggle, pulldown and field_text from enhanced GUI.
*
* (IN) toggle values TRUE = toggle checked
* FALSE = toggle unchecked
* Is num_Toggles long, as set in
*
* (IN) pulldown value from 0 to number of pulldown values
* Is num_pulldowns long, as set in
*
* (IN) field text any text
* '\0' if inactivated or nothing entered
* Is num_fields by Z_LEN_GUI_FIELD_STR, as set in
*
* Notes:
* This routine is called when the library is permanently
* loaded to the EnSight session, so define your globals
* in this and later routines.
*
* It's up to you to change your reader behavior according to
* user entries!
* -------------------------------------------------------------- */
void
USERD_set_extra_gui_data(int *toggle,
int *pulldown,
char **field_text)
2.3.39. USERD_set_filename_button_labels
/*--------------------------------------------------------------------
* <optional>
*
* Returns the labels that the EnSight GUI will place on the buttons
* in the Data Reader/Open dialog for Geometry and Results
*
* (OUT) filename_label_1 = Label for the first button
* (Z_MAX_USERD_NAME long)
* (generally the geom file)
*
* (OUT) filename_label_2 = Label for the second button
* (generally the results file)
* Not needed (so can be null) if two_fields
* is FALSE in USERD_get_name_of_reader
*
* Notes:
*---------------------------------------------------------------------*/
void
USERD_set_filename_button_labels(char filename_label_1[Z_MAX_USERD_NAME],
char filename_label_2[Z_MAX_USERD_NAME])
2.3.40. USERD_set_filenames
/*--------------------------------------------------------------------
*
* Receives the geometry and second text field entered in the data
* dialog. The user written code will have to store and use these
* as needed. The user written code must manage its own files!!
*
* (IN) filename_1 = the filename entered into the geometry
* field of the data dialog.
*
* (IN) filename_2 = The usage of this string depends on
* 'two_fields' in USERD_get_name_of_reader.
*
* If two_fields is FALSE then it's empty.
*
* If two_fields is TRUE, this is the
* manditory results file entered
* into the result field of the data dialog.
*
* (IN) the_path = the path info from the data dialog.
* Note: filename_1 and filename_2 have already
* had the path prepended to them. This
* is provided in case it is needed for
* filenames contained in one of the files
*
* (IN) swapbytes = TRUE if should swap bytes
* = FALSE normally
*
*
*
* Notes:
* * Since you must manage everything from the input that is entered in
* these data dialog fields, this is an important routine!
*
* * Since you manage these files, they can be whatever. Perhaps
* you will use only one, and have references to everything else
* you need within it, like EnSight6 does.
*--------------------------------------------------------------------*/
int
USERD_set_filenames(char filename_1[],
char param_2[],
char the_path[],
int swapbytes)
2.3.41. USERD_set_time_step
/*--------------------------------------------------------------------
*
* Set the current time step. All functions that need time, and
* that do not explicitly pass it in, will use this time step if
* needed.
*
* (IN) time_step - The current time step (0 to Num_time_steps-1)
*
* Note:
* * Current_time_step would be set here
*
* * This routine is called from the server exit_rout with a -1
* argument. This is the chance to clean up anything that
* should be cleaned up upon exit. Like temporary files....
*--------------------------------------------------------------------*/
void
USERD_set_time_step(int time_step)
2.3.42. USERD_set_var_extract_gui_data
/*----------------------------------------------------------------------------
* <optional>
*
* Receives the toggle, pulldown and field_text from var extract input.
*
*
*
*
* Notes:
*
* user entries!
* -------------------------------------------------------------- */
void
USERD_set_var_extract_gui_data(int *toggle,
int *pulldown,
char **field_text)
2.3.43. USERD_get_max_time_steps
/*--------------------------------------------------------------------
* USERD_get_max_time_steps -
*--------------------------------------------------------------------
*
* Get the max number of time steps for a changing timestep model.
* You must use this routine if you want EnSight to consider a growing
* number of timesteps.
*
* So its presence, and a maximum greater than 1 is needed to flag EnSight
* to actuall do a rereading of the timesteps when prompted to do so.
*
* returns: max number of time steps
*--------------------------------------------------------------------*/
int
USERD_get_max_time_steps( void )
2.3.44. USERD_stop_part_building
/*--------------------------------------------------------------------
*
* This routine called when the part building dialog is closed. It is
* provided in case you desire to release memory, etc. that was only needed
* during the part building process.
*--------------------------------------------------------------------*/
void
USERD_stop_part_building( void )
This chapter will describe the EnSight User Defined Reader Version 2.0 API. It was designed to be con-
siderably more efficient than the 1.0 API and has a number of new features that later versions of EnSight
can take advantage of.
If you are producing a new reader, or considering upgrading an existing version 1.0 API reader, please
see the discussion on the philosophical differences between the two API's in User Defined Reader
APIs (p. 1)
If you wish to convert an existing 1.0 API reader to the 2.0 API, see Converting a 1.0 API Reader to a 2.0
API READER (p. 170).
Reader (p. 3).
3.1. Quick Index of 2.0 Library Routines

Routine Name Optional Routine Description
Generally needed for UNSTRUCTURED data
USERD_get_part_coords (p. 112) Part's node coordinates
USERD_get_part_coords_in_buffers (p. 113) X Part's node coordinates in buffers.
(For unstructured autodistrib for SOS)

USERD_get_part_elements_by_type (p. 120) Part's element connectivities
USERD_get_part_elements_by_type_in_buffers (p. 121) X Part's element connectivities in
buffers.
(For unstructured autodistrib for SOS)

USERD_get_periodic_ghosts_num_pairs (p. 128) X Return the number of pairs of nodes for
each part periodic symmetry face
USERD_get_periodic_ghosts_pairs (p. 129) X Return the pairs for each symmetry face
Generally needed for BLOCK data
USERD_get_block_coords_by_component (p. 66) Block node coordinates
USERD_get_block_ghost_flags (p. 67) Block ghost cell flags
USERD_get_block_iblanking (p. 67) Block iblanking values
USERD_set_block_range_and_stride (p. 161) Sets the min, max, and stride of a block (if
doing structured cinching)
USERD_get_ghosts_in_block_flag (p. 83) Block ghost cell existence?
USERD_get_periodic_ghosts_structured_face_info (p. 130) X Returns face info for structured parts with
periodic symmetry

Generally needed for either or both kinds of data
USERD_bkup (p. 64) Archive routine
USERD_exit_routine (p. 66) Cleanup upon exit routine
USERD_get_border_availability (p. 68) Part border provided?
USERD_get_border_elements_by_type (p. 69) Part border conn & parent info
USERD_get_changing_geometry_status (p. 70) Changing geometry?
USERD_get_constant_per_part_data (p. 147) X Returns constant per part variable values
USERD_get_constant_val (p. 71) Constant variable's value
USERD_get_dataset_query_file_info (p. 71) Info about each model file
USERD_get_descrip_lines (p. 72) File associated descrip lines
USERD_get_element_label_status (p. 73) Element labels?
USERD_get_extra_gui_defaults (p. 73) X Gets the default values for the extra GUI
members
USERD_get_extra_gui_numbers (p. 74) X Gets the number of toggles, pulldowns
and fields
USERD_get_geom_timeset_number (p. 76) Timeset # to use for geom
USERD_get_gold_part_build_info (p. 76) Gets the info needed for part building
process
USERD_get_gold_variable_info (p. 81) Variable type/descrip etc
USERD_get_ghosts_in_model_flag (p. 84) Model contains ghost cells?
USERD_get_matf_escalars_desc (p. 84) X Gets material scalars description (Youngs
method)
USERD_get_matf_set_info (p. 84) Gets the material set indices and
names
USERD_get_matf_set_type (p. 85) X Gets the material set type
USERD_get_matf_var_info (p. 85) Gets the material indices and descriptions
USERD_get_matsp_info (p. 86) Gets material species id, descriptions, etc.
USERD_get_max_time_steps (p. 86) X Maximum number of timesteps when
dynamically adding timesteps (e.g. if
solution is ongoing)
USERD_get_maxsize_info (p. 87) Part/block allocation maximums
USERD_get_metadata (p. 89) provide xml metadata from reader up to
EnSight
USERD_get_model_extents (p. 91) Provide model bounding extents
USERD_get_name_of_reader (p. 91) Name of reader for GUI
USERD_get_nfaced_conn (p. 92) Gets the element connectivities for nfaced
elements (utilizes the number of nodes
per face obtained in
USERD_get_nfaced_nodes_per_face
USERD_get_nfaced_conn_in_buffers (p. 94) X Gets the element connectivities for nfaced
elements in buffers. (For unstructured
autodistrib for SOS)
Quick Index of 2.0 Library Routines

USERD_get_nfaced_nodes_per_face (p. 98) Gets the number of nodes per face for
nfaced elements (utilizes the number of
faces per element obtained in
USERD_get_part_ele-
ments_by_type)
USERD_get_node_label_status (p. 100) Node labels?
USERD_get_nsided_conn (p. 101) Gets the element connectivities for nsided
elements. (utilizes the number of nodes
per element obtained in
USERD_get_part_ele-
ments_by_type)
USERD_get_nsided_conn_in_buffers (p. 103) X Gets the element connectivities for nsided
elements in buffers. (For unstructured
USERD_get_num_of_time_steps (p. 106) Number of time steps
USERD_get_num_xy_queries (p. 106) X Number of xy queries
USERD_get_number_of_files_in_dataset (p. 107) Number of files in model
USERD_get_number_of_material_sets (p. 107) Number of material sets
USERD_get_number_of_materials (p. 110) Number of materials
USERD_get_number_of_model_parts (p. 110) Number of model parts
USERD_get_number_of_species (p. 111) Number of species
USERD_get_number_of_timesets (p. 111) Number of timesets
USERD_get_number_of_variables (p. 112) Number of variables
USERD_get_part_element_ids_by_type (p. 116) Part's element ids
USERD_get_part_element_ids_by_type_in_buffers (p. 117) X Part's element ids in buffers (For
unstructured autodistrib for SOS)
USERD_get_part_node_ids (p. 125) Part's node ids
USERD_get_part_node_ids_in_buffers (p. 125) X Part's node ids in buffers (For unstructured
USERD_get_periodic_ghosts_num_symmetry_faces (p. 128)X Returns the number of symmetry faces for
each part
USERD_get_reader_descrip (p. 133) X Provide GUI more description
USERD_get_reader_release (p. 133) X Release string of reader
USERD_get_reader_version (p. 134) Provide reader version number
USERD_get_sol_times (p. 134) Solution time values
USERD_get_structured_reader_cinching (p. 135) Tells if the reader will do structured
cinching
USERD_get_timeset_description (p. 135) Description of timeset
USERD_get_uns_failed_params (p. 136) Gets variable and thresholds/criteria for
failure
USERD_get_var_by_component (p. 137) Part or block variable values

USERD_get_var_by_component_given_coords (p. 139) X get variable component value at a given
coord location
USERD_get_var_by_component_in_buffers (p. 142) X Part or block variable values in buffers (For
unstructured autodistrib for SOS)
USERD_get_var_extract_gui_defaults (p. 148) X Gets the default values for the var_ex-
tract members
USERD_get_var_extract_gui_numbers (p. 149) X Gets the number of toggles, pulldowns
and fields
USERD_get_var_value_at_specific (p. 150) Node's or element's variable value over
time
USERD_get_var_value_at_xyz_specific (p. 152) ariable value over time at specific
coordinate
USERD_get_var_value_at_xyz_specific (p. 152) X Gets counts for number of vector vglyphs
USERD_get_vglyph_timeline_info (p. 153) X Gets vector vglyph timeline metadata
USERD_get_vglyph_timeline_times (p. 154) X Gets vector vglyph timeline times
USERD_get_vglyph_vector_info (p. 154) X Gets vector vglyph metadata
USERD_get_vglyph_vector_values (p. 155) X Gets vector vglyph component values
USERD_get_vglyph_vector_xyzloc (p. 155) X Gets vector vglyph xyz locations
USERD_get_xy_query_data (p. 156) X Gets xy query xy values
USERD_get_xy_query_info (p. 156) X Gets xy query names, titles, num pairs, etc.
USERD_load_matf_data (p. 157) Gets the material ids list,
mixed-material ids list, or
mixed-material values list
USERD_prefer_auto_distribute (p. 158) X Tells whether reader will distribute for SOS
USERD_rigidbody_existence (p. 159) Returns whether rigid body transformation
data exists for the model.
USERD_rigidbody_values (p. 159) Returns the euler and location values for
a given part
USERD_set_extra_gui_data (p. 162) X Returns the Extra GUI answers provided
by the user
USERD_set_filename_button_labels (p. 163) X Sets Get File button text
USERD_set_filenames (p. 163) Filenames entered in GUI
USERD_set_right_side (p. 164) X Informs the reader when the time set is
for the right side of a time span during
variable interpolation between time steps.
USERD_set_server_number (p. 164) Server which of how many
USERD_set_time_set_and_step (p. 165) Current timeset and time step
USERD_set_var_extract_gui_data (p. 165) X Returns the variable extract answers
provided by the user
USERD_size_matf_data (p. 166) Gets the length of either the material ids
list, mixed-material ids list, or
mixed-material values list
Order Routines Are Called

USERD_stop_part_building (p. 167) Cleanup after part build routine
USERD_use_periodic_ghosts (p. 167) X Returns whether any parts have periodic
symmetry
3.2. Order Routines Are Called

It is often helpful in the development of your reader to know what order the routines will be called.
The various main operations are given basically in the order they will be performed. Within each oper-
ation, the order the routines will be called is given.
1. Setting name in the graphical user interface, and specifying one or two input fields
USERD_get_reader_descrip (p. 133) (optional)
USERD_prefer_auto_distribute (p. 158) (optional)
USERD_set_filename_button_labels (p. 163) (optional)
USERD_get_extra_gui_numbers (p. 74) (optional)
USERD_get_extra_gui_defaults (p. 73) (optional)
USERD_get_reader_release (p. 133) (optional)
2. Getting the reader version (also distinguishes between API's)
USERD_get_reader_version (p. 134)
3. Setting filenames and getting timeset and time info
USERD_set_extra_gui_data (p. 162) (optional if reader has USERD_get_extra_gui_defaults (p. 73)

routine)
USERD_get_structured_reader_cinching (p. 135)
USERD_set_server_number (p. 164)
USERD_set_extra_gui_data (p. 162) (optional)
USERD_get_number_of_timesets (p. 111)
USERD_get_geom_timeset_number (p. 76)
for each timeset
USERD_get_timeset_description (p. 135)
USERD_get_max_time_steps (p. 86)
USERD_get_num_of_time_steps (p. 106)
USERD_get_sol_times (p. 134)
USERD_set_time_set_and_step (p. 165)
4. Gathering info for part builder
USERD_rigidbody_existence (p. 159)
USERD_get_descrip_lines (p. 72) (for geometry)
USERD_get_gold_part_build_info (p. 76)
USERD_get_ghosts_in_model_flag (p. 84)
USERD_get_maxsize_info (p. 87)
USERD_get_ghosts_in_block_flag (p. 83) (if any ghost cells in model)
USERD_get_model_extents (p. 91) -- or -- (for model extents)
USERD_get_part_coords (p. 112) -- and/or --
<USERD_set_block_range_and_stride (p. 161) > (if doing structured reader cinching)
USERD_get_uns_failed_params (p. 136)
5. Gathering variable info
USERD_get_gold_variable_info (p. 81)
6. Part building (per part created)
Both unstructured and structured
If unstructured part
USERD_get_part_coords (p. 112) -- or --
USERD_get_part_coords_in_buffers (p. 113) (optional)
USERD_rigidbody_values (p. 159) (optional)
USERD_get_part_node_ids (p. 125) -- or --
USERD_get_part_node_ids_in_buffers (p. 125) (optional)
USERD_get_part_element_ids_by_type (p. 116) - - or --
USERD_get_part_element_ids_by_type_in_buffers (p. 117) (optional)
USERD_get_part_elements_by_type (p. 120) -- or --
USERD_get_part_elements_by_type_in_buffers (p. 121) (optional)
If any nsided elements
USERD_get_nsided_conn (p. 101) -- or --
USERD_get_nsided_conn_in_buffers (p. 103) (optional)
If any nfaced elements
USERD_get_nfaced_nodes_per_face (p. 98)
USERD_get_nfaced_conn (p. 92) -- or --
USERD_get_nfaced_conn_in_buffers (p. 94) (optional)
else if structured part
<USERD_set_block_range_and_stride (p. 161) > (If doing structured reader cinching)
USERD_get_block_ghost_flags (p. 67) (If ghost cells in part)
USERD_get_part_node_ids (p. 125) (If node ids given)
USERD_get_part_element_ids_by_type (p. 116) (If element ids given)
both again
USERD_get_border_availability (p. 68) (If border representation is selected)
USERD_get_border_elements_by_type (p. 69) (If border representation is selected)
USERD_stop_part_building (p. 167) (only once when part builder dialog is closed)
7. Loading Variables
constants
USERD_get_constant_val (p. 71)
USERD_get_constant_per_part_data (p. 147)
scalars/vectors/tensors
USERD_get_descrip_lines (p. 72)
USERD_set_right_side (p. 164) (optional)
USERD_get_var_by_component (p. 137) -- or --
USERD_get_var_by_component_in_buffers (p. 142) (optional)
8. Changing geometry
changing coords only (per part)
changing connectivity (per part)
Both unstructured and structured
If unstructured part:
USERD_get_model_extents (p. 91) -- or --
USERD_get_part_coords (p. 112)
USERD_get_part_node_ids (p. 125) -- or --
USERD_get_part_node_ids_in_buffers (p. 125) (optional)
USERD_get_part_element_ids_by_type (p. 116) -- or --
USERD_get_part_element_ids_by_type_in_buffers (p. 117) (optional)
USERD_get_part_elements_by_type (p. 120) -- or --
USERD_get_part_elements_by_type_in_buffers (p. 121) (optional)
If any nsided elements:
USERD_get_nsided_conn (p. 101) -- or --
USERD_get_nsided_conn_in_buffers (p. 103) (optional)
If any nfaced elements:
USERD_get_nfaced_conn (p. 92) -- or --
USERD_get_nfaced_conn_in_buffers (p. 94) (optional)
else if structured part:
USERD_get_model_extents (p. 91) -- or --
USERD_get_block_ghost_flags (p. 67) (If ghost cells in part)
USERD_get_part_node_ids (p. 125) (If node ids given)
USERD_get_part_element_ids_by_type (p. 116) (If element ids given)
both again
USERD_get_border_availability (p. 68) (If border representation is selected)
USERD_get_border_elements_by_type (p. 69) (If border representation is selected)
9. Node or Element queries over time
USERD_get_var_value_at_specific (p. 150)
10. To see if materials in the model
USERD_get_number_of_material_sets (p. 107)
USERD_get_matf_set_info (p. 84)
If any material sets in the model (calls these once per material set)
USERD_get_number_of_materials (p. 110)
USERD_get_matf_var_info (p. 85)
USERD_get_matf_set_type (p. 85)
USERD_get_matf_escalars_desc (p. 84)
For each element type of each part containing material ids, calls
USERD_size_matf_data (p. 166)
USERD_load_matf_data (p. 157)
If there are any elements with mixed materials, when a domain or interface is created, calls these
again per part
11. To modify the variable extraction parameters and have the variables update accordingly.
USERD_get_var_extract_gui_numbers (p. 149)
USERD_get_var_extract_gui_defaults (p. 148)
USERD_set_var_extract_gui_data (p. 165)
12. To get vector vglyphs
USERD_get_var_value_at_xyz_specific (p. 152)
USERD_get_vglyph_timeline_info (p. 153)
USERD_get_vglyph_timeline_times (p. 154)
USERD_get_vglyph_vector_info (p. 154)
USERD_get_vglyph_vector_values (p. 155)
USERD_get_vglyph_vector_xyzloc (p. 155)
Routine History
3.3. Routine History

The following table is an alphabetical listing of the routines in the API. It indicates at which version the
routines appeared (or were modified). Additionally it indicates which routines are optional (OPT).
Routine Name O 2 2 2 2 2 2 2 2 2 2
P . . . . . . . . . .
T 0 0 0 0 0 0 0 0 0 1
0 1 3 4 5 6 7 8 9 0
USERD_bkup (p. 64) X X X X X X X X X X
USERD_exit_routine (p. 66) X X X X X X X X X X
USERD_get_block_coords_by_component (p. 66) X X X X X X X X X X
USERD_get_block_iblanking (p. 67) X X X X X X X X X X
USERD_get_block_ghost_flags (p. 67) X X X X X X X X X
USERD_get_border_availability (p. 68) X X X X X X X X X X
USERD_get_border_elements_by_type (p. 69) X X X X X X X X X X
USERD_get_changing_geometry_status (p. 70) X X X X X X X X X X
USERD_get_constant_val (p. 71) X X X X X X X X X X
USERD_get_dataset_query_file_info (p. 71) X X X X X X X X X X
USERD_get_descrip_lines (p. 72) X X X X X X X X X X
USERD_get_element_label_status (p. 73) X 1 X X X X X X X X
USERD_get_extra_gui_defaults (p. 73) X X X X X X X X X X X
USERD_get_extra_gui_numbers (p. 74) X X X X X X X X X X X
USERD_get_geom_timeset_number (p. 76) X X X X X X X X X X
USERD_get_gold_part_build_info (p. 76) X 2 3 X X X X X X X
USERD_get_gold_variable_info (p. 81) X X X X X X X X X X
USERD_get_ghosts_in_block_flag (p. 83) X X X X X X X X X
USERD_get_ghosts_in_model_flag (p. 84) X X X X X X X X X
USERD_get_matf_escalars_desc (p. 84) X X
USERD_get_matf_set_info (p. 84) X X X X X X X X
USERD_get_matf_set_type (p. 85) X X
USERD_get_matf_var_info (p. 85) X X X X X X X X
USERD_get_matsp_info (p. 86) X X X X X X
USERD_get_maxsize_info (p. 87) X 2 X X X X X X X X
USERD_get_model_extents (p. 91) X X X X X X X X X X
USERD_get_name_of_reader (p. 91) X X X X X X X X X X
USERD_get_nfaced_conn (p. 92) X X X X X X X X
USERD_get_nfaced_conn_in_buffers (p. 94) X X X X
USERD_get_nfaced_nodes_per_face (p. 98) X X X X X X X X
Routine Name O 2 2 2 2 2 2 2 2 2 2
P . . . . . . . . . .
T 0 0 0 0 0 0 0 0 0 1
0 1 3 4 5 6 7 8 9 0
USERD_get_node_label_status (p. 100) X 1 X X X X X X X X
USERD_get_nsided_conn (p. 101) X X X X X X X X
USERD_get_nsided_conn_in_buffers (p. 103) X X X X
USERD_get_num_of_time_steps (p. 106) X X X X X X X X X X
USERD_get_num_xy_queries (p. 106) X X X X
USERD_get_number_of_files_in_dataset (p. 107) X X X X X X X X X X
USERD_get_number_of_material_sets (p. 107) X X X X X X X X
USERD_get_number_of_materials (p. 110) X X X X X X X X
USERD_get_number_of_model_parts (p. 110) X X X X X X X X X X
USERD_get_number_of_species (p. 111) X X X X X X
USERD_get_number_of_timesets (p. 111) X X X X X X X X X X
USERD_get_number_of_variables (p. 112) X X X X X X X X X X
USERD_get_part_coords (p. 112) X X X X X X X X X X
USERD_get_part_coords_in_buffers (p. 113) X X X X
USERD_get_part_element_ids_by_type (p. 116) X 1 2 X X X X X X X
USERD_get_part_element_ids_by_type_in_buffers (p. 117) X X X X
USERD_get_part_elements_by_type (p. 120) X 1 2 X X X X X X X
USERD_get_part_elements_by_type_in_buffers (p. 121) X X X X
USERD_get_part_node_ids (p. 125) X 1 2 X X X X X X X
USERD_get_part_node_ids_in_buffers (p. 125) X X X X
USERD_get_reader_descrip (p. 133) X X X X X X X X X X X
USERD_get_reader_release (p. 133) X X X X X X X X X X X
USERD_get_reader_version (p. 134) X X X X X X X X X X
USERD_get_sol_times (p. 134) X X X X X X X X X X
USERD_get_structured_reader_cinching (p. 135) X X X X X
USERD_get_timeset_description (p. 135) X X X X X X X X X X
USERD_get_uns_failed_params (p. 136) X X X X X X X
USERD_get_var_by_component (p. 137) X 2 X X X X X X X X
USERD_get_var_by_component_in_buffers (p. 142) X X X X
USERD_get_var_extract_gui_defaults (p. 148) X X X X X X X
USERD_get_var_extract_gui_numbers (p. 149) X X X X X X X
USERD_get_var_value_at_specific (p. 150) X X X X X X X X X X
USERD_get_var_value_at_xyz_specific (p. 152) X X X
USERD_get_vglyph_timeline_info (p. 153) X X X
Routine History
Routine Name O 2 2 2 2 2 2 2 2 2 2
P . . . . . . . . . .
T 0 0 0 0 0 0 0 0 0 1
0 1 3 4 5 6 7 8 9 0
USERD_get_vglyph_timeline_times (p. 154) X X X
USERD_get_vglyph_vector_info (p. 154) X X X
USERD_get_vglyph_vector_values (p. 155) X X X
USERD_get_vglyph_vector_xyzloc (p. 155) X X X
USERD_get_xy_query_data (p. 156) X X X X
USERD_get_xy_query_info (p. 156) X X X X
USERD_load_matf_data (p. 157) X X X X X X X X
USERD_prefer_auto_distribute (p. 158) X X X X X
USERD_rigidbody_existence (p. 159) X X X X X X
USERD_rigidbody_values (p. 159) X X X 4 X X
USERD_set_block_range_and_stride (p. 161) X X X X X
USERD_set_extra_gui_data (p. 162) X X X X X X X X X X X
USERD_set_filename_button_labels (p. 163) X X X X X
USERD_set_filenames (p. 163) X X X X X X X X X X
USERD_set_right_side (p. 164) X X X X X X X
USERD_set_server_number (p. 164) X X X X X X X X X X
USERD_set_time_set_and_step (p. 165) X X X X X X X X X X
USERD_set_var_extract_gui_data (p. 165) X X X X X X X
USERD_size_matf_data (p. 166) X X X X X X X X
USERD_stop_part_building (p. 167) X X X X X X X X X X
Footnotes
1. Modifications due to user specified ids for structured blocks.
2. Additional valid ghost element types available.
3. Modifications for specification of structured ranges.
4. Added yaw, pitch, roll.
3.3.1. At Version 2.00

These routines existed in the original 2.00 version.
USERD_bkup (p. 64)
USERD_exit_routine (p. 66)
USERD_get_border_availability (p. 68)
USERD_get_border_elements_by_type (p. 69)
USERD_get_constant_val (p. 71)
USERD_get_extra_gui_defaults (p. 73) <optional>
USERD_get_extra_gui_numbers (p. 74) <optional>
USERD_get_gold_variable_info (p. 81)
USERD_get_model_extents (p. 91)
USERD_get_part_element_ids_by_type (p. 116)
USERD_get_part_elements_by_type (p. 120)
USERD_get_part_node_ids (p. 125)
USERD_get_reader_descrip (p. 133) <optional>
USERD_get_reader_release (p. 133) <optional>
Routine History
USERD_get_var_by_component (p. 137)
USERD_get_var_value_at_specific (p. 150)
USERD_set_extra_gui_data (p. 162) <optional>
USERD_stop_part_building (p. 167)

ADDED for Ghost Cell support:
USERD_get_block_ghost_flags (p. 67)
USERD_get_ghosts_in_block_flag (p. 83)
MODIFIED for user specified ids for structured blocks:
MODIFIED for Ghost Cell support:

ADDED to handle material sets:
ADDED to handle nsided and nfaced elements:
USERD_get_nfaced_conn (p. 92)
USERD_get_nsided_conn (p. 101)
MODIFIED so structured ranges can be specified:

ADDED to handle failed elements:
(Can implement to specify to EnSight, which variable is the failed element variable and what the
conditions of failure are)

ADDED to handle material species:
USERD_get_matsp_info (p. 86)
USERD_get_number_of_species (p. 111)
ADDED to handle variable extraction after a read:
(This is similar to Extra graphical user interface options, but will modify the variable extraction options
after the initial read - and update the variables accordingly)
USERD_get_var_extract_gui_defaults (p. 148) <optional>
USERD_get_var_extract_gui_numbers (p. 149) <optional>
USERD_set_var_extract_gui_data (p. 165) <optional>
ADDED to obtain rigid body values:
Routine History
(If you can provide euler parameters for rigid body motion of parts, you should implement these
routines)
USERD_rigidbody_values (p. 159)
ADDED to let reader know when on right side of a time interval for var values:
(When the current time is between 2 given time steps - requiring interpolation of variable values -
EnSight asks for the left then the right side values. For most readers, you never need to know this.
But, if you must do some efficient interpolation within the reader itself because of differing timelines
- this can be useful information)
USERD_set_right_side (p. 164) <optional>

ADDED to allow structured readers to deal with min, max, and stride in reader:
(To keep from having to send the entire non-strided block to EnSight - and having it then limit the
processing - you can implement this routine, and deal with the limiting and striding within the
reader itself. Allowing for lower memory requirements. If you want to use structured auto-distribute,
you must implement these routines.)
USERD_set_block_range_and_stride (p. 161)

ADDED to allow specification of whether the reader will auto distribute within itself for SOS:
(If your reader can (and will) partition based on which server of the total number of severs - you will
want to provide this routine)
USERD_prefer_auto_distribute (p. 158) <optional>
ADDED to allow readers to specify their own label for Set button in EnSight:
USERD_set_filename_button_labels (p. 163) <optional>

ADDED for efficient unstructured auto-distribute capability:
(If you want to be able to use the unstructured auto-distribute capability for SOS processing, in EnSight
8.2 or later, you should implement these routines):
Note:
These five routines are for normal elements. If any of them are implemented, they all
must be implemented.
USERD_get_part_coords_in_buffers (p. 113) <optional>
USERD_get_part_element_ids_by_type_in_buffers (p. 117) <optional>
USERD_get_part_elements_by_type_in_buffers (p. 121) <optional>
USERD_get_part_node_ids_in_buffers (p. 125) <optional>
USERD_get_var_by_component_in_buffers (p. 142) <optional>
This one routine for nsided elements.
USERD_get_nsided_conn_in_buffers (p. 103) <optional>
This one optional routine for nfaced elements
USERD_get_nfaced_conn_in_buffers (p. 94) <optional>
Unstructured Auto Distribute is a capability requiring Server of Servers (SOS) that will partition an
unstructured model for you automatically across a set of servers.
If you do not implement the routines listed above (and described below) in your reader, EnSight can
still perform this operation but will require much more memory on each server to read in the data
(somewhat like each server having to read the whole model). You will however, get the execution
advantage of having your model partitioned across multiple servers.
If you do implement these routines in your reader (in a proper manner), you should be able to not
only get the execution advantages, but also memory usage on each server which is proportional to
the subset that it is assigned to deal with.
Note:
The optional routines are functionally quite similar to the following functions. And therefore
their implementation should not be too difficult to add to any existing reader that has
already implemented these:
ADDED for providing xy plot data out of a reader:
(If your data format provides plot/query xy data, you can implement these routines to have that data
be available to EnSight's plotter)
USERD_get_num_xy_queries (p. 106) <optional>
USERD_get_xy_query_data (p. 156) <optional>
USERD_get_xy_query_info (p. 156) <optional>
MODIFIED for allowing yaw, pitch, roll:
(In addition to the specification of euler parameters and translations, and initial translational offsets,
this routine was modified to allow for initial yaw, pitch, roll transformations as well.)

ADDED for providing vector glyph data out of a reader:
(If your reader can (and will) provide vector glyph data (generally used for annotating force and/or
moment vectors), you will want to provide the following routines)
USERD_get_var_value_at_xyz_specific (p. 152) <optional>
USERD_get_vglyph_timeline_info (p. 153) <optional>
USERD_get_vglyph_timeline_times (p. 154) <optional>
USERD_get_vglyph_vector_info (p. 154) <optional>
USERD_get_vglyph_vector_values (p. 155) <optional>
USERD_get_vglyph_vector_xyzloc (p. 155) <optional>
3.3.10. At Version 2.10

ADDED for allowing materials to be specified as a scalar:
(If your reader can (and will) provide material data as per element scalars, you will want to provide
the following routines)
USERD_get_matf_set_type (p. 85) <optional>
USERD_get_matf_escalars_desc (p. 84) <optional>
3.4. Detailed Specifications

Include files
And it references
Special note
Make sure you use the proper define in the global_extern.h header file, namely:
#define USERD_API_208
Also, make sure the API version in the USERD_get_reader_version routine is set to the desired
version.
Basis of arrays
Global variables
You will generally need to have a few global variables which are shared by the various library routines.
The detailed specifications below have assumed the following are available. (Their names describe their
purpose, and they will be used in helping describe the details of the routines below).
static int Numparts_available = 0;

static int Num_unstructured_parts = 0;
static int Num_structured_blocks = 0;
/* Note: Numparts_available = Num_unstructured_parts + Num_structured_blocks */
static int Num_timesets = 1;
static int Current_timeset = 1;
static int Geom_timeset_number = 1;
static int Num_time_steps[Z_MAXSETS] = 1;
static int Num_variables = 0;
static int Num_dataset_files = 0;
static int Server_Number = 1;
static int Tot_Servers = 1;
Dummy (or stub) routines
Those routines marked optional, need not be included in a reader. They are truly optional. All other
routines for a given version number need to be included, but can often be dummy routines - depending
on what is returned for other related routines. As an example, if you always return that borders are not
available in USERD_get_border_availability, then the USERD_get_border_ele-
ments_by_type routine can be a dummy routine - because it will never be called.
The specifications for each routine in the API will now be given (routines are in alphabetical order):
/*--------------------------------------------------------------------
3.4.1. USERD_bkup
* (version 2.00 and later)
*--------------------------------------------------------------------
*
* Used in the archive process. Save or restore info relating to
* your user defined reader.
*
* (IN) archive_file = The archive file pointer
*
* (IN) backup_type = Z_SAVE_ARCHIVE for saving archive
* Z_REST_ARCHIVE for restoring archive
*

*
* Notes:
* * Since EnSight's archive file is saved in binary form, it is
* suggested that you also do any writing to it or reading from it
* in binary.
*
* * You should archive any variables, that will be needed for
* future operations, that will not be read or computed again
* before they will be needed. These are typically global
* variables.
*
* * Make sure that the number of bytes that you write on a save and
* the number of bytes that you read on a restore are identical!!
*
* * And one last reminder. If any of the variables you save are
* allocated arrays, you must do the allocations before restoring
* into them.
*
* =================================
* * SPECIAL NOTE FOR WINDOWS ONLY:
* Because our current implementation under windows needs to open and close files
* from within the reader .dll, a special structure (named USERD_globals) needs to
* be defined in the global space of your reader. This structure needs to be defined
* like: ------ -----
*
* #ifdef WIN32 (which includes 32 bit and 64 bit windows)
* W32EXPORT struct _USERD_globals {
* char arch_filename[256];
* unsigned long arch_fileptr;
* } USERD_globals;
* #endif
*
* This structure will be bound when the reader .dll is loaded and will be used to
* store the archive file name and the current offset therein.
* Again for windows only, you need to ignore the archive_file pointer in the
* argument list and instead open and close the arch_filename file as well as keep
* the arch_fileptr offset current in this routine.
*
* So first define the USERD_globals structure at the beginning of your reader.
*
* Then, when an archive is saved, the following needs to be done in this routine:
* 1. open USERD_globals.arch_filename for appending (within #ifdef WIN32)
* 2. do your writes
* 3. close the file (within #ifdef WIN32)
*
* When an archive is restored, do the following in this routine:
* 1. open USERD_globals.arch_filename for reading,
* and fseek to USERD_globals.arch_fileptr offset (within #ifdef WIN32)
* 2. do your reads
* 3. save the new USERD_globals.arch_fileptr offset (using ftell),
* and close the file (within #ifdef WIN32)
*
* Here is some pseudo code to illustrate:
* ---------------------------------------
* switch(baskup_type) {
* case Z_SAVE_ARCHIVE:
*
* #ifdef WIN32
* archive_file = fopen(USERD_globals.arch_filename,"ab");
* #endif
*
* .
* .
* .
* #ifdef WIN32
* #endif
*
* break;
*
* case Z_REST_ARCHIVE:
*
* #ifdef WIN32
* archive_file = fopen(USERD_globals.arch_filename,"rb");
* fseek(archive_file, USERD_globals.arch_fileptr, SEEK_SET);
* #endif
*
* .
* .
* .
*
* #ifdef WIN32
* USERD_globals.arch_fileptr = ftell(archive_file);
* #endif
*
* break;
* }
*
* And finally be aware of a current limitation of the
* Windows implementation of this routine:
* ---------------------------------------
* Because the structure uses a long for the file offset, the archive restore
* will not work when the offset to the information written in this routine
* is greater than 2 Gb, on 32 bit windows. On 64 bit windows there is no such
* limitation because the long is 64 bits.
*--------------------------------------------------------------------*/
int
USERD_bkup(FILE *archive_file,
int backup_type)
/*--------------------------------------------------------------------
3.4.2. USERD_exit_routine
*--------------------------------------------------------------------
*
* Called when EnSight is exited for USERD, can be used to
* clean up temporary files, etc. It is often simply a dummy.
*--------------------------------------------------------------------*/
void
USERD_exit_routine( void )
/*--------------------------------------------------------------------
3.4.3. USERD_get_block_coords_by_component
*--------------------------------------------------------------------
*
* Get the coordinates of a given block, component at a time
*
*
*
*
* It is NOT the part_id that is
* loaded in USERD_get_gold_part_build_info)
*
*
* (OUT) coord_array = 1D array containing x,y, or z
* coordinate component of each node
*
*
*
* Notes:
*
* * Only called for structured "block" parts
*--------------------------------------------------------------------*/
int
float *coord_array)
/*--------------------------------------------------------------------
3.4.4. USERD_get_block_iblanking
*--------------------------------------------------------------------
*
* Get the iblanking value at each node of a block - If Z_IBLANKED
*
*
*
*
*
* (OUT) iblank_array = 1D array containing iblank value
* for each node.
*
*
* possible values are: Z_EXT = exterior (outside)
* Z_INT = interior (inside)
* Z_BND = boundary
* Z_INTBND = internal boundary
* Z_SYM = symmetry plane
*
*
* Notes:
*
* * Not called unless Num_structured_blocks is > 0 and you have
* some iblanked blocks
*
* * Only called for structured "block" parts
*--------------------------------------------------------------------*/
int
int *iblank_array)
/*--------------------------------------------------------------------
3.4.5. USERD_get_block_ghost_flags
*--------------------------------------------------------------------
*
* Get the ghost_flags value at each element of a block containg ghost cells.
*
*
*
*
*
* (OUT) ghost_flags = 1D array containing ghost flag value
* for each block cell.
*
* (i-1)*(j-1)*(k-1) for the block long)
*
* possible values are: 0 = non-ghost cell (normal cell)
* >0 = ghost cell
*
*
*
* Notes:
*
* * Only called for structured "block" parts that have some ghost cells
* as indicated by the USERD_get_ghost_in_block_flag. The model must
* of course also have been indicated to have some ghost cells in the
* USERD_get_ghost_in_model_flag routine.
*
* * It is sufficient to set the value to be 1 to flag as a ghost cell,
* but the value can be any non-zero value, so you could use it to
* indicate which block or which server (for Server-of-server use) the
* cell is actually in.
*--------------------------------------------------------------------*/
int
USERD_get_block_ghost_flags(int block_number,
int *ghost_flags)
/*--------------------------------------------------------------------
3.4.6. USERD_get_border_availability
*--------------------------------------------------------------------
*
* Finds out if border elements are provided by the reader for the
* desired part, or will need to be computed internally by EnSight.
* The currently supported use-cases are that the reader either returns border
* elements for ALL of the parts or NONE of the parts.
*
*
*
*
*
* each type of border element in
* the part.
* ------------
*
* Z_POINT = point

*
* Returns:
* -------
* Z_OK if border elements will be provided by the reader.
* (number_of_elements array will be loaded and
* USERD_get_border_elements_by_type will be called)
*
* Z_ERR if border elements are not available - thus EnSight must compute.
* (USERD_get_border_elements_by_type will not be called)
*
*
* Notes:
* -----
* * Only called if border representation is used.
*
* * Will be based on Current_time_step
*
*--------------------------------------------------------------------*/
int
USERD_get_border_availability( int part_number,
int number_of_elements[Z_MAXTYPE])
/*--------------------------------------------------------------------
3.4.7. USERD_get_border_elements_by_type
*--------------------------------------------------------------------
*
* Provides border element connectivity and parent information.
* Note: The currently supported use-cases are that the reader either returns
* border elements for ALL of the parts or NONE of the parts.
*
*
*
*
*
* (IN) element_type = One of the following (See global_extern.h)
* Z_POINT node point element
* Z_BAR02 2 node bar
* Z_TRI03 3 node triangle
* Z_QUA04 4 node quad
*
* of each border element of the type.
*
* num_of_elements of the type by
* connectivity length of the type)
*
* ex) If number_of_elements[Z_TRI03] = 25
* number_of_elements[Z_QUA04] = 100
* as obtained in:
* USERD_get_border_availability
*

* conn_array[25][3] when called with Z_TRI03
*
* conn_array[100][4] when called with Z_QUA04
*
*
* (OUT) parent_element_type = 1D array containing element type of the
* parent element (the one that the border
* element is a face/edge of).
*
* num_of_elements of the type long)
*
* (OUT) parent_element_num = 1D array containing element number of the
* parent element (the one that the border
* element is a face/edge of).
*
* num_of_elements of the type long)
*
*
* Returns:
* -------
* Z_OK if successful
*
* Notes:
* -----
* * Only called if USERD_get_border_availability returned Z_OK
*
* * Will be based on Current_time_step
*
*--------------------------------------------------------------------*/
int
USERD_get_border_elements_by_type( int part_number,
int element_type,
int **conn_array,
short *parent_element_type,
int *parent_element_num)
/*--------------------------------------------------------------------
3.4.8. USERD_get_changing_geometry_status
*--------------------------------------------------------------------
*
* Gets the changing geometry status
*
* returns: Z_STATIC if geometry does not change
* Z_CHANGE_COORDS if changing coordinates only
* Z_CHANGE_CONN if changing connectivity
* Z_GEOM_PER_PART allows the use the new changing geometry per
* part option in EnSight
*
* Notes:
*
* EnSight does not support changing number of parts. But the
* coords and/or the connectivity of the parts can change. Note that
* a part is allowed to be empty (number of nodes and elements equal
* to zero).
* If you want to use
*
*--------------------------------------------------------------------*/
int
USERD_get_changing_geometry_status( void )
if(Geom_status_per_part) {
return(Z_GEOM_PER_PART);
}
else {
return(Geom_status);
}
/*--------------------------------------------------------------------
3.4.9. USERD_get_changing_geometry_status_per_part
* returns the changing
* geometry status for part sent to it.
* This status must not change over time.
*--------------------------------------------------------------------
*
* returns changing geometry status of the part, which must be one of:
* Z_STATIC
* Z_COORD_CHANGE
* Z_CONN_CHANGE
*
* Note: The status for a given part, is not allowed to change over time.
* Once set to be Z_COORD_CHANGE, for example, it may not become
* become Z_CONN_CHANGE or Z_STATIC at any other time.
*
* This routine will only be called if USERD_get_changing_geometry_status has
* returned a value of Z_GEOM_PER_PART. And it will be called right after the
* call to USERD_get_gold_part_build_info
*---------------------------------------------------------------------------------*/
int
USERD_get_changing_geometry_status_per_part(int part_number)
{
return(Geom_gcpp[part_number]);
}
/*--------------------------------------------------------------------
3.4.10. USERD_get_constant_val
*--------------------------------------------------------------------
*
*
* (IN) which_var = The variable number (1 to Num_variables)
*
* (IN) imag_data = TRUE if want imaginary data value.
* FALSE if want real data value.
*
*
* Notes:
*--------------------------------------------------------------------*/
float
USERD_get_constant_val(int which_var,
int imag_data)
/*--------------------------------------------------------------------
3.4.11. USERD_get_dataset_query_file_info
*--------------------------------------------------------------------
*
* Get the information about files in the dataset. Used for the
* dataset query option within EnSight.
*
* (OUT) qfiles = Structure containing information about each file
* of the dataset. The Z_QFILES structure is defined
* in the global_extern.h file
*
* (The structure will have been allocated
* num_dataset_files long, with 10 description
* lines per file).
* (See USERD_get_number_of_files_in_dataset)
*
* qfiles[].name = The name of the file
* (Z_MAXFILENP is the dimensioned length
* of the name)
*
* qfiles[].sizeb = The number of bytes in the file
*
* qfiles[].timemod = The time the file was last modified
* (Z_MAXTIMLEN is the dimesioned length
* of this string)
*
* qfiles[].num_d_lines = The number of description lines you
* are providing from the file. Max = 10
*
* qfiles[].f_desc[] = The description line(s) per file,
* qfiles[].num_d_lines of them
* (Z_MAXFILENP is the allocated length of
* each line)
*
*
* Notes:
* * If num_dataset_files is 0, this routine will not be called.
* (See USERD_get_number_of_files_in_dataset)
*--------------------------------------------------------------------*/
int
USERD_get_dataset_query_file_info(Z_QFILES *qfiles)
/*--------------------------------------------------------------------
3.4.12. USERD_get_descrip_lines
*--------------------------------------------------------------------
*
*
* (IN) which_type = Z_GEOM for geometry
*
* (IN) which_var = If it is a variable, which one. (1 to Num_variables)
*
* (IN) imag_data = TRUE if want imaginary data file.
* FALSE if want real data file.
*
*
* (OUT) line2 = The 2nd geometry description line
* Not used if variable type.
*
*
* Notes:
*
* * These are the lines EnSight can echo to the screen in
* annotation mode.
*--------------------------------------------------------------------*/
int
USERD_get_descrip_lines(int which_type,
int which_var,
int imag_data,
char line1[Z_BUFL],
char line2[Z_BUFL])
/*--------------------------------------------------------------------
3.4.13. USERD_get_element_label_status
* (Modified at 2.01 as indicated below)
*--------------------------------------------------------------------
*
*
* returns: TRUE if element labels will be provided
* FALSE if element labels will NOT be provided
*
* Notes:
* element labeling on-screen within EnSight.
*
* * Will call USERD_get_part_element_ids_by_type for each type of
* of each part if this routine returns TRUE.
*
* * Prior to API 2.01:
* =================
* per part, and are often unique per model.
*
* API 1.0:
* USERD_get_element_ids_for_part is used to obtain the ids,
* on a part by part basis, if TRUE status is returned here.
*
* API 2.0:
* USERD_get_part_element_ids_by_type is used to obtain the ids,
* on an element type by part basis, if TRUE status is returned here.
*
* status of TRUE here. You cannot assign them youself!!
*
* * Starting at API 2.01:
* ====================
* For both unstructured and structured parts, you can read them
* from your file if available, or can assign them, etc. They need
* to be unique per part, and are often unique per model (especially
* if you are dealing with a decomposed dataset).
*
* USERD_get_part_element_ids_by_type is used to obtain the ids,
* on an element type by part basis, if TRUE status is returned here.
*--------------------------------------------------------------------*/
int
USERD_get_element_label_status( void )
/*--------------------------------------------------------------------------
3.4.14. USERD_get_extra_gui_defaults
* <optional> (version 2.00 and later)
*--------------------------------------------------------------------------
*
* are fed up to the GUI.
*
*
*
*
*
*
*
*
*
*
* Notes:
*
* you'll lose them.
* ----------------------------------------------- */
int USERD_get_extra_gui_defaults(char **toggle_Title,
char **field_Title,
/*--------------------------------------------------------------------
3.4.15. USERD_get_extra_gui_numbers
* -------------------------------------------------------------------
*
* The Enhanced GUI routines are added to allow the user to customize a
* portion of the Data Reader dialog to pass in options to their user
* defined reader.
*
*
*
*
*
* Notes:
* USERD_get_extra_gui_defaults (this one)
*
*
* USERD_DISABLED_get_extra_gui_defaults
*
* use their data to modify the Data Reader dialog
*
*
*
*
* TRUE if checked
*
*
*
*
*
*
* =====================================================
*
* [ ] Title 1
* [X] Title 3
* [X] Title 2
* [X] Title 4
*
* Pulldown Menu ->
* Menu Choice 1
* Menu Choice 2
* Menu Choice 3
*
* Data Field Title 1 ____________________________
*
* Data Field Title 2 ____________________________
*
* =====================================================
*
*

*
* you'll lose them.
*---------------------------------------------------------------------------*/
void USERD_get_extra_gui_numbers(int *num_Toggles,
int *num_pulldowns,
int *num_fields)
/*--------------------------------------------------------------------
3.4.16. USERD_get_geom_timeset_number
*--------------------------------------------------------------------
*
* Gets the timeset number to be used for geometry
*
* It must be in the valid range of timeset numbers
* For example, If USERD_get_number_of_timesets
* returns 2, the valid timeset_number's
* would be 1 and 2.
*
* Returns:
* -------
* Geom_timeset_number = The timeset number that will be used for geometry.
* For example, if USERD_get_number_of timesets
* returns 2, the valid timeset numbers would be
* 1 or 2.
*
* Notes:
* * If your model is static, which you indicated by returning a zero
* in USERD_get_number_of_timesets, you can return a zero here as well.
*--------------------------------------------------------------------*/
int
USERD_get_geom_timeset_number( void )
/*--------------------------------------------------------------------
3.4.17. USERD_get_gold_part_build_info
*--------------------------------------------------------------------
* Gets the info needed for part building process
*
* (OUT) part_id = Array containing the external part
* ids for each of the model parts.
*
* IMPORTANT:
* External Part ids must be >= 1 because
* of the way they are used in the GUI
*
* *******************************************
* GUI (if possible). They are basically
* labels as far as you are concerned.
*
* Note: The part numbers you pass to routines which receive a
* part_number or block_number or which_part as and argument
* are the 1-based table index of the parts!
*
* example: If Numparts_available = 3
*
* Table index part_id
* ----------- -------
* 1 13
* 2 57
* 3 125
*
* ^ ^
* | |
* | These are placed in:
* | part_id[0] = 13
* | part_id[1] = 57
* | part_id[2] = 125
* | for GUI labeling purposes.
* |
* These implied table indices are the part_number,
* block_number, or which_part numbers that you would
* pass to routines like:
*
* USERD_get_part_coords(int part_number,...
* USERD_get_part_node_ids(int part_number,...
* USERD_get_part_elements_by_type(int part_number,...
* USERD_get_part_element_ids_by_type(int part_number,...
* USERD_get_block_coords_by_component(int block_number,...
* USERD_get_block_iblanking(int block_number,...
* USERD_get_block_ghost_flags(int block_number,...
* USERD_get_ghosts_in_block_flag(int block_number)
* USERD_get_border_availability(int part_number,...
* USERD_get_border_elements_by_type(int part_number,...
* USERD_get_var_by_component(int which_variable,
* int which_part,...
* USERD_get_var_value_at_specific(int which_var,
* int which_node_or_elem,
* ********************************************
*
*
* (OUT) part_types = Array containing one of the
* following primary types for each model part:
*
* Z_UNSTRUCTURED or
* Z_STRUCTURED or
* Z_IBLANKED
*
* Advanced:
* In addition to the three above options, EnSight can make use of
* the following flags with the bitwise OR operator to add them
* in with the above primary types to add nuanced behavior to
* EnSight.
*
* Z_STATIC_COORDS_HINT - do not update the coords at timestep change
* Z_STATIC_CONN_HINT - do not update the connectivity at timestep change
* Z_STATIC_COORDS_HINT | Z_STATIC_CONN_HINT - Static geometry
*
* Z_UNIFORM_HINT - Structured data is uniform
* Z_RECTILINEAR_HINT - Structured data is rectilinear
*
* Why to apply these flags:
* You would use these flags to hint something to EnSight to allow
* the EnSight code to operate in a more efficient manner on this part.
* For Example:
* You might want to speed up your reader by telling the server that
* this part is an unchanging geometry amidst other parts that are
* changing connectivity to save the time of reloading the part
* every timestep change.
* Also, you might want to tell EnSight that the structured mesh of this
* part is actually uniform in some way that might facilitate efficient
* volume rendering.
*
* How to apply these flags?
* Simply use a bitwise OR function to add in the hint of interest
* Z_STRUCTURED | Z_UNIFORM_HINT - This structured part is uniform

* Z_STRUCTURED | Z_RECTILINEAR_HINT - This structured part is rectilinear
*
* Suppose that you returned Z_CHANGE_CONN in USERD_get_changing_geom_status
* Now all parts will be completely reloaded (coordinates and connectivity)
* with every timestep change. But a given part is static. Use the following:
* Z_UNSTRUCTURED | Z_STATIC_COORDS_HINT | Z_STATIC_CONN_HINT - static geom
*
* or a given part is only changing coords, then use the following:
* Z_UNSTRUCTURED | Z_STATIC_CONN_HINT
*
*
*
* (OUT) part_description = Array containing a description
* for each of the model parts
*
* Numparts_available by Z_BUFL
* long)
*
* (OUT) number_of_nodes = Number of unstructured nodes in the part
*
*
* unstructured model part.
* ------------
*
* Z_POINT = point
* Starting at API 2.03 Z_NSIDED = nsided polygon
* Starting at API 2.03 Z_NFACED = nfaced polyhedron
*
* Starting at API 2.01:
* ====================
* Z_G_POINT ghost node point element
* Z_G_BAR02 2 node ghost bar
* Z_G_TRI03 3 node ghost triangle
* Z_G_QUA04 4 node ghost quad
* Z_G_TET04 4 node ghost tetrahedron
* Z_G_PYR05 5 node ghost pyramid
* Z_G_PEN06 6 node ghost pentahedron
* Z_G_HEX08 8 node ghost hexahedron
* Starting at API 2.03 Z_G_NSIDED ghost nsided polygon
* Starting at API 2.03 Z_G_NFACED ghost nfaced polyhedron
*
*
* Z_MAXTYPE long)
*
* (OUT) ijk_dimensions = 2D array containing ijk dimension info
* for structured blocks
*
* For Z_UNSTRUCTURED - is ignored
*
* For Z_STRUCTURED or Z_IBLANKED
*
* Prior to version 2.03:
* ----------------------
*
* ijk_dimensions[][0] = I dimension
* ijk_dimensions[][1] = J dimension
* ijk_dimensions[][2] = K dimension
*
*
* Starting at version 2.03:
* ------------------------
*
* There are two ways to do this:
* ------------------------------
* 1. The simple one, without ranges.
*
* This is good for all structured models
* that will a) NOT be used in EnSight's
* Server of Servers. or that will b) be used in
* Server of Servers with EnSight's autodistribute
* option.
*
* Simply provide the ijk dimensions in the
* first three slots and place a -1 in
* the 4th slot. (The remaining slots will
* be ignored).
*
* Thus,
* ijk_dimensions[][0] = I dimension of block
* ijk_dimensions[][1] = J dimension of block
* ijk_dimensions[][2] = K dimension of block
* ijk_dimensions[][3] = -1
*
*
*
*
*
*
* example: (Model has one part, a simple 2D block)
*
* (J planes)
* 4 *-------*-------*
* | | | ijk_dimension[0][0] = 3
* | | | ijk_dimension[0][1] = 4
* | | | ijk_dimension[0][2] = 1
* 3 *-------*-------*
* | | | ijk_dimension[0][4] = -1
* | | |
* | | |
* 2 *-------*-------*
* | | |
* | | |
* | | |
* 1 *-------*-------*
* 1 2 3 (I planes)
*
*
*
* 2. Using ranges.
*
* This one can be used anytime, but MUST
* be used if EnSight's Server of Servers
* is to be used without the autodistribute option!
*
* The first 3 slots contain the ijk dimension
* of the complete block (of which this may be
* a portion). The last 6 slots contain the
* ijk min and max ranges within the complete.
*
* Thus,
* ijk_dimensions[][0] = I dimension of complete block
* ijk_dimensions[][1] = J dimension of complete block
* ijk_dimensions[][2] = K dimension of complete block
*
* ijk_dimensions[][3] = Imin of portion (1-based)
* ijk_dimensions[][4] = Imax of portion (1-based)
* ijk_dimensions[][5] = Jmin of portion (1-based)
* ijk_dimensions[][6] = Jmax of portion (1-based)
* ijk_dimensions[][7] = Kmin of portion (1-based)
* ijk_dimensions[][8] = Kmax of portion (1-based)
*
* example1: (Model has one part, a simple 2D block,
* and want whole thing)
*
* (J planes)
* 4 *-------*-------*
* | | | ijk_dimension[0][0] = 3
* | | | ijk_dimension[0][1] = 4
* | | | ijk_dimension[0][2] = 1
* 3 *-------*-------*
* | | | ijk_dimension[0][3] = 1
* | | | ijk_dimension[0][4] = 3
* | | | ijk_dimension[0][5] = 1
* 2 *-------*-------* ijk_dimension[0][6] = 4
* | | | ijk_dimension[0][7] = 1
* | | | ijk_dimension[0][8] = 1
* | | |
* 1 *-------*-------*
* 1 2 3 (I planes)
* *
*
* example2: (Want to have the block represented
* in two portions - 2 parts)
*
* (J planes) top portion
* 4 *-------*-------*
* | | | ijk_dimension[0][0] = 3
* | | | ijk_dimension[0][1] = 4
* | | | ijk_dimension[0][2] = 1
* 3 *-------*-------*
* . . . ijk_dimension[0][3] = 1
* . . . ijk_dimension[0][4] = 3
* . . . ijk_dimension[0][5] = 3
* 2 ................. ijk_dimension[0][6] = 4
* . . . ijk_dimension[0][7] = 1
* . . . ijk_dimension[0][8] = 1
* . . .
* 1 .................
* 1 2 3 (I planes)
*
*
* (J planes) bottom portion
* 4 .................
* . . . ijk_dimension[1][0] = 3
* . . . ijk_dimension[2][1] = 4
* . . . ijk_dimension[3][2] = 1
* 3 *-------*-------*
* | | | ijk_dimension[1][3] = 1
* | | | ijk_dimension[1][4] = 3
* | | | ijk_dimension[1][5] = 1
* 2 *-------*-------* ijk_dimension[1][6] = 3
* | | | ijk_dimension[1][7] = 1
* | | | ijk_dimension[1][8] = 1
* | | |
* 1 *-------*-------*
* 1 2 3 (I planes)
*
*
* And note that if you were partioning this block yourself for
* EnSight's Server of Servers, you would only have one part,
* instead of two. Each SOS server would return its appropriate
* ranges in the last 6 slots. The first 3 slots would remain constant.
*
* Just to be clear on the setting of ranges (ijk_dimension[1][3-8],
* NON-SOS cases: Ranges can be used to specify partial blocks if desired, or
* can be set to the complete block by specifying them, or
* by setting ijk_dimension[i][3] to -1
*
* SOS cases, partitioning in the reader: Ranges must be set properly in this
* routine, so that each server has its
* portion.
*
* SOS cases, EnSight's autodistribute will be used: Ranges must be set to the
* complete block for each
* server. You can use the -1
* in the ijk_dimension[i][3]
* slot to do this if desired.
*
*
* (OUT) iblanking_options = 2D array containing iblanking
* options possible for each
* structured model part.
* ----------
* (Ignored unless Z_IBLANKED type)
*
*
* iblanking_options[][Z_EXT] = TRUE if external (outside)
* [][Z_INT] = TRUE if internal (inside)
* [][Z_BND] = TRUE if boundary
* [][Z_INTBND] = TRUE if internal boundary
* [][Z_SYM] = TRUE if symmetry surface
*
*
*
* Notes:
*
*--------------------------------------------------------------------*/
int
USERD_get_gold_part_build_info(int *part_id,
int *part_types,
char *part_description[Z_BUFL],
int *number_of_nodes,
int *number_of_elements[Z_MAXTYPE],
int *ijk_dimensions[9],
int *iblanking_options[6])
/*--------------------------------------------------------------------
3.4.18. USERD_get_gold_variable_info
*--------------------------------------------------------------------
*
* Get the variable descriptions, types and filenames
*
* (OUT) var_description = Variable descriptions
*
*
* variable description restrictions:
* ----------------------------------
* 1. Only first 19 characters used in EnSight prior to EnSight 8.2
* Starting at EnSight 8.2, 49 characters will be used.
* 2. Leading and trailing whitespace will be removed by EnSight.
* 3. Illegal characters will be replaced by underscores.
* 4. They may not start with a numeric digit.
* 5. No two variables may have the same description.
*
* (OUT) var_filename = Variable real filenames
*
*
* (OUT) var_type = Variable type
*
*
* types are: Z_CONSTANT
* Z_CONSTANT_PER_PART
* Z_SCALAR
* Z_VECTOR
* Z_TENSOR
* Z_TENSOR9
*
* (OUT) var_classify = Variable classification
*
*
* Z_PER_ELEM
* Z_PER_PART
*
* (OUT) var_complex = TRUE if complex, FALSE otherwise
*
*
* (OUT) var_ifilename = Variable imaginary filenames (if complex)
*
*
* (OUT) var_freq = complex frequency (if complex)
*
*
*
* (OUT) var_contran = TRUE if constant changes per time step
* FALSE if constant truly same at all time steps
*
*
* (OUT) var_timeset = Timeset the variable will use (1 based).
* (For static models, set it to 1)
*
*
* For example: If USERD_get_number_of_timesets
* returns 2, the valid
* timeset_number's would be 1 or 2.
*
*
* Notes:
* * The implied variable numbers apply, but be aware that the
* arrays are zero based.
* So for variable 1, will need to provide var_description[0]
* var_filename[0]
* var_type[0]
* var_classify[0]
* var_complex[0]
* var_ifilename[0]
* var_freq[0]
* var_contran[0]
* var_timeset[0]
*
* for variable 2, will need to provide var_description[1]
* var_filename[1]
* var_type[1]
* var_classify[1]
* var_complex[1]
* var_ifilename[1]
* var_freq[1]
* var_contran[1]
* var_timeset[1]
* etc.
*--------------------------------------------------------------------*/
int
USERD_get_gold_variable_info(char **var_description,
int *var_type,
int *var_classify,
int *var_complex,
char **var_ifilename,
float *var_freq,
int *var_contran,
int *var_timeset)
/*--------------------------------------------------------------------
3.4.19. USERD_get_ghosts_in_block_flag
*--------------------------------------------------------------------
*
* Gets whether ghost cells present in block or not
*
* (IN) block_number = The block part number
*
*
*
* It is NOT the part_id that
* is loaded in USERD_get_gold_part_build_info)
*
* returns: TRUE if any ghost cells in this structured part
* FALSE if no ghost cells in this structured part
*
* Notes:
*
* * Intended for structured parts only, value will be ignored for
* unstructured parts
*--------------------------------------------------------------------*/
int
USERD_get_ghosts_in_block_flag(int block_number)
/*--------------------------------------------------------------------
3.4.20. USERD_get_ghosts_in_model_flag
*--------------------------------------------------------------------
*
* Answers the question as to whether any ghost cells in the model.
*
* returns: TRUE if any ghost cells in the model
* FALSE if no ghost cells in the model
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_ghosts_in_model_flag( void )
/*--------------------------------------------------------------------
3.4.21. USERD_get_matf_escalars_desc
*--------------------------------------------------------------------
*
* Gets the list of descriptions of scalar per element variables to be defined
* as the specified materials. This list of element scalar descriptions must be
* given in the same order, or sequence as the listed material ids.
*
* (IN) set_index = The material set index
*
* (OUT) mesv_desc = 2D array of per element scalar descriptions
* Array will have beeen allocated by:
* [Num_materials[set_index]] by [Z_BUFL]
*
* returns: Z_OK if no problems
* Z_ERR if an error
*
*
* Notes:
* * See USERD_get_number_of_material_sets header for explanatory example
* * Will not be called unless the set_type in USERD_get_matf_set_type
* is Z_MISET_VIA_ESCAL_VARS
* * Use this in place of the sparse material list interfacing method, which uses
* USERD_size_matf_data and USERD_load_matf_data
* * This function does not work with material SPECIES, i.e. with the function
* calls USERD_get_matsp_info and USERD_get_number_of_species
* * The mesv_desc array is NOT the same as the mat_desc array given via the
* function USERD_get_matf_var_info
*--------------------------------------------------------------------*/
int
USERD_get_matf_escalars_desc(int set_index,
char **mesv_desc)
/*--------------------------------------------------------------------
3.4.22. USERD_get_matf_set_info
*--------------------------------------------------------------------
*
* Get the material set ids and names
*
* (OUT) mat_set_ids = 1D material set ids array. (A list of unique, non-zero,
* positive number ids to be
* associated with each material set)
*
* Num_material_sets long)
*
* (OUT) mat_set_name = 2D material set name array
*
* Num_material_sets by Z_BUFL long)
*
*
* Notes:
* * Will not be called if Num_material_sets is zero
*--------------------------------------------------------------------*/
int
USERD_get_matf_set_info(int *mat_set_ids,
char **mat_set_name)
/*--------------------------------------------------------------------
3.4.23. USERD_get_matf_set_type
*--------------------------------------------------------------------
* Gets the material set type
*
* (IN) set_index = The material set index
*
* returns: set_type = Z_MISET_VIA_SPARSE_MIX (default)
* Z_MISET_VIA_ESCAL_VARS
*
* Notes:
* * Z_MISET_VIA_ESCAL_VARS does not work with the material species functions, i.e.
* USERD_get_number_of_species and USERD_get_matsp_info
* * Use Z_MISET_VIA_SPARSE_MIX to interface materials via sparse material id, mixed
* id, and mixed value lists (see USERD_size_matf_data and USRERD_load_matf_data).
* * Use Z_MISET_VIA_ESCAL_VARS to interface materials via/as scalar per element
* variables (see USERD_get_matf_escalars_desc).
*--------------------------------------------------------------------*/
int
USERD_get_matf_set_type(int set_index)
/*--------------------------------------------------------------------
3.4.24. USERD_get_matf_var_info
*--------------------------------------------------------------------
*
* Get the material ids and descriptions for the material set
*
* (IN) set_index = the material set index (zero based)
*
* (OUT) mat_ids[set_index] = 1D materials ids array (internal, non-zero, positive
* numeric id)
*
* Num_materials long)
*
* (OUT) mat_desc[set_index] = 2D material descriptions array (description in GUI
* material list)
*
* Num_materials by Z_BUFL long)
*
*
* Notes:
*
* * Will not be called if Num_material_sets is zero, or
* Num_materials[set_index] is zero
*--------------------------------------------------------------------*/
int
USERD_get_matf_var_info(int set_index,
int *mat_ids,
char **mat_desc)
/*--------------------------------------------------------------------
3.4.25. USERD_get_matsp_info
*--------------------------------------------------------------------
*
* Get the material species ids, descriptions, count per material,
* and concatonated lists of species per material for the material set
*
* (IN) set_index = Material set index (zero based)
*
* (OUT) sp_ids[set_index] = 1D material species ids array (non-zero, positive
* numeric id)
*
* Num_species long)
*
* (OUT) sp_desc[set_index] = 2D material species descriptions array
*
* Num_species by Z_BUFL long)
*
* (OUT) sp_per_mat_cnt[set_index] = 1D species per material count array
*
* Num_materials long)
*
* (OUT) sp_per_mat_lis[set_index] = 1D concatonated lists of species
* per material array
*
* Num_materials*Num_species long)
*
*
* Notes:
*
*--------------------------------------------------------------------*/
int
USERD_get_matsp_info(int set_index,
int *sp_ids,
char **sp_desc,
int *sp_per_mat_cnt,
int *sp_per_mat_lis)
3.4.26. USERD_get_max_time_steps
/*--------------------------------------------------------------------
*--------------------------------------------------------------------
*
* number of timesteps, for example, when coproccessing solution data
* that is output during post processing.
*
* to actually do a rereading of the timesteps when prompted to do so.
*
*
* Note that this maximum number of timesteps is used to allocate
* an upper bound on Timesets in EnSight and uses a minimal amount of
* memory. Therefore making this number conservatively large has
* little impact on the EnSight memory. Your consideration should
* primarily be your own reader memory requirements.
*
*--------------------------------------------------------------------*/
int
/*--------------------------------------------------------------------
3.4.27. USERD_get_maxsize_info
* (Modified at 2.01 as decribed below)
*--------------------------------------------------------------------
*
* Gets maximum part sizes for efficient memory allocation.
*
* Transient models (especially those that increase in size) can cause
* reallocations, at time step changes, to keep chewing up more and
* more memory. The way to avoid this is to know what the maximum
* size of such memory will be, and allocate for this maximum initially.
*
* Accordingly, if you choose to provide this information (it is optional),
* EnSight will take advantage of it.
*
* (OUT) max_number_of_nodes = Maximum number of unstructured nodes
* that will be in the part (over all time).
*
*
* (OUT) max_number_of_elements = 2D array containing maximum number of
* unstructured model part (over all time).
* ------------
*
* Z_POINT = point
*
* ====================

*
*
* Z_MAXTYPE long)
*
* (OUT) max_ijk_dimensions = 2D array containing maximum ijk dimensions
* for each structured model part (over_all_time).
* ----------
* (Ignored if Z_UNSTRUCTURED type)
*
*
* max_ijk_dimensions[][0] = maximum I dimension
* max_ijk_dimensions[][1] = maximum J dimension
* max_ijk_dimensions[][2] = maximum K dimension
*
* Originally:
* returns: Z_OK if supplying maximum data
* Z_ERR if not supplying maximum data, or some error occurred
* while trying to obtain it.
* But as of EnSight 9.0.3(d):
* returns: Z_OK if supplying maximum data (and no largest time step)
* largest_time_step + 2 if supplying maximum data and the zero-based
* time step at which it occurred.
* (The +2 is needed to be able to distinguish this
* properly from Z_OK or Z_ERR. It will be subtracted
* again in EnSight.)
* Z_ERR if not supplying maximum data, or some error occurred
* while trying to obtain it.
*
* Notes:
* * You need to have first called USERD_get_number_of_model_parts and
* USERD_get_gold_part_build_info, so Numparts_available is known and
* so EnSight will know what the type is (Z_UNSTRUCTURED, Z_STRUCTURED,
* or Z_IBLANKED) of each part.
*
* * This will NOT be based on Current_time_step - it is to be the maximum
* values over all time!!
*
* * This information is optional. If you return Z_ERR, Ensight will still
* process things fine, reallocating as needed, etc. However, for
* large transient models you will likely use considerably more memory
* and take more processing time for the memory reallocations. So, if it
* is possible to provide this information "up front", it is recommended
* to do so.
*--------------------------------------------------------------------*/
int
USERD_get_maxsize_info(int *max_number_of_nodes,
int *max_number_of_elements[Z_MAXTYPE],
int *max_ijk_dimensions[3])
/*--------------------------------------------------------------------
3.4.28. USERD_get_metadata
*
*--------------------------------------------------------------------
*
* This provides a mechanism to provide the EnSight client extra
* information designed to customize EnSight directly from the reader
* Meta data is XML formatted string of chars sent up to EnSight in two
* sequential calls of this routine.
*
* Presumably you would open the dataset file(s) in USERD_set_filenames,
* understand the dataset, the parts, and the variables, and assemble
* together this array of metadata in an XML character string.
*
* The first call of this routine is designed to send the actual length
* of the meta_char so EnSight can allocate the char container.
* (IN) meta_char = (char *) NULL <- this indicates its the first call
*
(OUT) actual len is the strlen(meta_char)
*
* The second call of this routine is designed to fetch the char array.
* (IN) actual_len - this is the length of the char array in bytes that EnSight
* has allocated, ready to receive your xml formatted chars
* (OUT) meta_char = (char *) pointer ready to be populated
*
* Here's a sample (without the asterisks):
*
<?xml version="1.0" encoding="UTF-8"?>
<CEImetadata version="1.0">
<parts>
<partlist>
<group name="simple group">
<part name="anotherpart"></part>
</group>
<part name="mypart"></part>
</partlist>
</parts>
<vars>
<metatags>
<tag name="ENS_UNITS_LABEL" type="str"></tag>
<tag name="ENS_UNITS_DIMS" type="str">/</tag>
</metatags>
<varlist>
<var name="myvar" ENS_UNITS_LABEL="m s^-1" ENS_UNITS_DIMS="L/T"></var>
<var name="Coordinates" ENS_UNITS_LABEL="m" ENS_UNITS_DIMS="L"></var>
<var name="Time" ENS_UNITS_LABEL="s" ENS_UNITS_DIMS="T"></var>
</varlist>
</vars>
<xy_queries>
<metatags>
<tag name="ENS_UNITS_QUERY_X_VAR" type="str"></tag>
<tag name="ENS_UNITS_QUERY_Y_VAR" type="str"></tag>
</metatags>
<querylist>
<query name="myvar vs time" ENS_UNITS_QUERY_X_VAR="Time" ENS_UNITS_QUERY_Y_VAR="myvar"></query>
<query name="myvar vs Re" ENS_UNITS_QUERY_X_VAR="myvar" ENS_UNITS_QUERY_Y_VAR=""></query>
</querylist>
</xy_queries>
<case>
<metatags>
<tag name="ENS_UNITS_LABEL" type="flt">2.0</tag>
<tag name="ENS_UNITS_DIMS" type="flt">1.0</tag>
<tag name="ENS_UNITS_SYSTEM" type="flt">1.0</tag>
<tag name="ENS_UNITS_SYSTEM_NAME" type="str">SI</tag>
</metatags>
</case>
</CEImetadata>
*
* Note: some datasets may record this metadata into a separate file
* which is a perfectly valid methodology for recording this data.
* The XML format is the same: this is done in EnSight Case Gold format.
* A user defined reader can just read the data in and pass it up
* via this mechanism.
*
* There are sections for parts, variables, xy_queries
* (only used by user-defined readers that support xy queries)
* and the case. Note that in each section, objects are matched to metadata
* using their name (the DESCRIPTION property on the corresponding EnSight
* Python object). Each section begins by defining the attributes to be
* defined for the objects in the section using a <metatags> section.
* It defines all the attributes and their type (flt=float, str=string).
* The value specified for the <tag> is the default attribute value that
* is assigned if an object does not specify the attribute.
* When debugging metadata files, it can be useful to review what
* EnSight sees. The Python command:
* ensight.objs.core.CURRENTCASE[0].SERVERXML
* will return the XML metadata for the current case.
*
* In the example, the <parts> section just defines the grouping hierarchy
* that should be used when the dataset is loaded. Spatial units for
* parts are defined by the (implicit) 'Coordinates' variable.
* In the <vars> section, ENS_UNITS_DIMS and ENS_UNITS_LABEL metatags
* are defined. In the example, the former is set to default to unit-less "/".
* Each variable defined in the dataset is then listed in the <varlist>
* section with the appropriate values for ENS_UNITS_DIMS and ENS_UNITS_LABEL.
*
* Note that label strings should have the format: {unit}[{^{power}]
* with spaces between individual units. If the power is 1,
* the ^{power} can be dropped. If the unit is in the denominator,
* the power should be negative. No '/' characters should be in the label
* and all positive powers should appear before negative powers. An example
* for m/s= "m s^-1" and for m2/s2= "m^2 s^-2".
* Always include the implicit "Coordinates" and "Time" variables.
*
* Queries are handled a little differently.
* The <xy_queries> should only be used by a user-defined reader that
* implements the USERD_get_num_xy_queries, USERD_get_xy_query_info and
* USERD_get_xy_query_data functions. The two attributes:
* ENS_UNITS_QUERY_X_VAR and ENS_UNITS_QUERY_Y_VAR should be defined
* and set to the name of a variable in the dataset that has the same
* dimensions as the specified axis. The units for that specific axis
* will be taken from the variables named by those attributes.
* Note: there is no requirement that the variable name provided is
* the variable in the query, only that the units of that variable
* match the units of the axis of the specific query.
*
* The <case> section serves to define two things. First, it defines the
* versions of the ENS_UNITS_LABEL, ENS_UNITS_DIM and ENS_UNITS_SYSTEM_NAME
* protocols. These are all float values and should be set to 2.0, 1.0
* and 1.0 respectively as shown in the example (there is an earlier
* version of the ENS_UNITS_LABEL protocol, but it is not recommended
* for new development). Second, the name of the unit system that
* all the data that will be returned by the user-defined reader or is
* stored in the case gold format files.
* The list of valid unit system names includes the system string values
* from this table:
*
* System name System string Units: mass, length, time, temperature,
* current, angle, intensity, substance amount
*
* Metric SI SI kg, m, s, A, K, rad, mol, cd
* Metric CGS CGS g, cm, s, A, C, rad, mol, cd
* US ft Consistent BFT slug, ft, s, A, F, rad, slugmol, cd
* US in Consistent BIN slinch, in, s, A, F, rad, lbmmol, cd
* Metric MKS MKS kg, m, s, A, C, rad, mol, cd
* Metric MPA MPA tonne, mm, s, mA, C, rad, mol, cd
* Metric uMKS uMKS kg, um, s, pA, C, rad, mol, cd
* Metric CGSK CGSK g, cm, s, A, K, rad, mol, cd
* Metric NMM NMM kg, mm, s, mA, C, rad, mol, cd
* Metric uMKSS uMKSS kg, um, s, mA, C, rad, mol, cd
* Metric NMMDAT NMMDAT decatonne, mm, s, mA, C, rad, mol, cd
* Metric NMMTON NMMTON tonne, mm, s, mA, C, rad, mol, cd
* US ft BFTS lbm, ft, s, A, F, rad, lbmmol, cd

* US in BINS lbm, in, s, A, F, rad, lbmmol, cd
* US Engineering USENG lb, in, s, A, R, rad, lbmmol, cd
*
* It should be noted that for proper unit support in EnSight, only the
* ENS_UNITS_DIMS and ENS_UNITS_SYSTEM_NAME protocols need to be defined.
* The ENS_UNITS_LABEL protocol allows a dataset to specify a custom label
* to be used when a dataset is loaded in its natural unit system
* (e.g. "Pa" for M/LTT dimensions instead of the generated "kg/(m·s2)").
*
* EnSight will generate a valid unit label from the dimension string
* and the unit system if no label is specified, the current session
* unit system does not match the one in the dataset and for all
* computed variables.
*
* ------------------------------------------------- */
int
USERD_get_metadata(int *actual_len, char *meta_char)
/*-------------------------------------------------------------------
3.4.29. USERD_get_model_extents
*-------------------------------------------------------------------
*
* Gets the model bounding box extents. If this routine supplys them
* EnSight will not have to spend time doing so. If this routine
* returns Z_ERR, EnSight will have to take the time to touch all the
* nodes and gather the extent info.
*
* (OUT) extents[0] = min x
* [1] = max x
* [2] = min y
* [3] = max y
* [4] = min z
* [5] = max z
*
* returns: Z_ERR if no extents given (EnSight will read all coords and
* calculate)
* Z_OK if extents given
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_model_extents( float extents[6] )
/*--------------------------------------------------------------------
3.4.30. USERD_get_name_of_reader
*--------------------------------------------------------------------
*
*
* is 20)
*
* (OUT) *two_fields = FALSE if only one data field is required
* in the data dialog of EnSight.
*
* -1 if one field (Geom) required
* and one field (Param) is optional
* Param field can contain any text

* for example a file name, modifiers,
* etc. that can be used to modify the
* reader's behavior.
*
*
* Notes:
*--------------------------------------------------------------------*/
int
int *two_fields)
/*--------------------------------------------------------------------
3.4.31. USERD_get_nfaced_conn
*--------------------------------------------------------------------
*
* Gets the array containing the connectivity of nsided faces of
* nfaced elements
*
*
*
*
*
* (OUT) nfaced_conn_array = 1D array of nsided face connectivies of
* nfaced elements
*
* (int array will have been allocated
* long enough to hold all the nsided
* face connectivities. Which is the sum of
* all the nodes per face values in
* the nfaced_npf_array of
* USERD_get_nfaced_nodes_per_face)
*
* Providing nfaced information to Ensight:
*
* 1. In USERD_get_gold_part_build_info, provide the number of nfaced
* polyhedral elements in the part.
*
* 2. In USERD_get_part_elements_by_type, provide (in the conn_array),
* the number of faces per nfaced element. (as if connectivity
* length of an nfaced element is one)
*
* 3. In this routine, provide the streamed number of nodes per face
* for each of the faces of the nfaced elements.
*
*
* Simple example: 11 10 12
* +--------+-----+
* 2 nfaced elements: /| |\ /|
* (1 7-faced / | | \ / |
* 1 5-sided) / | | +9 |
* / | | /| |
* /7 | 8 / | |
* +-----------+/ | | |
* | |5 | |4 | |6
* | +-----|--+--|--+
* | / | \ | /
* | / | \|/3
* | / | +
* | / | /
* |/1 |2 /
* +-----------+/
*
*
*
*
*
* 1. In USERD_get_gold_part_build_info:
* number_of_elements[Z_NFACED] = 2
* .
* /|\
* |
* 2. In USERD_get_part_elements_by_type:
* length of conn_array will be: 2 x 1
* for element_type of Z_NFACED:
* conn_array[0][0] = 7 (for the 7-faced element)
*
* ==
* Sum 12
<---------+
* |
* 3. In USERD_get_faced_nodes_per_face: |
* length of nfaced_npf_array will be: 12
*
* nfaced_npf_array[0] = 5 (5-noded top face of 7-faced element)
* nfaced_npf_array[1] = 5 (5-noded bot face of 7-faced element)
* nfaced_npf_array[2] = 4 (4-noded front face of 7-faced element)
* nfaced_npf_array[3] = 4 (4-noded left face of 7-faced element)
* nfaced_npf_array[4] = 4 (4-noded back face of 7-faced element)
* nfaced_npf_array[5] = 4 (4-noded right front face of 7-faced element)
* nfaced_npf_array[6] = 4 (4-noded right back face of 7-faced element)
*
* nfaced_npf_array[10] = 4 (4-noded right face of 5-faced element)
* nfaced_npf_array[11] = 4 (4-noded left front face of 5-faced element)
*
* ==
* Sum 48
<-----------------+
* |
* 4. In this function: |
* length of the nfaced_conn_array will be: 48
*
* nsided_conn_array[0] = 7 (conn of 5-noded top face of 7-faced elem)
* nsided_conn_array[1] = 8
*
* nsided_conn_array[5] = 1 (conn of 5-noded bot face of 7-faced elem)
*
* nsided_conn_array[10] = 1 (conn of 4-noded front face of 7-faced elem)
*
* nsided_conn_array[14] = 5 (conn of 4-noded left face of 7-faced elem)
*
* nsided_conn_array[18] = 4 (conn of 4-noded back face of 7-faced elem)
*
* nsided_conn_array[22] = 2 (conn of 4-noded right front face of 7-faced)

*
* nsided_conn_array[26] = 3 (conn of 4-noded right back face of 7-faced)
*
*
*
*
* nsided_conn_array[40] = 3 (conn of 4-noded right face of 5-faced elem)
*
* nsided_conn_array[44] = 4 (conn of 4-noded left front face of 5-faced)
*
*
*
* Notes:
* * Will not be called unless there are some nfaced elements in the
* the part
*--------------------------------------------------------------------*/
int
USERD_get_nfaced_conn(int part_number,
int *nfaced_conn_array)
/*--------------------------------------------------------------------
3.4.32. USERD_get_nfaced_conn_in_buffers
*--------------------------------------------------------------------
*
* Gets three arrays containing the number of faces per element,
* number of nodes per face, and connectivity per face of nfaced
* elements in buffers
*
* This is one of several optional routines than can be added into any
* API 2.* reader to be used by the Unstructured Auto Distribute capability
* in EnSight 8.2 and later.
*
* Unstructured Auto Distribute is a capability requiring Server of Servers
* (SOS) that will partition an unstructured model for you automatically
* across a set of servers.
*
* If you do not implement this routine (and the other in_buffers routines)
* in your reader, EnSight can still perform this operation but will require
* much more memory on each server to read in the data (somewhat like each
* server having to read the whole model). You will however, get the execution
* advantage of having your model partitioned across multiple servers.
*
* If you do implement this routine (and the other in_buffers routines) in

* your reader (in a proper manner), you should be able to not only get the
* execution advantages, but also memory usage on each server which is
* proportional to the subset that it is assigned to deal with.
*
* Note that this optional routine is functionally quite similar
* to the USERD_get_nfaced_conn routine. And thus its implementation should
* not be too difficult to add to any existing reader that has already
* implemented the USERD_get_nfaced_conn routine.
*
*
*
*
*
*
* (IN) first = TRUE if first invocation of a buffered set.
* Will be FALSE for all subsequent invocations
* of the set. This is so you can open files,
* get to the correct starting spot,
* initialize, etc.
*
* (IN) e_beg = Zero based, first element number
* of the buffered set
*
* (IN) e_end = Zero based, last element number
*
* Thus, for first five elements of a type:
* e_beg = 0
* e_end = 4
* total_number = (e_end - e_beg) + 1 = (4 - 0) + 1 = 5
*
*
* for second five elements of a type, would be:
* e_beg = 5
* e_end = 9
*
* for all elements of the type of a part, would be:
* n_beg = 0
* n_end = num_elements_of_type - 1
*
* (IN) buffer_size = The size of the num_nodes_per_elem_array buffer.
* Namely: num_nodes_per_elem_array[buffer_size]
*
* (OUT) nfaced_fpe_array = 1D buffer array of the number of faces per nfaced
* element.
*
* buffer_size long)
*
* (OUT) nfaced_npf_array = 1D buffer array of the number of nodes per face
* for nfaced elements.
*
* (int array will have been allocated long
* enough to hold a buffer's size of values)
*
* (OUT) nfaced_conn_array = 1D array of nsided face connectivies of
* nfaced elements
*
* long enough to hold a buffer's worth of values)
*
*
* NOTE: for other nfaced operations you need these first two, but we
* don't actually use them in this routine.
*
*
*
* We do use the following:
* 3. In this routine, provide the corresponding number of faces per nfaced
* element, streamed number of nodes per face, and streamed face
* connectivities for each of the faces of the nfaced elements in the
* bufferred portion.
*
*
*
*
*
*
*
*
*
*
*
*
*
*
* +--------+-----+
* (1 7-faced / | | \ / |
* 1 5-sided) / | | +9 |
* / | | /| |
* /7 | 8 / | |
* +-----------+/ | | |
* | |5 | |4 | |6
* | +-----|--+--|--+
* | / | \ | /
* | / | \|/3
* | / | +
* | / | /
* |/1 |2 /
* +-----------+/
*
* Note, don't really use these first two here (See USERD_get_nfaced_conn)
*
* .
* /|\
* |
* ==
* Sum 12
*
*
* But for our simple example, lets assume that that our buffer is just 1
* so that we have multiple invocations. ================
* 3. In this routine:
*
* first invocation:
* first = TRUE
* e_beg = 0
* e_end = 1
* buffer_size = 1
* nfaced_fpe_array[1] load it: nfaced_fpe_array[0] = 7
*
* nfaced_npf_array[at least 7] load it: nfaced_npf_array[0] = 5
* nfaced_npf_array[1] = 5
*
* nsided_conn_array[at least 30] load it: nsided_conn_array[0] = 7
*
*
*
*
*
*
* *num_returned = 1;
* return(0)
*
* second invocation:
* first = FALSE
* e_beg = 0
* e_end = 1
* buffer_size = 1
* nfaced_fpe_array[1] load it: nfaced_fpe_array[0] = 5
*
* nfaced_npf_array[at least 7] load it: nfaced_npf_array[0] = 3
*
*
*
*
*
* *num_returned = 1;
* return(1)
*
* returns 0 if got some, more to do
* 1 if got some, done
* -1 if an error
*
* Notes:
*
* the part
*
*--------------------------------------------------------------------*/
int
USERD_get_nfaced_conn_in_buffers(int part_number,
int *nfaced_fpe_array,
int *nfaced_npf_array,
int *nfaced_conn_array,
int first,
int e_beg,
int e_end,
int buffer_size,
int *num_returned)
/*--------------------------------------------------------------------
3.4.33. USERD_get_nfaced_nodes_per_face
*--------------------------------------------------------------------
*
* Gets the array containing the number of nodes per face for each face
* of the nfaced elements.
*
*
*
*
*
* (OUT) nfaced_npf_array = 1D array of nodes per face for all
* faces of nfaced elements
*
* long enough to hold all the nodes per
* face values. Which is the sum of
* all the number of faces per element values in
* the conn_array of
* USERD_get_part_elements_by_type)
*
*
*

*
* 3. In this routine, provide the streamed number of nodes per face
* for each of the faces of the nfaced elements.
*
*
* +--------+-----+
* (1 7-faced / | | \ / |
* 1 5-sided) / | | +9 |
* / | | /| |
* /7 | 8 / | |
* +-----------+/ | | |
* | |5 | |4 | |6
* | +-----|--+--|--+
* | / | \ | /
* | / | \|/3
* | / | +
* | / | /
* |/1 |2 /
* +-----------+/
*
*
*
*
*
* .
* /|\
* |
*
* ==
* Sum 12
<---------+
* |
* 3. In this routine: |
* length of nfaced_npf_array will be: 12
*
* nfaced_npf_array[2] = 4 (4-noded front face of 7-faced element)
* nfaced_npf_array[3] = 4 (4-noded left face of 7-faced element)
* nfaced_npf_array[5] = 4 (4-noded right front face of 7-faced element)
* nfaced_npf_array[6] = 4 (4-noded right back face of 7-faced element)
*
* nfaced_npf_array[10] = 4 (4-noded right face of 5-faced element)
* nfaced_npf_array[11] = 4 (4-noded left front face of 5-faced element)
*
* ==
* Sum 48
<-----------------+
* |
* 4. In USERD_get_nfaced_conn: |
* length of the nfaced_conn_array will be: 48
*
*
*
* nsided_conn_array[10] = 1 (conn of 4-noded front face of 7-faced elem)
*
* nsided_conn_array[14] = 5 (conn of 4-noded left face of 7-faced elem)
*
*
* nsided_conn_array[22] = 2 (conn of 4-noded right front face of 7-faced)
*
* nsided_conn_array[26] = 3 (conn of 4-noded right back face of 7-faced)
*
*
*
*
* nsided_conn_array[40] = 3 (conn of 4-noded right face of 5-faced elem)
*
* nsided_conn_array[44] = 4 (conn of 4-noded left front face of 5-faced)
*
*
* Notes:
* the part
*--------------------------------------------------------------------*/
int
USERD_get_nfaced_nodes_per_face(int part_number,
int *nfaced_npf_array)
/*--------------------------------------------------------------------
3.4.34. USERD_get_node_label_status
* (Modified at 2.01 as described below)
*--------------------------------------------------------------------
*
* Answers the question as to whether node labels will be provided.
*
* returns: TRUE if node labels will be provided
* FALSE if node labels will NOT be provided
*
* Notes:
*
* * Will call USERD_get_part_node_ids for each part if this routine
* returns TRUE.
*
* * Prior to API 2.01:
* =================
* per part, and are often unique per model. They must also be
* positive numbers greater than zero.
*
* USERD_get_part_node_ids is used to obtain the ids, if the
*
* (Unlike API 1.0, where the connectivity of elements had to be
* according to the node ids - API 2.0's element connectivities
* are not affected either way by the status here.)
*
* status of TRUE here. You cannot assign them yourself!!
*
* * Starting at API 2.01:
* ====================
* For both unstructured and structured parts, you can read them
* from your file if available, or can assign them, etc. They need
* to be unique per part, and are often unique per model. They must
* also be positive numbers greater than zero.
*
* USERD_get_part_node_ids is used to obtain the ids, if the
*--------------------------------------------------------------------*/
int
USERD_get_node_label_status( void )
/*--------------------------------------------------------------------
3.4.35. USERD_get_nsided_conn
*--------------------------------------------------------------------
*
* Gets the array containing the connectivity of nsided elements
*
*
*
*
*
* (OUT) nsided_conn_array = 1D array of nsided connectivies
*
* connectivities. Which is the sum of
* all the nodes per element values in
* the conn_array of
* USERD_get_part_elements_by_type)
*
* Providing nsided information to Ensight:

*
* 1. In USERD_get_gold_part_build_info, provide the number of nsided
* elements in the part.
*
* the number of nodes per nsided element. (as if connectivity
* length of an nsided element is one)
*
* 3. In this routine, provide the streamed connectivities for each of the
* nsided elements.
*
*
* Simple example: 5 6
* +--------+
* 3 nsided elements: /| \
* (1 4-sided / | \
* 1 3-sided / | \
* 1 7-sided) / | \ 7
* /3 |4 +
* +-----+ |
* | | |
* | | |8
* | | +
* | | /
* | | /
* | | /
* |1 |2 /9
* +-----+--------+
*
*
*
*
*
*
*
* number_of_elements[Z_NSIDED] = 3
* .
* /|\
* |
*
* for element_type of Z_NSIDED:
* conn_array[0][0] = 4 (for the 4-sided element)
*
* Sum ===
* 14
<---------+
* |
* 3. In this routine: |
* length of nsided_conn_array will be: 14
*
* nsided_conn_array[0] = 1 (connectivity of 4-sided element)
*
*
*
*
*
* Notes:
* * Will not be called unless there are some nsided elements in the
* the part
*--------------------------------------------------------------------*/
int
USERD_get_nsided_conn(int part_number,
int *nsided_conn_array)
/*--------------------------------------------------------------------
3.4.36. USERD_get_nsided_conn_in_buffers
* <optional> (version 2.08 or later)
*--------------------------------------------------------------------
* Gets the two arrays containing the connectivity information
* of nsided elements in buffers
*
* API 2.* reader to be used by the Unstructured Auto Distribute
* capability in EnSight 8.2 and later.
*
*
*
*
* to the USERD_get_nsided_conn routine. And thus its implementation should
* implemented the USERD_get_nsided_conn routine.
*
*
*
*
*
* initialize, etc.
*
*
*
* e_beg = 0
* e_end = 4
*
* e_beg = 5
* e_end = 9
*
* n_beg = 0
*
* (IN) buffer_size = The size of the num_nodes_per_elem_array buffer.
* Namely: num_nodes_per_elem_array[buffer_size]
*
* (OUT) num_nodes_per_elem_array = 1D buffer array of the number of nodes
* per nsided element.
*
* (OUT) nsided_conn_array = 1D buffer array of nsided connectivies
*
* connectivities in the buffered chunk)
*
* (OUT) *num_returned = The number of elements whose connectivities
* are returned in the buffer. This will
* normally be equal to buffer_size except for
* that last buffer - which could be less than
* a full buffer.
*
* Providing nsided information to Ensight:
*
* NOTE: for other nsided operations you need these first two, but we
* don't actually use them in this routine.
*
* 1. In USERD_get_gold_part_build_info, provide the number of nsided
* elements in the part.
*
* the number of nodes per nsided element. (as if connectivity
* length of an nsided element is one)
*
* We do use the following:
* 3. In this routine, provide the corresponding num_nodes_per_element and
* streamed connectivities for each of the nsided elements in this
* buffered portion.
*
*
* Simple example: 5 6
* +--------+
* 3 nsided elements: /| \
* (1 4-sided / | \
* 1 3-sided / | \
* 1 7-sided) / | \ 7
* /3 |4 +
* +-----+ |
* | | |
* | | |8
* | | +
* | | /
* | | /
* | | /
* |1 |2 /9
* +-----+--------+
*
*
*
*
* NOTE, don't really use these first two here (See USERD_get_nsided_conn)
*
* number_of_elements[Z_NSIDED] = 3
* .
* /|\
* |
*
* for element_type of Z_NSIDED:
*
* Sum ===
* 14
*
* But for our example, lets assume that that our buffer is just 2
* ================
* 3. In this routine:
*
* first invocation:
* first = TRUE
* e_beg = 0
* e_end = 2
* buffer_size = 2
* num_nodes_per_elem_array[2] load it:
* num_nodes_per_elem_array[0] = 4
*
*
* *num_returned = 2
* return(0) return this (indicates more to do)
*
* first = FALSE
* e_beg = 0
* e_end = 2
* buffer_size = 2
* num_nodes_per_elem_array[2] load it:
*
* *num_returned = 1
* return(1) return this (indicates no more to do)
*
*
* -1 if an error
*
* Notes:
*
* * Will not be called unless there are some nsided elements in the
* the part
*--------------------------------------------------------------------*/
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)
/*--------------------------------------------------------------------
3.4.37. USERD_get_num_of_time_steps
*--------------------------------------------------------------------
*
* Get the number of time steps of data available for desired timeset.
*
* (IN) timeset_number = the timeset number (1 based)
*
* timeset_number's would be 1 and 2.
*
*
* Notes:
* * This should be >= 1 1 indicates a static timeset
*
*
* pipeline. The timeset_number sent to it will be a positive value.
*
* be reloaded.
*
* Then the timeset_number sent to this routine will be
* the negative of the actual value. Indicating that it
* "co-processing" purpose. Then this routine must also do
* the following:
*
* a) Check for the negtive timeset_number, and reverse it.
* b) Go get the new current number of time steps.
* c) Ensure that when USERD_get_sol_times is called again,
*--------------------------------------------------------------------*/
int
USERD_get_num_of_time_steps( int timeset_number )
/*--------------------------------------------------------------------
3.4.38. USERD_get_num_xy_queries
*--------------------------------------------------------------------
*
*
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_num_xy_queries( void )
/*--------------------------------------------------------------------
3.4.39. USERD_get_number_of_files_in_dataset
*--------------------------------------------------------------------
*
* Get the total number of files in the dataset. Used for the
*
* returns: the total number of files in the dataset
*
* Notes:
* care about the dataset query option, return a value of 0
* If you only want certain files, you can just include them. But,
* you will need to supply the info in USERD_get_dataset_query_file_info
* for each file you include here.
*
* * Num_dataset_files would be set here
*--------------------------------------------------------------------*/
int
USERD_get_number_of_files_in_dataset( void )
/*--------------------------------------------------------------------
3.4.40. USERD_get_number_of_material_sets
*--------------------------------------------------------------------
* Get the number of material sets in the model
*
* returns: Num_material_sets = number of material sets
* (Zero would indicate that you have no materials
* to deal with in the model)
* or
*
* -1 if an error condition
* Notes:
*
* * You may want to keep this as a global for use in other routines.
*
* ###############################################################
* NOTE: Since EnSight 7.6, only one material set is supported within EnSight
* Thus the only valid returns here are:
* 0 (no materials)
* 1 (for the one material set allowed)
* or -1 (if an error)
*
* If the casefile has more than this, this reader will read them,
* but EnSight will issue an error message and choke on them!
* ###############################################################
*
* ================================================================
* A very simple explanatory example, to use as a reference for the materials routines:
*
* Given a 2D mesh composed of 9 quad (Z_QUA04) elements, with two materials.
* Most of the model is material 1, but the top left corner is material 9 -
* basically as shown:
*
* *--------*--------*--------*
* | | / | |
* | Mat 9 / | |
* | | / | |
* | |/ | |
* | e7 / e8 | e9 |
* | /| | |
* | / | | |
* | / | | |
* *----/---*--------*--------*
* | / | | |
* | / | | |
* | / | Mat 1 |
* |/ | | |
* | e4 | e5 | e6 |
* | | | |
* | | | |
* | | | |
* *--------*--------*--------*
* | | | |
* | | | |
* | | | |
* | e1 | e2 | e3 |
* | | | |
* | | | |
* | | | |
* *--------*--------*--------*
*
* Thus, in this routine, set:
* Num_material_sets = 1
*
* In USERD_get_matf_set_info, set:
* mat_set_ids[0] = 1
* mat_set_name[0] = "Material Set 1" (or whatever name desired)
*
* In USERD_get_number_of_materials, input would be set_index = 0, and
* would need to set:
* Num_materials[0] = 2
*
* For simplicity, the ids and descriptions that would be returned in
* USERD_get_matf_var_info could be:
* mat_ids[0] = 1
* mat_ids[1] = 9
* mat_desc[0] = "mat 1" (or whatever desired)
* mat_desc[2] = "mat 9"
*
* Note1: In USERD_get_matf_set_type, the input would be set_index = 0, and if
* set_type = Z_MISET_VIA_SPARSE_MIX, the following 3 lists (material ids,
* mixed-material ids, and mixed-material values) would be needed and
* communicated by the following two USERD calls, i.e. USERD_size_matf_data
* and USERD_load_matf_data.
*
* The per element material ids list would need to be:
*
* material ids:
* -------------
* ids_list[0] = 1 (material id 1, for elem e1)
* ids_list[1] = 1 ( " e2)
* ids_list[2] = 1 ( " e3)
* ids_list[3] = -1 (neg. of index into mixed-material id list, for elem e4)
* ids_list[5] = 1 ( " e6)
* ids_list[6] = -5 (neg. of index into mixed-material id list, for elem e7)
* ids_list[7] = -9 ( " e8)
*
* Finally we need the mixed material ids list and the mixed materials
* values list, which would need to be:
*
* mixed-material ids:
* -------------------
* ==> 1 ids_list[0] = 2 (the -1 in the material variable points here,
* 2 indicates that two materials are present)
* 2 ids_list[1] = 1 (1st material is 1)
* 3 ids_list[2] = 9 (2nd material is 9)
* 4 ids_list[3] = -1 (negative of index into mixed-material val_list)
* ==> 5 ids_list[4] = 2 (the -5 in the material variable points here,
* 2 indicates that two materials are present)
* 6 ids_list[5] = 1 (1st material is 1)

* 7 ids_list[6] = 9 (2nd material is 9)
* 8 ids_list[7] = -3 (negative of index into mixed-material val_list)
* ==> 9 ids_list[8] = 2 etc.
* 10 ids_list[9] = 1
* 11 ids_list[10] = 9
* 12 ids_list[11] = -5
*
* mixed-material values:
* ----------------------
* ==> 1 val_list[0] = 0.875 (the -1 in the mixed-material ids_list points
* here, and this is the value for material 1)
* 2 val_list[1] = 0.125 (the value for material 9)
* ==> 3 val_list[2] = 0.125 (the -3 in the mixed-materials ids_list points
* here)
* 4 val_list[3] = 0.875
* ==> 5 val_list[4] = 0.875 (the -5 in the mixed-materials ids_list points
* here)
* 6 val_list[5] = 0.125
*
* So, USERD_size_matf_data would need to return
* matf_size = 8, when called with set_id = 1
* part_id = 1
* wtyp = Z_QUA04
* mat_type = Z_MAT_INDEX
*
* matf_size = 12, when called with set_id = 1
* part_id = 1
* mat_type = Z_MIX_INDEX
*
* = 6, when called with set_id = 1
* part_id = 1
* mat_type = Z_MIX_VALUE
*
* And, USERD_load_matf_data would need to return:
* the int array ids_list as shown above when called with:
* set_id = 1
* part_id = 1
* wtyp = Z_QUA04
* mat_type = Z_MAT_INDEX (indicating id list).
*
* the int array ids_list as shown above when called with:
* set_id = 1
* part_id = 1
* mat_type = Z_MIX_INDEX (indicating id list).
*
* the float array val_list as shown above when called with:
* set_id = 1
* part_id = 1
* mat_type = Z_MIX_VALUE (indicating val list).
*
* Note2: In USERD_get_matf_set_type, the input would be set_index = 0, and if
* set_type = Z_MISET_VIA_ESCAL_VARS, then only USERD_get_matf_escalars_desc
* would be called.
*
* In USERD_get_matf_escalars_desc, the input would be set_index = 0, and the
* descriptions of the per element scalar variables assigned as materials would
* need to be:
* mesv_desc[0] = "Escalar_1"
* mesv_desc[1] = "Escalar_9"
*
* Then corresponding per element lists would be:
* for list "Escalar_1"
* escal1_lis[0] = 1 {elem scalar value for elem 1}
* escal1_lis[3] = .875 {elem scalar value for elem 4}
*
* for list "Escalar_9"
*
* Note3: Only Note1 or Note2 can be used; not both simultaneously.
* Note1 should be used for readers that accommodate sparse material lists.
* Note2 should be used for readers that have the materials defined as
* per element scalar variables.
*--------------------------------------------------------------------*/
int
USERD_get_number_of_material_sets( void )
/*--------------------------------------------------------------------
3.4.41. USERD_get_number_of_materials
*--------------------------------------------------------------------
*
* Get the number of materials in the material set
*
*
* returns: Num_materials[set_index] = number of materials in set
* (Zero would indicate that you have
* no materials to deal with in the
* material set)
* or
*
*
* Notes:
* * This function only works when USERD_get_matf_set_type returns
* Z_MISET_VIA_SPARSE_MIX; and thus, is NOT available if USERD_get_matf_set_type
* returns Z_MISET_VIA_ESCAL_VARS.
*--------------------------------------------------------------------*/
int
USERD_get_number_of_materials( int set_index )
/*-------------------------------------------------------------------
3.4.42. USERD_get_number_of_model_parts
*-------------------------------------------------------------------
*
*
* This value is typically called: Numparts_available
*
* returns: Numparts_available (>0 if okay, <=0 if probs)
*
* Notes:
* * IMPORTANT!! The part or block numbers that get passed to various
* routines in this API, will be the one-based table index
* of these parts.
*
* For example, if you have three parts, the part or block
* numbers of these parts will be: 1,2,3
*
*-------------------------------------------------------------------*/
int
USERD_get_number_of_model_parts( void )
/*--------------------------------------------------------------------
3.4.43. USERD_get_number_of_species
*--------------------------------------------------------------------
*
* Get the number of material species in the material set
*
*
* returns: Num_species[set_index] = number of material species in set
* (Zero would indicate that you have
* no materials to deal with in the
* material set)
* or
*
*
* Notes:
* * This function only works when USERD_get_matf_set_type returns
* Z_MISET_VIA_SPARSE_MIX; and is not available if USERD_get_matf_set_type
* returns Z_MISET_VIA_ESCAL_VARS
*--------------------------------------------------------------------*/
int
USERD_get_number_of_species( int set_index )
/*--------------------------------------------------------------------
USERD_get_number_of_timesets

*--------------------------------------------------------------------
*
* Gets the number of timesets used in the model.
*
* returns:
* If you have a static model, both geometry and variables, you should
* return a value of zero.
*
* If you have a transient model, then you should return one or more.
*
* For example:
*
* Geometry Variables No. of timesets
* --------- ------------------------------ ---------------
* static static 0
* static transient, all using same timeset 1
*
* transient transient, all using same timeset as geom 1
*
* static transient, using 3 different timesets 3

*
* transient transient, using 3 different timesets and
* none of them the same as the
* geometry timeset 4
* etc.
*
* NOTE: ALL GEOMETRY MUST USE THE SAME TIMESET!!! You will have to provide
* the timeset number to use
* for geometry in:
* USERD_get_geom_timeset_number
*
* Variables can use the same timeset as the geometry, or can use
* other timesets. More than one variable can use the same timeset.
*
* example: changing geometry at 5 steps, 0.0, 1.0, 2.0, 3.0, 4.0
* variable 1 provided at these same five steps
* variable 2 provided at 3 steps, 0.5, 1.25, 3.33
*
* This routine should return a value of 2, because only
* two different timesets are needed. Timeset 1 would be for the
* geometry and variable 1 (they both use it). Timeset 2 would
* be for variable 2, which needs its own in this case.
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_number_of_timesets( void )
/*--------------------------------------------------------------------
USERD_get_number_of_variables

*--------------------------------------------------------------------
*
* Get the number of variables (includes constant, scalar,
* vector and tensor types), for which you will be providing info.
*
* returns: number of variables (includes constant, scalar, vector,
* and tensor types)
* >=0 if okay
* <0 if problem
*
* Notes:
* *****************************************************************
* * Variable numbers, by which references will be made, are implied
* here. If you say there are 3 variables, the variable numbers
* will be 1, 2, and 3.
* *****************************************************************
*
* * Num_variables would be set here
*--------------------------------------------------------------------*/
int
USERD_get_number_of_variables( void )
/*--------------------------------------------------------------------
USERD_get_part_coords

*--------------------------------------------------------------------
*
* Get the coordinates for an unstructured part.
*
*
*
*
*
* (OUT) coord_array = 2D float array which contains
* x,y,z coordinates of each node.
*
* (IMPORTANT: the second dimension of of this array is 1-based!!!)
*
* 3 by (number_of_nodes + 1) for the part
* long - see USERD_get_gold_part_build_info)
*
* ex) If number_of_nodes = 100
* as obtained in:
* USERD_get_gold_part_build_info
*
* Then the allocated dimensions of the
* pointer sent to this routine will be:
* coord_array[3][101]
*
* Ignore the coord_array[0][0]
* coord_array[1][0]
* coord_array[2][0] locations and start
* the node coordinates at:
* coord_array[0][1]
* coord_array[1][1]
* coord_array[2][1]
*
* coord_array[0][2]
* coord_array[1][2]
* coord_array[2][2]
*
* etc.
*
*
* Notes:
* * Not called unless number_of_nodes for the part > 0
*--------------------------------------------------------------------*/
int
USERD_get_part_coords(int part_number,
float **coord_array)
/*--------------------------------------------------------------------
USERD_get_part_coords_in_buffers

*--------------------------------------------------------------------
* Get the coordinates for an unstructured part in buffers.
*
*
*
*
*
* to the USERD_get_part_coords routine. And thus its implementation should
* implemented the USERD_get_part_coords routine.
*
*
*
*
*
* initialize, etc.
*
* (IN) n_beg = Zero based, first node index
*
* (IN) n_end = Zero based, last node index
*
* Thus, for first five nodes:
* n_beg = 0
* n_end = 4
* total_number = (n_end - n_beg) + 1 = (4 - 0) + 1 = 5
*
* for second five nodes, would be:
* n_beg = 5
* n_end = 9
*
* for all nodes of a part, would be:
* n_beg = 0
* n_end = num_nodes - 1
*
* (IN) buffer_size = The size of the buffer.
* Namely: coord_array[3][buffer_size]
*
* (OUT) coord_array = 2D float buffer array which is set up to
* hold x,y,z coordinates of nodes.
*
*
* (IMPORTANT: in the sister routine (USERD_get_part_coords) - which
* does not use buffers. This array is 1-based.
* So pay attention.)
*
* 3 by buffer_size long
*
* Example, if we had a part with 645 nodes and the buffer size was set to 200
*
* first invocation:
* first = TRUE Will be TRUE the first time!
* n_beg = 0
* n_end = 644
* buffer_size = 200
* coord_array[3][200] fill with values for nodes 1 - 200 (zero-based)
* *num_returned = 200 set this
*
* second invocation: which occurs because we returned a 0 last time

* first = FALSE will now be FALSE
* n_beg = 0
* n_end = 644
* buffer_size = 200
*
* third invocation: which occurs because we returned a 0 last time
* first = FALSE will still be FALSE
* n_beg = 0
* n_end = 644
* buffer_size = 200
*
* fourth invocation: which occurs because we returned a 0 last time
* n_beg = 0
* n_end = 644
* buffer_size = 200
* return(1) return this (indicates done!)
*
* (OUT) *num_returned = The number of nodes whose coordinates are returned
* in the buffer. This will normally be equal to
* buffer_size except for that last buffer -
* which could be less than a full buffer.
*
* -1 if an error
*
* Notes:
*
*
* * Again, make sure each buffer is zero based. For our example above:
*
* Invocation:
* 1 2 3 4
* ------- ------- -------- -------
* coord_array[0][0] x for node 1 node 201 node 401 node 601
* coord_array[1][0] y for " " " "
* coord_array[2][0] z for " " " "
*
*
* ...
*
*--------------------------------------------------------------------*/
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)
/*--------------------------------------------------------------------
USERD_get_part_element_ids_by_type

*--------------------------------------------------------------------
*
* Prior to API 2.01:
* ==================
* Gets the ids for the elements of a particular type for an
* unstructured part.
*
* ====================
* Gets the ids for the elements of a particular type for an
* unstructured or structured part.
*
*
*
*
*
*
* Z_TET04 4 node tetrahedron
* Z_PYR05 5 node pyramid
* Z_PEN06 6 node pentahedron
* Z_HEX08 8 node hexahedron
* Starting at API 2.03 Z_NSIDED nsided polygon
* Starting at API 2.03 Z_NFACED nfaced polyhedron
*
* ====================
*
* (OUT) elemid_array = 1D array containing id of each
* element of the type.
*
* number_of_elements of type long)
*
* number_of_elements[Z_HEX08] = 30
* as obtained in:
*
* elemid_array[25] when called with Z_TRI03
*
* elemid_array[100] when called with Z_QUA04
*
* elemif_array[30] when called with Z_HEX08
*
*
* Notes:
*
* =================
* * Not called unless Num_unstructured_parts is > 0 and element
* label status is TRUE
*
* ====================
* * Not called unless element label status is TRUE in
* USERD_get_element_label_status
*--------------------------------------------------------------------*/
int
USERD_get_part_element_ids_by_type(int part_number,
int element_type,
int *elemid_array)
/*--------------------------------------------------------------------
USERD_get_part_element_ids_by_type_in_buffers

*--------------------------------------------------------------------
*
* Gets the ids for the elements of a particular type
* in an unstructured part in buffers
*
*
*
* in your reader, EnSight can still perform this operation but will
* require much more memory on each server to read in the data (somewhat
* like each server having to read the whole model). You will however, get
* the execution advantage of having your model partitioned across multiple
* servers.
*
* If you do implement this routine (and the other in_buffers routines)
* in your reader (in a proper manner), you should be able to not only get
* the execution advantages, but also memory usage on each server which is
*
* to the USERD_get_part_element_ids_by_type routine. And thus its
* implementation should not be too difficult to add to any existing reader
* that has already implemented the USERD_get_part_element_ids_by_type
* routine.
*
*
*
*
*
*
*
* ====================
* Z_NSIDED n node ghost nsided polygon
* Z_NFACED n face ghost nfaced polyhedron
*
* ====================
* Z_NSIDED n node nsided polygon
* Z_NFACED n face nfaced polyhedron
* Z_G_NSIDED n node ghost nsided polygon
* Z_G_NFACED n face ghost nfaced polyhedron
*
* initialize, etc.
*
*
*
* e_beg = 0
* e_end = 4
*
* e_beg = 5
* e_end = 9
*
* n_beg = 0
*
* Namely: elemid_array[buffer_size]
*
* (OUT) elemid_array = 1D buffer array which is set up to hold ids
* of elements of the type.
*
* buffer_size long)
*
* * Example, (if 158 quad elements, and buffer size is 200)
*
* (get all 158 quad4 ids in one invocation)
* element_type = Z_QUA04
* e_beg = 0 (zero based, first element index)
* e_end = 157 (zero based, last element index)
* buffer_size = 200
* elemeid_array[200] Use first 158 locations of the array
*
*
* first invocation:
* e_beg = 0
* e_end = 157
* buffer_size = 75
* elemid_array[75] load in ids for elements 1 - 75
*
* e_beg = 0
* e_end = 157
* buffer_size = 75
*
* third invocation:
* e_beg = 0
* e_end = 157
* buffer_size = 75
*
*
* (OUT) *num_returned = The number of elements whose ids are returned
* in the buffer. This will normally be equal
* to buffer_size except for that last buffer
* - which could be less than a full buffer.
*
* -1 if an error
*
* Notes:
*
* * Again, make sure each buffer is zero based.
* For our example using buffers above:
*
* Invocation:
* 1 2 3
* ------- ------- --------
* elemid_array[0] elem id for quad 1 quad 76 quad 151
*
*
* ...
*
*--------------------------------------------------------------------*/
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)
/*--------------------------------------------------------------------
USERD_get_part_elements_by_type

*--------------------------------------------------------------------
*
* Gets the connectivities for the elements of a particular type
* in an unstructured part
*
*
*
*
*
* Starting at API 2.03 Z_NSIDED nsided polygon
* Starting at API 2.03 Z_NFACED nfaced polyhedron
*
* ====================

*
*
*
*
* of each element of the type.
*
* number_of_elements of
* the type by connectivity length
* of the type)
*
* number_of_elements[Z_HEX08] = 30
* as obtained in:
*
* conn_array[25][3] when called with Z_TRI03
*
*
* conn_array[30][8] when called with Z_HEX08
*
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_part_elements_by_type(int part_number,
int element_type,
int **conn_array)
/*--------------------------------------------------------------------
USERD_get_part_elements_by_type_in_buffers
* <optional> (Version 2.08 and later)

*--------------------------------------------------------------------
*
* Gets the connectivities for the elements of a particular type
* in an unstructured part in buffers
*
*

*
*
*
* to the USERD_get_part_elements_by_type routine. And thus its
* implementation should not be too difficult to add to any existing reader
* that has already implemented the USERD_get_part_elements_by_type routine.
*
*
*
*
*
*
*
*
*
* ====================
* Z_NSIDED n node ghost nsided polygon
* Z_NFACED n face ghost nfaced polyhedron
*
* ====================

*
* initialize, etc.
*
* (IN) e_beg = Zero based, first element number of the buffered set
*
* (IN) e_end = Zero based, last element number of the buffered set
*
* e_beg = 0
* e_end = 4
*
* e_beg = 5
* e_end = 9
*
* n_beg = 0
*
* Namely: conn_array[buffer_size][element_size]
*
* (OUT) conn_array = 2D buffer array which is set up to hold
* connectivity of elements of the type.
*
* buffer_size of the type by connectivity length
* of the type)
*
* ex) The allocated dimensions available
* conn_array[buffer_size][3] when called with Z_TRI03
*
* conn_array[buffer_size][4] when called with Z_QUA04
*
* conn_array[buffer_size][8] when called with Z_HEX08
*
* etc.
*
*
* (get all 158 quad4s in one invocation)
* e_beg = 0 (zero based, first element index)
* e_end = 157 (zero based, last element index)
* buffer_size = 200
* conn_array[200][4] Use first 158 locations of the array
*
*
* first invocation:
* e_beg = 0
* e_end = 157
* buffer_size = 75
* conn_array[75][4] load in conn for elements 1 - 75
*
* e_beg = 0
* e_end = 157
* buffer_size = 75
*
* third invocation:
* e_beg = 0
* e_end = 157
* buffer_size = 75
*
*
* (OUT) *num_returned = The number of elements whose connectivities
* are returned in the buffer. This will
* normally be equal to buffer_size except for
* that last buffer - which could be less than
* a full buffer.
*
* -1 if an error
*
* Notes:
*
*
* Invocation:
* 1 2 3
* ------- ------- --------
* conn_array[0][0] node 1 in conn for quad 1 quad 76 quad 151
*
*
* ...
*
*--------------------------------------------------------------------*/
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)
/*--------------------------------------------------------------------
USERD_get_part_node_ids
* (Version 2.00 and later)

*--------------------------------------------------------------------
* ==================
* Get the node ids of an unstructured part.
*
* ====================
* Get the node ids of an unstructured or structured part.
*
*
*
*
*
* (OUT) nodeid_array = 1D array containing node ids of
* each node in the part.
*
* (IMPORTANT: this array is 1-based!!!)
*
* (number_of_nodes + 1) for the part long
* see USERD_get_gold_part_build_info)
*
* as obtained in:
*
* nodeid_array[101]
*
* Ignore the nodeid_array[0] location and start
* the node ids at:
* nodeid_array[1]
*
* nodeid_array[2]
*
* etc.
*
* Notes:
*
* * Not called unless number_of_nodes for the part is > 0 and
* node label status is TRUE, as returned from USERD_get_node_label_status
*
* * The ids are purely labels, used when displaying or querying node ids.
* However, any node id < 0 will never be displayed
*--------------------------------------------------------------------*/
int
USERD_get_part_node_ids(int part_number,
int *nodeid_array)
/*--------------------------------------------------------------------
USERD_get_part_node_ids_in_buffers
* <optional> (Version 2.08 an later)

*--------------------------------------------------------------------
*
* Get the node ids for an unstructured part in buffers.

*
*
*
*
* If you do implement this routine (and the other in_buffers routines)
* in your reader (in a proper manner), you should be able to not only get
* the execution advantages, but also memory usage on each server which is
*
* to the USERD_get_part_node_ids routine. And thus its implementation should
* implemented the USERD_get_part_node_ids routine.
*
*
*
*
*
* of the set. This is so you can open files, get to
* the correct starting spot, initialize, etc.
*
* (IN) n_beg = Zero based, first node index
*
* (IN) n_end = Zero based, last node index
*
* Thus, for first five nodes:
* n_beg = 0
* n_end = 4
*
* for second five nodes, would be:
* n_beg = 5
* n_end = 9
*
* for all nodes of a part, would be:
* n_beg = 0
* n_end = num_nodes - 1
*
* Namely: nodeid_array[buffer_size]
*
* (OUT) nodeid_array = 1D buffer array which is set up to hold
* node ids of nodes
*
* (IMPORTANT: this array is 0-based!!!)
*
* (IMPORTANT: in the sister routine (USERD_get_part_node_ids) - which
* does not use buffers. This array is 1-based.
* So pay attention.)
*

* buffer_size long)
*
* Example, if we had a part with 645 nodes and the buffer size was set to 200
*
* first invocation:
* n_beg = 0
* n_end = 644
* buffer_size = 200
* nodeid_array[200] fill with values for nodes 1 - 200 (zero-based)
*
* second invocation: which occurs because we returned a 0 last time
* first = FALSE will now be FALSE
* n_beg = 0
* n_end = 644
* buffer_size = 200
*
* third invocation: which occurs because we returned a 0 last time
* n_beg = 0
* n_end = 644
* buffer_size = 200
*
* fourth invocation: which occurs because we returned a 0 last time
* n_beg = 0
* n_end = 644
* buffer_size = 200
* return(1) return this (indicates done!)
*
* (OUT) *num_returned = The number of nodes whose ids are returned
* in the buffer. This will normally be equal
* to buffer_size except for that last buffer
* - which could be less than a full buffer.
*
* -1 if an error
*
* Notes:
*
*
* * Again, make sure each buffer is zero based. For our example above:
*
* Invocation:
* 1 2 3 4
* ------- ------- -------- -------
* nodeid_array[0] id for node 1 node 201 node 401 node 601
*
*
* ...
*
*--------------------------------------------------------------------*/
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)
/*--------------------------------------------------------------------
USERD_get_periodic_ghosts_num_pairs

*--------------------------------------------------------------------
*
*
*
*
*
* face = The (zero-based) symmetry face number. This routine will
* be called the number of times as the number of faces
* declared in USERD_get_periodic_ghosts_num_symmety_faces.
*
* For translation and rotation, this routine will be
* called twice - once with face = 0, and once with
* face = 1;
* For mirroring, this routine can be called once,
* twice, or three times. Thus face will be 0, 0 and 1,
* or 0,1,2.
*
* returns: the number of node pairs for the symmetry face.
*
* Notes:
* You must have first called:
* USERD_use_periodic_ghosts (only need be done once for the model)
* USERD_get_periodic_ghosts_num_symmetry_faces
*
* and will need to call:
* USERD_get_periodic_ghosts_pairs
*
* See USERD_use_periodic_ghosts routine for examples.
*--------------------------------------------------------------------*/
int
USERD_get_periodic_ghosts_num_pairs(int part_number, int face)
/*--------------------------------------------------------------------
USERD_get_periodic_ghosts_num_symmetry_faces

*--------------------------------------------------------------------
*
*
*
*
*
* returns: The number of symmetry faces in the part, and for which the
* pairs of matching nodes will be provided in:
* USERD_get_periodic_ghosts_num_pairs
* USERD_get_periodic_ghosts_pairs.
*
* or the ijk information will be provided in:

* USERD_get_periodic_ghosts_structured_face_info
*
* Zero should be returned if this part has no symmetry faces.
*
* Notes:
*
* and will afterwards need to call either:
* USERD_get_periodic_ghosts_num_pairs and
* USERD_get_periodic_ghosts_pairs
*
* or
*
*
*
* For Translation, and rotation, the number should be 2 because there
* should always be an opposite face.
*
* For mirroring, the number can be 1, 2, or 3, depending on which of
* the reflection faces are being used. Namely, for mirror symmetry
* the original instance can reflect across x, y, z, xy, yz, xz, or xyz
* filling the appropriate other 7 quadrants. And the faces needing ghosts
* depends on which are used. (x, xy, xz, xyz need x face,
* y, xy, yz, xyz need y face,
* z, xz, yz, xyz need z face)
*--------------------------------------------------------------------*/
int
USERD_get_periodic_ghosts_num_symmetry_faces(int part_number)
/*--------------------------------------------------------------------
USERD_get_periodic_ghosts_pairs

*--------------------------------------------------------------------
*
*
*
*
*
* declared in USERD_get_periodic_ghosts_num_symmety_faces.
*
* face = 1;
* or 0,1,2.
*
* providing_matrix = TRUE if the reader is providing the matrix. And the
* m argument must contain that matrix.
*
* FALSE if EnSight should compute it from the node pairs.
* Thus m argument is ignored.
*
* Note: EnSight should be able to produce the m matrix
* for you, except for the condition of planar 2D
* with transformations out of plane.
*
* m = 4x4 transformation matrix.

* This will be used if providing_matrix flag is TRUE
*
* Note: this matrix will be used in the following fashion:
*
* {Ax Ay Az 1}|m11 m12 m13 m14| = {Bx By Bz 1}
* . |m21 m22 m23 m24| .
* . |m31 m32 m33 m34| .
* . |m41 m42 m43 m44| .
*
* where Ax Ay Az are the coords of node1 of a pair
* Bx By Bz are the coords of node2 of a pair
*
* This matrix is generally thought of as:
*
* | | 0| r is the rotational, shearing,
* | r | 0| reflection portion
* | | 0|
* |--------------|--|
* | t | 1| t is the translational portion
*
*
* (OUT) pairs = array of part node indicies that are periodic match pairs
* for the part and symmetry face.
*
* pairs[0] = node1 of 1st pair
* [1] = node2 of 1st pair
* [2] = node1 of 2nd pair
* [3] = node2 of 2nd pair
* [4] = node1 of 3rd pair
* [5] = node2 of 3rd pair
* .
* .
* .
*
* it's length needs to be twice the num_pairs returned in
* USERD_get_periodic_ghosts_num_pairs.
*
* The nodes need to be the node indicies, not the ids.
*
* returns: Z_OK if all is well
* Z_ERR if an error
*
* Notes:
*
*
*
* For translation and rotation, the pairs for face 1 will be the reverse
* of those for face 0.
* For mirroring, each pair will contain the same node index.
*--------------------------------------------------------------------*/
int
USERD_get_periodic_ghosts_pairs(int part_number,
int face,
int *providing_matrix,
double m[4][4],
int *pairs)
/*--------------------------------------------------------------------
USERD_get_periodic_ghosts_structured_face_info

*--------------------------------------------------------------------
*

*
*
*
*
* declared in USERD_get_periodic_ghosts_num_symmetry_faces.
*
* face = 1;
* or 0,1,2.
*
* providing_matrix = TRUE if the reader is providing the matrix. And the
* m argument must contain that matrix.
*
* FALSE if EnSight should compute it from the node pairs.
* Thus m argument is ignored.
*
* Note: EnSight should be able to produce the m matrix
* for you.
* Note that there is an issue with the
* condition of planar 2D transformations out of
* plane. The transformation matrix produced may not
* be what you wanted - because there isn't enough
* information provided. However, even if the
* transformation isn't exactly correct, the ghost
* elements produced may still do their job of
* proper interpolation across the boundary (unless
* direction is critical). So for scalars you should
* be good - but for vectors you may not be.
*
*
* m = 4x4 transformation matrix.
* This will be used if providing_matrix flag is TRUE
*
* Note: this matrix will be used in the following fashion:
*
* {Ax Ay Az 1}|m11 m12 m13 m14| = {Bx By Bz 1}
* . |m21 m22 m23 m24| .
* . |m31 m32 m33 m34| .
* . |m41 m42 m43 m44| .
*
* where Ax Ay Az are the coords of node1 of a pair
* Bx By Bz are the coords of node2 of a pair
*
* This matrix is generally thought of as:
*
* | | 0| r is the rotational, shearing,
* | r | 0| reflection portion
* | | 0|
* |--------------|--|
* | t | 1| t is the translational portion
*
*
* (OUT) which_ijk = 1 for i direction or axis
* 2 for j direction or axis
* 3 ofr k direction or axis
*
* min_or_max = 0 for min i,j, or k
* 1 for max i,j, or k
*
* returns: Z_OK if all is well
* Z_ERR if an error
*
* Notes:
* You must first call:
*
* Simple Structured Examples:
*
* periodic translation in i (min i goes to max i)
* ================================================
*
* j (in terms of original elements)
*
* *- - - - -*---------*---------*---------*- - - - -*
* . ghost | | | | ghost .
* . 8 | 6 | 7 | 8 | 6 .
* . | | | | .
* *- - - - -*---------*---------*---------*- - - - -*
* near. 5 | 3 | 4 | 5 | 3 . far
* . | | | | .
* *- - - - -*---------*---------*---------*- - - - -*
* . 2 | 0 | 1 | 2 | 0 .
* . | | | | .
* *- - - - -*---------*---------*---------*- - - - -* i
*
* <===== translation direction =====>
*
* num_symmetry_faces = 2;
* for face 0:
* which_ijk = 1
* min_or_max = 0
* for face 1:
* which_ijk = 1
* min_or_max = 1
*
*
* periodic rotation of 90 degrees about k (min j goes to max j)
* =============================================================
*
* 15 12 9
* *-----------*------------*
* | . |
* | . . | Not as easy to
* | . | show!
* | . . |
* far | . |
* face 14 | 11. 8 . | 6
* (max j) *----*-----* *
* | . . | . |
* | . | 5 . |
* | . . * |
* | . . | | ^
* |.. | 2 | 3 |
* *----------*-------------* j
* 1,4,7,10,13
* i ->
* near face (min j)
*
* rotates in plane about k
*
* num_faces = 2
* for face 0:
* which_ijk = 2
* min_or_max = 0
* for face 1:
* which_ijk = 2
* min_or_max = 1
*
*
* mirror in i, and j (so min i reflects, ans min j reflects)
* ==========================================================
*
* ^
* | (in terms of original elements
* j
*
* *- - - - -*---------*---------*---------*
* . ghost | | | |
* . 6 | 6 | 7 | 8 |
* . | | | |
* *- - - - -*---------*---------*---------*
* . ghost | | | |
* . 3 | 3 | 4 | 5 |
* . | | | |
* *- - - - -*---------*---------*---------*
* . ghost | | | |
* . 0 | 0 | 1 | 2 |
* . | | | |
* *- - - - -*---------*---------*---------* i -->
* . ghost . ghost . ghost . ghost .
* . 0 . 0 . 1 . 2 .
* . . . . .
* *- - - - -*- - - - -*- - - - -*- - - - -*
*
* num_faces = 2
* for face 0:
* which_ijk = 1;
* min_or_max = 0;
* for face 1:
* which_ijk = 2;
* min_or_max = 0;
*--------------------------------------------------------------------*/
int
USERD_get_periodic_ghosts_structured_face_info(int part_number,
int face,
int *providing_matrix,
double m[4][4],
int *which_ijk,
int *min_or_max)
/*--------------------------------------------------------------------
USERD_get_reader_descrip

*--------------------------------------------------------------------
*
*
* is 255)
*
*
*--------------------------------------------------------------------*/
int
/*--------------------------------------------------------------------
USERD_get_reader_release

*--------------------------------------------------------------------
*
*

*
* is 20)
*
*
* Notes:
*--------------------------------------------------------------------*/
int
/*--------------------------------------------------------------------
USERD_get_reader_version

*--------------------------------------------------------------------
*
* Gets the API version number of the user defined reader
*
* The functions that EnSight will call depends on this API
* version. See the README files for more information.
*
* (OUT) version_number = the version number of the reader
* is 20)
*
*
* Notes:
* * Always called.
*
* * This needs to be "2.000" or greater. Otherwise EnSight will assume
* this reader is API 1.0 instead of 2.0
*--------------------------------------------------------------------*/
int
USERD_get_reader_version(char version_number[Z_MAX_USERD_NAME])
/*--------------------------------------------------------------------
USERD_get_sol_times

*--------------------------------------------------------------------
*
* Get the solution times associated with each time step for desired timeset.
*
* (IN) timeset_number = the timeset number (1 based)
*
*
* (OUT) solution_times = 1D array of solution times per time step
*
* Num_time_steps[timeset_number] long)
*

*
* Notes:
*
* pipeline.
*
* be reloaded.
*
* Then the number of time steps may have increased. (See
* USERD_get_num_of_time_steps)
* Thus the solution times returned here must include all
* current steps.
*--------------------------------------------------------------------*/
int
USERD_get_sol_times(int timeset_number,
float *solution_times)
/*--------------------------------------------------------------------
USERD_get_structured_reader_cinching

*--------------------------------------------------------------------
*
* Gets whether this reader will do structured cinching for block data
* This means that it will handle the min, max, and step values for a
* given block and return the coordinate components or variable components
* in their "cinched" state when partial extraction or striding is used.
* This is as opposed to returning the entire component (ignoring min, max
* and stride) and letting Ensight pick out the values actually used.
*
* returns: Z_OK if the reader will handle the
* min, max, and stride and return
* the cinched values only.
*
* Z_UNDEF or Z_ERR if will return entire component
* and rely on EnSight to cinch.
*
* Notes:
* Unless you can actually pull out the desired min, max, and stride
* without using a full component of memory, don't enable this feature.
*
* IMPORTANT!! If your reader will be used for structured auto-distribute,
* you must implement this feature, which includes this routine and
* USERD_set_block_range_and_stride
*--------------------------------------------------------------------*/
int
USERD_get_structured_reader_cinching( void )
/*--------------------------------------------------------------------
USERD_get_timeset_description

*--------------------------------------------------------------------
*
* Get the description to associate with the desired timeset.
*
* (IN) timeset_number = the timeset number
*

*
* (OUT) timeset_description = timeset description string
*
*
*
* Notes:
* * A string of NULLs is valid for timeset_description
*--------------------------------------------------------------------*/
int
USERD_get_timeset_description(int timeset_number,
char timeset_description[Z_BUFL])
/*--------------------------------------------------------------------
USERD_get_uns_failed_params

*--------------------------------------------------------------------
*
* Provides the failure variable and and failure criteria for failed elements
*
* (OUT) fail_var_name = Variable name to be used for failure.
* Must be a per-elem scalar!
*
* (OUT) threshold_val1 = 1st number for failure comparison
* Always used in the determination.
* If threshold_operator1 is Z_ELE_FAILED_EQUAL,
* then only this threshold value is used.
*
* (OUT) threshold_val2 = 2nd number for failure comparison
* Will be used if threshold_operator1 is not
* set to Z_ELE_FAILED_EQUAL and
* logic_criteria2 is set to
* Z_ELE_FAILED_LOGIC_AND or
* Z_ELE_FAILED_LOGIC_OR
*
* (OUT) threshold_operator1 = 1st threshold operator
* Z_ELE_FAILED_GREATER - greater than
* Z_ELE_FAILED_LESS - less than
* Z_ELE_FAILED_EQUAL - equal
* Z_ELE_FAILED_NOT_EQUAL - not equal
* Sets the logic for use of threshold_val1
*
* (OUT) threshold_operator2 = 2nd threshold operator
* Z_ELE_FAILED_GREATER - greater than
* Z_ELE_FAILED_LESS - less than
* Z_ELE_FAILED_EQUAL - equal
* Z_ELE_FAILED_NOT_EQUAL - not equal
* Used if logic_criteria2 is set to
* Z_ELE_FAILED_LOGIC_AND or
* Sets the loginc for use of threshold_val2
*
* (OUT) logic_criteria2 = Determines if using second criteria and if it
* is an and or or condition
* Z_ELE_FAILED_LOGIC_NONE
* Z_ELE_FAILED_LOGIC_AND
*
* returns: TRUE if failed elements should be used
* FALSE if not using failed elements
*
*
* Notes:
*
* Example 1:
* If variable "failure" is an element scalar that has values which
* are either 0.0 (for not-failed) or 1.0 (for failed), then:

* fail_var_name = "failure"
* threshold_val1 = 1.0
* threshold_operator1 = Z_ELE_FAILED_EQUAL
* **rest is ignored**
*
*
*
* Example 2:
* If variable "Stress" is an element scalar, and failure occurs
* when the stress exceeds 3000.0
* fail_var_name = "Stress"
* threshold_operator1 = Z_ELE_FAILED_GREATER
* logic_criteria2 = Z_ELE_FAILED_LOGIC_NONE
*
* Example 3:
* If variable "Stress" is an element scalar, and failure occurs
* when the value is less than -500, or greater than 400
* fail_var_name = "Stress"
* threshold_val1 = -500.0
* threshold_operator1 = Z_ELE_FAILED_LESS
* threshold_operator2 = Z_ELE_FAILED_GREATER
* logic_criteria2 = Z_ELE_FAILED_LOGIC_OR
*-------------------------------------------------------------------*/
int USERD_get_uns_failed_params(char *fail_var_name,
float *threshold_val1,
float *threshold_val2,
int *threshold_operator1,
int *threshold_operator2,
int *logic_criteria2)
/*--------------------------------------------------------------------
USERD_get_var_by_component

*--------------------------------------------------------------------
*
* Gets the values of a variable component. Both unstructured and structured
* parts use this routine.
*
* if Z_PER_NODE:
* Get the component value at each node for a given variable in the part.
*
* or if Z_PER_ELEM:
* Get the component value at each element of a specific part and type for
* a given variable.
*
* (IN) which_variable = The variable number (1 to Num_variables)
*
* (IN) which_part Since EnSight Version 7.4
* -------------------------
* = The part number
*
*
*
*
* ----------------------------
* = The part id This is the part_id label
* loaded in
* USERD_get_gold_part_build_info.
* It is NOT the part table index.
*
* (IN) var_type = Z_SCALAR
* Z_VECTOR
* Z_TENSOR ( symmetric tensor)
* Z_TENSOR9 (asymmetric tensor)
*
* (IN) which_type
*
*
*
* ====================
*
* (IN) imag_data = TRUE if imag component
* FALSE if real component
*
* (IN) component = The component: (0 if Z_SCALAR)
* (0 - 2 if Z_VECTOR)
* (0 - 5 if Z_TENSOR)
* (0 - 8 if Z_TENSOR9)
*
* * 6 Symmetric Indicies, 0:5 *
* * ---------------------------- *
* * | 11 12 13 | | 0 3 4 | *
* * | | | | *
* * T = | 22 23 | = | 1 5 | *
* * | | | | *
* * | 33 | | 2 | *
*
* * 9 General Indicies, 0:8 *
* * ---------------------------- *
* * | 11 12 13 | | 0 1 2 | *
* * | | | | *
* * T = | 21 22 23 | = | 3 4 5 | *
* * | | | | *
* * | 31 32 33 | | 6 7 8 | *
*
* (OUT) var_array
*
* -----------------------------------------------------------------------
* (IMPORTANT: this array is 1-based for both Z_PER_NODE and Z_PER_ELEM!!!

* -----------------------------------------------------------------------
*
* if Z_PER_NODE: = 1D array containing variable component value
* for each node.
*
* (number_of_nodes+1) long)
*
* var_array[0] = not used
* var_array[1] = var component for node 1 of part
* etc.
*
* if Z_PER_ELEM: = 1d array containing variable component value
* for each element of particular part & type.
*
* (number_of_elements[which_part][which_type] + 1)
* long. See USERD_get_gold_part_build_info)
*
* var_array[1] = var component for elem 1 (of part and type)
* var_array[2] = var component for elem 2 "
* var_array[3] = var conponent for elem 3 "
* etc.
*
*
* or: Z_UNDEF if this variable is not defined on this part. In which
* case you need not load anything into the var_array.
*
* Notes:
*
* * Not called unless Num_variables is > 0
*
*
* * If the variable is not defined for this part, simply return with a
* value of Z_UNDEF. EnSight will treat the variable as undefined for
* this part.
*--------------------------------------------------------------------*/
int
USERD_get_var_by_component(int which_variable,
int which_part,
int var_type,
int which_type,
int imag_data,
int component,
float *var_array)
/*--------------------------------------------------------------------
USERD_get_var_by_component_given_coords
/*--------------------------------------------------------------------
USERD_get_var_by_component_given_coords(int which_variable,
int which_part,
int var_type,
int which_type,
int imag_data,
int component,
float *var_array)
* This routine is an optional replacement for
* USERD_get_var_by_component,
* and will be called only if it is defined and present in the reader.

*
* If this is present, USERD_get_var_by_component will not be called,
* and this routine will be called in its place.
*
* The reason you would implement this routine is if you needed the
* coordinate array for the process of generating your variable
* for example, for a coordinate transformation of a vector variable
* in order to supply the vector variable in cylindrical coordinates.
*
*
*--------------------------------------------------------------------
* (IN) handle = The USERDHandle pointer
* created in USERD_reader_open
*
* Gets the values of a variable component. Both unstructured and structured
* parts use this routine.
*
* if Z_PER_NODE:
* Get the component value at each node for a given variable in the part.
*
* or if Z_PER_ELEM:
* a given variable.
*
*
* -------------------------
* = The part number
*
*
*
*
* ----------------------------
* loaded in
*
* Z_VECTOR
*
* (IN) which_type
*
*
*
* ====================
*
*
*
* * ---------------------------- *
* * | 11 12 13 | | 0 3 4 | *
* * | | | | *
* * T = | 22 23 | = | 1 5 | *
* * | | | | *
* * | 33 | | 2 | *
*
* * ---------------------------- *
* * | 11 12 13 | | 0 1 2 | *
* * | | | | *
* * T = | 21 22 23 | = | 3 4 5 | *
* * | | | | *
* * | 31 32 33 | | 6 7 8 | *
*
*
* (IN) float **coord_array, /* [xyz, i.e. 0,1,2][node # 1 based ] */
* 2D float array which contains x,y,z coordinates of each node.
*
*
* 3 by (number_of_nodes + 1) for the part
* long - see USERD_get_gold_part_build_info)
*
* as obtained in:
*
* coord_array[3][101]
*
* Ignore the coord_array[0][0]
* coord_array[1][0]
* coord_array[2][0]
* the node coordinates begin at:
* coord_array[0][1]
* coord_array[1][1]
* coord_array[2][1]
*
* coord_array[0][2]
* coord_array[1][2]
* coord_array[2][2]
*
* etc.*
* (OUT) var_array
*
* -----------------------------------------------------------------------
* -----------------------------------------------------------------------
*
* if Z_PER_NODE: = 1D array containing variable component value
* for each node.
*
* (number_of_nodes+1) long)
*
* var_array[0] = not used
* etc.
*
* if Z_PER_ELEM: = 1d array containing variable component value
* for each element of particular part & type.
*
* (number_of_elements[which_part][which_type] + 1)
* long. See USERD_get_gold_part_build_info)
*
* var_array[1] = var component for elem 1 (of part and type)
* var_array[2] = var component for elem 2 "
* var_array[3] = var conponent for elem 3 "
* etc.
*
*
* or: Z_UNDEF if this variable is not defined on this part. In which
* case you need not load anything into the var_array.
*
* Notes:
*
* * Not called unless Num_variables is > 0
*
*
* * If the variable is not defined for this part, simply return with a
* value of Z_UNDEF. EnSight will treat the variable as undefined for
* this part.
*--------------------------------------------------------------------*/
USERD_get_var_by_component_in_buffers

*--------------------------------------------------------------------
*
* if Z_PER_NODE:
* Get the component value at each node for a given variable in the part
* in buffers.
*
* or if Z_PER_ELEM:
* a given variable in buffers.
*
*
*
*
*
* to the USERD_get_var_by_component routine. And thus its implementation
* should not be too difficult to add to any existing reader that has already
* implemented the USERD_get_var_by_component routine.
*
*
* -------------------------
* = The part number
*
*
*
*
* ----------------------------
* loaded in
* USERD_get_gold_part_build_inf\o.
*
* Z_VECTOR
*
* (IN) which_type
*
*
*

*
*
*
*
*
*
*
*
*
* * ---------------------------- *
* * | 11 12 13 | | 0 3 4 | *
* * | | | | *
* * T = | 22 23 | = | 1 5 | *
* * | | | | *
* * | 33 | | 2 | *
*
* * ---------------------------- *
* * | 11 12 13 | | 0 1 2 | *
* * | | | | *
* * T = | 21 22 23 | = | 3 4 5 | *
* * | | | | *
* * | 31 32 33 | | 6 7 8 | *
*
* (IN) ne_beg
* if Z_PER_NODE: = Zero based, 1st node index of the buffered set
* if Z_PER_ELEM: = Zero based, 1st element index of the buffered set
*
* (IN) ne_end
* if Z_PER_NODE: = Zero based, last node index of the buffered set
* if Z_PER_ELEM: = Zero based, last element index of the buffered set
*
* Thus, for first five elements or nodes:
* e_beg = 0
* e_end = 4
*
* for second five elements or nodes, would be:
* e_beg = 5
* e_end = 9
*
* for all elements or nodes of a part, would be:
* n_beg = 0
* n_end = num_elements_or_nodes - 1
*
* initialize, etc.
*
* Namely: var_array[buffer_size]
*
* (IN) leftside = TRUE if current time is at a timestep or
* when getting the left side of a time
* span that encloses the current time.
* = FALSE when getting the right side of a time
* span that encloses the current time.
*
* Timeline:
* step1 step2 step3
* |-------------|--------------|-------... requires no interpolation
* ^ get values at step2
* current time (leftside = TRUE)
*
*
*
* Timeline:
* step1 step2 step3
* |-------------|--------------|-------... requires interpolation
* ^ get values at step1 (leftside = TRUE)
* current time and get values at step2 (leftside = FALSE)
*
*
* Note that it would generally be easier for this routine if EnSight got all
* of the left side, then all of the right side, and then did its
* interpolation. But, in the spirit of doing things in buffers (to save
* memory) it gets a left side buffer (and the corresponding right side
* buffer and interpolates these), if needed, before going to the next
* buffer of the set. Thus, you need to be able to handle that
* situation.
*
* Note also that EnSight will have called the routine to change the current
* time step between the two invocations when interpolation is required.
* And Ensight does the interpolating. This variable is provided so
* that you can deal with two different files or pointers between the
* corresponding invocations for the two times
*
* (OUT) var_array
*
* -----------------------------------------------------------------------
* -----------------------------------------------------------------------
*
* if Z_PER_NODE: = 1D buffer array set up to hold a variable
* component value for nodes.
*
* if Z_PER_ELEM: = 1D buffer array set up to hold a variable
* component value for elements.
*
* buffer_size long)
*
* var_array[0] = var component for node or element 1 of part
* etc.
*
*
* * Example, (if 158 quad elements with a real Z_PER_ELEM scalar,
* current time is between steps, and buffer size is 75)
*
* first invocation: (for left side of time span)
* var_type = Z_SCALAR
* which_type = Z_PER_ELEM
* imag_data = FALSE
* component = 0
* ne_beg = 0
* ne_end = 157
* buffer_size = 75
* leftside = TRUE <==
* var_array[75] load in scalar value for elements 1 - 75
*
*
* second invocation: (for right side of time span)
* imag_data = FALSE
* component = 0
* ne_beg = 0
* ne_end = 157
* first = TRUE Note: Will still be TRUE (because is
* right side)
* buffer_size = 75
* leftside = FALSE <==
* var_array[75] load in scalar value for elements 1 - 75
*
* -------------------------------
* third invocation: (for left side of time span)
* imag_data = FALSE
* component = 0
* ne_beg = 0
* ne_end = 157
* first = FALSE Will be FALSE now
* buffer_size = 75
* var_array[75] load in scalar value for
* elements 76 - 150
*
* fourth invocation: (for right side of time span)
* imag_data = FALSE
* component = 0
* ne_beg = 0
* ne_end = 157
* first = FALSE
* buffer_size = 75
* var_array[75] load in scalar value for
* elements 76 - 150
*
*------------------------------------
* fifth invocation: (for left side of time span)
* imag_data = FALSE
* component = 0
* ne_beg = 0
* ne_end = 157
* first = FALSE Will still be FALSE
* buffer_size = 75
* var_array[75] load in scalar value
* for elements 151 - 158
*
* sixth invocation: (for right side of time span)
* imag_data = FALSE
* component = 0
* ne_beg = 0
* ne_end = 157
* first = FALSE
* buffer_size = 75
* var_array[75] load in scalar value
* for elements 151 - 158
*
*
* (OUT) *num_returned = The number of nodes or elements whose variable values
* are returned in the buffer. This will normally be
* equal to buffer_size except for that last buffer -
* which could be less than a full buffer
*
* -1 if an error
*
* Notes:
*
*
* Invocation:
* ---------------- ------------------ -------------------
* 1 2 3 4 5 6
* ------- ------- -------- -------- --------- ---------
* var_array[0] quad 1L quad 1R quad 76L quad 76R quad 151L quad 151R
*
*
* ...
*
*
* Where: L indicates left time step
* R indicates right time step
*--------------------------------------------------------------------*/
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)
/*--------------------------------------------------------------------
USERD_get_constant_per_part_data
* This routine will be called for each of

* variables whose part type is
* Z_CONSTANT_PER_PART as defined in
* USERD_get_gold_variable_info
*
* This returns the desired constant per part
* variable values, for the time step desired,
* for the parts that have this variable type.
*--------------------------------------------------------------------
* (IN) v = The variable number
* (IN) imag_data = TRUE if want imaginary portion. (not currently using)
* FALSE if want real portion
* (IN) itstep = Time step
* (OUT) extparts = Array to receive the external part numbers that have
* a value for this per_part constant.
* This is the part number used in the file (or the part label)
* The array is zero-based and will be Numparts_available long, so
* all original parts will fit. It is initialized to an
* impossible part number (-1) for every entry in the array.
* You do not have to have values for all parts.
* (OUT) values = Array to receive the per_part constant value for the parts loaded
* in extparts.
* The array is zero-based and will be Numparts_available long. Each
* array entry is initialized to Z_UNDEF.
* Notes:
* Example: Model with 5 parts
* At the input itstep:
* part 1 has no value (is undefined for this part)
* part 4 has a value of 13.45
* part 23 had no value
* part 24 had a value of -4.75
* Thus,
* extparts[0] = 4
* extparts[1] = 5
* extparts[2] = 24
* Note: extpats[3] and extpats[4] are their init values, -1
*
* values[0] = 13.45
* values[1] = 102.50
* values[2] = -4.75
* Note: values[3] and values[4] are their init values of Z_UNDEF
*
* Since there are two of the original parts (part 1 and part 23) that
* do not have a defined value for this constant per part, you should
* leave their values to the init values in extparts & values. So,
* extparts[3-4] & values[3-4] are -1 and Z_UNDEF, respectively for
* proper interpretation by EnSight.
* IMPORTANT: The constant per part variables are not treated like case constant
* variables, but rather similar to scalars, vectors, tensor
* variables so you must set their classification and type
* in the USERD_get_gold_variable_info
routine.
* var_type[ ] = Z_CONSTANT_PER_PART
* var_classify[ ] = Z_PER_PART
*
* The return is either Z_OK or Z_ERR.
*
* If all the per-part constants are undefined at the given timestep, simply
* return Z_OK without setting anything in extparts nor values.
*---------------------------------------------------------------------------------*/
int
USERD_get_constant_per_part_data(int v,
int imag_data,
int itstep,
int *extparts,
float *values) {
/*--------------------------------------------------------------------------
USERD_get_var_extract_gui_defaults

*--------------------------------------------------------------------------
*
* are fed up to the GUI for that after read situation. (It is very similar
* to the USERD_get_extra_gui_defaults routine, which occurs before the read)
*
*
*
*
*
*
*
*
*
*
* Notes:
*
* you'll lose them.
* ----------------------------------------------- */
int USERD_get_var_extract_gui_defaults(char **toggle_Title,
char **field_Title,
/*--------------------------------------------------------------------
USERD_get_var_extract_gui_numbers

* -------------------------------------------------------------------
* The Var_Extract GUI routines are added to allow the user to customize a
* extraction parameters for variable "after" the file has been read.
* These things can be modified and the variables will be updated/refreshed
* according to the new parameters.
* (It is similar to the USERD_get_extra_gui_numbers routine)
*
*
*
*
*
* Notes:
* USERD_get_var_extract_gui_defaults
*
* you wish to have the Var Extract capability.
*
* If you don't want the Var Extract GUI features,
* USERD_DISABLED_get_var_extract_gui_defaults
*
* use their data to modify the extraction parameters
*
* The user can then interact with the var extract portion of the
*
* Therefore if USERD_get_var_extract_gui_numbers
*
*
* TRUE if checked
*
*
*
*
*
* you'll lose them.
*-------------------------------------------------------------------------------*/
void USERD_get_var_extract_gui_numbers(int *num_Toggles,
int *num_pulldowns,
int *num_fields)
/*--------------------------------------------------------------------
USERD_get_var_value_at_specific

*--------------------------------------------------------------------
*
* if Z_PER_NODE:
* Get the value of a particular variable at a particular node in a
* particular part at a particular time.
*
* or if Z_PER_ELEM:
* Get the value of a particular variable at a particular element of
* a particular type in a particular part at a particular time.
*
* (IN) which_var = Which variable (1 to Num_variables)
*
* (IN) which_node_or_elem
*
* If Z_PER_NODE:
* = The node number. This is not the id, but is
* the index of the node
* list (1 based), or the block's
* node list (1 based).
*
* Thus, coord_array[1]
* coord_array[2]
* coord_array[3]
* . |
* . |which_node_or_elem index
* . ----
*
*
* If Z_PER_ELEM:
* = The element number. This is not the id, but is
* the element number index
* (see USERD_get_gold_part_build_info),
* or the block's element list
* (1 based).
*
* Thus, for which_part:
* . |
* . (which_node_or_elem - 1) index
* . ----
*
*
*
* -------------------------
* = The part number
*
*
*
*
*
* ----------------------------
* loaded in
*
* (IN) which_elem_type
*
* = Not used
*
* If Z_PER_ELEM:
* = The element type. This is the element type index
* (see USERD_get_gold_part_build_info)
*
* (IN) time_step = Time step to use (0 to Num_time_steps[the proper var timeset])
*
*
*
* Z_NOT_IMPLEMENTED if not implemented and want to use the slower,
* complete update method within EnSight.
*
* Notes:
* * This routine is used in node querys over time (or element querys over
* time for Z_PER_ELEM variables). If these operations are not critical
* to you, this can be a dummy routine.
*
*
* * The time step given is for the proper variable timeset. Thus, it
* must be obtainable from the variable number also.
*--------------------------------------------------------------------*/
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)
/*-----------------------------------------------------------------------------
USERD_get_var_value_at_xyz_specific

/*--------------------------------------------------------------------
* USERD_get_var_value_at_xyz_specific -
*--------------------------------------------------------------------
*
* (IN) which_var = Which variable
*
* (IN) xyz[3] = the xyz coordinates of the desired point.
*
* -------------------------
* = The part number
*
*
*
*
* ----------------------------
* in USERD_get_gold_part_build_info.
*
* (IN) time_step = Time step to use
*
*
*
* returns: Z_OK if xyz found in part provided.
* Z_UNDEF if not found in part provided
* Z_ERR if something terribly wrong
*
* Notes:
* * This routine is optional (if not provided, EnSight will do searches in
* each time step (which can be slow because it will have to update all
* results at each time step).
*
* * This routine is used in xyz querys over time.
* So if you can provide this info efficiently, please do so.
*
* * The time step given is for the proper variable timeset. Thus, it
* must be obtainable from the variable number also.
*--------------------------------------------------------------------*/
int
USERD_get_var_value_at_xyz_specific(int which_var,
float xyz[3],
int which_part,
int time_step,
float values[3],
int imag_data)
/*-----------------------------------------------------------------------------
USERD_get_vglyph_counts

*-----------------------------------------------------------------------------
*
* Gets the counts for the number of vector glyphs in the model
*
* (OUT) num_vglyph_vectors = The number of vector glyphs in the model.
* (Must be set to zero if none)
*
* (OUT) num_vglyph_timelines = The number of vector glyph timelines in the model.
* (can be zero if all vector glyphs are static)
*
* Z_ERR if an error
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_vglyph_counts(int *num_vglyph_vectors,
int *num_vglyph_timelines)
/*-----------------------------------------------------------------------------
USERD_get_vglyph_timeline_info

*-----------------------------------------------------------------------------
*
* Gets the vector glyph timeline metadata.
*
* (IN) vtl = The vector glyph timeline index
* 0 ... (Num_VGLYPH_Timelines-1)
*
* (OUT) id = The vector glyph timeline id listed in the file
*
* (OUT) numtimes = The number of times in the vector glyph timeline
*
* (OUT) before = If EnSight time is before the first step in the
* vector glyph timeline, a value of
* VG_UNDEF makes the glyph undefined
* VG_NEAREST makes it act as if it is at the first step
*
* (OUT) amidst = If EnSight time is between steps in the vector glyph timeline,
* VG_INTERPOLATE interpolates values linearly between them
* VG_NEAREST snaps to the closest step for its values.
*
* (OUT) after = If EnSight time is after the last step in the
* vector glyph timeline, a value of
* VG_UNDEF makes the glyph undefined
* VG_NEAREST makes it act as if it is at the last step
*
* Z_ERR if an error
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_vglyph_timeline_info(int vtl,
int *id,
int *numtimes,
int *before,
int *amidst,
int *after)
/*-----------------------------------------------------------------------------
USERD_get_vglyph_timeline_times

*-----------------------------------------------------------------------------
*
* Gets the vector glyph timeline times
*
* (IN) vtl = The vector glyph timeline index
* 0 ... (Num_VGLYPH_Timelines-1)
*
* (OUT) times = The array of times in the vector glyph timeline
*
* Z_ERR if an error
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_vglyph_timeline_times(int vtl,
float *times)
/*-----------------------------------------------------------------------------
USERD_get_vglyph_vector_info

*-----------------------------------------------------------------------------
*
* Gets the vector glyph metadata
*
* (IN) vg = The vector glyph index
* 0 ... (Num_VGLYPH_Vectors-1)
*
* (OUT) id = The vector glyph id number listed in the file
*
* (OUT) description = The vector glyph description.
* *** Note: This is what a user will see in
* the GUI to select the glyph
*
* (OUT) time_condition = VG_STATIC if vector glyph is always present,
* no timeline assiciated with it.
* VG_TRANSIENT if vector glyph is associated with
* a timeline
*
* (OUT) time_line = The external timeline index of the vector glyph,
* used on if time_condition is VG_TRANSIENT
*
* (OUT) part = The part that the vector glyph is associated with
*
* (OUT) nidloc = The node id number where the vector glyph is located.
* (must be -1 if not located at a node)
*
* (OUT) eidloc = The element id number where the vector glyph is located.
* (must be -1 if not located at an element)
*
*
* Z_ERR if an error
*
* Notes:
* For vector glyphs locates at an xyz location, make sure both nidloc and eidloc
* are both set to -1
*--------------------------------------------------------------------*/
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)
/*-----------------------------------------------------------------------------
USERD_get_vglyph_vector_values

*-----------------------------------------------------------------------------
*
* Gets the vector glyph vector component values
*
*
* (OUT) values = The vector glyph component vector values
* (2D array, with 3 values per timestep)
*
* for VG_STATIC vector glyph, would be 1 x 3 array
* [xc, yc, zc]
*
* for VG_TRANSIENT vector glyph, with a timeline
* that has 5 time steps, would be 5 x 3 array
* [xc1, yc1, zc1]
* [xc2, yc2, zc2]
* [xc3, yc3, zc3]
* [xc4, yc4, zc4]
* [xc5, yc5, zc5]
*
* Z_ERR if an error
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_vglyph_vector_values(int vg,
float **values)
/*-----------------------------------------------------------------------------
USERD_get_vglyph_vector_xyzloc

*-----------------------------------------------------------------------------
*
* Gets the vector glyph xyz locations
*
*
* (OUT) xyzloc = The vector glyph xyz location(s)
* (2D array, with 3 values per timestep)
*
* for VG_STATIC vector glyph, would be 1 x 3 array
* [x, y, z]
*
* for VG_TRANSIENT vector glyph, with a timeline
* that has 5 time steps, would be 5 x 3 array
* [x1, y1, z1]
* [x2, y2, z2]
* [x3, y3, z3]
* [x4, y4, z4]
* [x5, y5, z5]
*
* Z_ERR if an error
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_vglyph_vector_xyzloc(int vg,
float **xyzloc)
/*-----------------------------------------------------------------------------
USERD_get_xy_query_data

*-----------------------------------------------------------------------------
*
*
*
*
* (OUT) xvals = array of x values, dimensioned to num_vals (0 based)
*
* (OUT) yvals = array of y values, dimensioned to num_vals (0 based)
*
*
* Notes:
*----------------------------------------------------------------------------*/
int query_num,
int num_vals,
float *xvals,
float *yvals)
/*----------------------------------------------------------------------------
USERD_get_xy_query_info

*----------------------------------------------------------------------------
*
*

*
*
*
*
*
*
* Notes:
*---------------------------------------------------------------------------*/
int USERD_get_xy_query_info(int query_num,
char *query_name,
char *query_xtitle,
char *query_ytitle,
/*--------------------------------------------------------------------
USERD_load_matf_data

*--------------------------------------------------------------------
* Get the material id list, mixed-material id list, or
* mixed-material values list for the given material set and part (and
* element type if material id list)
*
*
* (IN) part_id = the part number desired
*
* (IN) wtyp = the element type (used for Z_MAT_INDEX only)
*
* Z_NSIDED nsided polygon
* Z_NFACED nfaced polyhedron
*

* Z_G_NSIDED ghost nsided polygon
* Z_G_NFACED ghost nfaced polyhedron
*
* (IN) mat_type = Z_MAT_INDEX for material ids list
* Z_MIX_INDEX for mixed-material ids list
* Z_MIX_VALUE for mixed-material values list
* Z_SPE_VALUE for material species values list
*
* (OUT) ids_list = If mat_type is Z_MAT_INDEX:
* ---------------------------
* 1D material id list
* (Int array will have been allocated
* the appropriate size, as returned in
* USERD_size_matf_data for mat_type Z_MAT_INDEX)
*
* If mat_type is Z_MIX_INDEX:
* ---------------------------
* 1D mixed-material id list
* (Int array will have been allocated
* USERD_size_matf_data for mat_type Z_MIX_INDEX)
*
* (OUT) val_list = 1D mixed-materials values list
* (only used if mat_type is Z_MIX_VALUE)
*
* (Float array will have been allocated
* USERD_size_matf_data for mat_type Z_MIX_VALUE)
*
*
* Notes:
* * Will not be called if Num_material_sets is zero,
* or Num_materials[set_index] is zero,
* or the appropriate size from USERD_size_matf_data is zero
* * This function is used only if USERD_get_matf_set_type returns
* Z_MISET_VIA_SPARSE_MIX.
* * This function is NOT used if USERD_get_matf_set_type returns
* Z_MISET_VIA_ESCAL_VARS (and thus is incompatible with
* USERD_get_matf_escalars_desc)
*--------------------------------------------------------------------*/
int
USERD_load_matf_data( int set_index,
int part_id,
int wtyp,
int mat_type,
int *ids_list,
float *val_list)
/*--------------------------------------------------------------------
USERD_prefer_auto_distribute

*--------------------------------------------------------------------
*
* Returns whether the reader will do its own partitioning for SOS
*
* returns: TRUE if reader prefers to do its own partitioning for SOS
* FALSE if EnSight will be asked to do the partitioning
* if an auto-distribute is specified
*
* Notes:
*-------------------------------------------------------------------*/
int
USERD_prefer_auto_distribute(void)
/*--------------------------------------------------------------------
USERD_rigidbody_existence

*--------------------------------------------------------------------
*
* Gets the existence of rigid body values or not in the model
*
* returns: Z_OK if rigid body values exist for the model
* Z_UNDEF if no rigid body values exist
* Z_ERR if an error
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_rigidbody_existence( void )
/*--------------------------------------------------------------------
USERD_rigidbody_values

*--------------------------------------------------------------------
*
* Gets the rigid body values for each part
*
*
*
*
*
* (OUT) values values[0] = IX (x location)
* values[1] = IY (y location)
* values[2] = IZ (z location)
* values[3] = E0 (e0 euler value)
*
* The next 3 are for an optional cg offset. If none
* is needed or desired (namely the first 7 values
* above contain all that is needed), then these
* should be set to 0.0
*
* values[7] = xoff (initial cg x offset)
* values[8] = yoff (initial cg y offset)
* values[9] = z0ff (initial cg z offset)
*
* Stated differently,
* The translation values are tx, in values[0]
* ty, in values[1]
* tz, in values[2]
* And the euler rotational values are
* e0, in values[4]
* e1, in values[5]
* e2, in values[6]
* e3, in values[7]
*
* The order that these are applied is euler rotation first, followed by the
* translation. And the rotation will be about the global coordinate system.
*
* Whenever the part's desired center of rotation is not the global axis orig, then
* you need to do an initial translational offset using values 7-9.
* Namely, you must do a translation that will place the desired part center of
* rotation at the coordinate system origin, then do the rotation, then translate the * part back to where it s
* be.
*
* The intitial translation can be done using values[7] through values[9], which
* get applied before those indicated above.
*
* ORDER of OPERATIONS
* First the translations of values[7] through values[9]
* Then the euler rotations of values[4] through values[7]
* Then the translations of values[0] through values[2]
* So, perhaps a simple 2d example:
* ================================
* Given a square at the location shown (centered on x=2, y=1).
Y
|
| 3 4
| *------------*
| | |
| | |
| | . | Center is at (2,1)
| | |
| | |
| *------------*
| 1 2
o----------------------------- x
* We desire to have it rotate 90 degrees about the z axis, and translate to x=3,y=0
Y
|
|
|
|
|
|
|
| 4 *------------* 2
| | |
| | |
0--------------| . |--- x Center is now at (3,0)
| |
| |
3 *------------* 1
* The values needed are:
*
* values[7] = -2 These are the initial translations to get center to the
* origin
* values[8] = -1
* values[9] = 0
*
* values[3] = 0.7071 These are the euler parameters for the 90 degree rotation
* values[4] = 0.0 about the z axis. Which will now occur about the part
* center, because
* values[5] = 0.0 that center has been moved to the coordinate system origin.
* values[6] = 0.7071
*
*
* values[0] = 3 These are the final translations to get the center from
* values[1] = 0 the origin to the desired final location.
* values[2] = 0
*
*
* So you can visualize this as moving the part to the origin, doing the rotation, and
* them moving the part
* back out to where you want it to end up.
*
* Starting at Version 2.08
* ========================
* The next 4 values are for and optional initial yaw,
* pitch, roll operation. This is useful to get parts

* from one standard layout to a different standard
* layout.
* (example, flex body parts computed in an axis system
* different than that of rigid body parts manipulation)
* If not needed or desired, set these to 0.0
*
* values[10] = rot_order (order the roations are applied
* 0.0 = no rotations
* 1.0 = xyz order
* 2.0 = xzy order
* 3.0 = yxz order
* 4.0 = yzx order
* 5.0 = zxy order
* 6.0 = zyx order)
* values[11] = xrot (initial x rotation - degrees)
* values[12] = yrot (initial y rotation - degrees)
* values[13] = zrot (initial z rotation - degrees)
*
* returns: Z_OK if rigid body values sent for this part
* Z_UNDEF if no rigid body values exist for this part
* Z_ERR if an error
*
*
* Notes:
* * It will not be called unless USERD_rigidbody_existence indicates
* that there are some values in the model by returning Z_OK.
* * Order that transformations will be applied is:
* 1. The yaw,pitch,roll rotations, if present
* (values[11] through values[13]
* in the order specified in rot_order, values[10])
* 2. The cg offsets, if present (values[7] through values[9])
* 3. The euler parameter rotations (values[3] through values[6])
* 4. The translations (values[0] through values[2])
*
*--------------------------------------------------------------------*/
int
USERD_rigidbody_values(int part_number,
float values[14]) /* Prior to Version 2.08,
float values[10] */
/*--------------------------------------------------------------------
USERD_set_block_range_and_stride

*--------------------------------------------------------------------
* Sets the min, max, and step values in each of the i, j, and k, directions
* for the given part.
*
*
*
*
*
* (IN) mini = min i plane desired (zero based)
* maxi = max i plane desired (zero based)
* stepi = i stride
* minj = min j plane desired (zero based)
* maxj = max j plane desired (zero based)
* stepj = j stride
* mink = min k plane desired (zero based)
* maxk = max k plane desired (zero based)
* stepk = k stride
*
*
* Z_ERR if an error
*
* Notes:
* * It will not be called unless USERD_get_structured_reader_cinching
* indicates that this reader does structured cinching by returning
* a Z_OK.
*
* * It will actually be called before each geom component and before
* each part variable - so if you are storing things locally, you should
* make this routine be able to quickly check whether anything needs
* updated or not.
*
* * If the stride (step) does not hit right on the max, the last element
* in each direction will be shortened appropriately.
* For example, if a block had 0 to 12 in the i direction,
* and the user specified min = 1
* max = 8
* step = 3
*
* 0 1 2 3 4 5 6 7 8 9 10 11 12
* | | | | | | | | | | | | |
*
* | | | |
*
* Namely, the coarser cell boundaries in this direction would be
* at 1, 4, 7, and 8
*
* IMPORTANT!! If your reader will be used for structured auto-distribute,
* you must implement this feature, which includes this routine and
* USERD_get_structured_reader_cinching
*--------------------------------------------------------------------*/
int
USERD_set_block_range_and_stride(int part_number,
int mini, int maxi, int stepi,
int minj, int maxj, int stepj,
int mink, int maxk, int stepk)
/*----------------------------------------------------------------------------
USERD_set_extra_gui_data

*----------------------------------------------------------------------------
*
* Receives the toggle, pulldown and field_text from enhanced GUI.
*
*
*
*
* Notes:
*
* user entries!
* -------------------------------------------------------------- */
void
USERD_set_extra_gui_data(int *toggle,
int *pulldown,
char **field_text)
/*--------------------------------------------------------------------
USERD_set_filename_button_labels

*--------------------------------------------------------------------
*
* Returns the labels that the EnSight GUI will place on the buttons
* in the Data Reader/Open dialog for Geometry and Results
*
* (OUT) filename_label_1 = Label for the first button
* (generally the geom file)
*
* (OUT) filename_label_2 = Label for the second button
* (generally the results file)
* Not needed (so can be null) if two_fields
* is FALSE in USERD_get_name_of_reader
*
* Notes:
*---------------------------------------------------------------------*/
void
USERD_set_filename_button_labels(char filename_label_1[Z_MAX_USERD_NAME],
char filename_label_2[Z_MAX_USERD_NAME])
/*--------------------------------------------------------------------
USERD_set_filenames

*--------------------------------------------------------------------
*
* Receives the geometry and result filenames entered in the data
*
* (IN) filename_1 = the filename entered into the geometry
*
* (IN) filename_2 = the filename entered into the result
* (If the two_fields flag in USERD_get_name_of_reader
* is FALSE, this will be null string)
*
* If two_fields is TRUE, this is the
* mandatory results file entered
* into the result field of the data dialog.
*
* If two_fields is -1, then this contains
* optional text (filenames, modifiers, etc.)
* that can be parsed and used to modify
* reader
*
* (IN) the_path = the path info from the data dialog.
*
* (IN) swapbytes = TRUE if should swap bytes when reading data.
* = FALSE normally
*
*
*
* Notes:
*
* you need within it, like EnSight's case file does.
*--------------------------------------------------------------------*/
int
USERD_set_filenames(char filename_1[],
char filename_2[],
char the_path[],
int swapbytes)
/*--------------------------------------------------------------------
USERD_set_right_side

*--------------------------------------------------------------------
*
* Informs the reader that the time currently set is the right side of a time
* span used for variable interpolation between time steps
*
* Notes:
* * Applies to Current_time_step
*
* * This is called just before USERD_get_var_by_component
*
* * This information is only needed if your reader must do its own
* interpolation along a variable timeline. This can occur when rigidbody
* information has its own timeline, which is sent to EnSight as the
* controlling time line, but the variables have a different timeline
* known only to the reader.
*--------------------------------------------------------------------*/
void
USERD_set_right_side( void )
/*--------------------------------------------------------------------
USERD_set_server_number

*--------------------------------------------------------------------
*
* Receives the server number of how many total servers.
*
* (IN) cur_serv = the current server.
*
* (IN) tot_servs = the total number of servers.
*
* Notes:
* * Only useful if your user defined reader is being used with EnSight's
* Server-of-Server capability. And even then, it may or may not be
* something that you can take advantage of. If your data is already
* partitioned in some manner, such that you can access the proper
* portions using this information.
*
* For all non-SOS uses, this will simply be 1 of 1
*
* * Really just a dummy for this reader - we don't need to use it.
*--------------------------------------------------------------------*/
void
USERD_set_server_number(int cur_serv,
int tot_servs)
/*--------------------------------------------------------------------
USERD_set_time_set_and_step

*--------------------------------------------------------------------
*
* Set the current time step in the desired timeset. All functions that
* need time, and that do not explicitly pass it in, will use the timeset
* and step set by this routine, if needed.
*
* (IN) timeset_number = the timeset number (1 based).
*
* would be 1 and 2.
*
* (IN) time_step - The current time step (0 to Num_time_steps[timeset_number])
*
* Notes:
* * Current_time_step and Current_timeset would be set here
*--------------------------------------------------------------------*/
void
USERD_set_time_set_and_step(int timeset_number,
int time_step)
/*----------------------------------------------------------------------------
USERD_set_var_extract_gui_data

*----------------------------------------------------------------------------
*
* Receives the toggle, pulldown and field_text from var extract input.
*
*
*
*
* Notes:
*
* user entries!
* -------------------------------------------------------------- */
void
USERD_set_var_extract_gui_data(int *toggle,
int *pulldown,
char **field_text)
/*--------------------------------------------------------------------
USERD_size_matf_data

*--------------------------------------------------------------------
*
* Get the length of the material id list, mixed-material id list, or
* mixed-material values list for the given material set and part (and
* element type if material id list)
*
*
* (IN) part_id = the part number desired
*
* (IN) wtyp = the element type (used for Z_MAT_INDEX only)
*
*
* Z_G_NSIDED ghost nsided polygon
* Z_G_NFACED ghost nfaced polyhedron
*
* (IN) mat_type = Z_MAT_INDEX for material ids list
* Z_MIX_INDEX for mixed-material ids list
* Z_MIX_VALUE for mixed-material values list
* Z_SPE_VALUE for material species values
*
* (OUT) matf_size = the length of the material id list, or
* mixed-material id list, or
* mixed-material values list
* for the given material set and part number
* (and element type if Z_MAT_INDEX)
*
*
* Notes:
* * This function is used only if USERD_get_matf_type returns
* Z_MISET_VIA_SPARSE_MIX.
* * This function is NOT usAed if USERD_get_matf_type returns

* Z_MISET_VIA_ESCAL_VARS (and thus is incompatible with
* USERD_get_matf_escalars_desc)
*--------------------------------------------------------------------*/
int
USERD_size_matf_data( int set_index,
int part_id,
int wtyp,
int mat_type,
int *matf_size)
/*--------------------------------------------------------------------
USERD_stop_part_building

*--------------------------------------------------------------------
*
* Called when part builder is closed for USERD, can be used to clean
* up memory, etc that was only needed during the part building process.
*--------------------------------------------------------------------*/
void
USERD_stop_part_building( void )
/*--------------------------------------------------------------------
USERD_use_periodic_ghosts

*--------------------------------------------------------------------
*
* The existence of the this as well as the following routines, implies to
* EnSight that the reader has the capability to read periodic models, and
* a return value of TRUE from this routine tells EnSight that at least one
* part has periodic symmetry faces and the following routines should be
* called. A return value of FALSE tells EnSight that no parts have
* periodic symmetry faces and not to call the remaining routines.
*
*
* and for unstructured parts:
* ---------------------------
* USERD_get_periodic_ghosts_pairs.
*
* and for structured parts:
* -------------------------
*
*
* returns: TRUE If there is at least one part that needs to
* use the node pairing information (for unstructured parts),
* or the face ijk information (for structured parts), or
* supplied transformation matrices, to augment the initial
* periodic instance with the proper ghosts across the
* symmetry face(s).
*
* FALSE if no parts have periodic faces and don't call the other
* periodic routines.
*
*
* Simple Examples:
*
* periodic translation of 3 units in x model
* ==========================================
* y
* 13 14 15 16
* *---------*---------*---------*
* | | | |
* | 6 | 7 | 8 |
* |9 |10 |11 |12
* *---------*---------*---------*
* | | | |
* face 0 | 3 | 4 | 5 | face 1
* |5 |6 |7 |8
* *---------*---------*---------*
* | | | |
* | 0 | 1 | 2 |
* |1 |2 |3 |4
* *---------*---------*---------* x
*
* <===== translation direction =====>
*
* y
* 15 13 14 15 16 14
* *- - - - -*---------*---------*---------*- - - - -*
* . 8 | 6 | 7 | 8 | 6 .
* .11 |9 |10 |11 |12 .10
* *- - - - -*---------*---------*---------*- - - - -*
* . 5 | 3 | 4 | 5 | 3 .
* .7 |5 |6 |7 |8 .6
* *- - - - -*---------*---------*---------*- - - - -*
* . 2 | 0 | 1 | 2 | 0 .
* .3 |1 |2 |3 |4 .2
* *- - - - -*---------*---------*---------*- - - - -* x
*
*
* face 0
* ------
* num_pairs = 4
* pairs[0] = 1 node 1 moves to node 4 location
* pairs[1] = 4
* pairs[3] = 8
* pairs[5] = 12
* pairs[7] = 16
*
* face 1
* ------
* num_pairs = 4
* pairs[1] = 1
* pairs[3] = 5
* pairs[5] = 9
* pairs[7] = 13
*
*-------------------------------------------------------------------
* periodic rotation of 90 degrees about z axis
* ============================================
* y
* 13 14 15 16
* *---------*---------*---------*
* | | | |
* | 6 | 7 | 8 |
* |9 |10 |11 |12
* *---------*---------*---------*
* | | | |
* face 1 | 3 | 4 | 5 |
* |5 |6 |7 |8
* *---------*---------*---------*
* | | | |
* | 0 | 1 | 2 |
* |1 |2 |3 |4
* *---------*---------*---------* x
* / face 0
* /
* -- rotates in plane about node 1
*
*
* y
* 8 13 14 15 16
* *- - - - -*---------*---------*---------*
* . ghost | | | |
* . 2 | 6 | 7 | 8 |
* .7 |9 |10 |11 |12
* *- - - - -*---------*---------*---------*
* . ghost | | | |
* . 1 | 3 | 4 | 5 |
* .6 |5 |6 |7 |8
* *- - - - -*---------*---------*---------*
* . ghost | | | |
* . 0 | 0 | 1 | 2 |
* .5 |1 |2 |3 |4
* *- - - - -*---------*---------*---------*
* . ghost . ghost . ghost .
* . 0 . 3 . 6 .
* .2 .6 .10 .14
* *- - - - -*- - - - -*- - - - -*
*
*
* face 0
* ------
* num_pairs = 4
* pairs[0] = 1 node 1 rotates to node 1 location
* pairs[1] = 1
* pairs[3] = 5
* pairs[5] = 9
* pairs[7] = 13
*
* face 1
* ------
* num_pairs = 4
* pairs[1] = 1
* pairs[3] = 2
* pairs[5] = 3
* pairs[7] = 4
*
*
*--------------------------------------------------------------------------
* mirror in x
* ===========
* y
* 13 14 15 16
* *---------*---------*---------*
* | | | |
* | 6 | 7 | 8 |
* |9 |10 |11 |12
* *---------*---------*---------*
* | | | |
* face 0 | 3 | 4 | 5 |
* |5 |6 |7 |8
* *---------*---------*---------*
* | | | |
* | 0 | 1 | 2 |
* |1 |2 |3 |4
* *---------*---------*---------* x
* <=== mirror
*
* y
* 14 13 14 15 16
* *- - - - -*---------*---------*---------*
* . ghost | | | |
* . 6 | 6 | 7 | 8 |
* .10 |9 |10 |11 |12
* *- - - - -*---------*---------*---------*
* . ghost | | | |
* . 3 | 3 | 4 | 5 |
* .6 |5 |6 |7 |8
* *- - - - -*---------*---------*---------*
* . ghost | | | |
* . 0 | 0 | 1 | 2 |
* .2 |1 |2 |3 |4
* *- - - - -*---------*---------*---------*
*
*
* face 0
* ------
* num_pairs = 4
* pairs[0] = 1 node 1 reflects about node 1
* pairs[1] = 1
* pairs[3] = 5
* pairs[5] = 9
* pairs[7] = 13
*--------------------------------------------------------------------*/
int
USERD_use_periodic_ghosts( void )
3.5. Converting a 1.0 API Reader to a 2.0 API Reader

If you have an existing 1.0 API Reader and you desire to convert it to a 2.0 API reader, to take advantage
of new capabilities, or the improved efficiency, the following may be helpful.
First the Good News!
The following routines were identical in both API's at the time that the 2.0 API was produced.
USERD_bkup
USERD_get_block_coords_by_component
USERD_get_block_iblanking
USERD_get_changing_geometry_status
USERD_get_dataset_query_file_info
USERD_get_element_label_status
USERD_get_name_of_reader
USERD_get_node_label_status
USERD_get_number_of_files_in_dataset
Converting a 1.0 API Reader to a 2.0 API Reader
USERD_get_number_of_model_parts
USERD_get_number_of_variables
USERD_set_filenames
USERD_stop_part_building
Second, pretty Good News!
The following routines have minor changes, namely a slight name change and the addition of arguments
related to complex data, constant type, or self contained parts vs global coords.
Note:
The name changes are needed so both API's can exist together.
The arguments must be added, but depending on your situation, many might simply be place holders.
A) Changes related to imaginary flag for complex data
If you don't deal with complex variables, simply add this flag to your argument list and ignore its
value.
API 1.0 API 2.0
USERD_get_constant_value (p. 19) USERD_get_constant_val (p. 71)
( (
int which var int which_var,
) int imag_data
)
USERD_get_descrip- USERD_get_descrip_lines (p. 72)
tion_lines (p. 20)
(
(
int which_type,
int which_type,
int which_var,
int which_var,
int imag_data,
char line1[Z_BUFL],
char line1[Z_BUFL],
char line2[Z_BUFL]
char line2[Z_BUFL]
) )
USERD_get_variable_value_at_spe- USERD_get_var_value_at_specif-
cific (p. 37) ic (p. 150)
( (
int which_var, int which_var,
int which_node_or_elem, int which_node_or_elem,
int which_part, int which_part,
int which_elem_type, int which_elem_type,
int time_dtep, int time_dtep,
float values[3] float values[3],
) int imag_data
B) Changes related to complex data info, and constant type (and some of the multiple timeset
support).
If you don't deal with complex variables, simply add the arguments for var_complex, var_ifi-
lename, and var_freq and assign var_complex to be FALSE.
The argument var_contran needs to be added, and set appropriately if you have constant variables,
to indicate if the constant variable is fixed for all time or varies over time.
The argument var_timeset needs to be added, and set appropriately.

API 1.0 API 2.0
USERD_get_variable_info (p. 36) USERD_get_gold_variable_info (p. 81)
( (
char **var_description, char **var_description,
char **var_filename, char **var_filename,
int *var_type, int *var_type,
int *var_classify int *var_classify,
) int *var_complex,
float *var_freq,
int *var_contran,
int *var_timeset
C) Changes related to self contained part coordinates.
The number_of_nodes argument needs to be added and set for each part. This one is critical for
you to do.
API 1.0 API 2.0
Converting a 1.0 API Reader to a 2.0 API Reader
USERD_get_part_build_info (p. 30) USERD_get_gold_part_build_info (p. 76)
( (
int *part_id, int *part_id,
int *part_types, int *part_types,
char *part_description[Z_BUFL], char *part_description[Z_BUFL],
int *number_of_elements[Z_MAX- int *number_of_nodes,

TYPE],
int *number_of_elements[Z_MAX-
int *ijk_dimensions[3], TYPE],
int *iblanking_options[6] int *ijk_dimensions[9],
) int *iblanking_options[6]
D) Changes related to multiple timeset support.
The timeset_number argument needs to be added for the following three routines.
The multiple timeset support also includes the change in B) above for USERD_get_gold_vari-
able_info and the three new routines in the next section.
API 1.0 API 2.0
USERD_get_num- USERD_get_num_of_time_steps (p. 106)
ber_of_time_steps (p. 29)
(
(
int timeset_number
void
)
)
USERD_get_solu- USERD_get_sol_times (p. 134)
tion_times (p. 34)
(
(
int timeset_number,
float *solution_times
float *solution_times
)
)
USERD_set_time_step (p. 43) USERD_set_time_set_and_step (p. 165)
( (
int time_step int timeset_number,
} int time_step
Third, deleted and new routines. (Here is where the work lies).
Several old routines are gone. You will have to create the new routines that replace them. I think you
will find in most cases that your old routines will form the basis of the new routines, and that it isn't
too difficult to provide the information in the new way.
See Detailed Specifications (p. 63) for the needed information on these new routines.
API 1.0 API 2.0

These routines: replaced by the single routine:
USERD_get_block_scalar_values (p. 17) USERD_get_var_by_component (p. 137)
USERD_get_scalar_values (p. 33)
USERD_get_vector_values (p. 38)

These global coordinate routines: replaced by part coord routines:
USERD_get_global_coords (p. 25) USERD_get_part_coords (p. 112)
USERD_get_global_node_ids (p. 26) USERD_get_part_node_ids (p. 125)

These par connectivity routines: replaced by part by type routines:
USERD_get_element_connectivities_for_part (p. 21) USERD_get_part_elements_by_type (p. 120)
USERD_get_element_ids_for_part (p. 22) USERD_get_part_element_ids_by_type (p. 116)

(Can be a dummy) -> These are new routines:
(Can be a dummy) -> USERD_exit_routine (p. 66)
(Required) -> USERD_get_model_extents (p. 91)

(Required) -> multiple timeset related:
(Required) -> USERD_get_number_of_timesets (p. 111)
(Required) -> USERD_get_timeset_description (p. 135)

(Required) -> border provided by the reader option:
(Can be a dummy) -> USERD_get_border_availability (p. 68)
USERD_get_border_elements_by_type (p. 69)

(Can be a dummy) -> transient model allocation efficiency:

(Can be a dummy) -> possible use with Server-of-Servers:
USERD Message Routines (Info, Error, Log, Etc.)

Required routines added after version 2.00
(Many can be dummy routines, depending
on features needed):
USERD_get_block_ghost_flags (p. 67)
USERD_get_ghosts_in_block_flag (p. 83)
USERD_get_matsp_info (p. 86)
USERD_get_number_of_species (p. 111)
USERD_set_block_range_and_stride (p. 161)

Also note the various optional routines
which can be in the 2.0 API. See the
Routine History (p. 55) for an easy
identification of these routines
3.6. USERD Message Routines (Info, Error, Log, Etc.)

Most of the USERD routines operate passively. They wait for the server to call them and then hand up
data. However, there are five USERD routines that call upwards into the server to pass information
messages designed for feedback to the user from the reader. These routines are active and can be called
at any location in any portion of a user-defined reader.
At this point, these routines will print their output to the EnSight console. The names of the routines
and when to call them are as follows.
USERD_info(const char format, ....)

Normal informational output typically to the console. It is a good idea to have a reader Format Option
pulldown that is None, Normal, Verbose and Debug to control the amount of informational output
that the user experiences.
USERD_warn(const char format, ....)

Encountered a problem but still proceeding with the read. This is either console or pop-up window.
USERD_error(const char format, ....)

Encountered a problem in which an error will be returned up to the server. This should be in a pop-up
window in the future. This calls a dummy routine named cvf_stop_here that you can use as a break
location.
USERD_fatal(const char format, ....)

A message indicating a fatal error which should not be called unless a crash is imminent as it may result
in the future in with a pop-up window and a graceful shutdown of EnSight. This calls a dummy routine
named cvf_stop_here that you can use as a break location.
USERD_log(const char format, ....)

All the output that you wish to go to a log, which should be the standard log file.
Example 3.1: Usage
USERD_info("Reading file number %d\n",fnum);
USERD_warn("Warning: missing element %d\n",elem_num);
USERD_error("Error, var value %12.5g exceeded %12.5g. Abort-

ing\n",var_val,max_val);
Implementation
In your reader, after your include of global_extern.h, you must include global_extern_func-
tions.h (in one C/C++ source file and one file only) in order to use these functions.
#include global_extern.h
#include global_extern_functions.h
This chapter will describe the EnSight User Defined Reader Version 3.0 API. It was designed to have
new features that later versions of EnSight can utilize.
Note:
SOS Auto-distribution (e.g. Server-decompose) for parallel computing, has not been
implemented in the 3.0 API. If you need parallel computing, then the reader needs to
be written to decompose the data itself (e.g. reader decompose).
Reader (p. 3).
4.1. Quick Index of 3.0 Library Routines
API 3.0 Routines, Requirements and Descriptions

Routine Name Code and Description Description
USERD_reader_close (p. 215) R Last routine
called upon
Required exit: free
allocated
memory
USERD_attribute (p. 216) O Unusual
routine in that
Optional it calls up into
the server to
set server
attributes. Put
this call within
USERD_set_filenames,
to set the
server attribute
to customize
EnSight's
behavior.
USERD_get_descrip_lines (p. 215) R File
associated
Required description
line

USERD_get_elemsets_in_geom (p. 228) R Retrieve
list of
Required elemsets
in a given
geom
USERD_get_geom_info (p. 228) R Retrieve
the info
Required for a
given
geom
USERD_get_geom_timeset_number (p. 224) R Get the
timeset
Required number to
be used
for
geometry
USERD_get_geoms_in_part (p. 227) R Retrieve
list of
Required geoms in
a given
part
USERD_get_node_coords (p. 231) R Retrieve
coords for
Required the nodes
in a given
nodeset
USERD_get_number_of_model_parts (p. 225) R Get total
number of
Required unstructured
and
structured
parts in
the model
USERD_get_num_of_time_steps (p. 222) R Get
number of
Required time steps
in a given
timeset
USERD_get_number_of_timesets (p. 220) R Get
number of
Required timesets
used in
the model
USERD_get_part_info (p. 226) R Retrieve
the info
Required for a
given part

USERD_get_max_time_steps (p. 223) O Update
the
Optional number of
timesteps
periodically
during the
EnSight
session
e.g. while
solving is
ongoing
USERD_get_sol_times (p. 223) R Get
solution
Required times for
the time
steps of a
given
timeset
USERD_get_timeset_description (p. 221) R Get
description
Required associated
with a
given
timeset
USERD_reader_close (p. 215) R Free
associated
Required memory
and the
handle
USERD_reader_open (p. 211) R Creates
the
Required handle
USERD_set_filenames (p. 224) R Receive
the
Required geometry
and
results
filenames
and set
up things
for the
reader
USERD_set_time_set_and_step (p. 225) R Set
current
Required time step
in desired
timeset

USERD_get_var_info (p. 241) OBN Retrieves
the info
Optional, but Needed if for a
USERD_get_number_of_vars exists given
variable
USERD_get_elem_ids (p. 239) OBN Retrieves
element
Optional, but Generally needed ids for the
elements
in an
elemset
USERD_get_node_ids (p. 232) OBN Retrieves
node ids
Optional, but Generally needed for the
nodes in a
nodeset
USERD_get_node_var_info (p. 242) OBN Retrieves
the var
Optional, but Generally needed for index, and
vars number of
values for
a nodeset
var
USERD_get_node_var_values (p. 243) OBN Retrieves
the
Optional, but Generally needed for variable
vars values for
the nodes
of a
nodeset
var.
Return
Z_UNDEF
if
undefined.
USERD_get_number_of_vars (p. 240) OBN Retrieves
the
Optional, but Generally needed for number of
vars non-constant
vars in
model
USERD_get_selem_ghost_flags (p. 238) OBN Retrieves
the ghost
Needed only for structured model flags for
elements
in a given
structured
elemset

USERD_get_selem_info (p. 237) OBN Retrieves
info for a
Needed only for structured model given
structured
elemset
USERD_get_snode_iblanking (p. 231) OBN Retrieves
the
Needed only for structured model iblanking
value for
nodes in a
sructured
nodeset
USERD_get_snode_info (p. 229) OBN Retrieve
the info
Needed only for structured model for a
given
structured
nodeset
USERD_get_uelem_conn (p. 235) OBN Retrieves
the
Needed for unstructured model unstructured
connectivies
for a
given
elemset
USERD_get_uelem_faces_per_elem (p. 234) OBN Retrieves
the list of
Needed for unstructured model the
number of
faces per
element
for a
given
unstructured
elemset
USERD_get_uelem_info (p. 233) OBN Retrieves
info for a
Needed for unstructured model given
unstructured
elemset
USERD_get_uelem_nodes_per_face (p. 235) OBN Retrieves
the list of
Needed for unstructured model number of
nodes per
face for a
given
elemset

USERD_get_unode_info (p. 229) OBN Retrieves
the info
Needed for unstructured model for a
given
unstructured
nodeset
USERD_get_dataset_query_file_info (p. 71) OB Get info
about files
Optional, but commonly used in the
dataset
USERD_get_elem_var_info (p. 243) OB Retrieves
the
Optional, but needed if elem vars var_index
used and
number of
values
from
given
elemset
var
USERD_get_elem_var_values (p. 244) OB Retrieves
the
Optional, but needed if elem vars variable
used values for
the
elements
in a given
elemset.
Return
Z_UNDEF
if
undefined.
USERD_get_element_label_status (p. 219) OB Answers
the
Optional, but needed if element question
labels used as to
whether
element
labels will
be
provided.
USERD_get_node_label_status (p. 220) OB Answers
the
Optional, but commonly used question
as to
whether
node
labels will

be
provided.
OB Get the
total
Optional, but commonly used number of
files in the
dataset.
USERD_get_number_of_model_constants (p. 245)
OB Retrieve
number of
Optional, but needed if model model
constants used constants
in model
USERD_stop_part_building (p. 167) OB Called
when part
Optional, but commonly used builder is
closed
USERD_get_constant_per_part_data (p. 246) O Returns
constant
Optional, unless model constants per part
used variable
values for
desired
time step
for parts
that have
them
USERD_get_extra_data O General
routine
Optional that can
be used
for
custom
extra data
USERD_get_extra_text (p. 248) O Allows detailed
customization
Optional of EnSight
behavior using
defined flags.
USERD_get_matf_escalars_desc (p. 84) O Gets
material
Optional scalars
description
(Youngs
method)
USERD_get_matf_set_info (p. 84) O Get
marerial
Optional set ids

and
names
USERD_get_matf_set_type (p. 85) O Gets the
materials
Optional set type
USERD_get_matf_var_info (p. 85) O Get
material
Optional set var ids
and
names
USERD_get_matsp_info (p. 86) O Gets
material
Optional species id,
descripotion,
etc.
USERD_get_maxsize_info (p. 87) O Get
maximum
Optional part sizes
for
efficient
memory
allocation
USERD_get_metadata (p. 217) O General
routine for
Optional custom
XML
metadata
USERD_get_model_constant_info (p. 245) O Get info
about a
Optional, Unless model
USERD_get_number_of_model_constants constant
USERD_get_model_constant_val (p. 246) O Get the
value of a
Optional, Unless constant
USERD_get_number_of_model_constants at a time
step
USERD_get_model_extents (p. 91) O Get the
model
Optional bounding
box
extents
USERD_get_num_xy_queries (p. 106) O Get the
number of
Optional xy queries
available
USERD_get_number_of_material_sets (p. 107) O Get the
number of
Optional

material
sets in the
model
USERD_get_number_of_materials (p. 110) O Get
number of
Optional materials
in the
material
set
USERD_get_number_of_species (p. 111) O Get
number of
Optional species
USERD_get_var_value_at_specific (p. 150) O Get value
of a
Optional variable at
a
particular
node or
element
at a given
time
USERD_get_var_value_at_xyz_specific (p. 152) O Get
variable
Optional value at a
particular
xyz
location at
a given
time
USERD_get_vglyph_counts (p. 153) O Retrieves
number of
Optional vectors
and
timelines
for
vglyphs
USERD_get_vglyph_timeline_info (p. 153) O Retrieves
vglyph
Optional timeline
info
USERD_get_vglyph_timeline_times (p. 154) O Retrieves
vglyph
Optional timeline
times
USERD_get_vglyph_vector_info (p. 154) O Retrieves
vglyph
Optional vector
metadata

USERD_get_vglyph_vector_values (p. 155) O Retrieves
vglyph
Optional vector
values
USERD_get_vglyph_vector_xyzloc (p. 155) O Retrieves
vglyph
Optional vector xyz
locations
USERD_get_xy_query_data (p. 240) O Retrieves
xy query
Optional, Unless xy data
USERD_get_num_xy_queries values
USERD_get_xy_query_info (p. 239) O Retrieves
xy query
Optional, Unless plot
USERD_get_num_xy_queries metadata
(titles,
etc.)
USERD_load_matf_data (p. 157) O Get the
different
Optional material
lists for
given
material
set, part,
and
element
type.
USERD_rigidbody_existence (p. 159) O Does
rigidbody
Optional data exist
for this
model
USERD_rigidbody_values (p. 159) O Retrieve
rigidbody
Optional, Unless data
USERD_rigidbody_existence values
USERD_set_block_range_and_stride (p. 161) O Send
reader the
Optional blocks
min/max/stride
USERD_set_right_side (p. 164) O Tell reader
if at right
Optional side of an
interpolation
interval
Order Routines Are Called API 3.0

USERD_size_matf_data (p. 166) O Get length
of the
Optional different
material
lists
4.2. Order Routines Are Called API 3.0

It is often helpful in development of your reader to know what order the routines will be called. While
not complete, below find a few sequences that might be helpful in determining this. It is not intended
to be totally complete. And for some things (such as vglphs, or materials), you should look at the cor-
responding section in the 2.0 API - because they will be similar.
Also, setting the following environment variable, will print out in the console the routine names as they
are being called in your reader. So, this can give the order for any situation.
setenv ENS_UDR_API3_VERBOSELEVEL 1 which will print out each routine name called.
0 for no such output.
2 for routine name and additional information.
1. Initialization by EnSight calls the following in each reader to initialize the graphical user interface.
USERD_reader_open (p. 211)
2. When the user chooses a reader and a data file(s) and clicks OK
USERD_reader_open (p. 211)
3. Get info about each part
USERD_get_part_info (p. 226)
USERD_get_geoms_in_part (p. 227)
USERD_get_geom_info (p. 228)
USERD_get_elemsets_in_geom (p. 228)
USERD_get_uelem_info (p. 233)
USERD_get_unode_info (p. 229)
USERD_get_snode_info (p. 229)
USERD_get_selem_info (p. 237)
4. Get the optional XY query data (optional, but if one is present, all must be present).
USERD_ get_num_xy_queries (p. 239)
USERD_get_xy_query_info (p. 239)
USERD_get_xy_query_data (p. 240)
5. Get variable information
USERD_get_number_of_model_constants (p. 245)
USERD_get_number_of_vars (p. 240)
USERD_get_model_constant_info (p. 245)
6. For each variable get information
USERD_get_var_info (p. 241)
USERD_get_model_constant_val (p. 246)
7. Loading unstructured parts
USERD_get_unode_info (p. 229)
USERD_get_node_coords (p. 231)
USERD_get_node_ids (p. 232)
Order Routines Are Called API 3.0
USERD_get_elem_ids (p. 239)
USERD_get_uelem_faces_per_elem (p. 234) (if any NFACED or NSIDED elems)
USERD_get_uelem_nodes_per_face (p. 235) (if any NFACED or NSIDED elems)
USERD_get_uelem_conn (p. 235)
8. Loading structured parts
USERD_get_node_coords (p. 231)
USERD_get_node_ids (p. 232)
USERD_get_elem_ids (p. 239)
9. When user activates a nodal variable
USERD_get_unode_info (p. 229) -- or --
USERD_get_node_var_info (p. 242)
USERD_get_node_var_values (p. 243)
10. When user activates an elemental variable
USERD_get_elem_var_info (p. 243)
USERD_get_elem_var_values (p. 244)
11. When user activates a constant per part variable
4.3. Overview Specifications

Include files
And it references
Special Note
Make sure you use the proper define in the global_extern.h header file, namely:
And, also make sure the API version in the USERD_get_reader_version routine is set to the desired
version.
Global variables
A big win of the new API 3.0 is that you no longer need globals. Simply populate a struct and its
pointer is passed in and out of the USERD routines as shown in USERD_reader_open, below.
API 3.0 Headers
4.4. Example Headers

The specifications for each routine in the API will now be given using an example reader. First an example
global_extern.h file.
/* *************************************************************
* Copyright 2017-2018 Ansys 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_H
#define GLOBAL_EXTERN_H
/*--------------------------------
* Set the reader version define
* (only one can be set at a time)
*--------------------------------*/
#if 0
#endif
#include "../extern/global_extern.h"
#endif
4.5. API 3.0 Headers

Three example API 3.0 readers are found in the following directories within your EnSight install. The
first contains an example of structured and unstructured data together, the second is structured data
alone, and the third contains unstructured data. This third one is the most common form of reader and
likely is the one you will use as a template for developing your own reader.
$CEI/ensight201/src/readers/test3
$CEI/ensight201/src/readers/test3s
$CEI/ensight201/src/readers/test3u
Look at these readers, compile them and use them as prototypes for your new reader. The following
contains the most useful headers in API 3.0, as extracted from the test3 readers.
4.5.1. User Defined test3 Reader

User Defined test3 Reader
/*----------------------------------------------------------------------------------------------
This reader does a simple (hard-coded) model:
It has both Unstructured and Structured geometry and variables.
* 300
. .
. .
. .
. .123
. .
100 *-------------------------* 200
* 5000 *-------------------------*
. | . | 5001 . | 6001
. | . | . |
. | . | 150 . |
. 20 | 30 . | . 175 |
. | . | . |
*------------*------------* *-------------------------*
| 4000 6000 | 3000 | 4004 | 3001
| | | |
| | | |
| | | |
| | | |
| | | |
| 10 | | 250 |
| | | |
| | | |
| | | |
| | | |
*-------------------------* *-------------------------*
1000 2000 1001 2001
Part 2 Part 3
Part 0: part_descriptions: "left" Part 1: part_description: "right"

part_index: 0 part_index: 1
part_id: 2 part_id: 3
number_of_geoms: 2 number_of_geoms: 2
geom_index[0] = 0 geom_index[0] = 1
-----------------------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------------------
* 5000
. | .
. | .
. | .
. 20 | 30 .
. | .
*------------*------------*
| 4000 6000 | 3000
| |
| |
| |
| |
| |
| 10 |
API 3.0 Headers
| |
| |
| |
| |
*-------------------------*
1000 2000
Geom 0: geom_type = Z_UNSTRUCTURED (Composed of a set of nodes used by

nodeset_index = 0 a set of 1 quad element, and
number_of_elemsets = 2 a set of 2 triangle elements)
elemset_index[0] = 0
Nodeset 0: number_of_nodes = 6 Elemset 0: number_of_elements = 1

interleave_flag = FALSE; etype = Z_QUA04
coords_changing_flag = FALSE contents_index_mode = BY_INDEX_1
transient_var_flag = FALSE conn_changing_flag = FALSE
num_node_variables = 2 transient_var_flag = FALSE
num_elem_variables = 2
coord_array_compx[0] = 0.0;
coord_array_compx[1] = 2.0; conn_array[0] = 1;
elem_id_array[0] = 10;
coord_array_compy[0] = 0.0;
coord_array_compy[2] = 2.0; Elemset 1: number_of_elements = 2
coord_array_compy[3] = 2.0; etype = Z_TRI03
coord_array_compy[4] = 3.0; contents_index_mode = BY_INDEX_1
coord_array_compy[5] = 2.0; conn_changing_flag = FALSE
transient_var_flag = FALSE
coord_array_compz[0] = 0.0; num_elem_variables = 2
coord_array_compz[1] = 0.0;
coord_array_compz[2] = 0.0; conn_array[0] = 4;
conn_array[3] = 3;
node_id_array[0] = 1000; conn_array[4] = 5;
node_id_array[1] = 2000; conn_array[5] = 6;
node_id_array[2] = 3000;
node_id_array[3] = 4000; elem_id_array[0] = 20;
Geom 2: geom_type = Z_UNSTRUCTURED (Composed of a set of 5 bar elements

nodeset_index = 0 which use the same set of nodes as geom 0)
number_of_elemsets = 1
Elemset 4: number_of_elements = 5
etype = Z_BAR02
contents_index_mode = BY_INDEX_0
conn_changing_flag = FALSE
conn_array[0] = 0;
conn_array[1] = 1;
conn_array[2] = 1;
conn_array[3] = 2;
conn_array[4] = 2;
conn_array[5] = 4;
conn_array[6] = 4;
conn_array[7] = 3;
conn_array[8] = 3;
conn_array[9] = 0;
-------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------
* 300
. .
. .
. .
. .123
. .
100 *-------------------------* 200
*-------------------------*
| 5001 . | 6001
| . |
| 150 . |
| . 175 |
| . |
*-------------------------*
| 4004 | 3001
| |
| |
| |
| |
| |
| 250 |
| |
| |
| |
| |
*-------------------------*
1001 2001
Geom 1: geom_type = Z_UNSTRUCTURED (Composed of a another set of nodes used

nodeset_index = 1 by a set of 1 quad element,
number_of_elemsets = 2 and a set of 2 tria3 elements)
Nodeset 1: number_of_nodes = 6 Elemset 2: number_of_elements = 1

interleave_flag = TRUE etype = Z_QUA04
coords_changing_flag = FALSE contents_index_mode = BY_ID
transient_var_flag = FALSE conn_changing_flag = FALSE
num_node_variables = 2 transient_var_flag = FALSE
conn_array[2] = 3001;
coord_array_compx[5] = 0.0 elem_id_array[0] = 250;
coord_array_compx[7] = 2.0; Elemset 3: number_of_elements = 2
coord_array_compx[8] = 0.0; etype = Z_TRI03
contents_index_mode = BY_ID
coord_array_compx[9] = 3.0; conn_changing_flag = FALSE
coord_array_compx[10] = 2.0 transient_var_flag = FALSE
coord_array_compx[11] = 0.0; num_elem_variables = 2
API 3.0 Headers



Geom 3: geom_type = Z_UNSTRUCTURED (Composed of another set of nodes used by

nodeset_index = 2 a single set of 1 tri element.)
Nodeset 2: number_of_nodes = 3
interleave_flag = TRUE Elemset 5: number_of_elements = 1
coords_changing_flag = FALSE etype = Z_TRI03
transient_var_flag = FALSE contents_index_mode = BY_ID
num_node_variables = 2 conn_changing_flag = FALSE
coord_array_compx[0] = 3.0; num_elem_variables = 2
conn_array[1] = 200;
coord_array_compx[5] = 0.0; elem_id_array[0] = 123;
Note that:
=> all three contents_index_modes were used above.
=> Muti-geom was used once with the same node set (pretty easy)
But, also was used once with different node sets (had to combine and modify conns)
-------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------
Now some parts using the same "Node", so we can test the efficiency of loading vbuf only
when needed.
*------------*------------*
| | |
| | |
| TLR |
| | |
| | |
*------------*------------*
| | |
| | |
| BL | BR |
| | |
| | |
*------------*------------*
Part 2: part_descriptions: "BL" Part 3: part_description: "BR"

part_index: 2 part_index: 3
part_id: 10 part_id: 11
number_of_geoms: 1 number_of_geoms: 1
Part 4: part_descriptions: "TLR"

part_index: 4
part_id: 12
number_of_geoms: 2
geom_index[0] = 6
geom_index[1] = 7
Geom 4: geom_type = Z_UNSTRUCTURED

nodeset_index = 3

nodeset_index = 3

nodeset_index = 3

nodeset_index = 3
interleave_flag = TRUE
coords_changing_flag = FALSE
num_node_variables = 2
API 3.0 Headers
etype = Z_QUA04
conn_array[0] = 0;
conn_array[1] = 1;
conn_array[2] = 4;
conn_array[3] = 3;
etype = Z_QUA04
conn_array[0] = 1;
conn_array[1] = 2;
conn_array[2] = 5;
conn_array[3] = 4;
etype = Z_QUA04
conn_array[0] = 3;
conn_array[1] = 4;
conn_array[2] = 7;
conn_array[3] = 6;
etype = Z_QUA04
conn_array[0] = 4;
conn_array[1] = 5;
conn_array[2] = 8;
conn_array[3] = 7;
----------------------------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------------------------
Now a part using the same "Node" set, but with nsided and nfaced elements
* 5
. / \ nfaced is the whole "house"
. / \
10 * / \ nsided elements used are the front and bottom

/ \ / \
/ \ / \
/ \3 * 4
/ \ . |
/ \ . |
* 8 * 9 |
| | |
| front | * 2
| | .
| | . \
*-----------* - - bottom
6 7
Part 5: part_descriptions: "House"

part_index: 5
part_id: 15
number_of_geoms: 2
geom_index[0] = 8
geom_index[1] = 9

nodeset_index = 4

nodeset_index = 5
interleave_flag = FALSE
API 3.0 Headers

etype = Z_NSIDED
fpe[0] = 1;
npf[0] = 5;
npf[1] = 4;
conn_array[0] = 5;
conn_array[1] = 6;
conn_array[2] = 8;
conn_array[3] = 9;
conn_array[4] = 7;
conn_array[5] = 0;
conn_array[6] = 1;
conn_array[7] = 6;
conn_array[8] = 5;

etype = Z_NFACED
fpe[0] = 7;
npf[0] = 5;
npf[1] = 5;
npf[2] = 4;
npf[3] = 4;
npf[4] = 4;
npf[5] = 4;
npf[6] = 4;
back
conn_array[0] = 1;
conn_array[1] = 3;
conn_array[2] = 5;
conn_array[3] = 4;
conn_array[4] = 2;
front
conn_array[0] = 7;
conn_array[1] = 9;
conn_array[2] = 10;
conn_array[3] = 8;
conn_array[4] = 6;
bottom
conn_array[0] = 1;
conn_array[1] = 2;
conn_array[2] = 7;
conn_array[3] = 6;
left
conn_array[0] = 1;
conn_array[1] = 6;
conn_array[2] = 8;
conn_array[3] = 3;
right
conn_array[0] = 2;
conn_array[1] = 4;
conn_array[2] = 9;
conn_array[3] = 7;
top left
conn_array[0] = 3;
conn_array[1] = 8;
conn_array[2] = 10;
conn_array[3] = 5;
API 3.0 Headers
top right
conn_array[0] = 4;
conn_array[1] = 5;
conn_array[2] = 10;
conn_array[3] = 9;

etype = Z_NSIDED
fpe[0] = 1;
npf[0] = 5;
npf[1] = 4;
conn_array[0] = 5;
conn_array[1] = 6;
conn_array[2] = 8;
conn_array[3] = 9;
conn_array[4] = 7;
conn_array[5] = 0;
conn_array[6] = 1;
conn_array[7] = 6;
conn_array[8] = 5;

etype = Z_NFACED
fpe[0] = 7;
npf[0] = 5;
npf[1] = 5;
npf[2] = 4;
npf[3] = 4;
npf[4] = 4;
npf[5] = 4;
npf[6] = 4;
back
conn_array[0] = 1;
conn_array[1] = 3;
conn_array[2] = 5;
conn_array[3] = 4;
conn_array[4] = 2;
front
conn_array[0] = 7;
conn_array[1] = 9;
conn_array[2] = 10;
conn_array[3] = 8;
conn_array[4] = 6;
bottom
conn_array[0] = 1;
conn_array[1] = 2;
conn_array[2] = 7;
conn_array[3] = 6;
left
conn_array[0] = 1;
conn_array[1] = 6;
conn_array[2] = 8;
conn_array[3] = 3;
right
conn_array[0] = 2;
conn_array[1] = 4;
conn_array[2] = 9;
conn_array[3] = 7;
top left
conn_array[0] = 3;
conn_array[1] = 8;
conn_array[2] = 10;
conn_array[3] = 5;
top right
conn_array[0] = 4;
conn_array[1] = 5;
conn_array[2] = 10;
conn_array[3] = 9;
-------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------
curvilinear structured block
- no iblanking
- assigning node and element ids
- no ghosts
j
|
|
*------------*------------*
/ / /|
*------------*------------* |
/ / /| |
*------------*------------* | |
/ / /| | |
*------------*------------* | | * ----- i
| | | | |/
| | | | *
| | | |/
| | | *
| | |/
*------------*------------*
/
/
k
Part 6: part_descriptions: "block 1"

part_index: 6
part_id: 7
number_of_geoms: 1
geom_index[0] = 10
Geom 14: geom_type = Z_STRUCTURED

nodeset_index = 6
Nodeset 6: ijk_dimension[0] = 3
ijk_dimension[1] = 2
API 3.0 Headers
stype = Z_CURVILINEAR
iblanking_options[Z_EXT] = FALSE
iblanking_options[Z_INT] = FALSE
iblanking_options[Z_BND] = FALSE
iblanking_options[Z_INTBND] = FALSE
iblanking_options[Z_SYM] = FALSE
Elemset 14: ijk_dimension[0] = 3

stype = Z_CURVILINEAR
ghost_flag = FALSE;
--------------------------------------------------------------------------------
Uniform structured block part
- no iblanking
- assigning node and element ids
API 3.0 Headers
- has ghosts
j
|
|
*------------*------------*
/ / /|
*------------*------------* |
/ / /| |
*------------*------------* | |
/ / /| | |
*------------*------------* | | * ----- i
| | | | |/
| | | | *
| | | |/
| | | *
| ^ | ^ |/
*-----|------*-----|------*
/ | |
/ |____________|____________ 2 ghost cells
k

part_index: 7
part_id: 8
number_of_geoms: 1
geom_index[0] = 11
Geom 11: geom_type = Z_STRUCTURED

nodeset_index = 7
stype = Z_UNIFORM
iblanking_options[Z_INT] = FALSE
iblanking_options[Z_SYM] = FALSE

stype = Z_UNIFORM
ghost_flag = TRUE;
ghost_flag_array[0] = 0;
-----------------------------------------------------------------------------------
rectilinear structured block
- with iblanking all nodes on the indicated j-k planes are:
- with node and element ids
- no ghosts Z_INT Z_INT Z_SYM
j / / /
| / / /
|
*------------*------------*
/ / /|
*------------*------------* |
/ / /| |
*------------*------------* | |
/ / /| | |
*------------*------------* | | * ----- i
| | | | |/
| | | | *
| | | |/ <--- So this surface is
| | | * a symmetry plane
| | |/
*------------*------------*
/
/
k
API 3.0 Headers

part_index: 8
part_id: 9
number_of_geoms: 1
geom_index[0] = 12
Geom 12: geom_type = Z_IBLANKED

nodeset_index = 8
stype = Z_RECTILINEAR
iblanking_options[Z_INT] = TRUE
iblanking_options[Z_SYM] = TRUE
coord_array_compy[0] = -2.0;
coord_array_compy[1] = -1.0;
iblanking_array[0] = Z_INT
iblanking_array[2] = Z_SYM

stype = Z_RECTILINEAR
ghost_flag = FALSE;
*------------------------------------------------------------------------------------------*/
/*------------------------------------------------------------------------------------------
* ======================
* Dealing with geometry
* ======================
*
* Parts
* =====
* 1. Set number of model parts in:
* USERD_get_number_of_model_parts
*
* 2. Set the part id, part description, number of geoms for each part in:
* (as well as the flag for border geom and the border geom index - if the part has such)
* USERD_get_part_info
*
* 3. Set the list of geoms in each part in:
* USERD_get_geoms_in_part
*
* Geoms
* =====
* 1. Set the geom type, the nodeset index, and the number of elemsets for each geom in:
* USERD_get_geom_info
*
API 3.0 Headers
* 2. Set the list of elemsets in each geom in:

* (Structured will only have one elemset)
* USERD_get_elemsets_in_geom
*
* Nodesets
* ========
* Unstructured:
* 1. Set the number of nodes, the interleave flag, the coords changing flag, and the number
* of nodal variables for each nodeset in:
* USERD_get_unode_info
*
* Structured:
* 1. Set the structured type, the ijk dimensions, the interleave flag, the coords changing flag
* the iblanking options, the transient variable flad, and the number of nodal variables
* for each nodeset in:
* USERD_get_snode_info
*
* 2. Set the nodal iblanking values in the iblanking_array in:
* USERD_get_snode_iblanking
*
* Both Unstructured and Structured:
* 1. Set the coordinates for the nodes in the nodeset in:
* USERD_get_node_coords
*
* 2. Set the ids for the nodes in the nodeset in:
* (only called if USERD_get_node_label_status indicates that the ids will be provided)
* USERD_get_node_ids
*
* Elemsets
* ========
* Unstructured:
* 1. Set the number of elements, the element type, the contents index mode,
* the conn changing flag, and the number of elem variables for each elemset in:
* USERD_get_uelem_info
*
* 2. For element connectivities, set things in the following routines:
* USERD_get_uelem_faces_per_elem
* USERD_get_uelem_nodes_per_face
* USERD_get_uelem_conn
*
* according to the following table:
*
* etype USERD_get_uelem_faces_per_elem USERD_get_uelem_nodes_per_face
* ------ ------------------------------ ------------------------------
* regular Need not call. If you do, this Need not call if caller knows the conlength.
* routine should return fpe[0]=1 If you call, should return npf[0] = conlength
*
* nsided Need not call. If you do, this Need to call. This routine needs to return
* routine should return fpe[0]=1 the npf array (#nodes/elem).
* This is needed to be able to figure the
* total length of conn_array.
*
* nfaced Need to call. This routine Need to call. This routine needs to return
* should return the fpe array the npf array (#nodes/face). This is
* (#faces/elem). This is needed needed to be able to figure the total
* to be able to figure the total length of the conn_array.
* number of faces (length of the
* npf array.
*
* all Need to call the USERD_get_uelem_conn routine which will return the connectivity
* array for each element in the elemset.
*
* Structured:
* 1. Set the structured type, the ijk dimensions, the conn changing flag, the ghost flag,
* the transient variable flag, and the number of elem variables for the one elemset in:
* USERD_get_selem_info
*
* 2. Set the ghost flags for each element in the elemset in:
* USERD_get_selem_ghost_flags
*
* Both Unstructured and Structured:
* 1. Set the ids for the elements of the elemset in:
* (only called if USERD_get_element_label_status indicates that the ids will be provided)

* USERD_get_elem_ids
*------------------------------------------------------------------------------------------*/
/*------------------------------------------------------------------------------------------
* ======================
* Dealing with variables
* ======================
*
* Constants:
* ==========
* 1. Need to set the total number of constant variables in the model in:
* USERD_get_number_of_model_constants
*
* 2. Return the attributes of model constant variables in:
* USERD_get_model_constant_info
*
* 3. Return the value of model constant variables in:
* USERD_get_model_constant_val
*
*
* Non-Constants:
* =============
* 1. Need to set the total number of non-constant variables in the model in:
* USERD_get_number_of_vars
* This will be var_index = 0, 1, ... (number of non-constant vars - 1)
*
* 2. Return the attributes of a given variable in:
* USERD_get_var_info
* Reference will be the var_index.
* (One important attribute is the interleave_flag - because it will control whether values
* will be obtained by component or all at once.)
*
* Nodal:
* ------
* 3. Set the number of nodal variables in a given nodeset in:
*
* Unstructured:
* USERD_get_unode_info
*
* Structured:
*
* 4. Return the var_index (and the number of values) for each nodal variable in this
* nodeset_index in:
* USERD_get_node_var_info
*
* 5. Return the values for each var_index nodal variable in:
* USERD_get_node_var_values
* This will be be by component, unless it is an interleaved variable.
*
*
* Elemental:
* ----------
* 6. Set the number of elemental variables in a given elemset in:
*
* Unstructured:
* USERD_get_uelem_info
*
* Structured:
*
* 7. Return the var_index (and the number of values) for each elemental variable in this
* elemset_index in:
* USERD_get_elem_var_info
*
* 8. Return the values for each var_index elemental variable in:
* USERD_get_elem_var_values
* This will be be by component, unless it is an interleaved variable.
*-------------------------------------------------------------------------------------------*/
#include <stdio.h>
API 3.0 Headers
#include <stdlib.h>
#ifndef WIN32
#include <unistd.h>
#endif
#include <string.h>
#include <time.h>
#include <sys/types.h>
#include <sys/stat.h>
#include "global_extern.h" /* Any files containing these routines */

/* should include this header file */
/*==========================================================================
* Required Structure Typedef
* --------------------------
* 1. Name can be whatever, but must be returned in USERD_reader_open
* 2. The first item in the structure must be the ReaderHandle_30 structure.
* 3. You can then add whatever reader specific items you desire.
*===========================================================================*/
typedef struct {
/* Required 1st item

*------------------*/
ReaderHandle_30 server;
/* Reader specific info

*---------------------*/
char *filename;
char *path;
} EnSightRdrHandle;
/* Local reader specific

*----------------------*/
static int Current_timeset = 1;
static int Num_Geoms_in_Part[13];
static int Geoms_in_Part[13][2];
4.5.2. Reader API 3 Routines
4.5.2.1. USERD_reader_open
/*----------------------------------------------------
* USERD_reader_open - creates the handle. Call first!
* ----------------- ==========
*
* Note that the return from this routine is USERDHandle, which is a pointer.
*
* A) You should have typedef'ed a structure, something like:
*
* typedef struct {
*
* * Required 1st item
* *------------------*
* ReaderHandle_30 server;
*
* * Reader specific info
* *---------------------*
* char *filename;
* char *path;
* } EnSightRdrHandle;
*
* Where:
* 1. Name can be whatever, but must be returned from this routine.
* 2. The first item in the structure must be the ReaderHandle_30 structure.
* 3. You can then add whatever reader specific items you desire.
*
* B) Allocate the handle, something like:
* EnSightRdrHandle *hdl = (EnSightRdrHandle *) calloc(sizeof(EnSightRdrHandle),1);
*
* C) Load the items in the ReaderHandle_30 portion of the handle.
* (You can see this structure in ../extern/global_extern.h)
*
* WARNING: The EnSight server, on startup, calls each of these routines for each
* reader. These must be populated properly. And, you cannot use strcpy into these
* char pointers below as they are null pointers. A strcpy will crash the reader
* and, consequently, crash the server immediately on startup. Use an assignment
* operator, as below, or use the C strdup function.
*
* hdl->server.APIVersion = "3.00"; <<< Warning max length is Z_MAX_USERD_NAME
* hdl->server.reader_name = "Ensight Sample 3.0"; <<< Warning max length is Z_MAX_USERD_NAME
* hdl->server.reader_description = "EnSightSample 3.0 Reader"; <<< Warning max length Z_MAXFILENP
* hdl->server.reader_release = "1.0 Beta"; <<< Warning length limit is Z_MAX_USERD_NAME
* hdl->server.iTwoFields = 0; <<< 1 (TRUE) if two fields used for two files
* (e.g. a geometry and a variable file)
* hdl->server.iUseAutoDistribute = 1; <<< Warning always make this 1 (TRUE) which means
* that reader will handle SOS.
* hdl->server.file_button_label_1 = "Set case"; <<< Warning length limit is Z_MAX_USERD_NAME
* hdl->server.file_button_label_2 = ""; <<< Warning length limit is Z_MAX_USERD_NAME
* this is only used if iTwoFields is TRUE
* etc...
*
* If you have extra gui, you will need to do some allocations and loading...
*
* The Enhanced GUI routines are added to allow
* the user to customize a portion of the Data
* Reader dialog to pass in options to their
* user defined reader. In this routine, you will define
* the toggles, pulldowns, and fields. And provide the
* defaults for them. This all goes in the handle.
*
* The User choices or entries will be avaiable in the handle
* as well. These are available by the time the USERD_set_filenames
* routine is called. So that is typically a good place to set things
* appropriately for the given responses. But, of course this can be used
* later as well.
*
* simply set the numbers of each type to zero.
*
* TRUE if checked
*
*
*
* In this routine define the numbers of toggles, pulldowns & fields
*
* The following are defined in the global_extern.h
*
*
* D) Load any items you desire in the reader specific portion. Now or later.
*
* E) Return the handle, casting it to USERDHandle, like:
* return ((USERDHandle)hdl);
*--------------------------------------------------------------------------------*/
API 3.0 Headers
4.5.2.2. USERD_get_name_of_reader
/* -----------------------------------------------
USERD_get_name_of_reader

*--------------------------------------------------------------------
*
*
* is 20)
*
* (OUT) *two_fields = FALSE if only one data field is required
* in the data dialog of EnSight.
*
* -1 if one field (Geom) required
* and one field (Param) is optional
* Param field can contain any text
* for example a file name, modifiers,
* etc. that can be used to modify the
* reader's behavior.
*
*
* Notes:
*--------------------------------------------------------------------*/
int
int *two_fields)
4.5.2.3. USERD_get_reader_descrip
/* -----------------------------------------------
USERD_get_reader_descrip

*--------------------------------------------------------------------
*
*
* is 255)
*
*
*--------------------------------------------------------------------*/
int
4.5.2.4. USERD_get_reader_version
/* -----------------------------------------------
USERD_get_reader_version

*--------------------------------------------------------------------
*
* Gets the API version number of the user defined reader
*
* The functions that EnSight will call depends on this API
* version. See the README files for more information.
*
* (OUT) version_number = the version number of the reader
* is 20)
*
*
* Notes:
* * Always called.
*
* * This needs to be "2.000" or greater. Otherwise EnSight will assume
* this reader is API 1.0 instead of 2.0
*--------------------------------------------------------------------*/
int
USERD_get_reader_version(char version_number[Z_MAX_USERD_NAME])
4.5.2.5. USERD_get_reader_release
/* -----------------------------------------------
USERD_get_reader_release

*--------------------------------------------------------------------
*
*
*
* is 20)
*
*
* Notes:
*--------------------------------------------------------------------*/
int
API 3.0 Headers
4.5.2.6. USERD_reader_close
/*-----------------------------------------------
* USERD_reader_close - destroy the handle
* ------------------
*
*
*
* This is the last reader routine called prior to
* shutting down the EnSight server. It provides a
* chance to cleanly free the memory used in this
* reader.
*
*
* Free memory, first for
* any allocated members of the handle memory
* and then the handle itself.
*
*
*
*------------------------------------------------*/
int
USERD_reader_close(USERDHandle handle)
4.5.2.7. USERD_exit_routine
//*--------------------------------------------------------------------
* USERD_exit_routine
*--------------------------------------------------------------------
*
*
* When the EnSight server receives the command to shut down,
* and it is connected to a user-defined reader, it calls the
* following two cleanup routines, in the following order:
*
* USERD_exit_routine - clean up external connections.
* USERD_reader_close - free memory
*
* So, this second-to-last reader routine called prior to server
* shutdown can be used to close and/or clean up temporary files,
* end comm connections, etc.
*
* Note: It is most often simply a dummy routine.
*--------------------------------------------------------------------*/
void
USERD_exit_routine(USERDHandle handle)
4.5.2.8. USERD_get_descrip_lines
/*--------------------------------------------------------------------
* USERD_get_descrip_lines -
*--------------------------------------------------------------------
*
* This routine is called to get descriptive text line(s) which can
* be used by the user in EnSight annotations.
*
* This routine is called once for geometry (which_type set to Z_GEOM)
* and expects two lines of text. Then it is called once for each
* variable (which_type is set to Z_VARI) and expects to get one
* text line for each variable.
*
*
*
* which_type = Z_GEOM for geometry
*
* which_var = If it is a variable, which one.
*
* imag_data = TRUE if want imaginary data file.
*
*
* line2 = The 2nd geometry description line
* >>> Not used if variable type.
*
*
* Notes:
* This will be based on hdl->current_time_step
*
* These are the lines EnSight can echo to the screen in
* annotation mode.
*--------------------------------------------------------------------*/
int
USERD_get_descrip_lines(USERDHandle handle,
int which_type,
int which_var,
int imag_data,
char line1[Z_BUFL],
char line2[Z_BUFL])
4.5.2.9. USERD_attribute
USERD_attribute( int attribute name ,
int *value,
int get_set_flag)
*
* This routine is unusual in that it is not called by the server.
* Rather this is a routine that you put into another USERD routine
* to call up into the server and to set a flag that changes the
* behavior of the server.
*
* This call into the server must occur no later than the end of the
* USERD_set_filenames routine, so please put it into the
* USERD_set_filenames routine.
*
*
* some examples:
* 1. Ordinarily the xy query routines are called once and never updated.
* To tell the server to re-call the three xy query routines when time changes,
* so you can update the xy data pairs,
* do the following into the USERD_set_filenames routine:
* int tmp = 1;
* USERD_attribute(USERD_ATTR_TEMPORAL_XY_QUERIES, &tmp, USERD_ATTR_SET);
* Note the default is that tmp is 0.
*
* The following three routines will be called every time that time is changed:
* USERD_get_num_xy_queries – You must not change the number of queries!
* USERD_get_xy_query_info – You can change the number of pairs, as well as
* the name and titles, but they may not update in the plot
* unless replotted.
* USERD_get_xy_query_data – You can freely change the x and y data values
*
* Note: If you are using SOS, then all of the servers will be called to update
* the xy query data. You only need to have one of the servers handle this; the
API 3.0 Headers
* others should ignore it.

*
* Note: there is an attribute in the client python used as a flag which can be changed
* as well independently to enable this capability interactively.
*
* 2. Ordinarily the isovolume is a bit jagged because it uses an elemental variable.
* tmp = 0; /* test: simple_isovolume_off */
* USERD_attribute(USERD_ATTR_SIMPLE_ISOVOLUME,&tmp,USERD_ATTR_SET);
* And now your isovolumes will use an interpolated nodal variable for smoothness
*
* 3. Others can be added as needed, please contact Ansys support if you need to
* change the behavior of EnSight from your reader.
*
4.5.2.10. USERD_get_metadata
/* -----------------------------------------------
USERD_get_metadata

*
*--------------------------------------------------------------------
*
* This provides a mechanism to provide the EnSight client extra
* information designed to customize EnSight directly from the reader
* Meta data is XML formatted string of chars sent up to EnSight in two
* sequential calls of this routine.
*
* Presumably you would open the dataset file(s) in USERD_set_filenames,
* understand the dataset, the parts, and the variables, and assemble
* together this array of metadata in an XML character string.
*
* The first call of this routine is designed to send the actual length
* of the meta_char so EnSight can allocate the char container.
* (IN) meta_char = (char *) NULL <- this indicates its the first call
*
(OUT) actual len is the strlen(meta_char)
*
* The second call of this routine is designed to fetch the char array.
* (IN) actual_len = this is the length of the char array in bytes that EnSight
* has allocated, ready to receive your xml formatted chars
* (OUT) meta_char = (char *) pointer ready to be populated
*
* Here's a sample (without the asterisks):
*
<?xml version="1.0" encoding="UTF-8"?>
<CEImetadata version="1.0">
<parts>
<partlist>
<group name="simple group">
<part name="anotherpart"></part>
</group>
<part name="mypart"></part>
</partlist>
</parts>
<vars>
<metatags>
<tag name="ENS_UNITS_LABEL" type="str"></tag>
<tag name="ENS_UNITS_DIMS" type="str">/</tag>
</metatags>
<varlist>
<var name="myvar" ENS_UNITS_LABEL="m s^-1" ENS_UNITS_DIMS="L/T"></var>
<var name="Coordinates" ENS_UNITS_LABEL="m" ENS_UNITS_DIMS="L"></var>
<var name="Time" ENS_UNITS_LABEL="s" ENS_UNITS_DIMS="T"></var>
</varlist>
</vars>
<xy_queries>
<metatags>
<tag name="ENS_UNITS_QUERY_X_VAR" type="str"></tag>
<tag name="ENS_UNITS_QUERY_Y_VAR" type="str"></tag>
</metatags>
<querylist>
<query name="myvar vs time" ENS_UNITS_QUERY_X_VAR="Time" ENS_UNITS_QUERY_Y_VAR="myvar"></query>
<query name="myvar vs Re" ENS_UNITS_QUERY_X_VAR="myvar" ENS_UNITS_QUERY_Y_VAR=""></query>
</querylist>
</xy_queries>
<case>
<metatags>
<tag name="ENS_UNITS_LABEL" type="flt">2.0</tag>
<tag name="ENS_UNITS_DIMS" type="flt">1.0</tag>
<tag name="ENS_UNITS_SYSTEM" type="flt">1.0</tag>
<tag name="ENS_UNITS_SYSTEM_NAME" type="str">SI</tag>
</metatags>
</case>
</CEImetadata>
*
* Note: some datasets may record this metadata into a separate file
* which is a perfectly valid methodology for recording this data.
* The XML format is the same: this is done in EnSight Case Gold format.
* A user defined reader can just read the data in and pass it up
* via this mechanism.
*
* There are sections for parts, variables, xy_queries
* (only used by user-defined readers that support xy queries)
* and the case. Note that in each section, objects are matched to metadata
* using their name (the DESCRIPTION property on the corresponding EnSight
* Python object). Each section begins by defining the attributes to be
* defined for the objects in the section using a <metatags> section.
* It defines all the attributes and their type (flt=float, str=string).
* The value specified for the <tag> is the default attribute value that
* is assigned if an object does not specify the attribute.
* When debugging metadata files, it can be useful to review what
* EnSight sees. The Python command:
* ensight.objs.core.CURRENTCASE[0].SERVERXML
* will return the XML metadata for the current case.
*
* In the example, the <parts> section just defines the grouping hierarchy
* that should be used when the dataset is loaded. Spatial units for
* parts are defined by the (implicit) 'Coordinates' variable.
* In the <vars> section, ENS_UNITS_DIMS and ENS_UNITS_LABEL metatags
* are defined. In the example, the former is set to default to unit-less "/".
* Each variable defined in the dataset is then listed in the <varlist>
* section with the appropriate values for ENS_UNITS_DIMS and ENS_UNITS_LABEL.
*
* Note that label strings should have the format: {unit}[{^{power}]
* with spaces between individual units. If the power is 1,
* the ^{power} can be dropped. If the unit is in the denominator,
* the power should be negative. No '/' characters should be in the label
* and all positive powers should appear before negative powers. An example
* for m/s= "m s^-1" and for m2/s2= "m^2 s^-2".
* Always include the implicit "Coordinates" and "Time" variables.
*
* Queries are handled a little differently.
* The <xy_queries> should only be used by a user-defined reader that
* implements the USERD_get_num_xy_queries, USERD_get_xy_query_info and
* USERD_get_xy_query_data functions. The two attributes:
* ENS_UNITS_QUERY_X_VAR and ENS_UNITS_QUERY_Y_VAR should be defined
* and set to the name of a variable in the dataset that has the same
* dimensions as the specified axis. The units for that specific axis
* will be taken from the variables named by those attributes.
* Note: there is no requirement that the variable name provided is
API 3.0 Headers
* the variable in the query, only that the units of that variable
* match the units of the axis of the specific query.
*
* The <case> section serves to define two things. First, it defines the
* versions of the ENS_UNITS_LABEL, ENS_UNITS_DIM and ENS_UNITS_SYSTEM_NAME
* protocols. These are all float values and should be set to 2.0, 1.0
* and 1.0 respectively as shown in the example (there is an earlier
* version of the ENS_UNITS_LABEL protocol, but it is not recommended
* for new development). Second, the name of the unit system that
* all the data that will be returned by the user-defined reader or is
* stored in the case gold format files.
* The list of valid unit system names includes the system string values
* from this table:
*
* System name System string Units: mass, length, time, temperature,
* current, angle, intensity, substance amount
*
* Metric SI SI kg, m, s, A, K, rad, mol, cd
* Metric CGS CGS g, cm, s, A, C, rad, mol, cd
* US ft Consistent BFT slug, ft, s, A, F, rad, slugmol, cd
* US in Consistent BIN slinch, in, s, A, F, rad, lbmmol, cd
* Metric MKS MKS kg, m, s, A, C, rad, mol, cd
* Metric MPA MPA tonne, mm, s, mA, C, rad, mol, cd
* Metric uMKS uMKS kg, um, s, pA, C, rad, mol, cd
* Metric CGSK CGSK g, cm, s, A, K, rad, mol, cd
* Metric NMM NMM kg, mm, s, mA, C, rad, mol, cd
* Metric uMKSS uMKSS kg, um, s, mA, C, rad, mol, cd
* Metric NMMDAT NMMDAT decatonne, mm, s, mA, C, rad, mol, cd
* Metric NMMTON NMMTON tonne, mm, s, mA, C, rad, mol, cd
* US ft BFTS lbm, ft, s, A, F, rad, lbmmol, cd
* US in BINS lbm, in, s, A, F, rad, lbmmol, cd
* US Engineering USENG lb, in, s, A, R, rad, lbmmol, cd
*
* It should be noted that for proper unit support in EnSight, only the
* ENS_UNITS_DIMS and ENS_UNITS_SYSTEM_NAME protocols need to be defined.
* The ENS_UNITS_LABEL protocol allows a dataset to specify a custom label
* to be used when a dataset is loaded in its natural unit system
* (e.g. "Pa" for M/LTT dimensions instead of the generated "kg/(mENTITY___middot;s2)").
*
* EnSight will generate a valid unit label from the dimension string
* and the unit system if no label is specified, the current session
* unit system does not match the one in the dataset and for all
* computed variables.
*
* ------------------------------------------------- */
int
USERD_get_metadata(
USERDHandle handle,
int *actual_len, char *meta_char)
4.5.2.11. USERD_get_element_label_status
/* -----------------------------------------------
USERD_get_element_label_status
*--------------------------------------------------------------------
*
*
*
* returns: TRUE if element labels will be provided by this reader
* FALSE if element labels will NOT be provided by this reader
*
* Notes:

* element labeling on-screen.
*--------------------------------------------------------------------*/
4.5.2.12. USERD_get_node_label_status
/* -----------------------------------------------
USERD_get_node_label_status
*--------------------------------------------------------------------
*
* Answers the question as to whether node labels will be provided.
*
*
* returns: TRUE if node labels will be provided in this reader
* FALSE if node labels will NOT be provided in this reader
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_node_label_status(USERDHandle handle)
{
EnSightRdrHandle *hdl = (EnSightRdrHandle *)handle;
if(hdl->server.iVerboseLevel == Z_FULL) {
fprintf(stderr," > Node Labels will be provided\n");
}
return(TRUE);
}
4.5.2.13. USERD_get_number_of_timesets
/* -----------------------------------------------
USERD_get_number_of_timesets
*--------------------------------------------------------------------
*
* Gets the number of timesets used in the model.
*
*
* If you have a static model, both geometry and variables, you should
* return a value of zero.
*
* If you have a transient model, then you should return one or more.
*
* For example:
*
* Geometry Variables No. of timesets
* --------- ------------------------------ ---------------
* static static 0
* static transient, all using same timeset 1
*
API 3.0 Headers
* transient transient, all using same timeset as geom 1

*
* static transient, using 3 different timesets 3
*
* transient transient, using 3 different timesets and
* none of them the same as the
* geometry timeset 4
* etc.
*
* NOTE: ALL GEOMETRY MUST USE THE SAME TIMESET!!! You will have to provide
* the timeset number to use
* for geometry in:
* USERD_get_geom_timeset_number
*
* Variables can use the same timeset as the geometry, or can use
* other timesets. More than one variable can use the same timeset.
*
* example: changing geometry at 5 steps, 0.0, 1.0, 2.0, 3.0, 4.0
* variable 1 provided at these same five steps
* variable 2 provided at 3 steps, 0.5, 1.25, 3.33
*
* This routine should return a value of 2, because only
* two different timesets are needed. Timeset 1 would be for the
* geometry and variable 1 (they both use it). Timeset 2 would
* be for variable 2, which needs its own in this case.
*
* Notes:
*--------------------------------------------------------------------*/
4.5.2.14. USERD_get_timeset_description
/* -----------------------------------------------
USERD_get_timeset_description
*--------------------------------------------------------------------
*
* Get the description to associate with the desired timeset.
*
*
* timeset_number = the timeset number
*
*
* (OUT) timeset_description = timeset description string
*
*
*
* Notes:
* * A string of NULLs is valid for timeset_description
*--------------------------------------------------------------------*/
int
USERD_get_timeset_description(USERDHandle handle,
int timeset_number,
char timeset_description[Z_BUFL])
{
#if 0
if(timeset_number == 1) {
strcpy(timeset_description,"Static Geometry timeset");

}
else if(timeset_number == 2) {
strcpy(timeset_description,"Transient Variable timeset");
}
#else
strcpy(timeset_description,"Static Geometry timeset");
#endif
fprintf(stderr," > Description for timeset %d = %s\n",timeset_number, timeset_description);
}
return(Z_OK);
}
4.5.2.15. USERD_get_num_of_time_steps
/*--------------------------------------------------------------------
* USERD_get_num_of_time_steps -
*--------------------------------------------------------------------
*
* Get the number of time steps of data available for desired timeset.
*
*
*
*
*
* Notes:
* * This should be >= 1 1 indicates a static timeset
*
*
* Notes:
* * This should be >= 1, and 1 indicates a static timeset
*
*
* pipeline. The timeset_number sent to it will be a positive value.
*
* However, if 1) a USERD_get_max_time_steps routine is implemented, and
* 2) the USERD_get_max_time_steps routine returns a
* value greater than 1, and
* 3) the user hits the GUI button that calls for time to
* be reloaded (or it is set to automatic),
*
* Then the timeset_number sent to this routine will be
* the negative of the actual value. Indicating that it
* "coprocessing" purpose. Then this routine must also do
* the following:
*
* a) Check for the negtive timeset_number, and reverse it.
* b) Go get the new current number of time steps.
* c) Ensure that when USERD_get_sol_times is called again,
* d) Note also that model constant values need to have
* their values updated to add the additional time steps
* USERD_get_model_constant_val will be called using the
API 3.0 Headers
* new timestep(s). So you may need to resize your model

* constant array in this routine.
*
* returns 2, the valid timeset_numbers
* would be 1 or 2 to get the number of timesteps
* or -1 or -2 to update the number of timesteps
* for timestep 1 or 2.
*
*--------------------------------------------------------------------*/
4.5.2.16. USERD_get_max_time_steps
/*--------------------------------------------------------------------
*--------------------------------------------------------------------
*
* number of timesteps.
*
* to actuall do a rereading of the timesteps when prompted to do so.
*
*--------------------------------------------------------------------*/
int
4.5.2.17. USERD_get_sol_times
/* -----------------------------------------------
USERD_get_sol_times
*--------------------------------------------------------------------
*
* Get the solution times associated with each time step.
*
*
*
*
* (OUT) solution_times = 1D array of solution times per time step
*
* Num_time_steps[timeset_number] long)
*
*
* Notes:
*--------------------------------------------------------------------*/
4.5.2.18. USERD_get_geom_timeset_number
/* -----------------------------------------------
USERD_get_geom_timeset_number
*--------------------------------------------------------------------
*
* Gets the timeset number to be used for geoemtry
*
* It must be in the valid range of timeset numbers
* For example, If USERD_get_number_of_timesets
* would be 1 and 2.
*
*
* Notes:
* * If your model is static, which you indicated by returning a zero
* in USERD_get_number_of_timesets, you can return a zero here as well.
*--------------------------------------------------------------------*/
4.5.2.19. USERD_set_filenames
/* -----------------------------------------------
USERD_set_filenames
*--------------------------------------------------------------------
*
* Receives the geometry and result filenames entered in the data
*
*
* filename_1 = the filename entered into the geometry
* filename_2 = the filename entered into the result
* (If the two_fields flag in USERD_get_name_of_reader
* is FALSE, this will be null string)
* the_path = the path info from the data dialog.
* swapbytes = TRUE if should swap bytes when reading data.
* = FALSE normally
*
*
*
* Notes:
*
* you need within it, like EnSight's case file does.
*
* * This is also the typical place to utilize other things in the
* handle. Such as the sever number, extra GUI user repsonses, etc.
*--------------------------------------------------------------------*/
API 3.0 Headers
4.5.2.20. USERD_set_time_set_and_step
/* -----------------------------------------------
*--------------------------------------------------------------------
*
* Set the current time step in the desired timeset. All functions that
* need time, and that do not explicitly pass it in, will use the timeset
* and step set by this routine, if needed.
*
*
* timeset_number = the timeset number (1 based).
*
* would be 1 and 2.
*
* time_step = The current time step
*
* Notes:
* * Current_time_step and Current_timeset would be set here
*--------------------------------------------------------------------*/
4.5.2.21. USERD_get_number_of_model_parts
/* -----------------------------------------------
USERD_get_number_of_model_parts
*-------------------------------------------------------------------
*
*
* This value is typically called: Numparts_available
*
*
* returns: Numparts_available (>0 if okay, <=0 if probs)
*
* Notes:
* * IMPORTANT!! The part or block numbers that get passed to various
* routines in this API, will be the one-based table index
* of these parts.
*
* For example, if you have three parts, the part or block
* numbers of these parts will be: 1,2,3
*
*-------------------------------------------------------------------*/
4.5.2.22. USERD_get_part_info
/* -----------------------------------------------
USERD_get_part_info
*--------------------------------------------------------------------
*
* Retrieve the information for a given part
*
*
* part_index = zero-based part index
*
* (OUT) part_id = the external part id for the model part.
*
* IMPORTANT:
* External Part ids must be >= 1 because
* of the way they are used in the GUI
*
* *******************************************
* GUI (if possible). They are basically
* labels as far as you are concerned.
*
* Note: The part numbers you pass to routines
* which receive a part_number or block_number
* or which_part as an argument are the 1-based
* table index of the parts!
*
* example: If Numparts_available = 3
*
* Table index part_id
* ----------- -------
* 1 13
* 2 57
* 3 125
*
* ^ ^
* | |
* | These are placed in:
* | part_id[0] = 13
* | part_id[1] = 57
* | part_id[2] = 125
* | for GUI labeling purposes.
* |
* These implied table indices are the part_number,
* block_number, or which_part numbers that you would
* pass to routines like:
*
* USERD_get_part_coords(int part_number,...
* USERD_get_part_node_ids(int part_number,...
* USERD_get_part_elements_by_type(int part_number,...
* USERD_get_part_element_ids_by_type(int part_number,...
* USERD_get_block_coords_by_component(int block_number,...
* USERD_get_block_iblanking(int block_number,...
* USERD_get_block_ghost_flags(int block_number,...
* USERD_get_ghosts_in_block_flag(int block_number)
* USERD_get_border_availability( int part_number,...
* USERD_get_border_elements_by_type( int part_number,...
* USERD_get_var_by_component(int which_variable,
* USERD_get_var_value_at_specific(int which_var,
* int which_node_or_elem,
API 3.0 Headers
* ********************************************
*
* part_description = Array containing a description for the model part
*
* (Array will have been allocated Z_BUFL long)
*
* number_of_geoms = number of geoms in the part
*
* has_border_geom = TRUE if a border geom will be provided for this part
* by the reader.
*
* border_geom_index = The zero-based geom index which is the border for this
* part, if provided - as indicated by previous argument.
*
*
* Notes:
*
*--------------------------------------------------------------------*/
int
USERD_get_part_info(USERDHandle handle,
int part_index,
int *part_id,
char part_description[Z_BUFL],
int *number_of_geoms,
int *has_border_geom,
int *border_geom_index)
4.5.2.23. USERD_get_geoms_in_part
/* -----------------------------------------------
USERD_get_geoms_in_part
*--------------------------------------------------------------------
*
* Retrieve the list of geoms in a given part
*
*
* part_index = zero-based part index
*
* (OUT) geoms = Pointer to list of geoms in the part
* (Length is the number_of_geoms returned in
* USERD_get_part_info)
*
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_geoms_in_part(USERDHandle handle,
int part_index,
int *geoms)
{
int i;
int ierr = Z_OK;
fprintf(stderr," > For part_index: %d\n",part_index);

}
/* For now, we simply have a single geom per part

*-----------------------------------------------*/
for(i=0; i<Num_Geoms_in_Part[part_index]; ++i) {
geoms[i] = Geoms_in_Part[part_index][i];
fprintf(stderr," > geoms[%d] = %d\n",i,Geoms_in_Part[part_index][i]);
}
}
return(ierr);
}
4.5.2.24. USERD_get_geom_info
/* -----------------------------------------------
USERD_get_geom_info
*--------------------------------------------------------------------
*
* Retrieve the information for a given geom
*
*
* geom_index = zero-based geom index
*
* (OUT) geom_type = Z_UNSTRUCTURED,
* Z_STRUCTURED, or
* Z_IBLANKED
*
* nodeset_index = zero-based nodeset index used by the geom
*
* number_of_elemsets = the list of elemsets in the geom
*
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_geom_info(USERDHandle handle,
int geom_index,
int *geom_type,
int *nodeset_index,
int *number_of_elemsets)
4.5.2.25. USERD_get_elemsets_in_geom
/*--------------------------------------------------------------------
* USERD_get_elemsets_in_geom
*--------------------------------------------------------------------
*
* Retrieve the list of elemset indicies (zero-based) in a given geom
*
API 3.0 Headers
*
* geom_index = zero-based geom index
*
* (OUT) elemset_index_array = Pointer to the list of elemset indicies in the geom
* (Length of the array is number_of_elemsets
* returned in USERD_get_geom_info)
*
*
* Notes: In a subsequent call, these element indicies in the elemset_index_array
* will be supplied to USERD_get_uelem_info in order to get the details
* including the number of elements and their type.
*--------------------------------------------------------------------*/
int
USERD_get_elemsets_in_geom(USERDHandle handle,
int geom_index,
int *elemset_index_array)
4.5.2.26. USERD_get_unode_info
/* -----------------------------------------------
USERD_get_unode_info
*--------------------------------------------------------------------
*
* Retrieve the information for a given unstructured nodeset
*
*
* nodeset_index = zero-based nodeset index
*
* (OUT) number_of_nodes = number of nodes in the nodeset
*
* interleave_flag = TRUE if nodes come xyzxyz... and will be accessed
* all at once.
* = FALSE if nodes will be accessed by component,
* thus, they are usually arranged xxxx...yyyy...zzzz
* or separately by components.
*
* coords_changing_flag = TRUE if number of nodes can vary over time,
* FALSE if number of nodes stay constant over time.
*
* num_node_variables = the number of nodal variables available per node.
*
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_unode_info(USERDHandle handle,
int nodeset_index,
int *number_of_nodes,
int *interleave_flag,
int *coords_changing_flag,
int *num_node_variables)
4.5.2.27. USERD_get_snode_info
/* -----------------------------------------------
USERD_get_snode_info
*--------------------------------------------------------------------
*
* Retrieve the information for a given structured nodeset
*
*
*
* (OUT) stype = Z_CURVILINEAR,
* Z_RECTILINEAR, or
* Z_UNIFORM
*
* ijk_dimensions = [0] = number of i planes
* [1] = number of j planes
* [2] = number of k planes
*
* if full range for each, then:
* [3] = -1;
*
* or if ranges to be used, then:
* [3] = 1-based imin of portion
* [4] = 1-based imax of portion
* [5] = 1-based jmin of portion
* [6] = 1-based jmax of portion
* [7] = 1-based kmin of portion
* [8] = 1-based kmax of portion
*
* example, if you wanted to specify full ranges yourself
* for a 2 x 4 x 3 block:
*
* You could specify: or just:
* ijk_dimensions[0] = 2 ijk_dimension[0] = 2
* ijk_dimensions[3] = 1 ijk_dimension[3] = -1
* ijk_dimensions[4] = 2
*
* But,if you only wanted the k=2 slice, you could specify:
*
* interleave_flag = TRUE if nodes come xyzxyz... and will be accessed
* all at once.
* = FALSE if nodes will be accessed by component,
*
* coords_changing_flag = TRUE if number of nodes can vary over time,
* FALSE if number of nodes stay constant over time.
*
* iblanking_options = [Z_EXT] = TRUE if some Exterior iblanked nodes
* [Z_INT] = TRUE if some Interior iblanked nodes
* [Z_BND] = TRUE if some Boundary iblanked nodes
* [Z_INTBND] = TRUE if some Internal Boundary/Baffle nodes
* [Z_SYM] = TRUE if some Symmetry surfaace nodes
*
* num_node_variables = the number of nodal variables available per node.
*
API 3.0 Headers

*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_snode_info(USERDHandle handle,
int nodeset_index,
int *stype,
int ijk_dimensions[9],
int *interleave_flag,
int *coords_changing_flag,
int iblanking_options[6],
int *num_node_variables)
4.5.2.28. USERD_get_snode_iblanking
/* -----------------------------------------------
USERD_get_snode_iblanking
*--------------------------------------------------------------------
*
* Retrieve the iblanking values for the nodes in a given structured nodeset
*
*
*
* (OUT) iblanking_array = Pointer to array of iblanking values per node.
* Each node will have one of the following
* iblank values:
* Z_EXT exterior
* Z_INT interior
* Z_BND boundary
* Z_INTBND internal boundary/baffle
* Z_SYM symmetry surface
*
* (Length of the array is the number of nodes in the nodeset.)
*
*
* Notes:
* * Only called if geom_type returned from USERD_get_geom_info is Z_IBLANKED
*----------------------------------------------------------------------------*/
int
USERD_get_snode_iblanking(USERDHandle handle,
int nodeset_index,
int *iblanking_array)
4.5.2.29. USERD_get_node_coords
/* -----------------------------------------------
USERD_get_node_coords
*--------------------------------------------------------------------
*
* Retrieve the coordinates for the nodes in a given nodeset
*

*
*
* (OUT) coord_array_compx = Pointer to array of x components of coordinates if
* interleave_flag is FALSE in USERD_get_unode_info or
*
* Pointer to entire coordinate array if
* interleave_flag is TRUE in USERD_get_unode_info or
*
* coord_array_compy = Pointer to array of y components of coordinates if
*
* coord_array_compz = Pointer to array of z components of coordinates
* So, if doing interleaved:
* only pointer to coord_array_compx is used. And you should load it
* in an xyzxyzxyz... fashion. (Length of array will be 3 x number of nodes
* in the nodeset.)
*
* But, if not doing interleaved:
* all three pointers are used.
* coord_array_compx = xxxx...
* coord_array_compy = yyyy...
* coord_array_compz = zzzz...
* (Each is the number of nodes in the nodeset long.)
*
*
* Notes:
* * Having the three pointers (and the interleave flag) is intended to
* give you flexibility in providing the data - hopefully without having
* to use any temporary arrays.
*---------------------------------------------------------------------------*/
int
USERD_get_node_coords(USERDHandle handle,
int nodeset_index,
float *coord_array_compx,
float *coord_array_compy,
float *coord_array_compz)
4.5.2.30. USERD_get_node_ids
/* -----------------------------------------------
USERD_get_node_ids
*--------------------------------------------------------------------
*
* Retrieve the node ids for nodes in a given nodeset
*
*
*
* (OUT) node_id_array = Pointer to array of node ids.
* (Length will be number of nodes in the nodeset)
*
API 3.0 Headers
*
* Notes:
* * Will only be called if the USERD_get_node_label_status specifies
* that node labels will be provided for the model.
*--------------------------------------------------------------------*/
int
USERD_get_node_ids(USERDHandle handle,
int nodeset_index,
int *node_id_array)
4.5.2.31. USERD_get_uelem_info
/* -----------------------------------------------
USERD_get_uelem_info
*--------------------------------------------------------------------
*
* Retrieve information for a given unstructured elemset
*
*
* elemset_index = zero-based elemset index
*
* (OUT) number_of_elements = number of elements in the elemset
*
* etype = One of the following (See global_extern.h)
* Z_G_POINT node point ghost element
* Z_G_NSIDED nsided ghost polygon
* Z_G_NFACED nfaced ghost polyhedron
*
* contents_index_mode = BY_INDEX_0 if conn_array in USERD_get_uelem_conn will
* contain zero-based node indicies.
*
* BY_INDEX_1 if conn_array in USERD_get_uelem_conn will

* contain one-based node indicies
*
* BY_ID id conn_array in USERD_get_uelem_conn will
* contain node ids.
*
* conn_changing_flag = TRUE if element connectivities can vary over time,
* FALSE if element connectivities will stay constant over time.
*
* transient_var_flag = TRUE if element variables change over time
* = FALSE if element variables are static
*
* num_elem_variables = the number of elem variables available per element.
*
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_uelem_info(USERDHandle handle,
int elemset_index,
int *number_of_elements,
int *etype,
int *contents_index_mode,
int *conn_changing_flag,
int *transient_var_flag,
int *num_elem_variables)
4.5.2.32. USERD_get_uelem_faces_per_elem
if any NFACED or NSIDED elems
/* -----------------------------------------------
USERD_get_uelem_faces_per_elem
*--------------------------------------------------------------------
*
* Retrieve the list of the number of faces per element for a given
* unstructured elemset.
*
*
*
* (OUT) fpe = Pointer to an array containing the number of faces
* per element.
* If called for:
* regular elements or
* nsided elements (which isn't needed),
* it will be of length 1, so return a fpe[0] = 1;
*
* nfaced elements (which is needed), it will be of
* length number of elems in the elemset. Return
* the number of faces per element.
*
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_uelem_faces_per_elem(USERDHandle handle,
int elemset_index,
int *fpe)
API 3.0 Headers
4.5.2.33. USERD_get_uelem_nodes_per_face
if any NFACED or NSIDED elems
/* -----------------------------------------------
USERD_get_uelem_nodes_per_face
*--------------------------------------------------------------------
*
* Retrieves the list of number of nodes per face for a given elemset
*
*
*
* (OUT) npf = Pointer to an array containing the number of nodes
* per face for each face of each element in the elemset.
* If called for:
* regular elements (which isn't needed), it will be of
* lenght 1, so return npf[0] = conlength.
*
* nsided elements (which is needed),
* it will be of length number of elements in elemset.
* Return with the number of nodes per each element.
*
* nfaced elements (which is needed), it will be of
* length total number of faces in the elemset. Which
* has to be summed up from the fpe array called in
* USERD_get_uelem_faces_per_elem. Return
* the number of nodes for each of these faces.
*
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_uelem_nodes_per_face(USERDHandle handle,
int elemset_index,
int *npf)
4.5.2.34. USERD_get_uelem_conn
/* -----------------------------------------------
USERD_get_uelem_conn
*--------------------------------------------------------------------
*
* Retrieves the unstructured connectivites for a given elemset
*
*
*
* (OUT) conn_array = Pointer to an array containing the connectivities
* of the elements in the elemset. One right after the other.

* So length will be:
* regular elements: number of elems in elemset * conlength
* nsided elements: summation of contents of npf_array
* from a call to USERD_get_uelem_nodes_per_face.
* (The npf_array will be # of elements long)
* nfaced elements: summation of contents of npf_array, from a
* call to USERD_get_uelem_nodes_per_face.
* (The npf_array will be total number of faces
* long. Which was determined by a summation
* of the fpe_array, from a call to
* USERD_get_uelem_faces_per_elem)
* Examples:
* 1. If elemset is composed of quad4's, then conn_array will be:
* conn_array[0] = q1n1 (quad 1, node 1)
* conn_array[2] = q1n3 etc.
* conn_array[3] = q1n4
*
* conn_array[5] = q2n2 etc.
*
* etc.
*
* 2. If elemset is composed of 3 nsided elements
* first is 5 nodes long, second is 7 nodes long, and
* third is 6 nodes long:
* conn_array[0] = ns1n1 (nsided 1, node 1)
* conn_array[2] = ns1n3 etc.
* conn_array[3] = ns1n4
*
* conn_array[6] = ns2n2 etc.
*
*
* 3. If elemset is composed of nfaced elements
* conn_array[0] = nf1f1n1 (nfaced 1, face 1, node 1)
*
* etc.
* etc.
* etc.
*
API 3.0 Headers

*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_uelem_conn(USERDHandle handle,
int elemset_index,
int *conn_array)
4.5.2.35. USERD_get_selem_info
/* -----------------------------------------------
USERD_get_selem_info
*--------------------------------------------------------------------
*
* Retrieves information for a given structured elemset
*
*
*
* (OUT) stype = Z_CURVILINEAR,
* Z_RECTILINEAR, or
* Z_UNIFORM
*
* ijk_dimensions = [0] = number of i planes
* [1] = number of j planes
* [2] = number of k planes
*
* if full range for each, then:
* [3] = -1;
*
* or if ranges to be used, then:
* [3] = 1-based imin of portion
* [4] = 1-based imax of portion
* [5] = 1-based jmin of portion
* [6] = 1-based jmax of portion
* [7] = 1-based kmin of portion
* [8] = 1-based kmax of portion
*
* example, if you wanted to specify full ranges yourself
* for a 2 x 4 x 3 block:
*
* You could specify: or just:
* ijk_dimensions[3] = 1 ijk_dimension[3] = -1
*
* But,if you only wanted the k=2 slice, you could specify:
*
* conn_changing_flag = TRUE if element connectivities can vary over time,
* FALSE if element connectivities stay constant over time.
*
* ghost_flag = TRUE if ghost values are to be assigned to the elements.
* FALSE if no ghost values to be considered.
*
* transient_var_flag = TRUE if element variables will vary over time.
* = FALSE, if element variables are static
*
* num_elem_variables = the number of elem variables available per element.
*
*
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_selem_info(USERDHandle handle,
int elemset_index,
int *stype,
int ijk_dimensions[9],
int *conn_changing_flag,
int *ghost_flag,
int *transient_var_flag,
int *num_elem_variables)
4.5.2.36. USERD_get_selem_ghost_flags
/* -----------------------------------------------
USERD_get_selem_ghost_flags
*--------------------------------------------------------------------
*
* Retrieves the ghost flag for the elements in a given structured elemset
*
*
*
* (OUT) ghost_flag_array = Pointer to ghost flag array per element.
* 0 if not a ghost (a regular element)
* 1 if a ghost element
* (Length of array will be number of elements in elemset)
*
*
* Notes:
* * Will not be called unless the ghost_flag is TRUE from a call to
*--------------------------------------------------------------------*/
int
USERD_get_selem_ghost_flags(USERDHandle handle,
int elemset_index,
int *ghost_flag_array)
API 3.0 Headers
4.5.2.37. USERD_get_elem_ids
/* -----------------------------------------------
USERD_get_elem_ids
*--------------------------------------------------------------------
*
* Retrieves the element ids for the elements in a given elemset
*
*
*
* (OUT) elem_id_array = Pointer to an array containing the element ids.
* (Length of array will be number of elements in elemset)
*
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_elem_ids(USERDHandle handle,
int elemset_index,
int *elem_id_array)
4.5.2.38. USERD_ get_num_xy_queries

/*--------------------------------------------------------------------
*
*
*
*
* Notes:
*
* You can be as complete as you want about this. If you don't
*--------------------------------------------------------------------*/
int
USERD_get_num_xy_queries(USERDHandle handle)
4.5.2.39. USERD_get_xy_query_info
/*----------------------------------------------------------------------------
*
*
*
*
*
*
*
*
*
* Notes:
*---------------------------------------------------------------------------*/
int USERD_get_xy_query_info(
USERDHandle handle,
int query_num,
char *query_name,
char *query_xtitle,
char *query_ytitle,
4.5.2.40. USERD_get_xy_query_data
/*-----------------------------------------------------------------------------
*
*
*
* (0 to one less than the number of queries
*
*
* (OUT) xvals = array of x values, dimensioned to num_vals (0 based)
*
* (OUT) yvals = array of y values, dimensioned to num_vals (0 based)
*
*
* Notes:
*----------------------------------------------------------------------------*/
USERDHandle handle,
int query_num,
int num_vals,
float *xvals,
float *yvals)
4.5.2.41. USERD_get_number_of_vars
/* -----------------------------------------------
USERD_get_number_of_vars
*--------------------------------------------------------------------
*
* Retrieves the number of non-constant vars in the model
*
*
* returns: number of non-constant vars in the model
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_number_of_vars(USERDHandle handle)
API 3.0 Headers
{
int num_vars;
num_vars = 4;
fprintf(stderr," > Number of (non-constant) vars = %d\n",num_vars);
}
return(num_vars);
}
4.5.2.42. USERD_get_var_info
/* -----------------------------------------------
USERD_get_var_info
*--------------------------------------------------------------------
*
* Retrieves the information for a given var
*
*
* var_index = The zero-based var_index
*
* (OUT) var_description = Pointer to description array
*
*
* var_type = Variable type
* types are: Z_CONSTANT_PER_PART
* Z_SCALAR
* Z_VECTOR
* Z_TENSOR
* Z_TENSOR9
*
* var_classify = Variable classification
* Z_PER_ELEM
*
* var_complex = Complex flag
* Set to TRUE if complex, FALSE otherwise
*
* var_freq = Complex frequency (if complex)
*
* var_timeset = Timeset the variable will use (1 based).
*
*
* interleave_flag = TRUE if values come xyzxyz... and will be accessed
* all at once.
* = FALSE if values will be accessed by component,
*
*
* Notes:
* 1. interleave_flag is currently constrained in the API to be a
* variable-wide attribute. In other words, we don't allow the same

* variable to be interleaved for some geoms,but non-interleaved for
* others. (This is mainly due to the way Ensight handles variables -
* so it could be changed if we want to. It will just make EnSight
* do more work to determine how large to make vbuf)
*
*--------------------------------------------------------------------*/
int
USERD_get_var_info(USERDHandle handle,
int var_index,
char *var_description,
int *var_type,
int *var_classify,
int *var_complex,
float *var_freq,
int *var_timeset,
int *interleave_flag)
4.5.2.43. USERD_get_node_var_info
/* -----------------------------------------------
USERD_get_node_var_info
*--------------------------------------------------------------------
*
* Retrieves the var_index associated with and the and the number of values
* from the given nodeset var
*
*
*
* node_var_index = zero-based local var index for the nodeset
*
* (OUT) var_index = zero-based var index
*
* number_of_values = The number of nodes in the nodeset
* (This is kind of redundant with what you can
* get from the nodeset info).
*
*
* Notes:
* 1. number_of_values is the number of nodes. It does not consider the
* number of components for the given variable type.
*
* So for a nodeset containing 100 nodes, the number_of_values is 100 no
* matter whether the variable is a nodal scalar, vector, or tensor.
*--------------------------------------------------------------------*/
int
USERD_get_node_var_info(USERDHandle handle,
int nodeset_index,
int node_var_index,
int *var_index,
int *number_of_values)
API 3.0 Headers
4.5.2.44. USERD_get_node_var_values
/* -----------------------------------------------
USERD_get_node_var_values
*--------------------------------------------------------------------
*
* Retrieves the variable values associated with a given nodeset var
*
*
*
* node_var_index = zero-based local var index for the nodeset
*
* comp = variable component to retrieve if interleaved.
* Otherwise is ignored and all values are obtained.
*
* (OUT) values = Pointer to values array.
* Load with all values if interleaved. Load with the
* appropriate component if not interleaved.
* (Length will either be the number of nodes long if
* not interleaved, or will be the number of nodes times
* the number of components for the type long.)
*
*
* Z_UNDEF if undefined.
*
* Notes:
* 1. comp is ignored if the var is interleaved, otherwise it is used.
*
* Thus, the calling programs should call this only once per nodeset
* for an interleaved variable, but should call it once per
* component for all other situations.
*--------------------------------------------------------------------*/
int
USERD_get_node_var_values(USERDHandle handle,
int nodeset_index,
int node_var_index,
int comp,
float *values)
4.5.2.45. USERD_get_elem_var_info
/* -----------------------------------------------
USERD_get_elem_var_info
*--------------------------------------------------------------------
*
* Retrieves the var_index associated with and the number of values
* from the given elemset var
*
*
*
* elem_var_index = zero-based local var index for the elemset
*
* (OUT) var_index = zero-based var index
*
* number_of_values = The number of elements in the elemset
* (This is kind of redundant with what you can
* get from the elemset info).
*
*
* Notes:
* 1. number_of_values is the number of elements that have values in the
* elemset. It does not consider the number of components for the given
* variable type.
*
* So for an elemset containing 50 triangles, the number_of_values is 50 no
* matter whether the variable is a elemental scalar, vector, or tensor.
*--------------------------------------------------------------------*/
int
USERD_get_elem_var_info(USERDHandle handle,
int elemset_index,
int elem_var_index,
int *var_index,
int *number_of_values)
4.5.2.46. USERD_get_elem_var_values
/* -----------------------------------------------
USERD_get_elem_var_values
*--------------------------------------------------------------------
*
* Retrieves the variable values associated with a given elemset var
*
*
*
* elem_var_index = zero-based local var index for the elemset
*
* comp = variable component to retrieve if interleaved.
* Otherwise is ignored and all values are obtained.
*
* (OUT) values = Pointer to values array.
* Load with all values if interleaved. Load with the
* appropriate component if not interleaved.
* (Length will either be the number of elements long if
* not interleaved, or will be the number of elements times
* the number of components for the type long.)
*
*
* Z_UNDEF if undefined.
*
*
* Notes:
* 1. comp is ignored if the var is interleaved, otherwise it is used.
*
* Thus, the calling programs should call this only once per set of
* elems for an interleaved variable, but should call it once per
* component for all other situations.
*--------------------------------------------------------------------*/
int
USERD_get_elem_var_values(USERDHandle handle,
int elemset_index,
API 3.0 Headers
int elem_var_index,
int comp,
float *values)
4.5.2.47. USERD_get_number_of_model_constants
/* -----------------------------------------------
USERD_get_number_of_model_constants
*--------------------------------------------------------------------
*
* Get the number of model constants for which you will be providing info.
*
*
* returns: number of model constants
* >=0 if okay
* <0 if problem
*--------------------------------------------------------------------*/
int
USERD_get_number_of_model_constants(USERDHandle handle)
4.5.2.48. USERD_get_model_constant_info
/* -----------------------------------------------
USERD_get_model_constant_info
*--------------------------------------------------------------------
*
* Get info about model constant
*
*
* (IN) which_constant = The constant number (0, 1, 2, ... num_constants)
*
* (OUT) description = Constant description
*
* (Array will have been allocated Z_BUFL long)
*
* (OUT) complex = TRUE if complex, FALSE otherwise
*
* (OUT) freq = complex frequency (if complex)
*
* (OUT) contran = TRUE if constant changes per time step
* FALSE if constant truly same at all time steps
*
* (OUT) timeset = Timeset the constant will use (1 based).
*
*
* Z_ERR if any errors
*
* Notes:
*--------------------------------------------------------------------*/
int
USERD_get_model_constant_info(USERDHandle handle,
int which_constant,
char *description,
int *complex,
float *freq,
int *contran,
int *timeset)
4.5.2.49. USERD_get_model_constant_val
/* -----------------------------------------------
USERD_get_model_constant_val
*--------------------------------------------------------------------
*
*
*
* (IN) which_constant = The constant number (0, 1, 2, ... num_constants)
*
* (IN) imag_data = TRUE if want imaginary data value.
* FALSE if want real data value.
*
*
* Notes:
*--------------------------------------------------------------------*/
float
USERD_get_model_constant_val(USERDHandle handle,
int which_constant,
int imag_data)
4.5.2.50. USERD_get_constant_per_part_data
/*--------------------------------------------------------------------
USERD_get_constant_per_part_data
* This routine will be called for each of
* variables whose part type is
* Z_CONSTANT_PER_PART as defined in
* USERD_get_gold_variable_info
*
* This returns the desired constant per part
* variable values, for the time step desired,
* for the parts that have this variable type.
*--------------------------------------------------------------------
*
* (IN) v = The variable number
*
API 3.0 Headers
* (IN) imag_data = TRUE if want imaginary portion. (not currently using)

* FALSE if want real portion
*
* (IN) itstep = Time step
*
* (OUT) extparts = Array to receive the external part numbers that have
* a value for this per_part constant.
* This is the part number used in the file (or the part label)
*
* The array is zero-based and will be Numparts_available long, so
* all original parts will fit. It is initialized to an
* impossible part number (-1) for every entry in the array.
* You do not have to have values for all parts.
*
* (OUT) values = Array to receive the per_part constant value for the parts loaded
* in extparts.
*
* The array is zero-based and will be Numparts_available long. Each
* array entry is intialized to Z_UNDEF.
* Notes:
* Example: Model with 5 parts
* At the input itstep:
* part 1 has no value (is undefined for this part)
* part 23 had no value
* part 24 had a value of -4.75
*
* Thus,
* extparts[0] = 4
* extparts[1] = 5
* extparts[2] = 24
* Note: extpats[3] and extpats[4] are their init values, -1
*
* values[0] = 13.45
* values[1] = 102.50
* values[2] = -4.75
* Note: values[3] and values[4] are their init values of Z_UNDEF
*
* Since there are two of the original parts (part 1 and part 23) that
* do not have a defined value for this constant per part, you should
* leave their values to the init values in extparts & values. So,
* extparts[3-4] & values[3-4] are -1 and Z_UNDEF, respectively for
* proper interpretation by EnSight.
*
* IMPORTANT: The constant per part variables are not treated like case constant
* variables, but rather similar to scalars, vectors, tensor
* variables so you must set their classification and type
* in the USERD_get_gold_variable_info routine.
*
* var_type[ ] = Z_CONSTANT_PER_PART
* var_classify[ ] = Z_PER_PART
*
* The return is either Z_OK or Z_ERR.
*
* If all the per-part constants are undefined at the given timestep, simply
* return Z_OK without setting anything in extparts nor values.
*---------------------------------------------------------------------------------*/
int
USERD_get_constant_per_part_data(
USERDHandle handle,
int v,
int imag_data,
int itstep,
int *extparts,
float *values) {
4.5.2.51. USERD_get_extra_text
int
USERD_get_extra_data(USERDHandle handle, /* must be always be defined */
int *target, int *nint, int *nflt, int *nchr, /* populated on first call */
int *pint, float *pflt, char *pchr) /* populated on second call */
* this routine is optional. It provides the ability to customize
* the behavior of EnSight.
*
*
* It is called twice: the first time to define the size of arrays
* and what to do with them, the second time to actually populate the
* arrays.
*
* FIRST CALL:
* If this routine is present, then the server will call into it
* expecting you to define the following:
* (IN) target = a defined DATA_TARGET_* values in the ../extern/global_extern.h
* (IN) nint = number of integers
* (IN) nflt = number of floats
* (IN) nchr = number of floats
* (IN) pint = NULL (do not write to this pointer on the first call!)
* (IN) pflt = NULL (do not write to this pointer on the first call!)
* (IN) pchr = NULL (do not write to this pointer on the first call!)
*
* SECOND CALL:
* EnSight will then allocate integer, float, and char arrays and
* call back into this routine to populate these arrays.
* (IN) pint[nint] with integer values
* (IN) pflt[nflt] with float values
* (IN) pchr[nchr] with char values
*
* and then EnSight will do something with these values depending on
* the value of the target.
*
* One example usage is, on the first call
* to define *target = DATA_TARGET_UNDEF_VAL
* and to defined nflt = 1
* then on the second call, pflt will be an array of 1
* (and the other arrays will still be NULL)
* Now defined pflt[0] to be some float value that is your custom
* undefined value for EnSight to handle as undefined.
*
* returns:
* Z_OK if successful
4.5.2.52. USERD_get_extra_gui_numbers
/* -----------------------------------------------
USERD_get_extra_gui_numbers
*
* The Enhanced GUI routines are added to allow
* the user to customize a portion of the Data
* Reader dialog to pass in options to their
* user defined reader. There are
* three routines:
* USERD_get_extra_gui_numbers (optional)
* USERD_get_extra_gui_defaults (optional)
* USERD_set_extra_gui_data (optional)
*
* The existence of these routines indicates that
*
API 3.0 Headers
* simply delete this routine, or change its

* name to something such as
* USERD_DISABLED_get_extra_gui_numbers
*
* The presence of USERD_get_extra_gui_numbers
* will ensure that EnSight will call it and
* use it's data to modify the Data Reader dialog
* Format Options Tab with some or all of the following:
*
*
* exists then the other two routines must exist.
*
* TRUE if checked
*
* the menu item selected from 0 to number of
* pulldown menu items - 1.
*
* Field will return a string up to Z_LEN_GUI_FIELD_STR long.
*
*
*=====================================================
*=====================================================
*
* X Toggle Title 1 X Toggle Title 3
* X Toggle Title 2 X Toggle Title 4
*
* Pulldown Menu ->
* Menu Choice 1
* Menu Choice 2
* Menu Choice 3
*
* Data Field Title 1 ____________________________
*
* Data Field Title 2 ____________________________
*
*=====================================================
*=====================================================
*
*
*
* The following are defined in the global_extern.h
*
* The library is loaded, this routine is
* called, then the library is unloaded.
*
* Do not define globals in this routine
* as when the library is unloaded, you'll
* lose them.
*
* ----------------------------------------- */
void USERD_get_extra_gui_numbers(
int *num_Toggles,
int *num_pulldowns,
int *num_fields)
{
if (Debug_mode) {
fprintf(stderr,"USERD_get_extra_gui_numbers\n");
*num_Toggles = Z_NUMGUITOGGLE;
*num_pulldowns = Z_NUMGUIPULLDOWN;
*num_fields = Z_NUMGUIFIELD;
}
4.5.2.53. USERD_get_extra_gui_defaults
/* -----------------------------------------------
USERD_get_extra_gui_defaults
* This routine defines the Titles, status,

* List choices, strings, etc that are fed
* up to the GUI.
*
* The library is loaded, this routine is
* called, then the library is unloaded.
*
* Do not define globals in this routine
* that you wish to use later,
* as when the library is unloaded, you'll
* lose them.
*
*
* ----------------------------------------------- */
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
char **field_Title, /* [num_fields][Z_LEN_GUI_TITLE_STR] */
char **field_user_string /* [num_fields][Z_LEN_GUI_FIELD_STR] */
)
{
/* -------------------------------
* toggles
* --------------------------------*/
strncpy(toggle_Title[0],"Load Internal Parts",Z_LEN_GUI_TITLE_STR);
strncpy(toggle_Title[1],"Use Meta Data Files",Z_LEN_GUI_TITLE_STR);
strncpy(toggle_Title[2],"Load _M1 _M2 vars",Z_LEN_GUI_TITLE_STR);
strncpy(toggle_Title[3],"Load all cell types",Z_LEN_GUI_TITLE_STR);
/* new with 6.4a 9.1.1(b) */
strncpy(toggle_Title[4],"Poly to Regular Cell",Z_LEN_GUI_TITLE_STR);
strncpy(toggle_Title[5],"Poly faced Hex to Poly",Z_LEN_GUI_TITLE_STR);
strncpy(toggle_Title[6],"Fix Hanging Nodes",Z_LEN_GUI_TITLE_STR);
strncpy(toggle_Title[7],"Read Parallel CAS Variables",Z_LEN_GUI_TITLE_STR);
strncpy(toggle_Title[8],"Read Particle Variables",Z_LEN_GUI_TITLE_STR);
strncpy(toggle_Title[9],"Use Zone IDs for Parts",Z_LEN_GUI_TITLE_STR);
strncpy(toggle_Title[10],"Read all files to create variable list",Z_LEN_GUI_TITLE_STR);
toggle_default_status[0] = FALSE; /* default is to NOT load internal parts */

toggle_default_status[1] = TRUE; /* default is to use meta data files */
toggle_default_status[2] = FALSE; /* default is to NOT load _M1 & _M2 vars */
toggle_default_status[3] = FALSE; /* default is to NOT load cell types that are not 1 */
/* new with 6.4a 9.1.1(b) */
toggle_default_status[4] = TRUE; /* default is to convert polys to regular cells where appropriate */
toggle_default_status[5] = FALSE; /* default is to NOT convert poly faced hexes to polys */
toggle_default_status[6] = TRUE; /* default is to fix hanging nodes */
toggle_default_status[7] = FALSE; /* default is to don't read CAS parallel variables */
toggle_default_status[8] = FALSE; /* default is to don't read particle variables */
toggle_default_status[9] = FALSE; /* default is to not use Zone IDs for matching parts */
toggle_default_status[10] = FALSE; /* default is to maintain varaibles read from last CAS, DAT file */
API 3.0 Headers
/* -------------------------------
* Pulldowns
* --------------------------------*/
strncpy(pulldown_Title[0],"Console Output",Z_LEN_GUI_TITLE_STR);
strncpy(pulldown_Title[1],"Time Values",Z_LEN_GUI_TITLE_STR);
/* pulldown_item_strings[num_pulldown][Z_MAX_NUM_GUI_PULL_ITEMS][Z_LEN_GUI_PULL_STR] */
strncpy(pulldown_item_strings[0][0],"Normal",Z_LEN_GUI_PULL_STR);
strncpy(pulldown_item_strings[0][1],"Verbose",Z_LEN_GUI_PULL_STR);
strncpy(pulldown_item_strings[0][2],"Debug",Z_LEN_GUI_PULL_STR);
strncpy(pulldown_item_strings[0][3],"",Z_LEN_GUI_PULL_STR); /* indicates last pulldown item */
strncpy(pulldown_item_strings[1][0],"Calc Const Delta",Z_LEN_GUI_PULL_STR);

strncpy(pulldown_item_strings[1][1],"Read Time Values",Z_LEN_GUI_PULL_STR);
strncpy(pulldown_item_strings[1][2],"Use Time Steps",Z_LEN_GUI_PULL_STR);
strncpy(pulldown_item_strings[1][3],"Use Filename Numbers",Z_LEN_GUI_PULL_STR);
strcpy(pulldown_item_strings[1][4] ,""); /* indicates last pulldown item */
pulldown_default_selection[0] = 0; /* Normal output by default */

pulldown_default_selection[1] = 1; /* Read Time values by default */
/* -------------------------------
* Fields - Currently no fields
*
* strncpy(field_Title[0],"Field 1",Z_LEN_GUI_TITLE_STR);
* strncpy(field_Title[1],"Field 2",Z_LEN_GUI_TITLE_STR);
* strncpy(field_user_string[0],"Put some default text here if you want",Z_LEN_GUI_FIELD_STR);
* strncpy(field_user_string[1],"-flag1 -flag2",Z_LEN_GUI_FIELD_STR);
* --------------------------------*/
return(Z_OK);
}
4.5.2.54. USERD_set_extra_gui_data
/* -----------------------------------------------
USERD_set_extra_gui_data
*
* toggle, pulldown and field_text from enhanced GUI.
*
* toggle values TRUE = toggle checked
*
* pulldown value from 0 to number of pulldown values
*
* field text any text
*
*
*
* user entries!
*
* -------------------------------------------------------------- */
void USERD_set_extra_gui_data(
int *toggle, /* [num_toggle] */
int *pulldown, /* [num_pulldown] */
char **field_text /* [num_fields][Z_LEN_GUI_FIELD_STR] */
)
{
int i;
if (Debug_mode) {
fprintf(stderr,"USERD_set_extra_gui_data\n");
}
/* Assign the choices to globals */
Num_toggle = Z_NUMGUITOGGLE;
Num_pulldown = Z_NUMGUIPULLDOWN;
Num_field = Z_NUMGUIFIELD;
for(i=0; i<Z_NUMGUITOGGLE; i++) {

Toggle_user[i] = toggle[i];
}
for(i=0; i<Z_NUMGUIPULLDOWN; i++) {

Pulldown_user[i] = pulldown[i];
}
for(i=0; i<Z_NUMGUIFIELD; i++) {
strcpy(Field_user[i],field_text[i]);
}
}
/*---------------- END of FILE ---------------------*/
4.6. Converting a 2.0 API Reader to a 3.0 API READER

If you have an existing 2.0 API Reader and you desire to convert it to a 3.0 API reader, to take advantage
of new capabilities, or the improved efficiency, the following may be helpful.
First the Good News!
All of your globals will now be contained in one struct, that you create that will be passed in to all of
your USERD routines via a pointer.
Second, pretty Good News!
The following routines have minor changes, namely a slight name change and the addition of arguments
related to complex data, constant type, or self contained parts vs global coords.
Note:
The name changes are needed so both API's can exist together
The arguments must be added, but depending on your situation, many might simply be place holders.
API 1.0 API 2.0 API 3.0

USERDHandle
USERD_reader_open
(void)
Creates the handle that

contains all the global stuff
Converting a 2.0 API Reader to a 3.0 API READER
API 1.0 API 2.0 API 3.0

needed to keep things
opaque from the application.
It is the starting routine to
call. Most other calls must
include this handle.
int
USERD_verbose_level
(USERDHandle handle,
int level)
Standardize debugging that

can be done from
userd_read.c
int
USERD_get_last_error
(USERDHandle
handle,int *er-
ror_flag,
char error-
String[Z_MAXSTR])
Last error will be contained

in the handle. So when any
routine returns an error that
should go back to the user
- it can be queried by a call
to this routine.
int int int <optional>
USERD_bkup
USERD_bkup USERD_bkup
(FILE *archive_file, (FILE *archive_file, FILE *archive_file,
int backup_type) int backup_type) int backup_type)
If not defined or
Z_NOT_IMPLEMENTED,
perform a restore by setting
the filename and timeset.
Server may need to store
additional info in it's own
backup space, such as the
user-defined GUI options.
int
USERD_reader_close
API 1.0 API 2.0 API 3.0

(USERDHandle handle)
Destroy the handle

void void
USERD_exit_routine USERD_exit_routine
( void ) ( USERDHandle handle

)
Do whatever you need to when
exiting the reader.
int int Replaced by new routines.
See second table.
USERD_get_block_co- USERD_get_block_co-
ords_by_component ords_by_component
(int block_num- (int block_number,

ber,int which_compon-
ent, float *coord_ar- int which_component,
ray) float *coord_array)
int int Replaced by new routines.
See second table.
USERD_get_block_ib- USERD_get_block_ib-
lanking lanking
(int block_number, (int block_number,

int *iblank_array) int *iblank_array)
int Replaced by new routines.
See second table.
USERD_get_block_ghost_flags
(int block_number,
int *ghost_flags)
int (See Replaced by new routines.
USERD_get_var_by_component (p. 137))
See second table.
USERD_get_block_scal-
ar_values
(int block_number,
int which_scalar,
int (See Replaced by new
USERD_get_var_by_com- routines. See second
USERD_get_block_vec- ponent (p. 137)) table.
tor_values_by_compon-
ent
(int block_num-
ber,int which_vec-
tor,
API 1.0 API 2.0 API 3.0

int Replaced by has_bor-
der_geom and bor-
USERD_get_bor- der_geom_index in
der_availability new routine:
USERD_get_part_info.
(int part_number,
int number_of_ele-
ments[Z_MAXTYPE])
int Replaced by has_bor-
der_geom and bor-
USERD_get_border_ele- der_geom_index in
ments_by_type new routine:
USERD_get_part_info.
(int part_number,int Get the element
element_type,int conns with regular
**conn_array, routines for geoms
and below.
short *parent_ele-
ment_type, int *par-
ent_element_num)
int int (This is now a un-
ode, snode, uelem,
USERD_get_chan- USERD_get_chan- selem attribute as
ging_geometry_status ging_geometry_status far as the readers
are concerned. See
( void ) ( void ) the new routines in
the second table.
Applications (like
EnSight) might still
choose to make it
model based - or
whatever)
float float int
USERD_get_con- USERD_get_con- USERD_get_num-

stant_value stant_val (int ber_of_model_con-
which_var, stants
(int which_var)
int imag_data) (USERDHandle handle)
int
USERD_get_model_con-
stant_info
int which_constant,
API 1.0 API 2.0 API 3.0

char *descrip-
tion,int *complex,
float *freq, int

*contran, int
*timeset)
float
USERD_get_model_con-
stant_val (USERD-
Handle handle,
int which_constant,
int imag_data)
int int int
USERD_get_data- USERD_get_data- USERD_get_data-

set_query_file_info set_query_file_info set_query_file_info
(Z_QFILES *qfiles) (Z_QFILES *qfiles) (USERDHandle handle,

Z_QFILES *qfiles)
int int int
USERD_get_descrip- USERD_get_descrip_lines USERD_get_descrip_lines

tion_lines (int which_type, (USERDHandle handle,
(int which_type,int int which_var,int int which_type,int

which_var, imag_data,char which_var,int
line1[Z_BUFL], char imag_data,char
char line1[Z_BUFL], line2[Z_BUFL]) line1[Z_BUFL], char
char line2[Z_BUFL]) line2[Z_BUFL])
Probably modify!
int int Replaced by new
routines. See second
USERD_get_ele- USERD_get_part_ele- table.
ment_connectivit- ments_by_type (int
ies_for_part part_number,
(int part_number, int element_type,
int **conn_ar- int **conn_array)

ray[Z_MAXTYPE])
int <optional> Replaced by new
USERD_get_part_ele- table.
ments_by_type_in_buf-
fers
API 1.0 API 2.0 API 3.0

(int part_number,
int element_type,
int **conn_array,
int first,
int e_beg,int
e_end,int buf-
fer_size,int
*num_returned)
USERD_get_ele- USERD_get_part_ele- table.
ment_ids_for_part ment_ids_by_type
(int part_number,
(int part_number,
int element_type,
int *elemid_ar-
ray[Z_MAXTYPE]) int *elemid_array)
USERD_get_part_ele- table.
ment_ids_by_type_in_buf-
fers
(int part_number,
int element_type,
int *elemid_array,
int first,
int e_beg,int
e_end,int buf-
fer_size,int
*num_returned)
int int int
USERD_get_element_la- USERD_get_element_la- USERD_get_element_la-

bel_status bel_status bel_status
( void ) ( void ) (USERDHandle handle)
Or this could be
discerned from the
info in the new
routines. We could
check the id arrays
against NULL. Or
even have a flag.
Then this routine
would be unneces-
sary.
API 1.0 API 2.0 API 3.0

int <optional> int <optional>
USERD_get_extra_data USERD_get_extra_data
(int *target, int (USERDHandle handle,

*nint, int *nflt,int int *target,int
*nchr, int *pint, *nint,int *nflt,
float *pflt, char
*pchr) int *nchr, int
*pint, float *pflt,
char *pchr)
int <optional> int <optional> ?????
USERD_get_ex- USERD_get_ex-
tra_gui_defaults tra_gui_defaults
(char (char
**toggle_Title,int **toggle_Title,int
*toggle_de- *toggle_de-
fault_status,char fault_status,char
**pulldown_Title,int **pulldown_Title,int
*pulldown_num- *pulldown_num-
ber_in_list, int ber_in_list, int
*pulldown_default_se- *pulldown_default_se-
lection, char lection, char
***pull- ***pull-
down_item_strings, down_item_strings,
char char
**field_Title,char **field_Title,char
**field_user_string) **field_user_string)
void <optional> void <optional> ?????
USERD_get_ex- USERD_get_ex-
tra_gui_numbers tra_gui_numbers
(int *num_Toggles, (int *num_Toggles,

int *num_pulldowns, int *num_pulldowns,
int *num_fields) int *num_fields)
int int
USERD_get_geom_timeset_num-
USERD_get_geom_timeset_num-
ber ber
( void ) (USERDHandle handle)

int int
USERD_get_ghosts_in_block_flag
USERD_get_ghosts_in_block_flag
(int block_number) (USERDHandle handle,

int block_number)
API 1.0 API 2.0 API 3.0

Or this could be
discerned from the
info in the new
routines. We could
check the ghost flag
arrays against NULL.
Or even have a flag.
Then this routine
would be unneces-
sary.
int int
USERD_get_ghosts_in_mod- USERD_get_ghosts_in_mod-
el_flag el_flag
( void ) (USERDHandle
handle)Or this could
be discerned from
the info in the new
routines. We could
check the ghost flag
arrays against NULL.
Or even have a flag.
Then this routine
would be unneces-
sary.
USERD_get_global_co- USERD_get_part_co- table.
ords ords (int part_num-
ber,
(CRD *coord_array)
USERD_get_part_co- table.
ords_in_buffers
(int part_number,
int first,int n_beg,
int n_end,int buf-

fer_size,int
*num_returned)
USERD_get_glob- USERD_get_part_node_ids table.
al_node_ids (int part_number,
API 1.0 API 2.0 API 3.0

(int *nodeid_array) int *nodeid_array)
USERD_get_part_node_ids_in_buf-
table.
fers
(int part_number,
int *nodeid_array,
int first,int n_beg,
int n_end,int buf-

fer_size,int
*num_returned)
USERD_get_matf_escal- USERD_get_matf_escal-
ars_desc ars_desc
(int set_index,char (USERD, Handle

**mesv_desc) handle,
int set_index,char
**mesv_desc)
int int
USERD_get_matf_set_info USERD_get_matf_set_info
(int *mat_set_ids, (USERDHandle handle,

int
char **mat_set_name) *mat_set_ids,char
**mat_set_name)
USERD_get_matf_set_type USERD_get_matf_set_type
(int set_index) (USERDHandle handle,

int set_index)
int int
USERD_get_matf_var_info USERD_get_matf_var_info
(int set_index, (USERDHandle handle,

int set_index,
int *mat_ids, char
**mat_desc) int *mat_ids, char
**mat_desc)
int int
USERD_get_matsp_info USERD_get_matsp_info
API 1.0 API 2.0 API 3.0

(int set_index,int (USERDHandle
*sp_ids,char handleint int
**sp_desc, *sp_ids,char
**sp_desc,int
int *sp_per_mat_cnt, *sp_per_mat_cnt, int
int *sp_per_mat_lis) *sp_per_mat_lis)
set_index,
int int <optional>
USERD_get_max-
USERD_get_max- size_info
size_info
(int *max_num-
ber_of_nodes, int *max_num-
ber_of_nodes,int
int *max_num- *max_number_of_ele-
ber_of_ele- ments[Z_MAXTYPE],
ments[Z_MAXTYPE], int *max_ijk_dimen-
int *max_ijk_dimen- sions[3])
sions[3])
int int <optional>
USERD_get_model_ex-
USERD_get_model_ex- tents
tents
( float extents[6]
) float extents[6] )
int int int
USERD_get_name_of_read- USERD_get_name_of_read- USERD_get_name_of_read-

er er er
(char read- (char read- (char read-

er_name[Z_MAX_USERD_NAME],er_name[Z_MAX_USERD_NAME],er_name[Z_MAX_USERD_NAME],
int *two_fields) int *two_fields) int *two_fields)
int Replaced by new
USERD_get_nfaced_conn table
(int part_number,
int *nfaced_conn_ar-
ray)
USERD_get_nfaced_conn_in_buf-
table
fers
(int part_number,int
*nfaced_fpe_array,
API 1.0 API 2.0 API 3.0

int *nfaced_npf_ar-
ray, int
*nfaced_conn_array,
int first,int
e_beg,int e_end,int
buffer_size,int
*num_returned)
int Replaced by new
USERD_get_nfaced_nodes_per_face
table
(int part_number,
int *nfaced_npf_ar-
ray)
int int int
USERD_get_node_la- USERD_get_node_la- USERD_get_node_la-

bel_status bel_status bel_status
( void ) ( void ) (USERDHandle

handle)Or this could
be discerned from
the info in the new
routines. We could
check the id arrays
against NULL. Or
even have a flag.
Then this routine
would be unneces-
sary.
int Replaced by new
USERD_get_nsided_conn table
(int part_number,
int *nsided_conn_ar-
ray)
USERD_get_nsided_conn_in_buf-
table
fers
(int part_number,int
*num_nodes_per_elem_ar-
ray, int
*nsided_conn_ar-
ray,int first,int
e_beg,int e_end,int
API 1.0 API 2.0 API 3.0

buffer_size,int
*num_returned)
int <optional> int <optional> int <optional>
USERD_get_num_xy_quer- USERD_get_num_xy_quer- USERD_get_num_xy_quer-

ies ies ies

int int int
USERD_get_num- USERD_get_num- USERD_get_num-

ber_of_files_in_data- ber_of_files_in_data- ber_of_files_in_data-
set set set

int (See
USERD_get_gold_part_build_info (p. 76))
USERD_get_num-
ber_of_global_nodes
( void )
int int
USERD_get_num- USERD_get_num-
ber_of_material_sets ber_of_material_sets

int int
ber_of_materials ber_of_materials
(int set_index ) (USERDHandle handle,

int set_index )
int int int
USERD_get_num- USERD_get_num- USERD_get_num-

ber_of_model_parts ber_of_model_parts ber_of_model_parts

int int int
USERD_get_num- USERD_get_num_of_time_steps
USERD_get_num_of_time_steps
ber_of_time_steps (int timeset_number (USERDHandle handle,
)
( void ) int timeset_number )
int int
ber_of_species ber_of_species
API 1.0 API 2.0 API 3.0

(int set_index ) (USERDHandle handle,
int set_index )
int int
ber_of_timesets ber_of_timesets

USERD_get_num- USERD_get_num- table.
ber_of_variables ber_of_variables
Will need to accumu-
( void ) ( void ) late intelligently
as you get Pbuild
info.
USERD_get_part_build_info USERD_get_gold_part_build_info
table.
(int *part_id,
(int *part_id,int
*part_types,char int *part_types,char
*part_descrip- *part_descrip-
tion[Z_BUFL],int tion[Z_BUFL],int
*number_of_ele- *number_of_nodes,int
ments[Z_MAXTYPE], *number_of_ele-
int *ijk_dimen- ments[Z_MAXTYPE],
sions[3], int *ijk_dimen-
sions[9],int *iblank-
int *iblanking_op- ing_options[6])
tions[6])
USERD_get_read- USERD_get_read- USERD_get_read-

er_descrip er_descrip er_descrip
(char descrip[Z_MAX- (char descrip[Z_MAX- (char descrip[Z_MAX-

FILENP]) FILENP]) FILENP])
USERD_get_reader_re- USERD_get_reader_re- USERD_get_reader_re-

lease lease lease
(char version_num- (char version_num- (char version_num-

ber[Z_MAX_USERD_NAME]) ber[Z_MAX_USERD_NAME]) ber[Z_MAX_USERD_NAME])
int int
USERD_get_reader_ver- USERD_get_reader_ver-
sion sion
API 1.0 API 2.0 API 3.0

(char version_num- (char version_num-
ber[Z_MAX_USERD_NAME]) ber[Z_MAX_USERD_NAME])
int (See
USERD_get_var_by_com-
USERD_get_scalar_val- ponent (p. 137))
ues
(int which_scalar,
int which_part,
int which_type,
int int int
USERD_get_solu- USERD_get_sol_times USERD_get_sol_times

tion_times (int timeset_number, (USERDHandle handle,
(float *solu- float *solu- int timeset_number,

tion_times) tion_times) float *solu-
tion_times)
int int
USERD_get_struc- USERD_get_struc-
tured_reader_cinch- tured_reader_cinch-
ing ing

int int
USERD_get_timeset_de- USERD_get_timeset_de-
scription scription
(int timeset_number, (USERDHandle

handle,int
char timeset_descrip- timeset_number,char
tion[Z_BUFL]) timeset_descrip-
tion[Z_BUFL])
int ?????
USERD_get_uns_failed_params
(char
*fail_var_name,
float
*threshold_val1,
float
*threshold_val2,
int *threshold_oper-
ator1, int
API 1.0 API 2.0 API 3.0

*threshold_operat-
or2, int *logic_cri-
teria2)
int <optional> int <optional> ?????
USERD_get_var_ex- USERD_get_var_ex-
tract_gui_defaults tract_gui_defaults
(char (char
**toggle_Title,int **toggle_Title,int
*toggle_de- *toggle_de-
fault_status,char fault_status,char
**pulldown_Title,int **pulldown_Title,int
*pulldown_num- *pulldown_num-
ber_in_list, int ber_in_list, int
*pulldown_default_se- *pulldown_default_se-
lection, char lection, char
***pull- ***pull-
down_item_strings, down_item_strings,
char char
**field_Title,char **field_Title,char
**field_user_string) **field_user_string)
USERD_get_var_ex- USERD_get_var_ex-
tract_gui_numbers tract_gui_numbers
(int *num_Toggles, (int *num_Toggles,

int *num_pulldowns, int *num_pulldowns,
int *num_fields) int *num_fields)
USERD_get_vari- USERD_get_gold_vari- table. and model
able_info able_info (char constants have their
**var_description, own routines now.
(char **var_descrip-
tion, char **var_fi- char **var_filename,
lename, int int *var_type,int
*var_type, *var_classify,int
*var_complex, char
int *var_classify) **var_ifilename,
float *var_freq,
int *var_contran,
int *var_timeset)
(See USERD_get_scal- int Replaced by new
ar_values (p. 33) & routines. See second
USERD_get_vector_val- USERD_get_var_by_com- table.
ues (p. 38) ponent
routines)
API 1.0 API 2.0 API 3.0

(int which_variable,
int which_part,int
var_type,
int which_type,
int imag_data, int

component, float
*var_array)
USERD_get_var_by_com- table.
ponent_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 buf-
fer_size,int left-
side,int *num_re-
turned)
int int int
USERD_get_vari- USERD_get_var_value_at_spe-
USERD_get_var_value_at_spe-
able_value_at_specif- cific (int cific (USERDHandle
ic which_var, handle,
(int which_var,int int int which_var,int

which_node_or_elem, which_node_or_elem, which_node_or_elem,
int which_part,int int which_part,int int which_part,int
which_elem_type,int which_elem_type,int which_elem_type,int
time_step, time_step, time_step,float val-
ues[3],int
float values[3]) float values[3], int imag_data)
imag_data)
int (See
USERD_get_var_by_com-
USERD_get_vector_val- ponent (p. 137))
ues
(int which_vector,
int which_part,
API 1.0 API 2.0 API 3.0

int which_type,
USERD_get_vglyph_counts USERD_get_vglyph_counts
(int (USERDHandle
*num_vglyph_vectors, handle,int
int *num_vglyph_vectors,
*num_vglyph_timelines) int
*num_vglyph_timelines)
(int vtl,int *id,int (USERDHandle handle,

*numtimes, int *be- int vtl,int *id,int
fore,int *amidst,int *numtimes,
*after)
int *before, int
*amidst, int *after)
(int vtl,float (USERDHandle handle,

*times) int vtl,float
*times)
USERD_get_vglyph_vec- USERD_get_vglyph_vec-
tor_info tor_info
(int vg,int *id,char (USERDHandle handle,

*description, int int vg,int *id,char
*type,int *time_con- *description,
dition, int
*time_line,int int *type,int
*part,int *nid- *time_condition, int
loc,int *eidloc) *time_line,int
*part,int *nid-
loc,int *eidloc)
tor_values tor_values
(int vg,float **val- (USERDHandle handle,

ues) int vg,float **val-
ues)
API 1.0 API 2.0 API 3.0

tor_xyzloc tor_xyzloc
(int vg,float **xyz- (USERDHandle handle,

loc) int vg,float **xyz-
loc)
USERD_get_xy_query_data USERD_get_xy_query_data USERD_get_xy_query_data
(int query_num, int (int query_num, int (USERDHandle handle,

num_vals, float num_vals, float int query_num,int
*xvals, float *xvals, float num_vals,float
*yvals) *yvals) *xvals,
float *yvals)
USERD_get_xy_query_info USERD_get_xy_query_info USERD_get_xy_query_info
(int query_num,char (int query_num,char (USERDHandle handle,

*query_name, char *query_name, char int query_num,char
*query_xtitle, char *query_xtitle, char *query_name, char
*query_ytitle,int *query_ytitle,int *query_xtitle,
*query_num_pairs ) *query_num_pairs )
char
*query_ytitle,int
*query_num_pairs )
int int
USERD_load_matf_data USERD_load_matf_data
(int set_index, int (USERDHandle handle,

part_id, int wtyp, int set_index,int
part_id,int wtyp,
int mat_type, int
*ids_list, float int mat_type, int
*val_list) *ids_list, float
*val_list)
USERD_prefer_auto_dis- USERD_prefer_auto_dis- USERD_prefer_auto_dis-

tribute tribute tribute
(void) (void) (USERDHandle handle)

int int
USERD_rigidbody_ex- USERD_rigidbody_ex-
istence istence
API 1.0 API 2.0 API 3.0

int int
USERD_rigidbody_val- USERD_rigidbody_val-
ues ues
(int part_number, (USERDHandle handle,

int part_num-
float values[14]) /* ber,float val-
Prior to Version ues[14])
2.08,float val-
ues[10] */
int int
(int part_number, (USERDHandle

handle,int part_num-
int mini, int maxi, ber,int mini, int
int stepi, int minj, maxi, int stepi, int
int maxj, int stepj, minj, int maxj, int
int mink, int maxk, stepj, int mink, int
int stepk) maxk, int stepk)
USERD_set_ex- USERD_set_ex-
tra_gui_data tra_gui_data
(int *toggle,int (int *toggle,int

*pulldown, char *pulldown, char
**field_text) **field_text)
void <optional> void <optional> void <optional>
USERD_set_file- USERD_set_file- USERD_set_file-

name_button_labels name_button_labels name_button_labels
(char filename_la- (char filename_la- (USERDHandle

bel_1[Z_MAX_USERD_NAME], bel_1[Z_MAX_USERD_NAME], handle,char file-
char filename_la- char filename_la- name_la-
bel_2[Z_MAX_USERD_NAME]) bel_2[Z_MAX_USERD_NAME]) bel_1[Z_MAX_USERD_NAME],
char filename_la-
bel_2[Z_MAX_USERD_NAME])
int int int
USERD_set_filenames USERD_set_filenames USERD_set_filenames
(char filename_1[], (char filename_1[], (USERDHandle handle,

char param_2[], char char filename_2[], char file-
the_path[], int char the_path[], int name_1[],char file-
swapbytes) swapbytes)
API 1.0 API 2.0 API 3.0

name_2[],char
the_path[],
int swapbytes)
void <optional> void <optional>
USERD_set_right_side USERD_set_right_side
( void ) (USERDHandle handle,

void )
void void
USERD_set_server_num- USERD_set_server_num-
ber ber
(int cur_serv, int (USERDHandle handle,

tot_servs) int cur_serv,int
tot_servs)
void void void
USERD_set_time_step USERD_set_time_set_and_step
(int timeset_number, (USERDHandle handle,
(int time_step)
int time_step) int timeset_number,
int time_step)
USERD_set_var_ex- USERD_set_var_ex-
tract_gui_data tract_gui_data
(int *toggle, int (int *toggle, int

*pulldown, *pulldown,
char **field_text) char **field_text)

int int
USERD_size_matf_data USERD_size_matf_data
(int set_index, int (USERDHandle handle,

part_id,int wtyp, int set_index,int
part_id,int wtyp,
int mat_type, int
*matf_size) int mat_type, int
*matf_size)
void void void
USERD_stop_part_build- USERD_stop_part_build- USERD_stop_part_build-

ing ing ing
4.7. API 3.0 Call Order for Major Routines

As Compared to past APIs (For Conversion Purposes)
Part Build Info Gathering Process

(does not include all routines - just the basic ones)
Old:
===
number_of_parts = USERD_get_number_of_model_parts()
(Called once for model expecting user to update)
USERD_get_gold_part_build_info(&part_id,
&part_types,
part_description,
&number_of_nodes,
number_of_elements,
ijk_dimension,
iblanking_options)
New:
====
number_of_parts = USERD_get_number_of_model_parts(handle)
Loop on Parts (part_index from 0 to number_of_parts): --------------------
USERD_get_part_info ( handle,
part_index,
&part_id,
part_description,
&number_of_geoms
&has_border_geom,
&border_geom_index))
Allocate geoms array to be number_of_geoms long.
USERD_get_geoms_in_part( handle,
API 3.0 Call Order for Major Routines
part_index,
geoms)
Loop on Geoms (geom_index from 0 to number_of_geoms
-----------------------
USERD_get_geom_info( handle ,
geom_index,
&geom_type, Keep track of for EnSight. To set part_type
&unode_index,
&number_of_elems,
&snode_index,
&selem_index)
If geom_type is Unstructured
---------------------------------------
if number_of_elems > 0
Allocate elem_index array to be number_of_elems long.
USERD_get_uelems_in_geom ( handle ,
geom_index,
elem_index)
Loop on elem_indicies (elem_index from 0 to number_of_uelems)
-------------------------------
USERD_get_uelem_info( handle,
elem_index,
&number_of_elements, accumulate by type for ensight
&etype,
&contents_index_mode, note so can swizzle and/or hash
&conn_changing_flag, keep track of for ensight global
&transient_var_flag,
&num_elem_variables)
end elem_indicies loop
------------------------
endif number_of_elems
if node_index != NULL
USERD_get_unode_info( handle ,
node_index,
&number_of_nodes, accumulate for ensight
&interleave_flag,
&coords_changing_flag, keep track of for ensight global
&num_node_variables)
endif node_index
endif geom_type Unstructured
else if geom_type is Structured
------------------------------------------
USERD_get_snode_info( handle ,
node_index,
&stype,
ijk_dimensions[9], accumulate for ensight
&interleave_flag,
iblanking_options[6],
USERD_get_selem_info( handle ,
elem_index,
&stype,
ijk_dimensions[9],
endif node_index
endif geom_type Structured
end geoms loop
-----------------------
end parts loop
--------------------
Part Creation Actual Data Retrieval Process

Old:
===
Loop on Parts (part_index from 0 to number_of_parts):
--------------------
if unstructured part
USERD_get_part_coords(int part_number,
USERD_get_part_node_ids(int part_number,
int *nodeid_array)
Loop on Element Types
---------------------------------
int element_type,
int *elemid_array)
int element_type,
int **conn_array)
end element type loop
-------------------------------
else if structured part
int *iblank_array)
float *coord_array)
USERD_get_block_ghost_flags(int block_number,
int *ghost_flags)
int element_type,
int *elemid_array)
int element_type,
int **conn_array)
endif
end part loop
------------------
New:
====
--------------------
USERD_get_part_info(handle,
part_index,
&part_id,
part_description,
&number_of_geoms,
&has_border_geom,
&border_geom_index)
USERD_get_geoms_in_part(handle,
part_index,
geoms)

-----------------------
USERD_get_geom_info(handle,
geom_index,
&unode_index,
&number_of_elems,
&snode_index,
&selem_index)
---------------------------------------
USERD_get_uelems_in_geom(handle,
geom_index,
elem_index)
Loop on elem_indices (elem_index from 0 to number_of_uelems)
-------------------------------
USERD_get_uelem_info(handle,
elem_index,
&etype,
&contents_index,_mode, note so can swizzle and/or hash
if etype is a regular elem
Allocate int conn_array (number_of_elements x known conlength)
USERD_get_uelem_conn(handle,
elem_index,
conn_array)
else if etype is nsided
Allocate int npf array (number_of_elements long)
USERD_get_uelem_nodes_per_face(handle,
elem_index,
npf)
Accumulate total length of conn_array loop thru npf

array.
Allocate int conn_array (as long as this accumulated length)
elem_index,
conn_array)
else if etype is nfaced
Allocate int fpe array (number_of_elements long)
USERD_get_uelem_faces_per_elem(handle,
elem_index,
fpe)
Accumulate total length of nfp array by running through fpe array.
Allocate int npf array (as long as this accumulated length)
USERD_get_uelem_nodes_per_face(handle,
elem_index,
npf)
Accumulate total length of conn_array by loop thru npf array.
Allocate int conn_array (as long as this accumulated length)
elem_index,
conn_array)
endif etype
Allocate int elem_id_array (number_of_elements long)
USERD_get_elem_ids(handle,
elem_index,
elem_id_array)
end elems loop
------------------------
endif number_of_elements
USERD_get_unode_info(handle,
node_index,
&interleave_flag,
Allocate the float coord_array (3 x (number_of_nodes+1))
USERD_get_node_coords(handle,
node_index,
&coord_array[0][1],
&coord_array[1][1],
&coord_array[2][1])
Allocate the int node_id_array (number_of_nodes+1)
USERD_get_node_ids(handle,
node_index,
node_id_array)
endif node_index
------------------------------------------
USERD_get_snode_info(handle,
node_index,
&stype,
&interleave_flag,
Allocate the float coord_array (3 x (i*j*k+1))
USERD_get_node_coords(handle,
node_index,
&coord_array[0][1],
&coord_array[1][1],
&coord_array[2][1])
Allocate for node_id_array (i*j*k + 1)
USERD_get_node_ids(handle,
node_index,
node_id_array)
if iblanking
Allocate for iblanking_array (i*j*k + 1)
USERD_get_snode_iblanking(USERDHandle
handle,
int snode_index,
int *iblanking_array)
endif
USERD_get_selem_info(handle,
elem_index,
&stype,
ijk_dimensions[9],
Allocate for elem_id_array ((i-1)*(j-1)*(k-1) long)
USERD_get_elem_ids(handle,
elem_index,
elem_id_array)
Allocate for ghost_flag_array ((i-1)*(j-1)*(k-1) long)
USERD_get_selem_ghost_flags(handle,
elem_index,
ghost_flag_array)
endif
endif
end geoms loop
-----------------------
end parts loop
--------------------
Var Info Gathering Process:

Old:
===
number_of_vars = USERD_get_number_of_variables( void )
(Called once for model)
USERD_get_gold_variable_info(char **var_description,
int *var_type,
int *var_classify,
int *var_complex,
float *var_freq,
int *var_contran,
int *var_timeset)
New:
====
Constants
--------------
number_of_model_constants = USERD_get_number_of_model_constants(handle)
Loop on model constants (which_constant from 0 to number_of_model_constants)
----------------------------------
USERD_get_model_constant_info(handle,
which_constant,
description,
&complex,
&freq, if complex
&contran, strict constant or single value that changes with time.
&timeset) if transient constant
end model constant loop
----------------------------------
Non-Constants
---------------------
number_of_parts = USERD_get_number_of_model_parts(handle)
--------------------
part_index,
&part_id,
part_description,
&number_of_geoms,
&has_border_geom,
&border_geom_index)
part_index,
geoms)
-----------------------
geom_index,
&unode_index,
&number_of_elems,
&snode_index,
&selem_index)
---------------------------------------
geom_index,
elem_index)
-------------------------------
elem_index,
&etype,
Loop on num_elem_variables vars
------------------------------------------------
USERD_get_var_info(handle,
var_index,
var_description,
var_filename,
&var_type,
&var_classify,
&var_complex,
var_ifilename,
&var_freq,
&var_timeset,
&num_entities,
&interleave_flag)
If new var, increment number_of_variables, and log its type etc.
end num_elem_variables loop
------------------------
end if number_of_elems
node_index,
&interleave_flag,
Loop on num_node_variables vars
------------------------------------------------
var_index,
var_description,
var_filename,
&var_type,
&var_classify,
&var_complex,
var_ifilename,
&var_freq,
&var_timeset,
&num_entities,
&interleave_flag)
If the variable is new, increment number_of_variables, and log its type.
end node_variables loop
endif node_index
else if Structured
node_index,
&stype,
&interleave_flag,
------------------------------------------------
var_index,
var_description,
var_filename,
&var_type,
&var_classify,
&var_complex,
var_ifilename,
&var_freq,
&var_timeset,
&num_entities,
&interleave_flag)
If the new var, increment number_of_variables, and log its type etc.
elem_index,
&stype,
ijk_dimensions[9],
------------------------------------------------
var_index,
var_description,
var_filename,
&var_type,
&var_classify,
&var_complex,
var_ifilename,
&var_freq,
&var_timeset,
&num_entities,
&interleave_flag)
If the new var, increment number_of_variables, and log its type etc.
end elem_variables loop
endif node_index
endif Structured
end Geoms loop
-----------------------
end Parts loop
--------------------
Var Data Retrieval Process:

Old:
===
Loop on Variables (which variable from 1 to number_of_vars)
-------------------------
USERD_get_var_by_component(int
which_variable,
int which_part,
int var_type,
int which_type,
int imag_data,
int component,
float *var_array)
end loop on variables
------------------------------
New:
====
Constants
--------------
number_of_model_constants = USERD_get_number_of_model_constants(handle)
Loop on model constants (which_constant from 0 to number_of_model_constants)
----------------------------------
USERD_get_model_constant_info(handle,
which_constant,
description,
&complex,
&freq,
&contran,
&timeset)
if real
real_constant_val =
USERD_get_model_constant_val(handle,
which_constant,
imag_data) set to FALSE
else if complex
imag_constant_val =
USERD_get_model_constant_val(handle,
which_constant,
imag_data) set to TRUE
endif
end model constant loop
----------------------------------
Non-Constants
---------------------
--------------------
part_index,
&part_id, part_description,
&number_of_geoms
&has_border_geom,
&border_geom_index)
part_index,
geoms)
-----------------------
geom_index,
&unode_index,
&number_of_elems,
&snode_index,
&selem_index)
---------------------------------------
geom_index,
elem_index)
-------------------------------
elem_index,
&etype,
&transient_var_flag
------------------------------------------------
var_index,
var_description,
var_filename,
&var_type,
&var_classify,
&var_complex,
var_ifilename,
&var_freq,
&var_timeset,
&num_entities,
&interleave_flag)
Allocate var_array according to var_type, and var_classify.
USERD_get_var_array(handle,
var_index,
var_array)
end num_elem_variables loop
------------------------
endif number_of_elements
node_index,
&interleave_flag,
------------------------------------------------
var_index,
var_description,
var_filename,
&var_type,
&var_classify,
&var_complex,
var_ifilename,
&var_freq,
&var_timeset,
&num_entities,
&interleave_flag)
var_index,
var_array)
end num_node_variables loop
endif node_index
------------------------------------------
node_index,
&stype,
&interleave_flag,
------------------------------------------------
var_index,
var_description,
var_filename,
&var_type,
&var_classify,
&var_complex,
var_ifilename,
&var_freq,
&var_timeset,
&num_entities,
&interleave_flag)
var_index,
var_array)
elem_index,
&stype,
ijk_dimensions[9])
USERD message routines:

EnSight includes several USERD functions that enable the reader to send informational, warning, error,
or logging information back up to the server at any point in the reader execution for display to the
console, a pop-up window or for entry into a log file. These are documented elsewhere USERD Message
Routines (Info, Error, Log, Etc.) (p. 175).
4.8. USERD Message Routines (Info, Error, Log, Etc.)

Most of the USERD routines operate passively. They wait for the server to call them and then hand up
data. However, there are five USERD routines that call upwards into the server to pass information
messages designed for feedback to the user from the reader. These routines are active and can be called
at any location in any portion of a user-defined reader.
At this point, these routines will print their output to the EnSight console. The names of the routines
and when to call them are as follows.
USERD_info(const char format, ....)

Normal informational output typically to the console. It is a good idea to have a reader Format Option
pulldown that is None, Normal, Verbose and Debug to control the amount of informational output
that the user experiences.
USERD_warn(const char format, ....)

Encountered a problem but still proceeding with the read. This is either console or pop-up window.
USERD_error(const char format, ....)

Encountered a problem in which an error will be returned up to the server. This should be in a pop-up
window in the future. This calls a dummy routine named cvf_stop_here that you can use as a break
location.
USERD_fatal(const char format, ....)

A message indicating a fatal error which should not be called unless a crash is imminent as it may result
in the future in with a pop-up window and a graceful shutdown of EnSight. This calls a dummy routine
named cvf_stop_here that you can use as a break location.
USERD_log(const char format, ....)

All the output that you wish to go to a log, which should be the standard log file.
Example 4.1: Usage
USERD_info("Reading file number %d\n",fnum);
USERD_warn("Warning: missing element %d\n",elem_num);
USERD_error("Error, var value %12.5g exceeded %12.5g. Abort-

ing\n",var_val,max_val);
Implementation
In your reader, after your include of global_extern.h, you must include global_extern_func-
tions.h (in one C/C++ source file and one file only) in order to use these functions.
#include global_extern.h
USERD Message Routines (Info, Error, Log, Etc.)
#include global_extern_functions.h
Chapter 5: User Defined Writer API
Users can write User-Defined Writers (UDW) to generate arbitrary data files for EnSight parts and
variables. The EnSight server provides a UDW API that can be used to query the currently selected parts
in the EnSight client part list. The UDW API includes methods to get, for example, node coordinates,
element connectivity, ids, variable values, and time information. A UDW can call any of the methods as
it wishes and create a data file(s) in any format desired. Additionally, the UDW dialog in the EnSight
client has a Parameter field that provides a mechanism for passing user specified options to the UDW.
What Information Can Be Provided by the API?

Which parts are available to the UDW? All parts currently selected in the main Parts list
(except those indicated below)
Where are the available parts located? On the EnSight server
Which parts are unavailable to the UDW? Any client-based parts:
contours
vector arrows
particle traces
profiles
Example Writers
Several example User-Defined Writers (including source code, Makefile, and shared library) are included
to demonstrate this capability. The easiest way to get started is to copy the whole directory of a simple
writer, such as the Flatfile writer, then change it's name, modify the Makefile, set the environment
variable ENSIGHT10_UDW, and make it. Once you have it made, start EnSight with the following option:
ensight201 -writerdbg
to verify that your writer is loading properly. Once loading properly, use print statements to aid in de-
bugging. Alternatively, attach a debugger to the ensight201.server at run time and set breakpoints
within the methods of the UDW.
The Flatfile UDW is designed to demonstrate the output of selected part nodal data (coordinates &
IDs) as well as active variable values (scalar and/or vector only) in a comma delimited format easily im-
ported into other applications. If any of the keywords ANSYS or force or body is entered into the Para-
meter field of the EnSight client UDW dialog, then the Flatfile UDW will output an ANSYS body force
file. If keywords SSCALE #, VSCALE # and/or GSCALE # are entered then the scalars, vectors, and/or geo-
metry are each scaled by the number following the keyword when written out to the file.
The HDF 5.0 UDW is designed to write out selected parts and their corresponding active variables using
the HDF 5.0 API which is compatible with the EnSight HDF User-Defined Reader. The HDF writer ignores
User Defined Writer API
the Parameter field. The HDF 5.0 writer illustrates most of the routines available to retrieve data from
EnSight.
The Case (Gold) Lite UDW is provided to demonstrate how to exercise most of the API and output a
subset of the Case (Gold) format. Complex numbers and the custom Gold format are not supported in
this writer. The Case (Gold) writer ignores the Parameter field. While the writer is not provided as a pre-
built library, the source code and Makefile are provided.
The STL UDW is provided to write out the border geometry in the form of triangular 2D elements for
the selected part(s) at the beginning timestep. The end time and the step time are ignored. The STL
format does not support multiple parts in a single binary file, but does support multiple parts in a single
ASCII file. Therefore, if multiple parts are selected and ASCII is checked, the STL writer outputs an ASCII
file with the border of each of the parts. If multiple parts are selected and binary is checked, the STL
writer outputs a binary file containing a single border of the multiple parts. The STL writer ignores the
Parameter field.
5.1. Directions For Writing Your Own UDW

1. Create a directory where your writer will be located, for example
$CEI/ensight201/src/writers/mywriter/
2. Several example writers are provided which have source code and a Makefile.
For example, look at the flatfile format, an ASCII comma delimited writer.
cd $CEI/ensight201/src/writers/flatfile
Notice that there are several files in this directory.
• libuserd_write.c - The writer code
• Makefile - makefile
• README - specific directions for using this writer
3. Copy these files into your directory:
$CEI/ensight201/src/writers/mywriter/
• The Makefile should be used to compile and link a shared library.
Edit the Makefile so that it names the shared library properly.
• Edit the C file.
– give the writer a name. Ignore the other returned variable.
– give the writer a version so you can use version control in the future revisions
– The UDW routine called by EnSight. What you do in here is up to you; but basically you can open a
file for writing, call a bunch of methods (listed below) to get the data of interest, write data into a file,
and return an error status code to EnSight.
This method has the following arguments:
Directions For Writing Your Own UDW
char - (IN) file name requested by

full_fname[Z_MAXFI- the user from the GUI
LENP]
int - (IN) list of parts selected by
lis_parts[Z_MAX- the user in EnSight
PART]
int num_parts - (IN) number of selected parts
int do_binary - (IN) TRUE if writing binary file
FALSE if writing ASCII file

float max_fsize_mb - (IN) maximum file size value
for this machine
int combined - (IN) TRUE if user requests
single file output
FALSE if user allows

multiple file output
float - (IN) array of time step values
*timestep_vals
int ntime_steps - (IN) number of time steps
char text_input[ - (IN) string entered from GUI
UDW_STRSIZE] by user can be used to
input commands to
modify writer behavior
int *error_flag - (OUT) Return from writer
Z_ERR if a problem
Z_EN_ERR_NONE if no
problem
– Edit the README file
Since each writer can operate however it wants, document any constraints, expectations, limit-
ations, user specified parameters, etc, here. Given this is likely the only documentation available
for the writer, give enough details about it for both end-users and future maintainers.
– Set the UDW environment variable:
setenv ENSIGHT10_UDW $CEI/ensight201/src/writers/mywriter/
EnSight will first look in $ENSIGHT10_UDW and load the writer library. Next, EnSight will
then look in $CEI/ensight201/machines/$CEI_ARCH/lib_writers/. If duplicate
writers are found, they will only be loaded once.
– Make your library and fix all compile errors.
– Run the EnSight using a manual connection and specify the command line option -writerdbg to
the server to verify that it is loading the UDW correctly at runtime:
ensight201.server -writerdbg ( or for Windows ensight201_server -writer-

dbg)
– Compile in UDW debug output to track the progress of runtime loading of the writer and proper op-
eration.
Topical List Of User-Defined Writer API Methods

The following is a topical list of the User-defined Writer API methods along with a brief description of
each. These methods should be called from within the UDW's () method to retrieve data from EnSight.
General Info
USERD_writer_part_verify • Good part if at least one part > 0
• Is at least one part created geometry?
(Not discrete and not model part)
• Do I need to write model geometry?
(not discrete particle type)
• Do I need to write measured geometry?
(discrete particle type)
USERD_get_undef_ptr Checks each element type for any

undefined variable values
USERD_get_num_time_steps Return the time-set num steps index
based on var_index and meas_data
USERD_writer_get_variable_transient Returns variable static (0) or transient
(1)
USERD_writer_get_var_type TRUE if model vars = static && measured
vars = constant
Variable Info
USERD_writer_get_undef_val Echoes the EnSight undefined value
USERD_writer_get_exist_active Does var exist and is it active?
USERD_writer_get_variable_info Gets variable descriptors source,
complex, type, descrip, vref, freq, parent
USERD_writer_get_per_elem_node Gets per element or per node flags, any
undefined flag
USERD_writer_get_number_of_variables Returns number of variables
USERD_writer_get_measured_vector_var_val Returns vector of measured variable
values
USERD_writer_get_part_variable_status T or F, does part have variable(s)?
USERD_writer_get_static_const_value A variable's current constant value
USERD_writer_get_component_vector_var_val Returns vector of variable value
Part Info
Directions For Writing Your Own UDW
USERD_writer_get_part_info Gets part_type, num elems, descrip,

struct_flag
USERD_writer_get_part_struct_unstruct Returns either structured or
unstructured
USERD_writer_get_changing_measured_geometry_flag Measured geom change status
USERD_writer_get_changing_model_geometry_flag Coord, connect change status
USERD_writer_get_structured_data Gets values assoc w/ struct data
part_ijk_num, iblank nf, ghost flag, cell
type
USERD_writer_get_structured_data_ijk Gets values assoc w/ struct data
part_ijk_num, iblank nf, ghost flag, cell
type
USERD_writer_get_structured_cell_type Gets only the cell type for structured
data
Nodal Info
USERD_writer_get_node_label_status Does MODEL have node labels?
USERD_writer_get_part_node_label_status Does PART have node labels? (T or F)
USERD_writer_get_part_coords Gets part x, y, & z coordinates in 2d
format
USERD_writer_get_part_coords_vector Gets part x, y, & z coordinates in vector
format
USERD_writer_get_part_implicit_coords Gets structured part ijk implicit
coordinate data
USERD_writer_get_part_node_id Gets part node ids
Element Info
USERD_writer_get_element_label_status Does MODEL have element labels?
USERD_writer_get_part_element_label_status Does PART have element labels? (T or
F)
USERD_writer_get_part_elem_id Returns array of element id's
USERD_writer_get_part_elem_id_per_type Returns array of element id's per elem
type
USERD_writer_get_eletype_string Get the string describing that element
type
USERD_writer_get_element_connectivities_for_part Elem connectivity vector
USERD_writer_get_element_connectivities_for_part_simple Elem connectivity by elem type
USERD_get_Nfaced_size Total vector length, index of first
connectivity val, max conn size, total #
faces
USERD_get_Nfaced_vector Gets vector of connectivity data
Time
USERD_writer_validate_time_step Validates the current EnSight time step
for multiple scales
USERD_writer_get_original_time Gets client time which is the original

time.
USERD_writer_set_current_time Sets the time
Other
USERD_get_titles Gets the two model title description
lines
USERD_writer_get_ensight_release Get EnSight release letter as string
USERD_writer_get_ensight_version Get EnSight version number as string
USERD_writer_whatis_machine_byte_order Current machine is big- or little-endian
Sizing
USERD_writer_get_var_max_sect_vals Loop thru parts & find max # variables
of node or elem type
USERD_get_modl_geo_max_node_size Loop thru parts & find max # of nodes
USERD_get_modl_geo_max_conn_size Loop thru parts and find max
connectivity size
USERD_get_current_model_extents Either assign or compute model ranges
Specialized
USERD_writer_get_part_coords_per_elem Gets part coordinates fro TRI & QUA
elems
USERD_writer_get_part_coords_per_elem_border Gets part border coords for TRI & QUA
USERD_run_border Calls create_border and finds boundary
of part
5.2. Routine Detail Specifications

Include files:
#include "../extern/global_extern_w.h"
And for windows, the following is referenced from within:

#include "global_extern_w_dispatch.h"
Global Define:
The following should be defined in your writer code.

#define USERD_WRITER_GLOBALS
USERD_writer_get_name
/*--------------------------------------------------------------------*/
/* */
/* Gets the name of the writer, so gui can list as a writer */
/* */
Routine Detail Specifications
/* (OUT) writer_name = the name of the writer (data format) */

/* (max length is Z_MAX_USERD_NAME, which */
/* is 20) */
/* */
/* (OUT) *two_fields = FALSE if only one data field is */
/* required. */
/* TRUE if two data fields required */
/* */
/* returns: Z_OK if successful */
/* Z_ERR if not successful */
/* */
/* Notes: */
/* * Always called. Provide a name for your custom writer format */
/* */
/* * If you don't want a custom writer to show up in the data dialog */
/* choices, return a name of "No Custom" */
/*--------------------------------------------------------------------*/
int
USERD_writer_get_name(char writer_name[Z_MAX_USERD_NAME],
int *two_fields)
/*--------------------------------------------------------------------
USERD_writer_get_writer_version
*--------------------------------------------------------------------
*
* Gets the release string for the writer.
*
* This release string is a free-format string.
* It is used for version control and backwards compatibility.
* It is useful to increment
* the release number/letter to indicate a change in the writer.
* when the writer is selected.
*
* (OUT) release_number = the release number of the writer
* is 20)
*
*
* Notes:
* Called when the writer is selected for use.
* called by USERD_writer routines
*--------------------------------------------------------------------*/
int
USERD_writer_get_writer_version(char version_number[Z_MAX_USERD_NAME])
/*-----------------------------------------------------------------------
USERD_writer_write_geom
*-----------------------------------------------------------------------
*
* Write user specified data for selected parts and active variables.
*
* (IN) char full_fname[Z_MAXFILENP] = file name requested by the user from the GUI
* (IN) int lis_parts[Z_MAXPART] = list of parts selected by the user in EnSight
* (IN) int num_parts = number of selected parts
* (IN) int do_binary = TRUE if writing binary file
* FALSE if writing ascii file
* (IN) float max_fsize_mb = maximum file size value for this machine
* (IN) int combined = TRUE if user requests single file output
* FALSE if user allows multiple file output
* (IN) float *timestep_vals = array of time step values
* (IN) int ntime_steps = number of time steps
* (IN) char text_input[UDW_STRSIZE] = string entered from GUI by user can be used to
* input commands to modify writer behavior
* (OUT) int *error_flag = Return from writer
* Z_EN_ERR_NONE if no problem
*-----------------------------------------------------------------------*/
void
USERD_writer_write_geom(char full_fname[Z_MAXFILENP],
int lis_parts[Z_MAXPART],
int num_parts,
int do_binary,
float max_fsize_mb,
int combined,
float *timestep_vals,
int ntime_steps,/
char text_input[ UDW_STRSIZE],
int *error_flag)
Chapter 6: User Defined Math Functions
Users can write external variable calculator functions called User Defined Math Functions (UDMF)
that can be dynamically loaded by EnSight. These functions appear in EnSight's calculator in the general
function list and can be used just as any other calculator function to derive new variables.
Several examples of UDMFs can be found in the directory $CEI/ensight201/src/math_func-

tions/. See these examples if you wish to create your own UDMFs.
When the EnSight server starts it will look in the following subdirectories for UDMF dynamic shared
libraries:
./libudmf-devel.so (.sl) (.dll)
$ENSIGHT10_UDMF/libudmf-*.so (.sl) (.dll)
<install location>/ensight201/machines/$ENSIGHT10_ARCH/lib_udmf/libudmf-*.so (.sl) (.dll)
Depending on the server platform, the dynamic shared library must have the correct suffix for that
platform (e.g. .so, .sl, .dll).
How the Routines Are Invoked

Currently, when a UDMF is used in the EnSight calculator, it is invoked for each node in the specified
part(s) if all the variables operated on for the specified part(s) are node centered. If all of the variables
are element centered, then the UDMF is invoked for each element in the part(s). If the variables are a
mix of node and element centered values, then the node centered values are automatically converted
to element centered values and then the UDMF is invoked for each element using element centered
variables.
Arguments and the return type for the UDMF can be either scalar or vector EnSight variables or constants.
Current Limitation
At this time, only variable quantities and constants can be passed into UDMFs. There is no mechanism
for passing in either part geometry, neighboring variables, or other information.
6.1. Detailed Routine Specifications

Include files:
#include "/udmf_extern.h"
/*--------------------------------------------------------------------
User Defined Math Functions
USERD_get_name_of_mf
*--------------------------------------------------------------------
*
* Gets the name of the math function, so gui can list as a calculator
* function.
*
* (OUT) mf_name = the name of the math function
* (max length is UDMFSNAME, which is 64)
*
*
*--------------------------------------------------------------------*/
int
USERD_get_name_of_mf(char mf_name[UDMFSNAME])
/*--------------------------------------------------------------------
USERD_get_mf_version
*--------------------------------------------------------------------
*
* Gets the version number of the user defined math function supported API
*
* (OUT) version_number = the version number of the math function
*
*
* Notes:
* * version needs to be "1.000".
*--------------------------------------------------------------------*/
int
USERD_get_mf_version(char version_number[UDMFSNAME]) {
strcpy(version_number, "1.000");
return(Z_OK);
}
/*--------------------------------------------------------------------
USERD_get_nargs
*--------------------------------------------------------------------
*
* Gets the number of arguments needed by the function.
*
* (OUT) nArgs = the number of arguments
*
*
*--------------------------------------------------------------------*/
int
USERD_get_nargs(int *nArgs) {
*nArgs = 2;
return(Z_OK);
}
/*--------------------------------------------------------------------
Detailed Routine Specifications
USERD_get_meta_data
*--------------------------------------------------------------------
*
* Get the function descriptions, argument types, and return type.
*
* (OUT) listDescription = description shown in general function column
* (OUT) funcDescription = description shown in feedback window
* (OUT) argTypes = data types of arguments passed into USERD_evaluate
* (OUT) returnType = data type returned by function USERD_evaluate
*
*
*--------------------------------------------------------------------*/
int
USERD_get_meta_data(char listDescription[UDMFLNAME],
char funcDescription[UDMFLNAME],
int *argTypes, int *returnType) {
strcpy(listDescription, "add2(part, scalar, scalar)");
strcpy(funcDescription, "add2(any part(s), scalar, scalar)");
argTypes[0] = UDMFSCL;
*returnType = UDMFSCL;
return(Z_OK);
}
/*--------------------------------------------------------------------
USERD_evaluate
*--------------------------------------------------------------------
* Note: see math_functions/example1/libudmf-ex1.c
* Evaluate the function.
*
* (OUT) args = pointers to arguments
* args[0] = pointer to the first variable needed by the function
* args[1] = pointer to the second variable needed by the function
* ...
* args[n] = pointer to the last variable needed by the function
* EnSight 10.1 adds args[n+1] and args[n+2] as follows
* args[n+1] is a float that is the number of nodes
* when computing a constant then num_nodes = 0.
* when computing a per-node variable num_nodes = 1
* when computing a per-element variable num_nodes
* is the number of nodes is the element being processed.
* args[n+2] is the coordinates, x1,y1,z1,x2,y2,z2,...
* if xyz = args[3] then,
* xyz[0] = x coordinate of the first node
* xyz[1] = y coordinate of the first node
* xyz[2] = z coordinate of the first node
* xyz[3] = x coordinate of the second node
* xyz[4] = y coordinate of the second node
*
* (OUT) undefined = boolean; true if return value is undefined.
* (OUT) value = returned value
*
*--------------------------------------------------------------------*/
int
USERD_evaluate(void *args[], void *value, int *undefined) {
int i, j, num_nodes;
float *result;
float *arg1, *arg2;
float *num_nodes_float;
float *xyz;
result = value;
User Defined Math Functions
arg1 = args[0];
arg2 = args[1];
num_nodes_float = args[2];
xyz = args[3];
num_nodes = *num_nodes_float;
if(*num_nodes_float - num_nodes > .5) {
++num_nodes;
}
fprintf(stderr,"number of nodes from udmf = %d\n",num_nodes);
for(i=0; i<num_nodes; ++i) {
fprintf(stderr,"x/y/z coords = %f %f %f\n",xyz[i*3],xyz[i*3+1],xyz[i*3+2]);
}
*result = *arg1 + *arg2;
*undefined = 0;
return(Z_OK);
}
6.2. Example
The following example simply adds two scalars. Other examples can be found in subdirectories of
$CEI/ensight201/src/math_functions/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#ifndef WIN32
#include <unistd.h>
#endif
#include "../extern/udmf_extern.h"
/*--------------------------------------------------------------------
* USERD_get_name_of_mf
*--------------------------------------------------------------------
*
* Gets the name of the math function, so gui can list as a calculator
* function.
*
* (OUT) mf_name = the name of the math function
*
*
*--------------------------------------------------------------------*/
int
USERD_get_name_of_mf(char mf_name[UDMFSNAME]) {
memset(mf_name,'\0',UDMFSNAME);
strcpy(mf_name, "addTwoScalars");
return(Z_OK);
}
/*--------------------------------------------------------------------
* USERD_get_mf_version
*--------------------------------------------------------------------
*
* Gets the version number of the user defined math function supported API
*
* (OUT) version_number = the version number of the math function
*
*
* Notes:
* * version needs to be "1.000".
*--------------------------------------------------------------------*/
int
USERD_get_mf_version(char version_number[UDMFSNAME]) {
strcpy(version_number, "1.000");
return(Z_OK);
Example
}
/*--------------------------------------------------------------------
* USERD_get_nargs
*--------------------------------------------------------------------
*
* Gets the number of arguments needed by the function.
*
* (OUT) nArgs = the number of arguments
*
*
*--------------------------------------------------------------------*/
int
USERD_get_nargs(int *nArgs) {
*nArgs = 2;
return(Z_OK);
}
/*--------------------------------------------------------------------
* USERD_get_meta_data
*--------------------------------------------------------------------
*
* Get the function descriptions, argument types, and return type.
*
* (OUT) listDescription = description shown in general function column
* (OUT) funcDescription = description shown in feedback window
* (OUT) argTypes = data types of arguments passed into USERD_evaluate
* (OUT) returnType = data type returned by function USERD_evaluate
*
*
*--------------------------------------------------------------------*/
int
USERD_get_meta_data(char listDescription[UDMFLNAME],
char funcDescription[UDMFLNAME],
int *argTypes, int *returnType) {
strcpy(listDescription, "add2(part, scalar, scalar)");
strcpy(funcDescription, "add2(any part(s), scalar, scalar)");
*returnType = UDMFSCL;
return(Z_OK);
}
/*--------------------------------------------------------------------
* USERD_evaluate
*--------------------------------------------------------------------
*
* Evaluate the function.
*
* (OUT) args = pointers to arguments
* (OUT) undefined = boolean; true if return value is undefined.
* (OUT) value = returned value
*
*
*--------------------------------------------------------------------*/
int
USERD_evaluate(void *args[], void *value, int *undefined) {
float *result;
float *arg1, *arg2;
result = value;
arg1 = args[0];
arg2 = args[1];
*result = *arg1 + *arg2;
*undefined = 0;
return(Z_OK);
}
Chapter 7: EnSight Command Driver
Overview
This document provides information about a communication mechanism which can be used to drive
EnSight from an external program using EnSight's command language. The logical steps involved in
this process are:
1. Compile your external program with the enscmddriver_comm library. (p. 311)
2. Start EnSight and have it listen for the connection from the external program. (p. 311)
3. Start the external program and issue the connect command within that program. (p. 312)
4. Send commands to EnSight using the enscmddriver_sendmesg routine. (p. 312)
5. Shutdown Ensight. (p. 314)
More detail will now be provided for each of these steps.
Step 1
Compile your external program with the enscmddriver.a library. This library is provided in the EnSight
distribution, under the src/cmddriver directory. Directions for compiling are contained in the
README file contained in that directory. Also provided therein is a sample external program (entitled
enscmddriver.c) which is used to show how to compile, as well as for examples of how to utilize
the following routines within your external driver:
To establish the connection with EnSight

To send command language to EnSight
To query information from EnSight (limited)
To disconnect and leave EnSight running (not commonly used)
Step 2
Start EnSight and have it listen for the connection from the external program. Normally this will be
done from your external program and will therefore use batch mode to start EnSight.
In Batch Mode
ensight201 -X -batch -externalcmds
While not the norm, it is possible to have EnSight start listening for the connection from an interactive
session.
EnSight Command Driver
Interactively (From the Command Dialog in EnSight)

test: acceptcmddriver
EnSight will listen on Port 1104 for the connection from the external program. If a different port is desired,
you can use the command line option -externalcmdport # when starting EnSight. Replace the #
with a legitimate (>1024) port number. Then be sure to use the specified socket in the enscmd-
driver_connect call within your external program.
Step 3
Once EnSight is listening, start the external program and issue the connect command within that program.
For the provided enscmddriver sample, this is done as follows:
enscmddriver HOSTNAME
Where, HOSTNAME is the name of the machine running EnSight.
Note:
The sample enscmddriver program calls the enscmddriver_connect routine to

establish the connection.
Step 4
Send commands to EnSight using the enscmddriver_sendmesg routine. The commands that you
send to EnSight using this routine are the same commands that EnSight produces when users are ma-
nipulating a model with the EnSight Graphical User Interface.
Note:
The enscmddriver_sendmesg routine returns an ok or ERROR indicating its success

or not.
It is possible to play entire command files that are accessible from the machine where the EnSight client
is running. You can send a "play:" command to specify the name of the command file to use. Com-
mands that are played using a file (play:) will execute faster than sending individual commands. The
following is a command file (amiread.enc) that reads and colors the ami data set that is shipped
with EnSight.
VERSION 7.52
data: binary_files_are big_endian
data: format case
data: path /usr/local/CEI/ensight201/data/ami
data: geometry ami.case
data: read
data_partbuild: begin
part: select_default
part: modify_begin
part: elt_representation not_loaded
part: modify_end
data_partbuild: data_type unstructured
data_partbuild: select_begin
data_partbuild: select_end
data_partbuild: description
data_partbuild: create
part: modify_begin
part: elt_representation 3D_border_2D_full
part: modify_end
data_partbuild: data_type unstructured
data_partbuild: select_begin
data_partbuild: select_end
data_partbuild: description
data_partbuild: create
data_partbuild: end
variables: activate pressure
part: select_all
part: modify_begin
part: colorby_palette pressure
part: modify_end
Your external program could send the command "play: amiread.enc" to EnSight using the en-
scmddriver_sendmesg routine. EnSight would play the command file, which would read in the
model and color it by pressure, etc. It would then return and allow the external program to continue
to issue other commands, such as would create images, produce VRML, create flipbook or keyframe
animation sequences, etc.
The enscmddriver_query routine can be used to obtain some limited information back from EnSight.
The current possibilities for this option will be described in the query section below.
Step 5
Shutdown EnSight. If you did the normal, and started EnSight in batch mode - you close the commu-
nication and get EnSight to stop by sending an exit command with the enscmddriver_sendmesg
routine.
If you happen to be running EnSight interactively, rather than the normal batch mode, and you desire
to close the connection, but leave EnSight running - you can use the enscmddriver_disconnect
routine.
Example
Assuming that you were able to successfully compile our sample external program, enscmddriver,
and that your machine name was speedy, you could do the following:
Start EnSight in batch mode (on your machine named speedy):
> ensight201 -X -batch -externalcmds &
Start the enscmddriver sample routine:
> enscmddriver speedy
Issue the following commands as prompted by the enscmddriver program:
What would you like to do?
play: amiread.enc
view: hidden_surface ON
savegeom: format vrml
savegeom: binary OFF
savegeom: save_geometric_entities /tmp/ami
exit
Query Capability
Which would read in the ami model using the amiread.enc command file, then turn shading on,
then save a VRML file in /tmp. It would then close the communication and cause EnSight to exit.
You will of course be using your own external program, so the actual use of the enscmddriver_con-
nect, and enscmddriver_sendmesg routines will be of interest to you. You can see them being
used in the enscmddriver.c file. The routine arguments are described in detail in Routine Descrip-
tions (p. 337).
7.1. Query Capability

The EnSight external command driver as first implemented with EnSight version 6.2.4, was purely a
one-way interface. Namely, the external program could send command language to EnSight, but could
not receive any type of information back (except for the error flag concerning success or failure of the
command). Starting with EnSight 7.6, the capability to query EnSight for certain data has been added.
While initially the scope of implemented queries is small, the implementation is general enough that
future desirable queries should be easily added. Currently you can query for various transformation and
viewport information.
The enscmddriver_query routine is driven by keywords. According to the keyword, the needed
input parameters are defined, as well as the returned results.
Note:
In the descriptions of the transformation matrices below, the components of a 4 x 4 matrix

are:
| a11 a12 a13 a14 |
| a21 a22 a23 a24 |
| a31 a32 a33 a34 |
| a41 a42 a43 a44 |
Query Keyword Details

Count of 3D arrow annotations
Keyword:
ARROW_COUNT
example command> query ARROW_COUNT
Input:
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = number of 3D arrow annotations
On Failure -> (-1)
ret_error_buf contains the error message string
3D arrow annotation display attributes
Keyword:
ARROW_DISPLAY_ATTRIBUTES
example command> query ARROW_DISPLAY_ATTRIBUTES 1
Input:
param_cnt = 1
param_array[0] = 3d arrow’s id
Return Values:
On Success -> (1)
ret_str_cnt = total number of attributes
ret_str_array = 1D array of command strings, each NULL terminated
command1 NULL command2 NULL ... lastcommand NULL
On Failure -> (-1)
3D arrow label text
Keyword:
ARROW_LABEL_TEXT
example command> query
Input:
param_cnt = 1
param_array[0] = 3d arrow’s id
Return Values:
On Success -> (1)
ret_str_cnt = 1
ret_str_array = 1D array containing the arrow label text
On Failure -> (-1)
Selected 3D arrows
Keyword:
ARROW_SELECTED_OBJECTS
example command> query ARROW_SELECTED_OBJECTS
Input:
Return Values:
On Success -> (1)
ret_int_cnt = total selected 3D arrows
ret_int_array = 1D array of selected 3d arrow ids
On Failure -> (-1)
Count of dial annotations
Keyword:
DIAL_COUNT
example command> query DIAL_COUNT
Input:
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = number of dial annotations
On Failure -> (-1)
Query Capability
Dial annotation display attributes
Keyword:
DIAL_DISPLAY_ATTRIBUTES
example command> query DIAL_DISPLAY_ATTRIBUTES 1
Input:
param_cnt = 1
param_array[0] = dial's id
Return Values:
On Success -> (1)
On Failure -> (-1)
Selected dials
Keyword:
DIAL_SELECTED_OBJECTS
example command> query DIAL_SELECTED_OBJECTS
Input:
Return Values:
On Success -> (1)
ret_int_cnt = total selected dials
ret_int_array = array of selected dial ids
On Failure -> (-1)
Flipbook creation attributes
Keyword:
FLIPBOOK_INFORMATION
example command> query FLIPBOOK_INFORMATION
Input:
Return Values:
On Success -> (1)
On Failure -> (-1)
Flipbook loaded or not?
Keyword:
FLIPBOOK_LOADED
example command> query FLIPBOOK_LOADED
Input:
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = 1(Yes), 0(No)
On Failure -> (-1)

Flipbook running or not?
Keyword:
FLIPBOOK_RUNNING
example command> query FLIPBOOK_RUNNING
Input:
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = 1(Yes), 0(No)
On Failure -> (-1)
Number of Frames
Keyword:
FRAME_COUNT
example command> query FRAME_COUNT
Input:
param_cnt = 0
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = number of frames
On Failure -> (-1)
Frame Location
Keyword:
FRAME_LOCATION
example command> query FRAME_LOCATION 1
Input:
param_cnt = 1
param_array[0] = frame’s id
Return Values:
On Success -> (1)
ret_float_cnt = 12
ret_float_array[0] = x origin
ret_float_array[1] = y origin
ret_float_array[2] = z origin
ret_float_array[3] = x vector u
ret_float_array[4] = x vector v
ret_float_array[5] = x vector w
ret_float_array[6] = y vector u
ret_float_array[7] = y vector v
ret_float_array[8] = y vector w
ret_float_array[9] = z vector u
ret_float_array[10] = z vector v
ret_float_array[11] = z vector w
On Failure -> (-1)
Count of gauge annotations
Query Capability
Keyword:
GAUGE_COUNT
example command> query GAUGE_COUNT
Input:
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = number of gauge annotations
On Failure -> (-1)
Gauge annotation display attributes
Keyword:
GAUGE_DISPLAY_ATTRIBUTES
example command> query GAUGE_DISPLAY_ATTRIBUTES 1
Input:
param_cnt = 1
param_array[0] = gauge's id
Return Values:
On Success -> (1)
On Failure -> (-1)
Selected gauges
Keyword:
GAUGE_SELECTED_OBJECTS
example command> query GAUGE_SELECTED_OBJECTS
Input:
Return Values:
On Success -> (1)
ret_int_cnt = total selected gauges
ret_int_array = array of selected gauge ids
On Failure -> (-1)
Number of legend annotations
Keyword:
LEGEND_COUNT
example command> query LEGEND_COUNT
Input:
param_cnt = 0
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = number of legend annotations
On Failure -> (-1)
Legend's display attributes
Keyword:
LEGEND_DISPLAY_ATTRIBUTES
example command> query LEGEND_DISPLAY_ATTRIBUTES 1
Input:
param_cnt = 1
param_array[0] = legend’s id (0-based)
Return Values:
On Success -> (1)
ret_char_cnt = number of attributes + 2
ret_char_array[0] = legend description, format, and attribute commands with values
desc NULL format NULL command1 NULL command2 NULL ...
lastcommand NULL
On Failure -> (-1)
Selected legends
Keyword:
LEGEND_SELECTED_OBJECTS
example command> query LEGEND_SELECTED_OBJECTS
Input:
Return Values:
On Success -> (1)
ret_int_cnt = total selected legends
ret_int_array = array of selected legend ids
On Failure -> (-1)
Number of line annotations
Keyword:
LINE_COUNT
example command> query LINE_COUNT
Input:
param_cnt = 0
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = number of line annotations
On Failure -> (-1)
Lines's display attributes
Keyword:
LINE_DISPLAY_ATTRIBUTES
example command> query LINE_DISPLAY_ATTRIBUTES 1
Input:
param_cnt = 1
param_array[0] = line’s id (0-based)
Return Values:
On Success -> (1)
Query Capability
ret_char_cnt = number of attributes

ret_char_array[0] = attribute commands with values
On Failure -> (-1)
Selected lines
Keyword:
LINE_SELECTED_OBJECTS
example command> query LINE_SELECED_OBJECTS
Input:
Return Values:
On Success -> (1)
ret_int_cnt = total selected lines
ret_int_array = array of selected line ids
On Failure -> (-1)
Number of logo annotations
Keyword:
LOGO_COUNT
example command> query LOGO_COUNT
Input:
param_cnt = 0
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = number of logo annotations
On Failure -> (-1)
Logo's display attributes
Keyword:
LOGO_DISPLAY_ATTRIBUTES
example command> query LOGO_DISPLAY_ATTRIBUTES 1
Input:
param_cnt = 1
param_array[0] = logo’s id (0-based)
Return Values:
On Success -> (1)
On Failure -> (-1)
Selected logos
Keyword:
LOGO_SELECTED_OBJECTS
example command> query LOGO_SELECTED_OBJECTS
Input:
Return Values:
On Success -> (1)
ret_int_cnt = total selected logos
ret_int_array = array of selected logo ids
On Failure -> (-1)
et_error_buf contains the error message string
Message Window contents
Keyword:
MESSAGES
example command> query MESSAGES
Input:
param_cnt = 0
Return Values:
On Success -> (1)
ret_char_cnt = 1
ret_char_array[0] = message window contents
On Failure -> (-1)
Part's display attributes
Keyword:
PART_DISPLAY_ATTRIBUTES
example command> query PART_DISPLAY_ATTRIBUTES 1
Input:
param_cnt = 1
param_array[0] = part’s id as returned from “query PART_OBJECTS”
Return Values:
On Success -> (1)
ret_char_array[n] = attribute commands with values
On Failure -> (-1)
Element's id and X,Y,Z model location of pick point on the element
Keyword:
PART_ELEMENT_PICKEDBYWINXY
example command> query PART_ELEMENT_PICKEDBYWINXY x y
Input:
param_cnt = 2
mouse pointer location(X Y) as returned by WINDOW_MOUSELASTPRESS_INFO, so:
param_array[0] = x location
param_array[1] = y location
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = element id
ret_float_cnt = 3
ret_float_array[0] = X model location
ret_float_array[1] = Y model location
ret_float_array[2] = Z model location
On Failure -> (-1)
Query Capability
Element's id at model coordinate(X,Y,Z)
Keyword:
PART_ELEMENT_PICKEDBYWORLDXYZ
example command> query PART_ELEMENT_PICKEDBYWORLDXYZ x y z
Input:
param_cnt = 3
model location(X Y Z), so:
param_array[2] = z location
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = element id
On Failure -> (-1)
Node's id and X,Y,Z model location of pick point on the node
Keyword:
PART_NODE_PICKEDBYWINXY
example command> query PART_NODE_PICKEDBYWINXY x y
Input:
param_cnt = 2
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = node id
ret_float_cnt = 3
On Failure -> (-1)
Node's id at model coordinate(X,Y,Z)
Keyword:
PART_NODE_PICKEDBYWORLDXYZ
example command> query PART_NODE_PICKEDBYWORLDXYZ x y z
Input:
param_cnt = 3
model location(X Y Z), so:
param_array[2] = z location
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = node id
On Failure -> (-1)
Part general existence information
Keyword:
PART_OBJECTS
example command> query PART_OBJECTS
Input:
param_array_cnt = 0
Return Values:
On Success -> (1)
ret_int_cnt = number of parts + 1
ret_int_array[0] = number of parts
ret_int_array[1] = ID for part 1
ret_int_array[3] = ID for part 3 .
.
.
.
ret_int_array[number of parts] = ID for last part
ret_charstr_cnt = number of parts
ret_char_str = name_of_part1 NULL name_of_part2 NULL ... name_of_lastpart NULL
On Failure -> (-1)
Part's id and X,Y,Z model location of pick point on the part
Keyword:
PART_PICKED
example command> query PART_PICKED x y
Input:
param_cnt = 2
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = part id
ret_float_cnt = 3
On Failure -> (-1)
Part selection information
Keyword:
PART_SELECTED_OBJECTS
example command> query PART_SELECTED_OBJECTS
Input:
param_array_cnt = 0
Return Values:
On Success -> (1)
ret_int_cnt = number of selected parts + 1
ret_int_array[0] = number of selected parts
ret_int_array[3] = ID for part 3 .
.
.
ret_int_array[number of parts] = ID for last selected part
Query Capability
ret_charstr_cnt = number of selected parts

ret_char_str = name_of_part1 NULL name_of_part2 NULL ... name_of_lastpart NULL
On Failure -> (-1)
Number of plotters
Keyword:
PLOT_COUNT
example command> query PLOT_COUNT
Input:
param_cnt = 0
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = number of plotters
On Failure -> (-1)
Plotter's display attributes
Keyword:
PLOT_DISPLAY_ATTRIBUTES
example command> query PLOT_DISPLAY_ATTRIBUTES 1
Input:
param_cnt = 1
param_array[0] = plotter’s id (0-based)
Return Values:
On Success -> (1)
ret_char_array[0] = plotter description NULL plotter title NULL
x axis title NULL y axis title NULL
x axis format string NULL y axis format string NULL
attribute commands with values separated by NULLs
On Failure -> (-1)
Plotter's id
Keyword:
PLOT_PICKED
example command> query PLOT_PICKED x y
Input:
param_cnt = 2
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = plotter id
On Failure -> (-1)
Number of queries
Keyword:
QUERY_COUNT
example command> query QUERY_COUNT
Input:
param_cnt = 0
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = number of queries
On Failure -> (-1)
Query's display attributes
Keyword:
QUERY_DISPLAY_ATTRIBUTES
example command> query QUERY_DISPLAY_ATTRIBUTES 1
Input:
param_cnt = 1
param_array[0] = query’s id (0-based)
Return Values:
On Success -> (1)
ret_char_array[0] = query description NULL attribute commands
with values separated by NULLs
On Failure -> (-1)
Query item's id and value pair at pick point on curve
Keyword:
QUERY_PICKED
example command> query QUERY_PICKED x y
Input:
param_cnt = 2
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = query item id
ret_float_cnt = 2
ret_float_array[0] = X value
ret_float_array[1] = Y value
On Failure -> (-1)
Query Probe's display attributes
Keyword:
QUERY_PROBE_ATTRIBUTES
example command> query QUERY_PROBE_ATTRIBUTES
Input:
Return Values:
On Success -> (1)
Query Capability

On Failure -> (-1)
Count of probe queries
Keyword:
QUERY_PROBE_COUNT
example command> query QUERY_PROBE_COUNT
Input:
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = number of probe queries
On Failure -> (-1)
Query Probe's output
Keyword:
QUERY_PROBE_OUTPUT
example command> query QUERY_PROBE_OUTPUT
Input:
param_cnt = 2
Return Values:
On Success -> (1)
ret_char_cnt = 1
ret_char_array[0] = query probe output
ret_char_cnt = 0
ret_char_array = <No output>
On Failure -> (-1)
Count of shape annotations
Keyword:
SHAPE_COUNT
example command> query SHAPE_COUNT
Input:
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = number of shape annotations
On Failure -> (-1)
Shape annotation display attributes
Keyword:
SHAPE_DISPLAY_ATTRIBUTES
example command> query SHAPE_DISPLAY_ATTRIBUTES 1
Input:
param_cnt = 1
param_array[0] = shape's id
Return Values:
On Success -> (1)
On Failure -> (-1)
Selected shapes
Keyword:
SHAPE_SELECTED_OBJECTS
example command> query SHAPE_SELECTED_OBJECTS
Input:
Return Values:
On Success -> (1)
ret_int_cnt = total selected shapes
ret_int_array = array of selected shape ids
On Failure -> (-1)
Number of text annotations
Keyword:
TEXT_COUNT
example command> query TEXT_COUNT
Input:
param_cnt = 0
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = number of text annotations
On Failure -> (-1)
Text's display attributes
Keyword:
TEXT_DISPLAY_ATTRIBUTES
example command> query TEXT_DISPLAY_ATTRIBUTES 1
Input:
param_cnt = 1
param_array[0] = text’s id (0-based)
Return Values:
On Success -> (1)
On Failure -> (-1)
Text's display text
Keyword:
Query Capability
TEXT_DISPLAY_TEXT
example command> query TEXT_DISPLAY_TEXT 1
Input:
param_cnt = 1
param_array[0] = text’s id (0-based)
Return Values:
On Success -> (1)
ret_char_cnt = 1
ret_char_array[0] = text annotation’s text
On Failure -> (-1)
Selected text strings
Keyword:
TEXT_SELECTED_OBJECTS
example command> query TEXT_SELECTED_OBJECTS
Input:
Return Values:
On Success -> (1)
ret_int_cnt = total selected text strings
ret_int_array = array of selected text string ids
On Failure -> (-1)
The Center of Transformation
Keyword:
TRANSFORMATION_CENTER_OF
example command> query TRANSFORMATION_CENTER_OF 1
Input:
param_array_cnt = 1
param_array[0] = Viewport number for the desired viewport (zero based)
Return Values:
On Success -> (1)
ret_float_cnt = 3
ret_float_array[0] = x coordinate of center of transformation
ret_float_array[1] = y coordinate of center of transformation
ret_float_array[2] = z coordinate of center of transformation
On Failure -> (-1)
The Composite Transformation matrix - A combination of the look_at/look_from transform

and the global transformation matrix.
Keyword:
TRANSFORMATION_COMPOSITE_MATRIX
example command> query TRANSFORMATION_COMPOSITE_MATRIX 1
Input:
param_array_cnt = 1
Return Values:
On Success -> (1)
ret_float_cnt = 16 (4 x 4 matrix)
ret_float_array[0] = a11 ret_float_array[8] = a31

On Failure -> (-1)
The Lookat Position
Keyword:
TRANSFORMATION_LOOKAT_POSITION
example command> query TRANSFORMATION_LOOKAT_POSITION 1
Input:
param_array_cnt = 1
Return Values:
On Success -> (1)
ret_float_cnt = 3
ret_float_array[0] = x coordinate of lookat point
ret_float_array[1] = y coordinate of lookat point
ret_float_array[2] = z coordinate of lookat point
On Failure -> (-1)
The Lookfrom Position
Keyword:
TRANSFORMATION_LOOKFROM_POSITION
example command> query TRANSFORMATION_LOOKFROM_POSITION 1
Input:
param_array_cnt = 1
Return Values:
On Success -> (1)
ret_float_cnt = 3
ret_float_array[0] = x coordinate of lookfrom point
ret_float_array[1] = y coordinate of lookfrom point
ret_float_array[2] = z coordinate of lookfrom point
On Failure -> (-1)
Perspective angle
Keyword:
TRANSFORMATION_PERANG
example command> query TRANSFORMATION_PERANG 0
Input:
param_cnt = 1
param_array[0] = viewport number
Return Values:
On Success -> (1)
ret_float_cnt = 1
ret_float_array[0] = perang
On Failure -> (-1)
Query Capability
Projection matrix
Keyword:
TRANSFORMATION_PROJ_MATRIX
example command> query TRANSFORMATION_PROJ_MATRIX 0
Input:
param_cnt = 1
param_array[0] = viewport number
Return Values:
On Success -> (1)
ret_float_array[0] = a11
On Failure -> (-1)
where the matrix components are | a11 a12 a13 a14 |
| a21 a22 a23 a24 |
| a31 a32 a33 a34 |
| a41 a42 a43 a44 |
The Rotate Transformation matrix
Keyword:
TRANSFORMATION_ROTATE_MATRIX
example command> query TRANSFORMATION_ROTATE_MATRIX 1
Input:
param_array_cnt = 1
Return Values:
On Success -> (1)
On Failure -> (-1)
The Scale Transformation matrix
Keyword:
TRANSFORMATION_SCALE_MATRIX
example command> query TRANSFORMATION_SCALE_MATRIX 1

Input:
param_array_cnt = 1
Return Values:
On Success -> (1)
On Failure -> (-1)
The Translate Transformation matrix
Keyword:
TRANSFORMATION_TRANSLATE_MATRIX
example command> query TRANSFORMATION_TRANSLATE_MATRIX 1
Input:
param_array_cnt = 1
Return Values:
On Success -> (1)
On Failure -> (-1)
Zclip locations
Keyword:
TRANSFORMATION_ZCLIP_LOCATIONS
example command> query TRANSFORMATION_ZCLIP_LOCATIONS
Input:
param_array_cnt = 1
param_array[0] = Viewport number (zero based)
Return Values:
On Success -> (1)
ret_float_cnt = 2
ret_float_array[0] = near zplane z location
ret_float_array[1] = far zplane z location
On Failure -> (-1)
Variable information - such as the active/inactive flag, current min and max values,expression
for computed vars, etc.
Keyword:
Query Capability
VARIABLE_INFORMATION
example command> query VARIABLE_INFORMATION 1
Input:
ret_param_cnt = 1
ret_params[0] = variable number starting with 0 as returned
from “query VARIABLE_OBJECTS”.
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = active flag (0 if inactive, 1 if active)
If Computed
ret_int_count = 2 + number of parts used to compute it.
ret_int_array[0] = active flag (0 if inactive, 1 if active)
ret_int_array[1] = count of parts used to compute it
ret_int_array[2] = 1st part used to compute it.
ret_int_array[3] = 2nd part used to compute it.
. . .
ret_int_array[2+n] = nth part used to compute it.
If Scalar:
ret_float_cnt = 2
ret_float_array[0] = min value
ret_float_array[1] = max value
If Vector:
ret_float_cnt = 8
ret_float_array[0] = x comp min value
ret_float_array[1] = x comp max value
ret_float_array[2] = y comp min value
ret_float_array[3] = y comp max value
ret_float_array[4] = z comp min value
ret_float_array[5] = z compmax value
ret_float_array[6] = magnitude min value
ret_float_array[7] = magnitude max value
If Computed:
ret_charstr_cnt = 1
ret_char_str[0] = command for calculator expression
On Failure -> (-1)
Variable general existence information
Keyword:
VARIABLE_OBJECTS
example command> query VARIABLE_OBJECTS
Input:
param_array_cnt = 0
Return Values:
On Success -> (1)
ret_int_cnt = number of vars + 1
ret_int_array[1] = type for variable 1
ret_int_array[2] = type for variable 2
ret_int_array[3] = type for variable 3 .
.
.
ret_int_array[number of vars] = type for last variable
ret_int_array[1 + number of vars] = order for variable 1
ret_int_array[2 + number of vars] = order for variable 2
ret_int_array[3 + number of vars] = order for variable 3 .
.
.
ret_int_array[2 * number of vars] = order for last variable
ret_charstr_cnt = number of variables
ret_char_str = name_of_var1 NULL name_of_var2 NULL ... name_of_lastvar NULL
On Failure -> (-1)
Map of variable types:
0 = Scalar
1 = Vector
2 = Tensor
3 = Scalar Complex
4 = Vector Complex
Map of variable orders:
0 = Per Case (constant)
1 = Per Elem
2 = Per Node
Current view mode - Helps in determining which menu to bring up. For example a menu with
part or plotter actions.
Keyword:
VIEW_MODE
example command> query VIEW_MODE
Input:
Return Values:
On Success -> (1)
ret_char_cnt = 1
ret_char_array = a string value which is one of:
Part,Frame,Annot,Plot,VPort
On Failure -> (-1)
Number of viewports
Keyword:
VIEWPORT_COUNT
example command> query VIEWPORT_COUNT
Input:
param_cnt = 0
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = number of viewports
On Failure -> (-1)
Viewport's display attributes
Keyword:
VIEWPORT_DISPLAY_ATTRIBUTES
example command> query VIEWPORT_DISPLAY_ATTRIBUTES 1
Input:
param_cnt = 1
param_array[0] = viewport’s id (0-based)
Return Values:
On Success -> (1)
On Failure -> (-1)
The Location of bottom left of Viewport - returned both as screen and as normalized coords
Query Capability
Keyword:
VIEWPORT_LOCATION
example command> query VIEWPORT_LOCATION 1
Input:
param_array_cnt = 1
Return Values:
On Success -> (1)
ret_float_cnt = 2
ret_float_array[0] = normalized window x coordinate of bottom left of viewport (0. to 1.)
ret_float_array[1] = normalized window y coordinate of bottom left of viewport (0. to 1.)
ret_int_cnt = 3
ret_int_array[0] = screen x coordinate of bottom left of viewport
ret_int_array[1] = screen y coordinate of bottom left of viewport
On Failure -> (-1)
Viewport's id
Keyword:
VIEWPORT_PICKED
example command> query VIEWPORT_PICKED x y
Input:
param_cnt = 2
Return Values:
On Success -> (1)
ret_int_cnt = 1
ret_int_array[0] = viewport id
On Failure -> (-1)
The Size of the Viewport, width and height - returned both as screen and as normalized values
Keyword:
VIEWPORT_SIZE
example command> query VIEWPORT_SIZE 1
Input:
param_array_cnt = 1
Return Values:
On Success -> (1)
ret_float_cnt = 2
ret_float_array[0] = normalized window x size of viewport (0. to 1.)
ret_float_array[1] = normalized window y size of viewport (0. to 1.)
ret_int_cnt = 3
ret_int_array[0] = screen x size of viewport
ret_int_array[1] = screen y size of viewport
On Failure -> (-1)
Window depth values
Keyword:
WINDOW_DEPTH_VALUES
example command> query WINDOW_DEPTH_VALUES
Input:
param_cnt = 0
Return Values:
On Success -> (1)
ret_float_cnt = xSize * ySize
ret_float_array[n] = depth pixel interlaced values
if stereo, then the array is xSize * ySize * 2 and the
two stereo pairs are back to back
On Failure -> (-1)
Mouse current location and button information
Keyword:
WINDOW_MOUSECURRENT_INFO
example command> query WINDOW_MOUSECURRENT_INFO
Input:
Return Values:
On Success -> (1)
ret_int_cnt = 7
query_int_array[0] = x
query_int_array[1] = y
query_int_array[2] = left mouse button state
query_int_array[3] = middle mouse button state
query_int_array[4] = right mouse button state
query_int_array[5] = Control key down(1=True,0=False)
query_int_array[6] = window
On Failure -> (-1)
Mouse location and button information at last mouse button press
Keyword:
WINDOW_MOUSELASTPRESS_INFO
example command> query WINDOW_MOUSELASTPRESS_INFO
Input:
Return Values:
On Success -> (1)
ret_int_cnt = 7
query_int_array[0] = x
query_int_array[1] = y
query_int_array[2] = double click(1=True,0=False)
query_int_array[3] = left mouse button state
query_int_array[4] = middle mouse button state
query_int_array[5] = right mouse button state
query_int_array[6] = Control key down(1=True,0=False)
On Failure -> (-1)
Window RGBA values
Keyword:
WINDOW_RGBA_VALUES
example command> query WINDOW_RGBA_VALUES
Input:
Routine Descriptions
param_cnt = 0
Return Values:
On Success -> (1)
ret_char_cnt = xSize * ySize * 4
ret_char_array[n] = rgba pixel interlaced values
if stereo, then the array is xSize * ySize * 4 * 2 and the
two stereo pairs are back to back
On Failure -> (-1)
Window size
Keyword:
WINDOW_SIZE
example command> query WINDOW_SIZE
Input:
param_cnt = 0
Return Values:
On Success -> (1)
ret_int_cnt = 3
ret_int_array[0] = x size (pixels)
ret_int_array[1] = y size (pixels)
ret_int_array[2] = isStereo (boolean)
On Failure -> (-1)
The supplied sample external routine ( enscmddriver.c ) contains an example of the use of this
routine.
See the Routine Descriptions (p. 337) section for an explanation of the other arguments to the routine.
7.2. Routine Descriptions
enscmddriver_connect
/*******************************************************************************
* Starts up connection to the EnSight client to drive it via commands.
* Parameters:
* host_toconnectto - Character buffer containing hostname
* where EnSight is running.
* sockport - Port number to use for socket( > 1024).
* print_error - if (1) will print errors to stderr when
* they occur.
* Return Values:
* On Success - Socket file descriptor to communicate with
* EnSight, if success.
* On Failure
* ENS_SOCKRANGE - Port number out of range. Must be > 1024.
* ENS_CONNECT - Connection to EnSight failed. EnSight must
* be ready for the external command connection.
* ENS_HANDSHAKE - The call to receive the handshake string
* from the EnSight client failed.
* ENS_HOSTTOOLONG - The hostname specified is too large.
******************************************************************************/
int
enscmddriver_connect(char *host_toconnectto,
int sockport,
int print_error)
enscmddriver_sendmesg
/*******************************************************************************
* This routine sends the EnSight client a command and waits for an ok (or ERROR).
* Parameters:
* comm_socket - Socket to communicate on.
* cmd - command string being sent
* print_error - if (1) will print errors to stderr when
* they occur.
* Return Values:
* 1 - upon success
* -1 - upon failure
******************************************************************************/
int
enscmddriver_sendmesg(int comm_socket,
char *cmd,
int print_error)
Note:
The cmd argument can be basically any of the commands in the EnSight Command language.
enscmddriver_query
/*******************************************************************************
* This routine sends the EnSight client a query command and waits for the results.
* Parameters:
* query_keyword - Query keyword
* param_array_cnt - Count of parameters in array below.
* param_array - Floating point array containing any parameters
* for the query operation. The count above helps
* to clarify any changes that might be made to
* a particular query in the future. This will
* help to allow forward/backward compatibility
* and prevent users from always having to use
* the latest library.
*
* ***NOTE: the next 6 need to be passed in by address(ex. &ret_int_cnt)
* because return values will be placed in the ...cnt variables
* and space will be allocated for the others and return
* information will be placed in this space.
* ret_charstr_cnt - Count of strings concatenated into string return
* ret_char_str - String(s) returned from query and separated
* by NULLs. When the user finishes with the
* information they must use free() to deallocate.
* ret_int_cnt - Count of integers in return int array.
* ret_int_array - Array of integer return values. When the user
* finishes with the information they must use
* free() to deallocate.
* ret_float_cnt - Count of floats in return float array.
* ret_float_array - Array of float return values. When the user
* finishes with the information they must use
* free() to deallocate.
*
* ret_error_buf - Buffer for error return string. This buffer
* should be preallocated to 500 characters by
* the caller. It will contain a NULL terminated
* error string when the return value is -1.
*
* Return Values:
* On Success - (1)
* On Failure - (-1) (See error_buffer above)
*
******************************************************************************/
int
enscmddriver_query(int comm_socket,
Routine Descriptions
char *query_keyword,
int param_array_cnt,
float *param_array,
int *ret_charstr_cnt,
char **ret_char_str,
int *ret_int_cnt,
int **ret_int_array,
int *ret_float_cnt,
float **ret_float_array,
char ret_error_buf[500])
enscmddriver_disconnect
/*******************************************************************************
* This routine cleans up the connection to EnSight. This must
* be done before you exit, especially if your application is dieing
* because it received a signal. If the socket is not closed properly
* your port may become hung and you won’t be able to use it until
* it is cleared out by a reboot of your system or some other event.
*
* Parameters:
*
* Return Values:
* None
******************************************************************************/
void
enscmddriver_disconnect(int comm_socket)
Chapter 8: EnSight Python Interpreter
Python EnSight Module Interface (p. 347)
EnSight object API (p. 378)
EnSight extension mechanism (p. 378)
Helper modules (p. 385)
Overview
EnSight includes a built-in interpreter for the Python programming language (www.python.org). The
system allows Python code to be executed within the EnSight program, not unlike the command language
allows. Python is a more fully featured programming language with formal flow control, classes and
complex variable types. It is also intrinsically extensible. EnVe is an example of a Python extension. The
popularity of the Python language means that there are a large number of available extensions (e.g.
XML, SQL, COM, etc). The Python built into EnSight includes the core classes and libraries as well as the
EnSight, EnVe, numpy and PyQt (Python interface to the PyQt GUI library) modules. The PyQt module
allows Python code running inside of EnSight to create cross-platform custom GUIs that can interact
with EnSight. The EnSight core itself implements extensions (command language, right mouse button
menus, user-defined tools and user-defined GUIs) in Python.
EnSight uses Python, PyQt and PyQt. The Python interpreter uses version 2.7.1 and generally includes
the modules built from the standard Python source code distribution. PyQt is version 4 with corres-
ponding updates to QScintilla and PyQt. See the Qt and PyQt websites for more details on this change.
The core interface to the Python interpreter is accessed via the Python tab in the command dialog
graphical user interface.
EnSight Python Interpreter
The Cmd: edit field allows the user to interactively type in Python commands. The output of those
commands is captured in the pane above the prompt. Normal output from Python is in black text, while
error output is displayed as red text. Simple, one-line commands can be entered and executed when
the user presses Enter. The command prompt allows for command recall as well. The Up and Down
arrow keys walk though the most recently entered commands, facilitating rapid editing and re-issuing
of commands. A button is provided to clear the current log text at any time. The Log font... button
allows the user to change the font used in the dialog as well as the Python source code editor.
EnSight provides a built-in editor for Python code that includes Python aware syntax highlighting.
Buttons are provided to create a new Python script file or edit an existing one. The editor window looks
like this:
The line numbers are down the left side and a column is provided to allow the user to hide/show blocks
of text. This also makes it easier to see how the block indented structure of Python denotes scope. The
menu options allow for many options. In addition to basic file I/O and cut/copy/paste editing, there is
a find/replace dialog set and options to indent/unindent and block comment. A menu allows the user
to adjust the font used for display. This selection is stored in the user's preferences.
The editor provides a simple auto-completion mechanism that can be enabled from the Edit menu or
by typing the Ctrl+Tab key. When enabled, if the . character is typed, the text to the left of the . is
scanned for a Python module name match and items in that module are displayed for easy selection.
For example, entering ensight. brings up a list of objects in the Python EnSight module. The can be
very helpful in getting the proper syntax, especially of seldom used commands.
Note:
The system will work for the EnSight core Python modules as well as any module that
has been imported into the global Python interpreter namespace.
Converting Command Language to EnSight Python

There is a built-in mechanism to convert code in command language into Python. To do this, you first
paste the command language into the Python editor (lines of command language can be selected and
copied using the right mouse button menu in the Execution tab). Next, select the text in the editor
and use the Edit menu options for Convert selection to sendmesg() or Convert selection to native
Python. In general, the native Python conversion results in much more readable Python code that is
far easier to edit than the sendmesg() option. The native option should be used for all but legacy
development.
The file menu provides two items to execute the current file text in the EnSight Python interpreter. The
Run script item causes the file contents to be executed in the global namespace (e.g. like the exec-
file() function). The Import script as module item first saves the current file to disk and then executes
a Python import operation on the file, which executes in a private namespace. Both will check the syntax
of the current file and allow for rapid prototyping.
Write and Import Modules for EnSight Python

If you wish to write and import your own python modules and import them into EnSight, then set the
environmental variable CEI_PYTHONPATH to point to the location of your module. After you put your
new module in place, you may need to start up EnSight once with the -no_prefs option to force a
reload of all the modules, then quit and restart EnSight normally to get all your preferences for your
session.
ensight -no_prefs
For an example module that you can import and use in your scripts, as well as use as a template for
your module, see $CEI/ensight201/site_preferences/extensions/ens_utils.py. Try
the following in your python scripts or in the command window.
import ens_utils as eu
dir(eu)
Then pick a module that you are interested in and do a help, for example:
help(eu.get_const_var_names)
help(eu.get_const_val)
General Python Use in EnSight
EnSight will accept Python scripts in most situations where it is expecting a command script. For example,
in the Load: prompt in the Command dialog, as the name of a keyboard or HUM macro and on the
command line (-p), the user may specify the name of a Python script to be executed. This would allow
things like graphical user interfaces to be popped up when keys are pressed, etc. The command language
play: filename command will accept a Python filename, allowing the execution of Python code
from any command file. EnSight differentiates between command language files and Python files based
on filename suffix. Python files are assumed to end in '.py' or '.pyc'. All other files are assumed to
contain EnSight command language instructions. Unlike the command language, EnSight Python code
is not journaled during execution by default, thus Python commands will not show up in any saved
EnSight command stream unless special flags are set.
Simple Python commands can also be embedded directly in EnSight command language. If a line of
command language begins with 'ensight.', it is assumed to be Python code and is passed directly to
the Python interpreter. This means that the native API, discussed later in this section, can be used directly
in .enc files. Also, the command language command: ext: python has been added to command
language. This command passes the remainder of the command line to the Python interpreter. Therefore,
in EnSight, the following is a legal .enc file:
VERSION 10.2
ensight.view_transf.rotate(0.0,0.0,0.1)
ext: python print("Hello from Python!")
Note:
The printed string will appear in the Python tab in the Command dialog.
How Not to Use EnSight Python

When you want to do something in EnSight, try thinking within the EnSight functionality and only use
EnSight Python to control EnSight, or to make it easier using a new custom graphical user interface, or
to make it work repetitively.
Do not use Python as a substitute for the EnSight calculator. Python is an interpreted language. Python
is serial within EnSight for many operations. For example, EnSight Python query of elements requires
a sequential round trip for every element in a serial fashion.
For example, if I wish to count the number of cells in a part inside a box tool, it would be a very, very
bad idea to get the box tool attributes in python and then cycle through a EnSight Python query of
each of the elements in all the parts to see which ones fell inside the box tool limits. Instead, I would
use the EnSight calculator, which has a server with a calculator written in optimized, compiled, threaded
code as follows. I could use a inner clip of the box tool and find only those cells with a value inside. I
would assign a value of 1.0 to each element using MakeScalElem and a value of 1.0, and then sum
up the values all in the EnSight calculator using StatMoment with the sum option.
Using EnSight, I would have even more flexibility: I could even filter by the element type using the
EleMetric and the Filter function to filter out the unwanted element types.
Python and the EnSight Command Line

There are a number of situations where it would be helpful for the Python interpreter in EnSight to
have access to the EnSight command line. This is done through the 'sys.argv' interface in Python.
The EnSight client application supports the command line options '-pyargv' and '-endpyargv'. These
options serve to mark a section of the command line used to launch EnSight to be passed to the EnSight
Python interpreter. For example:
ensight201_client -c -pyargv example -another_example -endpyargv -X
Will cause EnSight to be launched with the -c and -X options and the value of sys.argv to be set
to [ensight,example,-another_example] in Python. The use of -endpyargv is optional and
if missing, will cause all the arguments following '-pyargv' to be passed to sys.argv.
Note:
EnSight will prepend the string ensight to the start of sys.argv. If the raw command
line is desired, it is available as the 'ensight.argv' list.
In the above example, the output would be something like: ['C:\\Program Files\\CEI\\en-
sight201\\machines\\win64\\ens201cl.exe', '-hide_console', '-c', '-pyargv',
'example', '-another_example', '-endpyargv', '-X', '-iwd', '-homecwd']
Limitations of the EnSight Python Interface

Python is a complex and broad-ranging programming language. There are a few features of the language
that can cause problems if called from within EnSight. The features should not be used by Python code
running inside of EnSight.
Re-entrant interfaces to the command language are not allowed. For example, a Python script may use
ensight.sendmesg() to play a command language file. If that file in turn tries to execute a Python
script, EnSight will fail. The reverse is also true. If a command language script calls a Python script which
then calls a command language script, EnSight will fail. In general, avoid nesting play: commands that
change interpreters.
Python supports threads and you can use these, except there are two problems. Python threads require
the interpreter be running at all times to execute. In EnSight, the interpreter is dormant unless Python
code is being executed, so the threads may not always be executed. Second, threads that explicitly or
implicitly modify graphical user interface elements can cause issues. In EnSight, it is critical that only
the main thread of execution make graphical user interface changes.
Note:
Even simple things like print in EnSight Python cause graphical user interface elements
to change (the output is logged to a Qt widget). The best advice is not to use Python
threads in EnSight.
The PyQt module provides a socket interface. This interface is based on asynchronous socket calls.
While the interface is quite nice, it has the side effect of making all the other socket calls in EnSight
under Windows asynchronous. This will cause EnSight's socket communication library to fail. If you need
a socket connection in Python, use the provided Python module instead of the PyQt module.
Python EnSight Module Interface
EnSight balances the X11 Motif widgets with those provided by PyQt, allowing both to exist and co-
operate. One exception to this rule is the issue of modal widgets. The current event handling system
cannot properly handle the case of both widget systems having a modal widget. Therefore, this case
must be avoided. The most common situation occurs when a modal PyQt widget is active and a callback
function on that widget uses ensight.sendmesg() and the resulting command causes EnSight to
pop up a modal X11 dialog. This will cause EnSight to hang. The work-around is to avoid calling
sendmesg() when there is a modal PyQt widget.
Note:
Qt popup menus are modal widgets. Always allow the modal operation to complete
before making the sendmesg() calls.
In order to provide a more seamless integration between the EnSight core windows and those generated
via the Python API, special consideration must be given to the parents of top-level widgets. Two
methods, ensight.qtparent() and ensight.reparent(), provide this functionality. Proper
use of these methods is to provide ensight.qtparent() as the parent of any top-level Qt widget
and to call ensight.reparent() in the widget __init__() method. An example would be:
class example(QWidget):
def __init__(self, parent=None, flags=Qt.WType_TopLevel):
QWidget.__init__(self, parent, flags)
ensight.reparent(self)
...
temp = example(ensight.qtparent())
temp.show()
The resulting top-level widget will interact properly with the EnSight graphical user interface windows.
8.1. Python EnSight Module Interface

Key to interacting with EnSight from within Python is the ensight module. This module is pre-loaded
into the environment and provides a number of methods that can be used to communicate directly
with EnSight. There are a large number of examples that use this interface included in the user-defined
EnSight extensions. These can be found in the $CEI/ensight201/site_preferences/exten-
sions/user_defined directory tree.
Interpreter Startup
When the EnSight Python interpreter is initialized it performs the following operations:
1. Set up PYTHON_HOME/PATH.
2. Create the ensight module.
3. Create the cmdlanguage methods in the ensight module for the native API.
4. Import the sys, sip and imp modules.
5. Import the PyQt4.Gui module.
6. Add $CEI/ensight201/site_preferences/extensions to sys.path.
7. If it exists, add the EnSight Defaults Directory path plus the extensions subdirectory to sys.path. The
EnSight Defaults Directory path is %HOMEDRIVE%%HOMEPATH%\(username)\.ensight201 com-
monly C:\Users\username\.ensight201 Win10, ~/.ensight201 on Linux, and ~/Library/Ap-
plication Support/ensight201 on the Mac.
8. Import the ensight.core module. This has the side effect of adding the names specified by the
CEI_PYTHONPATH environmental variable (: separated under Unix and ; separated under Windows) to
sys.path.
9. Execute ensight.core.load_extensions(). This walks the extension tree, loads any user defined
extensions and reads in any Qt4 language files (*.qm) it finds.
EnSight Module Methods

ensight.sendmesg(cmd|(cmdlist)[,record=r] [,display=d] [,exception=e]
[,version=v] [,noexec=n])
This method executes one or more command language commands. The function can be passed
a single string or a tuple of strings. In the latter case, all the strings in the tuple will be executed.
For example:
ensight.sendmesg(("shell: echo A", "shell: echo B")) executes two

command language commands. The sendmesg() function provides mechanisms to control
the display and recording of the individual command language commands it executes. The
'record=' and 'display=' keyword arguments control this. By default, commands are not
recorded in the session command log. If the record keyword is set to 1, the commands will be
recorded in the session log. For example: ensight.sendmesg("shell: echo
hello",record=1) will execute the command and cause it to be recorded. If the display
keyword is set to '1', the commands will be echoed as text as they are executed to the Python
text log in the command dialog Python tab. Similarly, the 'noexec=' keyword controls if the
command being issued should actually be executed. Setting noexec to 1 suppresses actual
execution of the command, but still allows for the command to be displayed or recorded as
selected by other keywords.
This method returns a 0 if no error and a -1 if error. For example we can purposely enter in
the correct rotate command and an incorrect rotate command and show the return values:
a = ensight.sendmesg("view_transf: rotate -1 1 0")
print(a)
a = ensight.sendmesg("view_transf: rotERRORate -1 1 0")
print(a)
-1
If the exception keyword is set to 1, and the command language string resulted in an error,
Python will raise a Python exception instead of returning -1, which can be trapped by normal
Python exception handling mechanisms.
If the version keyword is set, the version of the command language will be set to that version
for the duration of this single command. The default is to use the version set by sendmesgop-
tions(). If the keyword is set to 0, the current version of EnSight is used.
Explicitly setting any keywords will override the defaults set by the ensight.sendmesgop-
tions() method.
Note:
You can send the commands that open a part of the current EnSight graphical
user interface with this method. See GUI raw commands (p. 338)
ensight.sendmesgoptions([record=r] [,display=d] [,exception=e] [,ver-

sion=v] [,noexec=n])
This method allows the caller to set the default values for the exception, record, display,
version and noexec keywords in the ensight.sendmesg() method. By default, the
keywords except 'version' are set to 0. If they are set to 1 by this method, subsequent
sendmesg() calls without the keywords specified will use the values set by this method. For
example:
ensight.sendmesgoptions(record=1,display=1)
ensight.sendmesg("shell: echo A")
will result in the shell: command being both logged and printed. The commands: en-
sight.sendmesgoptions(record=1,display=1)
ensight.sendmesg("shell: echo A",record=0) would result in the shell: command

being printed, but not recorded. The noexec keyword can be set to 1 to allow the record and
display operations to run as selected, but actual execution of the line of command language
is suppressed.
By default, version is set to the current EnSight command language version number. The
keyword can be set to any valid floating point version number. If it is set to 0, the version will
be reset to the version of EnSight running (its initial state).
(value,type,scope) = ensight.ensvariable(varname)
This method will query EnSight command language variable values and returns a tuple
containing the value, its type and the scope it was found in (similar to the command language
$ functionality, allowing access to variables defined directly in command language or computed
constants). The function returns None if the variable cannot be found.
The TYPE of the variable will be 0 if the value is an integer, 1 if the value is a float and 2 if the
value is a string.
The SCOPE is an integer that specifies where the variable was found.
-2: the variable is in the enscl namespace (e.g. ensight.ensvariable(enscl.FOO)).
-1: the variable is an EnSight constant variable (file, case or computed variable).
0: the variable is global in the command language interpreter (e.g. $globalint BAR) or is
a special command language variable like: APPTOTALTIMESTEPS.
+1: the variable is local in the command language interpreter and the number is the depth in
the interpreter stack where the value is defined.
ensight.play(filename)
This method causes the command language file (.enc) specified by FILENAME to be executed
(similar to the play: filename command). If the name of a Python (.py) file is specified,
the file will be read into memory and executed with the Python 'exec()' command.
ensight.reparent(QWidget_object)
This method is useful on X11 platforms and harmless under Windows. It causes any PyQt widgets
one might create in the EnSight Python interpreter to properly layer with the EnSight windows
(keeping them above the main EnSight window).
Note:
Calling this function with the wrong argument type can cause EnSight to crash.
(err, value, ...) = ensight.query(param[,which])

This method allows the caller to query various attributes in EnSight. The returned value is always
a list that starts with an error code. The list will include one or more returned values (specific
to the param). See Query Capability (p. 315).
Valid param values include the following:
ensight. FRAME_COUNT (p. 318)
ensight. FRAME_LOCATION (p. 318) *
ensight. LEGEND_COUNT (p. 319)
ensight. LEGEND_DISPLAY_ATTRIBUTES (p. 320) *
ensight. LEGEND_SELECTED_OBJECTS (p. 320)
ensight. LINE_COUNT (p. 320)
ensight. LINE_DISPLAY_ATTRIBUTES (p. 320) *
ensight. LINE_SELECTED_OBJECTS (p. 321)
ensight. LOGO_COUNT (p. 321)
ensight. LOGO_DISPLAY_ATTRIBUTES (p. 321) *
ensight. LOGO_SELECTED_OBJECTS (p. 321)
ensight. DIAL_COUNT (p. 316)
ensight. DIAL_DISPLAY_ATTRIBUTES (p. 317) *
ensight. DIAL_SELECTED_OBJECTS (p. 317)
ensight. FLIPBOOK_INFORMATION (p. 317)
ensight. FLIPBOOK_LOADED (p. 317)
ensight. FLIPBOOK_RUNNING (p. 318)
ensight. GAUGE_COUNT (p. 319)
ensight. GAUGE_DISPLAY_ATTRIBUTES (p. 319) *
ensight. GAUGE_SELECTED_OBJECTS (p. 319)
ensight. SHAPE_COUNT (p. 327)
ensight. SHAPE_DISPLAY_ATTRIBUTES (p. 327) *
ensight. SHAPE_SELECTED_OBJECTS (p. 328)
ensight. ARROW_COUNT (p. 315)
ensight. ARROW_DISPLAY_ATTRIBUTES (p. 316) *
ensight. ARROW_SELECTED_OBJECTS (p. 316)
ensight. ARROW_LABEL_TEXT (p. 316)
ensight. MESSAGES (p. 322)
ensight. PART_DISPLAY_ATTRIBUTES (p. 322) *
ensight. PART_ELEMENT_PICKEDBYWINXY (p. 322) * *
ensight. PART_ELEMENT_PICKEDBYWORLDXYZ (p. 323) * * * *
ensight. PART_NODE_PICKEDBYWINXY (p. 323) * *
ensight. PART_NODE_PICKEDBYWORLDXYZ (p. 323) * * * *
ensight. PART_OBJECTS (p. 324)
ensight. PART_PICKED (p. 324) * *
ensight. PART_SELECTED_OBJECTS (p. 324)
ensight. PLOT_COUNT (p. 325)
ensight. PART_DISPLAY_ATTRIBUTES (p. 322) *
ensight. PLOT_PICKED (p. 325) * *
ensight. QUERY_COUNT (p. 326)
ensight. QUERY_DISPLAY_ATTRIBUTES (p. 326)
ensight. QUERY_PICKED (p. 326) * *
ensight.QUERY_PROBE_DATA
ensight. QUERY_PROBE_OUTPUT (p. 327) *
ensight. QUERY_PROBE_ATTRIBUTES (p. 326)
ensight. TEXT_COUNT (p. 328)
ensight. TEXT_DISPLAY_TEXT (p. 329) *
ensight. TEXT_DISPLAY_ATTRIBUTES (p. 328) *
ensight. TEXT_SELECTED_OBJECTS (p. 329)
ensight. TRANSFORMATION_PERANG (p. 330) *
ensight. TRANSFORMATION_PROJ_MATRIX (p. 331) *
ensight. TRANSFORMATION_CENTER_OF (p. 329) *
ensight. TRANSFORMATION_COMPOSITE_MATRIX (p. 329) *
ensight. TRANSFORMATION_LOOKAT_POSITION (p. 330) *
ensight. TRANSFORMATION_LOOKFROM_POSITION (p. 330) *
ensight. TRANSFORMATION_ROTATE_MATRIX (p. 331) *
ensight. TRANSFORMATION_SCALE_MATRIX (p. 331) *
ensight. TRANSFORMATION_TRANSLATE_MATRIX (p. 332) *
ensight. TRANSFORMATION_ZCLIP_LOCATIONS (p. 332) *
ensight. VARIABLE_OBJECTS (p. 333)
ensight. VARIABLE_INFORMATION (p. 333) *
ensight. VIEWPORT_COUNT (p. 334)
ensight. VIEWPORT_DISPLAY_ATTRIBUTES (p. 334) *
ensight. VIEWPORT_LOCATION (p. 335) *
ensight. VIEWPORT_SIZE (p. 335) *
ensight. WINDOW_SIZE (p. 337)
ensight. WINDOW_DEPTH_VALUES (p. 336)
ensight. WINDOW_RGBA_VALUES (p. 336) †
Note:
An * means the which argument is required.
† The ensight.WINDOW_RGBA_VALUES is a special case. The second argument value picks

the format of the returned data. A 0 returns the image as a list of integers, 1 returns the image
as an ASCII string (which happens to be a valid .PPM file) and 2 returns the image as an enve
image object
The following query param() options are specific to the Python interface and are not supported
by the command driver interface:
ensight.TEXTURE_COUNT
Returns the number of textures EnSight supports.
ensight.TEXTURE_IMAGE *
Returns the texture selected by param1 as an EnVe image object (see the EnVe module
description of the image object).
ensight.TEXTURE_BORDER_COLOR *
Returns the texture border color [R,G,B,A] selected by param1.
ensight.VARIABLE_PALETTE * [*]
Returns the current palette for the variable index (see ensight.VARIABLE_OBJECTS
) selected by param1. If the variable is a vector, param2 selects the palette for the
magnitude (0), x (1), y (2) or z (3) components (it defaults to 0). Each palette entry is four
values in the floating point array. The first is the value and the next three are the R, G, B
color for that value.
ensight.CMDLANG_VERSION
Returns the current EnSight command language version number being used. The value
is returned as a string.
ensight.VARIABLE_HISTOGRAM *
Returns the min, max and current histogram for the variable index (see ensight.VARI-
ABLE_OBJECTS) selected by param1. For a scalar variable, 102 floating point values are
returned. The first two are the variable min and max respectively. The subsequent 100
values are the counts for 100 bins between the min and max values. For vector variables,
four times the number of values are returned. Values for the magnitude and x, y, and z
components are included.
ensight.QUERY_DATA *
For the query selected by param1 (see ensight.QUERY_COUNT ), this values returns
the actual point data for that query. The routine returns integer, string and float values.
The integers start with the number of columns. These will be 2 or 5 depending on the
type of query (e.g. over time or over distance). The remaining integers define the number
of point that go into each segment. The (2 or 5) strings are the labels for the columns.
The floating point values will be either 2 or 5 per point and there will be as many points
as the sum of the integers following the number of columns.
Example 8.1: ensight.QUERY_DATA *

num_queries = ensight.query(ensight.QUERY_COUNT)
print("The number of queries is {}".format(num_queries[1])
for query_num in range(num_queries[1][0]):
query_vals = ensight.query(ensight.QUERY_DATA,query_num)
print("query vals, query num {} = {}".format(query_num, query_vals))
ensight.QUERY_PROBE_DATA
Returns the current interactive probe query values. The output is a list, one item per query
value. Each item is a list of the form:
[[variables], [xyz], [ijk], ID, type]
The first item in the output list contains text headers for all the columns. The variables
list contains one item for each selected variable. The xyz list contains a list of three floats,
the coordinates of the query. The ijk list (which can be null) contains a list of three ints,
the ijk values of the query (if any). If the query has an ID value, it will be returned ad
ID (or the value will be null). The type of the query is an ASCII string of the source of
the query.
Note:
Undefined values will be returned as Python None objects.
Example for a simple query with two probes and two variables:
print(ensight.query(ensight.QUERY_PROBE_DATA))
[
[[‘temperature’, ‘velocity’], [‘X’,’Y’,’Z’], [‘I’,’J’,’K’], ‘ID’,
‘Type’],
[[0.9, 0.9], [1.5, -2.0, 0.9], [None, None, None], None, ‘Surface
Pick’],
[[0.9, 0.9], [-0.8, -2.0, 0.9], [None, None, None], None, ‘Surface
Pick’]
]
ensight.DATASET
Returns information about the current dataset. The output may be None if the current
case is not loaded of a list of the form:
[[filedata],coord_sys,coord_type,full_flag,[[minx,miny,minz],
[maxx,maxy,maxz]], total_nodes, total_elements, [elementlist]]
The FILEDATA list describes the various files opened (as specified by the actual reader).
The information includes the filename, its size, its date and any number of description
strings. The list has the form:
[[filename,file_size,file_date,["desc1","desc2",...]]
COORD_SYS specifies the file's coordinate system and can be: Cylindrical, Rectan-
gular, Spherical or Unknown. COORD_TYPE specifies the file's temporal scheme and
can be: Static, Changing Connectivity or Changing Coordinate.
The FULL_FLAG is 1 if the min/max arrays are for the entire dataset. Otherwise the
numbers are just for the loaded parts. The subsequent arrays specify the coordinate
min/max values for x, y and z.
TOTAL_NODES and TOTAL_ELEMENTS specify the total number of nodes and elements
in the dataset respectively. The ELEMENTLIST list describes the number of elements in
the dataset of each element type. The list has the form:
[["type1",num_elements1],["type2",num_elements2],...]
ensight.TIMEVALS
This query returns a dictionary of the current EnSight timeline. The dictionary keys include:
timecurrent - the current time value
stepcurrent - the current timestep (note: this is a float as it could be interpolated)
timelimits - list of the minimum and maximum time values
steplimits - list of the minimum and maximum time steps (integers)
timevalues - list of [timestep, timevalues] lists for every simulation time
ensight.FULLSCREEN
This query returns zero if EnSight is not in fullscreen mode or non-zero if it is in fullscreen
mode.
ensight.PREFERENCESPATH
This query returns a string that is the directory name where EnSight is reading and writing
preference data to.
ensight.SENDMESG_RECORD,SENDMESG_RAISE,SENDMESG_NOEXEC,SENDMESG_DIS-
PLAY
These four queries return the current value of the record, exception, noexec or
display named arguments respectively to the ensight.sendmesgoptions()
method.
ensight.GLCONFIG
This query returns a dictionary of OpenGL related information. The dictionary keys include
(on most platforms):
vendor - the OpenGL vendor string
renderer - the OpenGL renderer string
version - the OpenGL version string
stencilbuffer - a non-zero integer if a stencil buffer is being used
doublebuffer - a non-zero integer if depth buffering is being used
occlusiontest - True if the OpenGL occlusion test is being used
wirefamemode - True if wireframe mode is done with lines (instead of polygons)
displaylist - True if OpenGL display lists are being used
normpervertex - True if EnSight is generating a normal per vertex
vertexcount - the number of vertices in a geometry block
palettemode - "Textures" or "RGB"
extensions - the OpenGL extension string
freevideoram - Amount of available GPU memory, in MB (If 0, then graphics card or

software driver does not allow a query of memory).
ensight.SYSINFO
This query returns a dictionary of system resource related information. The dictionary keys
include (on most platforms):
numprocs - number of processor (cores) in the system
totalmem - amount of physical RAM in the system (in kilobytes)
freemem - amount of free RAM in the system (in kilobytes)
memuse - the amount of RAM being used by the EnSight process (in kilobytes)
pointersize - the size of a pointer in bits on the platform (32 or 64)
ensight.DR_INFO
This query returns a dictionary of system resource related information. The dictionary keys
include (on most platforms):
parallelrendering - a non-zero integer if the system is using parallel rendering
masterclient - True if the current node is the DR master client
compositing - True if image-based parallel compositing is being used
detached - True if DR detached displays are being used
rank - the rank of the current EnSight client node in DR
ranksize - the number of clients nodes being used in this DR session.
ensight.UNIQUE_ID
This query returns a unique integer number every time it is called. This can be useful with
things like obtaining a unique, private filter flag for the ENS_EVENT_PYTHON event
interface.
ensight.SPLINE_COUNT
This query returns the number of splines currently defined. The value is returned as with
the command driver queries: [errorcode, [number_of_splines]].
ensight.SPLINE_DATA
This query returns the actual raw splince coordinates for a given spline number. For
example:
a = ensight.query(ensight.SPLINE_DATA, 1)
returns the control points for spline number 1. The spline data itself has the following
form:
[errorcode,[num_points],[x0,y0,z0,x1,y1,
z1...],['spline name']]
ensight.TOOL_PARAMS *
Allows the user to query the current setting for the various EnSight data tools.
The param1 value should be one of the following:

ensight.TOOL_CURSOR Value is three floats: [x,y,z] the point
ensight.TOOL_LINE Value is six floats: [x0,y0,z0,x1,y1,z1] two
points
ensight.TOOL_PLANE Value is twelve floats:
[x0,y0,z0,x1,y1,z1,x2,
y2,z2,x3,y3,z3] four points
(must be rectangular and co-planar)
ensight.TOOL_BOX Value is fifteen floats:
[ox,oy,oz,xx,xy,xz,yx,yy,
yz,zx,zy,zz,sx,sy,sz] an origin point, three
normal vectors (must be orthogonal)
for the axis and three length values
ensight.TOOL_CYLINDER Value is seven floats:

[x0,y0,z0,x1,y1,z1,rad] two points at the
ends of the cylinder and the radius
ensight.TOOL_SPHERE Value is six floats: [x0,y0,z0,x1,y1,z1] two
points that define the diameter (and
major axis) of the sphere.
ensight.TOOL_CONE Value is seven floats:
[x0,y0,z0,x1,y1,z1,
cone_ang] two points at the ends of the
cone and the angle at the apex.
ensight.TOOL_REVOLUTION Value is six + 2*N floats:
[x0,y0,z0,x1.y1.
z1,d0,r0,d1,r1,...] two point, one at the end and
the other that defines the axis followed by
a variable number of distance, radius pairs
that define the profile
err = ensight.modify(param,(value))
This method is used to set various EnSight global parameters.
The valid values for param are:

ensight.TEXTURE_IMAGE
In this case, value should be a tuple of the form (texure_index, image). Texture_in-
dex is an integer from 0 to 7 and image is an EnVe module image object.
ensight.TEXTURE_BORDER_COLOR
In this case, value should be a tuple of the form (texure_index,(r,g,b,a)). Tex-
ture_index is an integer from 0 to 7, while (r,g,b,a) is a four valued float tuple that
specifies a color+alpha value (all values are in the range [0,1]).
ensight.TOOL_PARAMS
In this case, value should be a tuple of the form (tool_name, (tool_setting)).
Tool_name is one of the options documented for TOOL_PARAMS for ensight.query()
above (e.g. ensight.TOOL_CURSOR). Tool_setting is the value to change to change
the tool location/settings to (see the TOOL_PARAMS section in the ensight.query()
documentation for details on the individual tool formats.
ensight.refresh()
This method queues up an EnSight redraw for the next idle redraw of its graphics displays. Use
the following to force the redraw immediately: ensight.refresh(force=1) .
image = ensight.render([x=dx] [,y=dy] [,dpi=dpi] [,stereo=s]

[,plots_only=po] [,invert_background=ib][,num_samples=ns])
This method causes EnSight to render the current image to one or more EnVe image objects.
The return value is either a single EnVe image object by default. If the stereo keyword is set to
1, the return value will be a list of two image objects. The first is the left eye view and the
second the right eye view. By default, the output image(s) will be the size of the current EnSight
rendering window. The x and y keywords can be set to any desired output image size. The
dpi keyword selects the dots per inch resolution of the output. In the current release, this
keyword is ignored. When set to 1, the plots_only keyword will cause only the EnSight plots
to be drawn instead of both the plots and the geometry. When set to 1, the invert_back-
ground keyword will cause the current background to toggle between black and white. This
can be useful if the ultimate target of the image is a printer or perhaps an embedded document.
The num_samples keyword sets the number of passes of full scene anti-aliasing that should
be used to render the output image. The default number of samples is 1 and the maximum
number is 16.
value = ensight.query_points(pointlist [,parts=partlist] [,variables=varl-

ist] [,time=t])
This function is a basic variable and mesh query mechanism. It takes a list of points as input.
The list is a Python list of 3 value python lists. An example would be: [ [1,2,0], [2,4,2] ] for two
points. The function will perform a query at each point in the list.
The parts keyword variable is optional. If not present, the currently selected parts will be
used. The parts keyword can be set to the string all (e.g. parts="all") to select all parts
in the current case, otherwise, partlist should be a Python list variable may include any
mixture of string names, part numbers or part objects for all the parts that should be included
in the query. For example: parts=["mesh","field",8] will include the parts named
mesh, field, and part number 8 in the query.
The variables keyword variable is optional. If present, varlist should be a Python list
variable that may include any mixture of string names, variable numbers or variable objects
for all the variables that should be included in the query. For example: variables=["velo-
city","pressure",2] will include output for the variables named velocity, pressure
and variable number 2 in the query.
The time keyword variable is optional. If not present, the query will be for the current time
value in EnSight. The caller can also specify a specific time value using this keyword.
The return value is a list of output lists. One list for each input point. If no variables are specified,
the query will be about the mesh structure and the list for each point will appear as:
[part_number, structuredpart_flag, closest_node, element_id]
The values are the part number the point was found in, a flag that is non-zero if the part is
structured, the node id of the node closest to the point and the element id of the element that
contains the point.
If a list of variables is specified, the returned value will be a list of lists, one for each variable.
If the input variables were "pressure" and "velocity" (a scalar and a vector), the output (per
point) would be:
[ [pressure_value], [velocity_x, velocity_y, velocity_z] ]
value = ensight.query_nodes(nodelist [,parts=partlist][,variables=varl-

ist][,time=t])
This function is a basic variable and mesh query mechanism. It takes a list of node ids as input.
An example would be: [500, 323] for two nodes. The function will perform a query at each node
in the list.
Important:
Each of these nodal queries makes a round trip from the client to the server,
one at a time. This is not intended to be used to query large numbers of nodes
and will be extremely slow for large numbers of nodes. Use EnSight python for
controlling EnSight, not for replacing the EnSight server.
used. The parts keyword can be set to the string "all" (e.g. parts="all") to select all parts
The "time" keyword variable is optional. If not present, the query will be for the current time
The return value is a list of output lists. One list for each input node. If no variables are specified,
the query will be about the mesh structure and the list for each node will appear as:
[part_number, structuredpart_flag, [node_x, node_y, node_z], [ele-

ment_list]
The values are the part number the node was found in, a flag that is non-zero if the part is
structured, the coordinates of the node and a list of elements that reference that node.
If the input variables were pressure and velocity (a scalar and a vector), the output (per
node) would be:
value = ensight.query_elems(elemlist [,parts=partlist][,variables=varl-

ist][,time=t])
This function is a basic variable and mesh query mechanism. It takes a list of element ids as
input. An example would be: [232, 4733] for two elements. The function will perform a query
at each element in the list.
The time keyword variable is optional. If not present, the query will be for the current time
The return value is a list of output lists. One list for each input element. If no variables are
specified, the query will be about the mesh structure and the list for each element will appear
as:
[part_number, structuredpart_flag, element_type, failed_flag,

[element_ijk_list], [node_list], [neighbor_element_list]]
The values are the part number the element was found in, a flag that is non-zero if the part is
structured, the type of the element, a flag that is non-zero if the element is currently failed,
a list of ijk bounds for the element (if the part is structured), a list of the nodes this element
references and a list of the elements that neighbor this element.
If the input variables were pressure and velocity (a scalar and a vector), the output (per
element) would be:
value = ensight.query_trace_paths([parts=partlist][,variables=varlist])
This function allows the user to directly query the points that make up particle traces. The
output is similar to the output generated by the test: trace_dump command, except that
it is returned as a Python variable insted of a text file on disk. The function takes a list of particle
trace objects as input, along with an optional list of variable names.
city", "pressure", 2] will include output for the variables named velocity, pres-
sure and variable number 2 in the query.
Note:
In order to get a valid return for a given variable, it must be active, and have
been activated prior to the creation of the trace.
The return value is a list of output lists. One list for each input part. The list for each part will
contain one list for every trace in the part. If no variables are specified, the list for each trace
will contain information about the temporal and spatial location of each point on the trace in
the form:
[x,y,z,t]
The time value t is the resident time for the trace.
If a list of variables is specified, the returned value will be a list per part of lists per trace of
lists, one for each variable. If the input variables were pressure and velocity (a scalar and
a vector), the output (per point on a trace) would be:
[ [pressure_value], [velocity_x, velocity_y, velocity_z]]
Example 8.2: In the Case of Two Parts, Each with 3 Traces of 4 Points Each and the
Variable Keyword Specifying a Vector and a Scalar Variable, the Full Output Would
Be
#part 1
#trace 1
[[[vx,vy,vz],[s]],[[vx,vy,vz],[s]],[[vx,vy,vz],[s]],[[vx,vy,vz],[s]]],
#trace 2
[[[vx,vy,vz],[s]],[[vx,vy,vz],[s]],[[vx,vy,vz],[s]],[[vx,vy,vz],[s]]],
#trace 3
[[[vx,vy,vz],[s]],[[vx,vy,vz],[s]],[[vx,vy,vz],[s]],[[vx,vy,vz],[s]]]
],
#part 2
[...]
ensight.query_parts([parts=partlist][,client=client][,variables=varlist])
This method returns basic information about parts as a Python list. The parts keyword variable
is optional. If not present, the currently selected parts will be used. The parts keyword can
be set to the string all (e.g. parts="all") to select all parts in the current case, otherwise,
partlist should be a Python list variable may include any mixture of string names, part
numbers or part objects for all the parts that should be included in the query. For example:
parts=["mesh","field",8] will include the parts named mesh, field, and part number
8 in the query.
city", "pressure", 2] will include output for the variables named velocity, pres-
sure and variable number 2 in the query.
The return value is a list of output lists, one list for each selected part. The list for each part
can have one of three structures, depending on the setting of the client keyword and the
presence of the variables keyword. If the variables keyword is present, the return value is a list
of lists, one per parts. Each list has the following structure:
[partID, [vlist]]
The vlist list has one value for each variable being queried. The value is 1 if the variable
exists, is active and has some defined values for the given part. The value is -1 if the variable
not active or not defined for the given part. -2 is returned if the part does not contain the
variable or the variable is not defined. Other values are returned for invalid input parameters.
By default, the client keyword is 0 and results in a server query, much like the Query → Show
Information → Part menu selection. Client side parts (e.g. groups, pathlines, vector arrows)
will not be included in this output. If the client keyword is set to the value 1, the query will be
performed on the client. This is a much faster query and it includes all parts, but it returns less
detailed information than the server query.
In the server query case (client=0), the list for each part has the following structure:
[partID, part_type, [x0,y0,z0], [x1,y1,z1], num_nodes, elemlist,

is_selected, "partname", is_structured, ijkbounds, casenum, parent-
partlist]
In the client query case (client=1), the list for each part has the following structure:
[partID, part_type, is_selected, "partname", is_structured, casenum,

parentpartlist]
In both cases, the named fields are defined as:
partID = the part ID
part_type = the EnSight part type (e.g. model, clip, etc) (int)
part_type will be one of the following values:
ensight.PART_MODEL, ensight.PART_CLIP_PLANE, ensight.PART_CONTOUR, en-

sight.PART_DISCRETE_PARTICLE, ensight.PART_FRAME, ensight.PART_ISO_SUR-
FACE, ensight.PART_PARTICLE_TRACE, ensight.PART_PROFILE, ensight.PART_VEC-
TOR_ARROW, ensight.PART_ELEVATED_SURFACE, ensight.PART_DEVELOPED_SUR-
FACE, ensight.PART_MODEL_EXTRACT, ensight.PART_MODEL_CUT, en-
sight.PART_MODEL_BOUNDARY, ensight.PART_ISO_VOLUME, en-
sight.PART_BUILT_UP, ensight.PART_TENSOR_GLYPH, ensight.PART_FX_VOR-
TEX_CORE, ensight.PART_FX_SHOCK, ensight.PART_FX_SEP_ATT, ensight.PART_MA-
TERIAL_INTERFACE, ensight.PART_POINT, ensight.PART_AXI_SYMMETRIC, en-
sight.PART_MODEL_MERGE, ensight.PART_MULT
x0,y0,z0 = the part minimum x,y,z coords
x1,y1, z1 = the part maximum x,y,z coords
num_nodes = the number of nodes in the part
elemlist = a list of element types and the number of elements each type. For each element
type in the part, there is a two element list in elemlist of the form: ['elemtype', num],
that defines the number of elements of the specified type. elemtypes as text strings like
Tria3 or Hexa8.
is_selected = an integer that is non-zero if the part is currently selected
partname = the name of the part as a string
is_structured = an integer that is non-zero if the part is structured. If non-zero, the

ijkbounds list will be present.
ijkbounds = this list is only present if the part is structured. It consists of three, three element
lists and has the form: [ [i_min, i_max, i_step, i_limit], [j_min, j_max,
j_step, j_limit], [k_min, k_max, k_step, k_limit] ]. These are the current
min, max and step size along the i, j and k axis for the structured part as well as the maximum
(limit) of the individual axis bounds.
casenum = the case number to which this part belongs
parentpartlist= a list of part numbers that are the parents to this part. This list may be
empty. It will be non-empty for derived parts (e.g. clips, contours, etc).
ensight.query_cases()
This method returns basic information about the current EnSight cases as a Python list. The
returned list has the following format:
[current_case_num-
ber,[case1_num,"case1_name"],[case2_num,"case2_name"]...]
The first item is the current case number (zero based). There will be one subsequent item for
each current case. Each of those items is a list containing the number for that case and its
name.
err=ensight.query_xy_create(title,xtitle,ytitle,data[,segments=seg])
This function creates a new xy query in EnSight. It is similar to reading a query from an external
file, except the data is passed from Python. title, xtitle and ytitle are strings that
specify the textual labels for the curve, x and y axis. "data" is a list of lists that takes the form:
[[x0,y0],[x1,y1],[x2,y2],...]
That is a list of two element lists which contain two float values each that are interpreted as
an X,Y point in space. By default, the data is plotted as a connected line. The optional seg-
ments=seg keyword allows the caller to specify a seg variable which is a list of integers. Each
integer is the length of a connected line of points. For example: [10,24,8] specifies that the first
10 points should be connected as a polyline, the next 24 as separate polyline and the remaining
8 as a separate polyline. The sum of the seg list integers must be the same as the number of
points in the "data" list. A return value of 0 means the creation was successful, -1 means there
were issues in the format of the input arguments, -2 suggests an out of memory condition and
-3 means that the query was created, but that some values in the data list were missing (and
set to 0.0).
ensight.qtparent()
This method returns None on X11 platform and a QWidget object under Windows. It is used
in conjunction with ensight.reparent() to ensure that Python Qt windows can interact properly
with the existing EnSight windows.
ensight.version([element])
Returns information about EnSight
Prior to version 2019 R1, the standard way of using this function was to call ensight.ver-
sion() with no arguments and using the default data returned (described below). Since 2019
R1, the recommended method is to pass an element argument to ensight.version(),
requesting the specific piece of information desired. In a future release, the legacy method of
calling ensight.version() with no argument will be deprecated; an element argument
will be required.
If no element argument is specified, the function returns a list containing 10 items:
1. A version string in the legacy format xx.x.x(a). E.g., 19.4.0(a)
2. The license type as a string. E.g., Enterprise, Standard, etc.
3. The architecture of the client machine. E.g., linux_2.6_64, win64
4. The base installation directory
5. The server version if one is running, otherwise None.
6. The SOS version if one is running, otherwise None.
7. A user and license dictionary (see below).
8. major version string
9. GUI type (only Qt)
10. Apex release number.
The contents of the user and license dictionary will vary depending on the type of license
manager. At the very least, the dictionary will contain an lmtype key, whose value will be
ANSYS, SLiM, or FSI indicating the license manager type.
If the license manager is ANSYS, the “user and license” dictionary will contain the following
items:
• keypath:ANSYS
• host: The hostname of the client machine
• customer: The Siebel customer number
• username: The current user name
• lmtype: ANSYS
If the license manager is SLiM or FSI, the user and license dictionary will contain the
following items:
• host: The hostname of the client machine
• ip: The IP address of the client machine
• customer: Customer ID
• contact: The contact name from the license
• company: The company name from the license
• expdate: The license expiration date string
• slimversion: The version number of the SLiM license manager
• keypath: The location of the license information or server
• hostid: A list of host IDs from the license manager
• lmtype:SLiM
An example of such a list is:
['19.2.0(a)', 'Standard', 'win64', 'C:\\Program Files\\ANSYS

Inc\\v194\\CEI', '19.2.0(a)', None, {'customer': '12345678',
'username': 'yourid', 'host': 'MACHINENAME', 'keypath': 'ANSYS',
'lmtype': 'ANSYS'}, '194', 'Qt', '194']
If a string is passed as the element argument, a particular element of version information is

returned, corresponding to the following map:
• version-full: The release number returned as a string. E.g., 2019 R2
• numeric: The release number returned as a list containing year, minor version, patch, and beta
string returned as a Python list. E.g., [2019, 2, 0, ‘’]
• year: The year portion of the release number. Returned as an integer. E.g., 2019
• rel: The minor release number. Returned as an integer. E.g., 2
• patch: The patch number. Returned as an integer. E.g., 0
• beta: If the release was built as a beta, the beta string. Otherwise, an empty string.
• ip: The IP address of the client machine.
• product: The product name. E.g., EnSight, EnVision, etc.
• mode, license, or flavor: The license name. E.g., Enterprise, Standard, etc.
• company: The company name from the license. Can be an empty string if none is available.
• customer: The customer name or id from the license returned as a string. Can be an empty string
if none is available.
• arch: The architecture of the client machine. E.g.linux_2.6_64, win64
• CEI_HOME or home: The base installation directory as a string. E.g., 'C:\\Program

Files\\ANSYS Inc\\v194\\CEI'. The string will be formatted in a platform-specific way,
with a drive letter and backslashes on Windows and forward slashes on Linux and macOS.
• lmtype: The license manager type. One of ANSYS, SLiM, or FSI.
• Slimversion: The version number of the SLiM license manager. None if the SLiM license manager
is not used.
• keypath: The location of the license file or server if the SLiM license manager is used. None
otherwise.
• hostname: The host name of the client machine.
• haveServer: A Python boolean indicating whether an EnSight server is currently running.
• haveSOS: A Python boolean indicating whether an EnSight Server of Servers is currently running.
• suffix: A three-character numeric string that serves as a short version number. E.g., "194". This
is frequently used when naming directories.
If an element string is given that is not supported, a ValueError Python exception is thrown.
ensight.checkabort([throw_exception])
In the EnSight Python editor, there is an option to set an abort flag. When this method is
called, two things happen. First, all the pending graphical user interface events are processed.
Second, if the user has selected the abort menu option, this method resets the abort state and
returns a non-zero integer. If the abort menu has not been selected, this method returns the
value 0. If throw exception is passed as an argument and is non-zero, if the function would
return a non-zero value, it will instead throw a Python exception.
ensight.batch()
This method returns a non-zero integer if the EnSight client is running in batch mode.
ensight.exit()
This method causes EnSight to shut down the current EnSight session.
The Python Native Command Language Interface

As described in the previous section, the ensight.sendmesg() function can be used to execute
command language from Python. The command language takes the form of a Python string or list of
strings. There exists a collection of modules that implement a more natural Python (native) interface to
the command language. These modules follow the form of the EnSight command language syntax. All
command language commands have the fundamental form:
category: command <args>
For example:
view_transf: rotate 9.657229e+000 2.282249e+001 0.000000e+000
has a category of 'view_transf', a command of rotate and arguments of 9.657229e+000

2.282249e+001 0.000000e+000. The native command language interface maps the category and command
names to modules under the 'ensight' module. For example, the above command is equivalent to the
following line of Python code:
ensight.view_transf.rotate('9.657229e+000 2.282249e+001 0.000000e+000')
Additionally, the native interface will try to map data types to <args> strings. So the following lines
of Python code are all equivalent:
ensight.view_transf.rotate(9.657229e+000,2.282249e+001,0.000000e+000)
ensight.view_transf.rotate([9.657229,2.282249e+01,0])
a=[9.657229,2.282249e+01,0]
ensight.view_transf.rotate(a)
The use of Python native variables makes this interface much more flexible for complex scripting.
The native interface handles the select_begin/select_end commands very differently. The
command language includes structures like:
part: select_begin
1 2 3 4 5 6 7 8
part: select_end
part: select_byname_begin
(CASE:Case 1)Block ID 7 - HEX" "(CASE:Case 1)Block ID 8 - HEX
part: select_byname_end
The native Python interface is aware of the list nature of the select_begin/select_end commands
and maps them to a single command (the select_begin). The above lines translate to two lines of
Python:
ensight.part.select_begin(1,2,3,4,5,6,7,8)
ensight.part.select_byname_begin("(CASE:Case 1)Block ID 7 -
HEX","(CASE:Case 1)Block ID 8 - HEX","(CASE:Case 1)Block ID 9 -
HEX","(CASE:Case 1)Block ID 10 - HEX","(CASE:Case 1)Block ID 11 -
HEX","(CASE:Case 1)Block ID 1 - HEX")
The *_end functions are not necessary. Additionally, a list-based syntax is also supported, so the fol-
lowing three lines are also equivalent:
ensight.part.select_begin([1,2,3,4,5,6,7,8])
list = ["(CASE:Case 1)Block ID 7 - HEX",
"(CASE:Case 1)Block ID 8 - HEX",
"(CASE:Case 1)Block ID 1 - HEX"]
ensight.part.select_byname_begin(list)
In all cases where the command language uses a *_begin/*_end syntax with a collection of items
(numerical or strings), a Python command structure similar to the above may be used.
Conversion of Command Language Scripts to the Native Interface

In previous versions of EnSight, functions were provided to convert selections of command language
to ensight.sendmesg() format. With the native interface, these have been replaced with two menu
options in the EnSight Python script editor. Under the Edit menu, there is an option Convert selection
to sendmesg() which converts the currently selected text in the editor into the ensight.sendmesg()
form. More importantly, there is a Convert selection to native Python option. This function will convert
command language to the native interface described here. One can convert a .enc file by loading it
into the script editor window, selecting all of the text and converting it to native Python. The result can
be saved as a .py file. An example of the conversion results would be:
VERSION 8.26
part: modify_begin
part: elt_representation 3D_feature_2D_full
part: modify_end
data: binary_files_are big_endian
data: format case
data: shift_time 1.000000 0.000000 0.000000
data: replace c:/Program Files/CEI/ensight102/data/cube/cube.case
view_transf: rotate -6.277198e+001 6.945956e-001 0.000000e+000
part: select_all
clip: begin
clip: value MID-RANGE
clip: domain intersect
clip: tool xyz
clip: end
clip: create
part: select_begin
2
part: select_end
view_transf: rotate 1.904619e+001 3.095920e+001 0.000000e+000
part: modify_begin
clip: value -0.425000
clip: tool xyz
part: modify_end
view: hidden_surface ON
variables: activate temperature
part: select_all
part: modify_begin
part: colorby_palette temperature
part: modify_end
Translates into the following native Python code:
ensight.sendmesgoptions(version=8.26)
ensight.part.select_default()
ensight.part.modify_begin()
ensight.part.elt_representation("3D_feature_2D_full")
ensight.part.modify_end()
ensight.data.binary_files_are("big_endian")
ensight.data.format("case")
ensight.data.shift_time(1.000000,0.000000,0.000000)
ensight.data.replace("c:/Program Files/CEI/ensight102/data/cube/cube.case")
ensight.view_transf.rotate(-6.277198e+001,6.945956e-001,0.000000e+000)
ensight.part.select_all()
ensight.clip.begin()
ensight.clip.value("MID-RANGE")
ensight.clip.domain("intersect")
ensight.clip.tool("xyz")
ensight.clip.end()
ensight.clip.create()
ensight.part.select_begin(2)
ensight.view_transf.rotate(1.904619e+001,3.095920e+001,0.000000e+000)
ensight.clip.value(-0.425000)
ensight.clip.tool("xyz")
ensight.view.hidden_surface("ON")
ensight.variables.activate("temperature")
ensight.part.select_all()
ensight.part.colorby_palette("temperature")
ensight.sendmesgoptions(version=0)
This language conversion is actually performed by the class Cmd2Py in the Python module: cei.cmd2py.
A quick study of the cmd2py.py file will give an overview of the conversion process and what is and
what is not handled by the conversion. Some command language cannot be converted automatically.
Files that include things like command language loops cannot be converted automatically and the
conversion system will insert comments detailing the failures. Examples that use other command language
features that cannot be directly translated (e.g. $ variables) will be converted to ensight.sendmesg()
formatted lines as a fallback. In most cases, users are better off converting such sections of code into
native Python in any case. A command line program: cmd2py is also provided to aid in the conversion
of files outside of EnSight.
Usage Notes on the Native Python Interface

The native interface has the same limitations listed in Limitations of the EnSight Python Interface (p. 346).
In general, all of the command language is supported with a few exceptions.
One exception is the test: commands. These commands are not supported by the native interface
(i.e. there is no ensight.test module). They can of course be issued using the en-
sight.sendmesg("test:...") interface.
There are a number of commands in the EnSight command language that are not valid Python names.
A few examples include:
function: #_of_levels 5
annotation: 3d_label_size 10.0
command: print "hello"
viewport: raise
The reasons a name might be invalid include:
1. name includes an invalid character (e.g. "#")
2. name begins with a digit (e.g. "1")
3. name is a Python reserved word (e.g. "raise")
These are transformed using the following rules:
1. "#" characters are replaced with the text number
2. names that start with a digit are prefixed with an _
3. names that are the same as a Python reserved word are prefixed with an _
The previous examples become:
ensight.function.number_of_levels(5)
ensight.annotation._3d_label_size(10.0)
ensight.command.print("hello")
ensight.viewport._raise()
There are a few obsolete EnSight command language functions that are not supported. One example
would be:
part: symmetry_1_1_-1
Such functions can still be executed using ensight.sendmesg().
The native interface methods do not include the exception, record, display or version keywords
like ensight.sendmesg(). However, they do honor the values set by ensight.sendmesgop-
tions(). That function can be used to cause the code that uses the native interface do be executed
under the particular rules of a specific command language version or to throw exceptions on errors for
instance.
EnSight Python Events

EnSight has a mechanism to execute Python code when various events occur in the main program. The
module provides methods to add a callback and remove one. Each callback consists of a Python object,
the name of a method on the object and a reason to be called back. An example Python class that re-
gisters itself for one rendering callback and then removes itself would be:
class cb_class:
def register(self):
self.ID = ensight.addcallback(self,"callback",ensight.ENS_EVENT_PRERENDER)
def callback(self,value):
print("Called back from EnSight {}".format(value))
ensight.removecallback(self.ID)
example = cb_class()
example.register()
Note:
Be aware that callback in the addcallback() method specifies the name of the function
in the object to call. The value in the callback value argument vary depending on the
specific event it is tied to, but it will always be a tuple that starts with the original event
name passed in addcallback(). Another example, using the ENS_EVENT_PYTHON inter-
face might be:
class py_cb_class:
def init (self):
self.filter = ensight.query(ensight.UNIQUE_ID)
self.ID1 = ensight.addcallback(self,"fil_cb",ensight.ENS_EVENT_PYTHON,self.filter)
self.ID2 = ensight.addcallback(self,"def_cb",ensight.ENS_EVENT_PYTHON)
def fil_cb(self,value):
print("Filtered callback {} {}".format(self.filter, value))
return 0
def def_cb(self,value):
print("Default callback {}".format(value))
return 0
def test(self):
print("immediate,filtered: {}".format(ensight.sendevent(["hello"],filter=self.filter))))
print("deferred: {}".format(ensight.sendevent(["goodbye"],deferred=1)))
example = py_cb_class()
example.test()
In this example, take careful note of the position and order of the generated output to see
the effects of deferred callbacks.
EnSight Python Code Methods

ID = ensight.addcallback(object,"methodname",event_type[,timeout|filter])
This method registers the specified method name will be called on the passed object
when the specified event_type occurs in EnSight. The function returns an ID
number that can be passed to removecallback() to unregister the callback.
Currently defined values for event_type:

ensight.ENS_EVENT_ALL The method will be called for all
EnSight events. The callback function
value will reflect the actual event type
for which the callback was invoked.
ensight.ENS_EVENT_QUIT EnSight is about to exit.
ensight.ENS_EVENT_SOLU- The current solution time has changed.
TION_TIME The new time is passed as the value.
ensight.ENS_EVENT_NEW_TIME The number of time steps has
changed. The new time is passed as
the value. This event is triggered due
to simulation monitoring updates. This
is an topic discussed in Load Transient
Data.
ensight.ENS_EVENT_POSTRENDER EnSight has just redrawn its current

displays.
ensight.ENS_EVENT_PRECOMMAND EnSight is about to execute the
command language string passed as
the value.
ensight.ENS_EVENT_POSTCOM- EnSight has just executed the
MAND command language string passed as
the value.
ensight.ENS_EVENT_TIMEOUT A periodic time has occurred (see
below).
ensight.ENS_EVENT_PARTSELECT The current part selection has changed
to the tuple of part numbers passed
as value.
ensight.ENS_EVENT_PART A part has either been created or
destroyed. A value of 0 is passed on
construction and 1 is passed on
destruction. A value of 3 is passed
when a part is renamed.
ensight.ENS_EVENT_CASE A case has either been created,
renamed, made current or destroyed.
A value of 0 is passed on construction,
1 is passed on destruction, 2 is passed
if the current case is made current and
3 is passed if a case is renamed.
ensight.ENS_EVENT_QUERY A query in ensight has been created,
destroyed or updated. Two values are
passed. The first selects the type of the
query. If the first value is: en-
sight.ENS_EVENT_QUERY_PROBE,
the second value will be 0 and the
current probe information has been
updated. If the first value is: en-
sight.ENS_EVENT_QUERY_DATA
the value can be 0 if a query has been
created or 1 if it has been destroyed.
ensight.ENS_EVENT_VARIABLE A variable has either been
created/activated or
destroyed/deactivated. A value of 0 is
passed on construction and 1 is passed
on destruction.
Special Event Types:
These events come from different sources and the callback functions may have
slightly different behavior from the basic event types.
Python events:
ensight.ENS_EVENT_PYTHON This event allows multiple Python
objects running inside of the EnSight
Python interpreter to pass information
to each other. A callback function that
is associated with this event type will

be passed a Python list as its value
(see: the method en-
sight.sendevent()). The return
value of this callback function is
important. If it has the integer value
1, no additional ENS_EVENT_PYTHON
callbacks will be called with the value.
If the callback returns the value 0, any
remaining ENS_EVENT_PYTHON
callbacks will also be called with the
same value. When this event is
specified, the optional filter
parameter to the ensight.addcall-
back() is used. The parameter
registers a tag with the callback that
specifies that only the callbacks
generated by a sendevent() call
with that same tag be called. By
default, the filter values are set to zero
in both functions which results in a
broadcast of the python list to all
callbacks. The application can specify
a unique 'tag' number to send private
messages. See en-
sight.sendevent() for more
details.
Low Level CVF (device) events:

EnSight's rendering windows are based on a framework called CVF. This framework
provides an abstraction for all user input events. These event types give a Python
callback the opportunity to see these low-level device events. It also gives the callback
the opportunity to suppress the handling of these events by the normal EnSight
handlers. This can be useful for applications that decide they want specify control
over user input in the graphics windows or want to override the default EnSight
behavior for types of interaction. If the callback for one of these events returns the
integer value 1, the event will not be passed on to EnSight. A return value of 0 will
allow normal EnSight event processing to occur.
ensight.ENS_EVENT_MOUSE_BUTTON_DOWN
The passed value will be the list: [ENS_EVENT_MOUSE_BUTTON_DOWN, button,

buttonstate, modifiers, x, y]
ensight.ENS_EVENT_MOUSE_BUTTON_UP
The passed value will be the list: [ENS_EVENT_MOUSE_BUTTON_UP, button,

ensight.ENS_EVENT_MOUSE_DOUBLE_CLICK
The passed value will be the list: [ENS_EVENT_MOUSE_DOUBLE_CLICK, button,

ensight.ENS_EVENT_MOUSE_MOTION
The passed value will be the list: [ENS_EVENT_MOUSE_MOTION, buttonstate,

modifiers, x, y]
ensight.ENS_EVENT_WHEEL_MOTION
The passed value will be the list: [ENS_EVENT_WHEEL_MOTION, val, dir,

modifiers, x, y]
ensight.ENS_EVENT_KEY_DOWN
The passed value will be the list: [ENS_EVENT_KEY_DOWN, key, modifiers,

x, y]
ensight.ENS_EVENT_KEY_UP
The passed value will be the list: [ENS_EVENT_KEY_UP, key, modifiers,

x, y]
ensight.ENS_EVENT_6D_MOTION
The passed value will be the list: [ENS_EVENT_6D_MOTION, tracker]

ensight.ENS_EVENT_6D_BUTTON_DOWN
The passed value will be the list: [ENS_EVENT_6D_BUTTON_DOWN, tracker]

ensight.ENS_EVENT_6D_BUTTON_UP
The passed value will be the list: [ENS_EVENT_6D_BUTTON_UP, tracker]

ensight.ENS_EVENT_6D_VALUATOR
The passed value will be the list: [ENS_EVENT_6D_VALUATOR, valuator,

value]
ensight.ENS_EVENT_DRAWABLE_RESIZ
The passed value will be the list: [ENS_EVENT_DRAWABLE_RESIZE]

ensight.ENS_EVENT_DRAWABLE_EXPOSE
The passed value will be the list: [ENS_EVENT_DRAWABLE_EXPOSE

ensight.ENS_EVENT_DRAWABLE_SHOW
The passed value will be the list: [ENS_EVENT_DRAWABLE_SHOW]

ensight.ENS_EVENT_DRAWABLE_HIDE
The passed value will be the list: [ENS_EVENT_DRAWABLE_HIDE]

ensight.ENS_EVENT_DRAWABLE_FOCUSIN
The passed value will be the list: [ENS_EVENT_DRAWABLE_FOCUSIN]

ensight.ENS_EVENT_DRAWABLE_FOCUSOUT
The passed value will be the list: [ENS_EVENT_DRAWABLE_FOCUSOUT]

ensight.ENS_EVENT_DRAWABLE_ENTER
The passed value will be the list: [ENS_EVENT_DRAWABLE_ENTER]

ensight.ENS_EVENT_DRAWABLE_LEAVE
The passed value will be the list: [ENS_EVENT_DRAWABLE_LEAVE]

ensight.ENS_EVENT_DRAWABLE_SAVE
The passed value will be the list: [ENS_EVENT_DRAWABLE_SAVE]

ensight.ENS_EVENT_DRAWABLE_RESTORE
The passed value will be the list: [ENS_EVENT_DRAWABLE_RESTORE]
The x and y values are the location of the cursor at the time of the event. Generally,
the button value will be one of (ensight.ENS_BUTTON_LEFT, en-
sight.ENS_BUTTON_RIGHT, ensight.ENS_BUTTON_MIDDLE, en-
sight.ENS_BUTTON_WHEEL), while buttonstate is the arithmetic or of these
values together for the current state of all the buttons. The modifiers values will be
the arithmetic or of none or some of the following values: ensight.MODIFI-
ER_CTRL , ensight.MODIFIER_SHIFT , ensight.MODIFIER_ALT .
Timer events
ensight.ENS_EVENT_TIMEOUT
This is a special case in that it requires an extra timeout argument to addcall-

back(). Registering for this event type schedules a periodic callback to the Python
code from EnSight every timeout seconds (timeout is a float). ENS_EVENT_ALL
callbacks are not called for ENS_EVENT_TIMEOUT events.
err = ensight.removecallback(ID)
This method removes the previously registered callback function.
suppressed = ensight.sendevent( python_list [,filter=f][,deferred=d] )

This method works in conjunction with ensight.ENS_EVENT_PYTHON. When
this function is called from the EnSight Python interpreter, all of the callback functions
that were associated with ENS_EVENT_PYTHON are called with the Python list
object passed to this function as a parameter. If a callback returns the value of 1,
then the list is not passed to any additional callback functions of this type and
sendevent() returns 1. This mechanism is used to allow multiple objects running
within the EnSight Python interpreter to communicate with each other and pass
data, messages, etc back and forth within EnSight. By default, this is a synchronous
call, so callback functions that themselves call sendevent() must take care to
ensure that their callback function is reentrant. The user may also specify the de-
ferred= keyword to make the callback asynchronous. If deferred is set to 1, this
function will return immediately, but will queue up the callback for later execution.
A the next point where EnSight becomes idle the callbacks will be executed. This
can be very useful in breaking circular callback loops. By default, the python list
object is sent to all methods registered for the ENS_EVENT_PYTHON callback. The
filter= keyword can be used to select a specific subset of registered methods be
called instead of all of them. The filter keyword works in conjunction with the filter
parameter to ensight.addcallback() to create private communications
channels. The ensight.query(ensight.UNIQUE_ID) call can be used to
generate guaranteed unique numbers that can be used for filter values at runtime
to avoid colliding with other applets which may also use this mechanism.
8.2. EnSight Object API

Starting in EnSight 9.0, EnSight has added a new Python API based on the intrinsic objects inside of
the EnSight core. This API targets applications developers that wish to build more complex applications
on top of the EnSight Qt and Python interfaces. This API is utilized by EnSight itself internally. The API
is much larger than the previous API and the documentation would not fit easily into these documents.
Furthermore, the API is not yet complete and ANSYS reserves the right to change anything in the API
without warning at this point in time. Many folks have asked for access to this API, even though it is
not yet complete. ANSYS does not offer formal support for any of the Object API interfaces at this point
in time. We will take bug reports, but due to the nature of the API, we are not providing normal support
services.
ANSYS provides two locations for information on the API. First, in the user-defined tools, there is a tool
located under Utilities/Development named "Python Object API". This tool allows the user to browse
the various classes available and their attributes/methods. The tool is self-documenting in that all the
information it displays is generated from the core objects at runtime. There is also a website https://
nexusdemo.ensight.com/docs/python/html/Python.html that contains additional information about the
various APIs. The website is dynamically updated and interested parties can subscribe to changes via
RSS feeds.
8.3. EnSight Extension Mechanism

A number of features of EnSight are written as extensions in Python or command language. In EnSight,
this system has been written to more fully integrate graphical user interface objects and command
language extensions into EnSight. The extension framework itself is written in Python and resides in
$CEI/ensight201/site_preferences/extensions. This directory contains two directories:
core and user_defined. The core directory contains the Python implementation of all of the base
classes described here. The user_defined directory contains the various EnSight extensions that are
loaded on startup. At least two replacement Graphical User Interface extensions, ten Tools and a large
number of Menus are included by ANSYS in the distribution. The source code to these are an extremely
valuable reference to the extension developer.
8.3.1. Startup Process

At startup, EnSight builds a default sys.path which includes $CEI/ensight201/site_prefer-
ences/extensions as well as EnSightDefaultDirectory/extensions (if it exists). En-
SightDefaultsDirectory is %HOMEDRIVE%%HOMEPATH%\(username)\.ensight201
commonly located at C:\Users\username\.ensight201 on Vista and newer Windows Operating
Systems, C:\Documents and Settings\yourusername\.ensight201 on older Windows,
and ~/.ensight201 on Linux, and ~/Library/Application Support/ensight201 on
the Mac. It will also add any directories specified by the CEI_PYTHONPATH environmental variable.
This variable may contain multiple directory names, separated by a : under UNIX operating systems
and a ; under Windows.
EnSight scans in sys.path, looking for entries that end in the name 'extension'. If any subdirectory
of an extension directory contains an __init__.py file, the subdir is 'import'ed into the module
ensight.ext (note: ensight.ext.__path__ is modified to include the extensions dirnames).
If a user has common Python utilities or a startup script, it can be added as a module to the internal
Python interpreter via this mechanism.
EnSight Extension Mechanism
8.3.2. Formal EnSight Extensions

EnSight supports the concept of a formal extension. An extension to EnSight is a subclass of one of
the base-classes of the extension framework. Common extensions are for user-defined menus or tools
and to replace the EnSight graphical user interface itself. All extensions include a mechanism to extend
EnSight command language to include custom batch scripting and action logging. EnSight looks for
extensions by scanning all of the .DEFINE, .py and .enc files located in subdirectories rooted by
a subdirectory of a sys.path extension directory (as described above) named user_defined
for specially formatted comment blocks. There are two comment block forms for Legacy and Direct
load extensions.
Legacy Extensions
Legacy extensions can include operations written in command language or Python. The comment
block in each of these extensions has the general form:
#ENSIGHT_USER_DEFINED_BEGIN
#TEXT=name used for GUIs
#TOOLTIP=text displayed in tooltips
#ICON=name_of_an_iconfile.png
#NAME=simplename
#DESC=text description of the item
#TYPE=TOOL,MENU,TOOLDIR,MENUDIR
#MODE=All,Part,Annot,Plot,VPort,Frame
#PTYPE=All,None,Mixed,Model,ClipPlane,Contour,Discrete-
Particle,Frame,IsoSurface,ParticleTrace,Profile,VectorArrow,ElevatedSur-
face,DevelopedSurface,ModelExtract,ModelCut,ModelBoundary,Iso-
Volume,BuiltUp,TensorGlyph,FxVortexCore,FxShock,FxSepAtt,MaterialInter-
face,Point,AxiSymmetric,ModelMerge,Mult
#ENSIGHT_USER_DEFINED_END
Most of these fields are optional. If they are included in a .py or .enc file, they inform EnSight that
these are TOOL or MENU extensions (depending on the TYPE= value). EnSight will build an extension
object (a subclass of the tool_extension or menu_extension classes) for the file and if the
extension is executed, the contents of the file will be executed. When it is run, the directory containing
the file will be added to sys.path temporarily.
MODE= and PTYPE= fields are used for filtering the display of the item depending on the current
state of EnSight (what mode and what type of parts are selected).
A file named menu.define or tool.define can contain just this comment block, but uses the
type TOOLDIR or MENUDIR. If this file exists, the other commented files are included as GUI children
of that object. The loader will instantiate a class of the proper type: menu_extension or
tool_extension and registers it with EnSight. The registration operation has two parts. First, the
class is stored under the proper key in the dictionary ensight.core.extensions so that object
can query and use the various extensions. Second, the register method is called on the base class
(core_extension). This methods registers a method on the object as a the command language
extension. Therefore, an object with the name foo that is a child of an object with the name bar will
be able to generate command language of the form ext: bar.foo string. It is also able to
handle the playback of such strings by overriding the base class.
Direct Loaded (Python) Extensions

Direct load extensions can only be written in Python and have a number of advantages over Legacy
extensions, including private namespaces in both Python and command language. Developers are
encouraged to use this form of extension whenever possible as it avoid potential namespace collisions
both in Python and EnSight. To use this mechanism, the developer writes their own subclass(es) of
the appropriate extension base class(es). They then add a comment block to the top of the Python
source code file that looks like this:
#ENSIGHT_USER_DEFINED_BEGIN
#FACTORY=function_name
#ENSIGHT_USER_DEFINED_END
In this case, the file will be imported and the function function_name() will be invoked with a
single parent parameter. The function should create all of the instances of the extension class objects
needed and return them as a Python list.
Note:
The function_name() should also do any parent adding for the objects it wants
before returning them. The calling system will register the objects in the returned list
and insert them into the ensight.core.extension dictionary. When this file is
imported, the directory it is in will have been added to the sys.path variable.
8.3.3. Extension Base Classes

The extension mechanism is based on Python subclasses. All extensions subclass from a code base
class. This class provides two important features. First, each extension is in a private namespace in
Python, allowing each one to have its own global variables. Second, each extension is given part of
the command language namespace complete with methods to generate custom command language
and replay it. The simplest extension just extends command language with a new command (note:
in command language, all extensions appear as: ext: namespace string). The base classes are core,
guibase, gui, tool and menu.
core_extension class
Basic extension of the command language (type = "core"). Override the cmdExec() and cmdRe-
cord() methods to generate your own command language extensions.
Data Members
_version : version number
_path : path to the file defining this extension
_name : name for purposes of Python/cmdlang namespaces (no spaces, odd chars, etc)
_text : Display name of the extension (spaces allowed)
_desc : ASCII description of the extension (spaces allowed)
_namespace : actual cmdlang namespace (e.g. ext: namespace foo)
_children : list of children of this extension
Member Functions
addChild(child) : add a child
setDesc(text)
setSort(text) : set the menu sorting value for this extension
cmdExec(string) : called back when cmdlang sees ext: namespace foo String will be foo
cmdRecord(string) : call to record command language ext: _namespace string
guibase_extension class (subclass of core_extension)

This class adds common GUI elements such as itcons and tooltips (type = "guibase"). In general, user
defined extensions should not subclass this class directly.
Member Functions
setInMenus(v) : Set the state of dynamic menu visiblity
getInMenus() : True if this extension should show up in any dynamic menus
setTooltip(text) : the text for the tooltip
setIcon("pathname") : filename for the icon, can be a resource reference (e.g. ":/ensight/...")
getWidget(w,parent) : return the widget representation of the object. This method is overridden
by subclasses
setWaitCursor(onoff) : display/clear the hourglass cursor for this extension
gui_extension class (subclass of guibase_extension)

A full user-defined GUI (type = "gui"). Subclass this class to completely replace the EnSight GUI with
your own GUI.
Note:
The cmdExec method has been overridden to include activate_gui.
Member Functions
setSplash(pathname) : pathname to an SVG file to use as the splash screen
doActivate(onoff) : called to enable/disable this graphical user interface must be overridden,

returns False on failure.
doErrorMessage(message,style) : called when EnSight throws an error or needs a Yes/No

question, must be overridden.
doGuiEvent(message,targetlist) : called when there is a graphical user interface event,

must be overridden.
Useful Module Functions
These functions can be used directly by applications that want to interact with the core graphical
user interface and its events.
ensight.core.gui_extension.gui_activate(name)
gui=ensight.core.gui_extension.current_active_gui()
ensight.core.gui_extension.error_message(msg,what)
ensight.core.gui_extension.gui_event(msg,targets)
tool_extension class (subclass of guibase_extension)

Baseclass for an EnSight user-defined tool (type = "tool"). All tool extensions must subclass from this
class.
Member functions
run() : This function is called when the tool is invoked. The function must be overridden.
menu_extension class (subclass of guibase_extension)

Baseclass for an EnSight popup menu (type = "menu"). All menu extensions must subclass from this
class.
Data Members
_info : the dictionary of values resulting from the mousedown that triggered this menu
Member Functions
setSeparator(boolean) : set to true if this menu is a separator
setMode(mode) : a string containing the mode names for this menu to be displayed in. Concatenated
from: Part,Annot,Plot,VPort,Frame,All
setPartType(type) : a string containing the part types for which this menu is to be displayed.
Concatenated from: All,Model,ClipPlane,Contour,DiscreteParticle,Frame,IsoSur-
face,ParticleTrace,Profile,VectorArrow,ElevatedSurface,DevelopedSurface,Model-
Extract,ModelCut,ModelBoundary,IsoVolume,BuiltUp,TensorGlyph,FxVortexCore,Fx-
Shock,FxSepAtt,MaterialInterface,Point,AxiSymmetric, ModelMerge,Mult
validFilter(self,emode,ptype) : return 1 if this menu should be shown. By default, it filters

using the mode and parttype values as noted above, however for general filtering, one ma override
this method.
run() : override this method do what this menu should do when selected.
the _info attribute is set to the context of the operation that started the menu operation. It is a
dictionary. Some fields are pre-defined, depending on the EnSight RMB context.
The pre-defined _info fields are:
Common to All Modes
pick: the click target
pos: the (x,y,z) tuple of the click in data space
target: list of ensight object references that are the action target (list can be empty)
mousepos: (x,y) position tuple in the graphics window of the mouse down (normalized coords). -1,-
1 if there is no position or one is not in the window.
pick: CVF_CURSOR_TOOL
pick: CVF_LINE_TOOL
'item': The part of the line clicked: CVF_EVENT_LOCAT_MID, CVF_EVENT_LOCAT_END2,

CVF_EVENT_LOCAT_END1, CVF_EVENT_LOCAT_XAXIS, CVF_EVENT_LOCAT_YAXIS,
CVF_EVENT_LOCAT_ZAXIS
pick: CVF_PLANE_TOOL
'item': The part of the line clicked: CVF_EVENT_LOCAT_MID, CVF_EVENT_LOCAT_UPPER_RIGHT,

CVF_EVENT_LOCAT_LOWER_LEFT, CVF_EVENT_LOCAT_LOWER_RIGHT, CVF_EVENT_LOCAT_UPPER_LEFT,
CVF_EVENT_LOCAT_XAXIS, CVF_EVENT_LOCAT_YAXIS, CVF_EVENT_LOCAT_ZAXIS
pick: CVF_CYLINDER_TOOL

CVF_EVENT_LOCAT_ZAXIS, CVF_EVENT_LOCAT_RADIUS
pick: CVF_CONE_TOOL

CVF_EVENT_LOCAT_ZAXIS, CVF_EVENT_LOCAT_RADIUS
pick: CVF_SPHERE_TOOL

pick: CVF_REVO_TOOL

pick: CVF_POLYLINE
'item': The spline number clicked on
'point': The index into the spline knot points
pick: CVF_LEGEND
'item': The palette id
'component': The palette id component (for vectors)
pick: CVF_ANNOT
'item': The annotation id (the target object has the type implicitly)
pick: CVF_PART
'item': The part id
pick: CVF_VIEWPORT
'item': The viewport id
pick: CVF_PLOTTER
'curve': The curve number clicked on
'value': The (f,x) value at the clicked point
'_prepick_': This key is optional. If set to the name of a user-defined menu, the doPopup() function
will not display any menus. Instead, it will call the 'run()' method on the first menu with that name.
This mechanism makes it easy to execute a menu in a given spatial context.
Useful Module Functions
core.userdefinedmenus.doPopup(infodict) : popup the current RMB menu at the mouse.

You must pass a proper info dictionary (see: _info above)
With this function, the caller needs to create the _info dictionary. One special key has been defined:
'mode'. If this key is present, it will override the current EnSight mode value for validFilter()
filtering. An example using this function would be:
dict = {'pick': ensight.CVF_PART, 'item': partid, 'target': partobj,
'pos': (0,0,0), 'mousepos': (-1,-1) }
ensight.core.userdefinedmenus.doPopup(dict)
Helper Modules
Internationalization and EnSight Extensions

The EnSight core includes an instance of the CEItranslate object. It can be accessed as: en-
sight.core.tr. When the ensight.core module loads and scans the directories for extensions,
it also scans for any *.qm files and automatically registers them with ensight.core.tr. Thus, if
you have internationalized an extension GUI (or any other Qt/PyQt GUI), simply place the translation
files in the extensions directory and they will be loaded. When the QApplication instance is created,
ensight.core.tr.changelang() is called. If the user has set CEI_LANG (or the host system
has a language set), the translation files for that language are automatically loaded. CEI_LANG should
be set to the two character ISO 639 code for the target language. See http://en.wikipedia.org/wiki/
List_of_ISO_639-1_codes for more information.
In Python code, you can trap and handle dynamic language changes by including the following
method to your top level widget:
# i18n bits: handle dynamic language changes
def changeEvent(self, event):
if (event.type() == QtCore.QEvent.LanguageChange):
self.retranslateUi(self)
QtGui.QMainWindow.changeEvent(self, event)
Note:
You may need to change QMainWindow to the appropriate classname. The 'self.re-
translateUi()' call should be replaced with whatever function regenerates the
graphical user interface text contents on your system (it may be more than one call to
auto-generated retranslateUi() methods.
8.4. Helper Modules

ANSYS has included a number of helper modules that wrapper common functions. These are included
in a couple of different modules. Python developers are encouraged to familiarize themselves with
these modules and their functions as they can save a great deal of development time and provide a
more consistent user experience.
'ensight.core' module
This module include a number of image saving and printing functions that implement standard GUI
menus.
CeiEnSightPrintWindow() class for rasterizing and printing (in qtimageutils.py)
CeiEnSightCopyWindow() copy to clipboard (in qtimageutils.py)
CeiEnSightSaveImage() save image to disk (in qtimageutils.py)
CeiEnSightImportImageAnnot() import image file/movie as an annotation (in qtimageut-

ils.py)
In the core, there are some useful items (created by __init__.py). ensight.core.ENS_stdout_in-
stance/ENS_stderr_instance are the wrappers for the Python interpreter output. EnSight has
'resume()' and 'suspend()' methods which allows output to be redirected to the console instead
of the command dialog Python tab. There is also a dictionary 'ensight.core.extensions'. The
keys of the dict include menu, tool, core, gui and each points to a list of instances of object of the
class xxxx_extension's that were created on startup.
cei module
This module includes a number of common functions that are not generally EnSight specific. They are
used in tools like EnVe, but can be used by any EnSight Python application.
CeiPrintDlg() class for PyQt based rendering and printing of the main window (in printdlg.py)
CeiQtImageFormatOptions() class for prompting the user for UDIL selection/options (in qtimg-
formats.py)
CeiQtSaveImage() class to prompt the user for a complete set of image size/saving options, including
the render and save) (in qtimgformats.py)
CeiPlot() classes to wrapper matplotlib. Create a graph and save it to disk (in plots.py)
CeiQtPlotWindow() class providing a dockable Qt4 widget that contains a CeiPlot object, including
copy and print operations (in qtplots.py)
CEItranslate() class that acts as a repository for .GM translation files and allows for dynamic
changing of the language for all objects as well as a method to get a language menu (in qtlan-
guage.py)
ceisplash() class to manage a splash screen from a .SVG file (in ceisplash.py)
CeiLogging() and logging shortcuts (in ceilogging.py)
CeiQtGenericDialog() class that generates dynamic dialogs from simple lists and prompts the
user for values. It can handle things like text, checkboxes, ints, floats, variables, parts, option menus,
strings, filenames, etc (in qtgenericdlg.py).
Chapter 9: EnVe Module
Introduction
EnVe refers to two entities. First EnVe refers to the enve extension module within EnSight which includes
programming routines for manipulating images and movies. Second EnVe refers to an interactive ap-
plication with a graphical User Interface that is built upon the image and movie manipulation extension
module. The enve extension module will be discussed first, followed by the EnVe application.
The EnVe extension module can be imported into an EnSight python routine to make use of two main
Python objects: the image and the movie objects to access low-level manipulation methods. These
methods are discussed in detail in then next section. If you wish to use the low-level image and movie
methods, the enve module can be imported into your EnSight python code with the following statement
at the top:
import enve
Higher level manipulation routines that both provide high-level movie and image functionality as well
as serve as enve tutorial routines, have been included with your EnSight install as an ens_utils
module.
Note:
You cannot use the ens_utils module outside of EnSight. To use these routines,
simply import the ens_utils module as follows:
These routines translate movies and images to another format, they concatenate movies or images into
another movie of a chosen format, they difference images or movies and return the statistics on the
differences and/or write out the difference as an image or movie, respectively. Example usage of these
routines will be discussed in a bit more detail in the next section. The ens_utils module is located
as follows:
$CEI/ensight201/site_preferences/extensions/ens_utils.py
The second major entity is the EnVe interactive application. It is built on the PyQt (Python interface to
the Qt GUI library) module and the enve module. This application allows interactive loading and
modification of images and movies and can be accessed by typing in the following at the command
line:
enve
Alternatively, double-clicking the EnVe 2020 R1 icon on your desktop will start up the application.
Studying and using the enve modules as well as their usage in the ens_utils module will help you
to understand the EnVe application's options and using the EnVe application will help you understand
the EnVe modules.
EnVe Module
EnVe Extension Module Programming (p. 388)
EnVe Python ens_utils module (p. 388)
The EnVe Movie object (p. 393)
The EnVe Image object (p. 399)
EnVe Application (p. 408)
Helper modules (p. 416)
Important:
The current codec for writing mp4 files does not properly read them. Therefore you can write
mpeg4 files, including those using the H264 standard, but will often fail at reading them into
EnVe and also into the enve module.
9.1. EnVe Extension Module Programming
EnVe Python ens_utils Module

The ens_utils module is a collection of high-level EnSight and EnVe routines available to speed up
your programming workflow. These modules fit between the EnVe application and the enve module:
they do some of the high-level manipulations of the EnVe application while they are still useable in
your EnSight Python code. The code in the ens_utils.py module also serves to illustrate the usage
of the low-level movie and image functions. These routines can enhance your post-post processing
productivity. For example, you might want to convert a number of files into a movie. You would simply
import the ens_utils module and find your module from the description below and use it. Or, look
it up in the python source to see how it works if you want to understand the enve module in detail
in action.
The ens_utils module is included in the following directory.
$CEI/site_preferences/extensions/ens_utils.py
and is easily imported as follows:
Edit the ens_utils.py and find the enve routines and take a look at them as they are discussed
below. The detailed, low-level enve functions that are used will be discussed in the movie and image
sections below.
A Dictionary of the Codecs: eu.codec_dictionary()
The enve module has a number of codecs designed to read and write movies and images. All of the
packages installed with EnSight (EnVe, EnVideo and EnSight) use these codecs, so that you are guaranteed
to be able to read and write your movies and images on all platforms that we support. So the first thing
you might need to do is to get a listing of the supported codecs and the extensions. The second thing
you might want to do is to get a listing of what options are available for controlling the output of each
of these formats. To use it in your python, do the following:
EnVe Extension Module Programming
# Get a dictionary of all codecs
cdict = eu.codec_dictionary()
cdict['name'] will have a list of all of the codec names:
['AVI', 'BMP', 'EVO', 'FLV', 'GIF', 'JPG', 'MPEG', 'MPEG4', 'PNG', ...]
cdict['ext'] will provide a list of all the appropriate extensions for each of these names:
Note:
Some codec names have multiple extensions
[['.avi'], ['.bmp'], ['.evo'], ['.flv'], ['.gif'], ['.jpg', '.jpeg'],

['.mpg', '.mpeg', '.mp4'], ['.mp4'], ['.png'],...]
cdict["name"][0] is the codec name with the extensions in cdict["ext"][0]: 'AVI'

corresponds to the '.avi' extension
Take a look at the comments in the ens_utils.py file for the codec_dictionary() function as
follows:
###################################################################
#
# returns an enve codec dictionary
# IN
# If both inputs are empty (default) then you get a list of ALL
# enve codecs
# If name OR ext are defined then you get a list of codecs that
# match either.
# name = codec name, e.g. 'MPEG4', 'PNG'. Note since codec names are
# all CAPITAL letters the name is converted to all upper
# prior to comparison, so it is case insensitive
# ext = codec suffix e.g. '.mpg', '.png'. Note since all codec
# suffixes start with a '.', a missing '.' is added prior to
# comparison and all ext are converted to lower so it is
# case insensitive.
# the_type = 'movie' - returns only movie formats that can store
# multiple frames in one file
# 'image' - returns only image formats that can store
# one frame per file
# 'all' - returns both movie and image formats
#
# OUTPUT
# A Dictionary with the following KEYS:
#
# 'name' - a list of all the codec names available
# 'ext' - a list of lists of recognized extensions
# corresponding to the name list above
# 'desc' - a list of detailed descriptions of the
# codecs corresponding to the name list abvoe
# 'stereo' - a list of True or False whether the codec
# supports stereo
# 'single file' - a list of True or False whether the
# True means all frames in one file
# False means one frame per file
EnVe Module
# 'options' - a list of lists corresponding to the codec

# name list as follows:
# [[name,'type',[choices], default, detailed descrip],
# [name2, 'type',[choices], default, detailed descrip],... ]
# name is the option name
# 'type' is 'BOOL', 'INT', 'FLOAT', 'CHOICE'
# [choices] is
# [0,1] for BOOL
# [min,max] for INT or FLOAT (a range of choices)
# ['choice1', 'choice2',...'choiceN'] a list of text choices for CHOICE
# default is the default choice for this option
# detailed description is the complete option description
#
def codec_dictionary(name="", ext="", the_type='all'):
Mapping Name to File Extension: get_codec_extension and get_codec_name
Sometimes it is useful to parse a filename extension and then ask enve if it has a codec for that exten-
sion. Or, if you are going to save an image, the enve image save decides on what codec to use based
on the filename extension, so you want to be able to name the file appropriately prior to saving it.
print("\n\nName to Extension")
for cdt in cdict['name']:
print("{} {}".format(cdt, eu.get_codec_extension(cdt)))
print("\n")
print("\n\nExtension to Name")
for ext in cdict['ext']:
for ee in ext:
print("{} {}".format(ee, eu.get_codec_name(ee)))
print("\n")
Has the following output

Name to Extension
AVI ['.avi']
BMP ['.bmp']
EVO ['.evo']
FLV ['.flv']
GIF ['.gif']
JPG ['.jpg', '.jpeg']
MPEG ['.mpg', '.mpeg', '.mp4']
MPEG4 ['.mp4']
PNG ['.png']
PPM ['.ppm', '.pgm', '.pbm', '.pnm']
MOV ['.mov']
SGI ['.rgb', '.bw', '.sgi']
SM ['.sm']
SWF ['.swf']
TIFF ['.tif', '.tiff']
XPM ['.xpm']
Extension to Name
.avi AVI
.bmp BMP
.evo EVO
.flv FLV
.gif GIF
.jpg JPG
.jpeg JPG
.mpg MPEG
.mpeg MPEG
.mp4 MPEG
.mp4 MPEG
.png PNG
.ppm PPM
.pgm PPM
.pbm PPM
.pnm PPM
.mov MOV
.rgb SGI
.bw SGI
.sgi SGI
.sm SM
.swf SWF
.tif TIFF
.tiff TIFF
.xpm XPM
Print out Movie Codecs and Image Codecs: eu.codec_dictionary()

print("\n\nImage formats:")
print(eu.codec_dictionary("","","image"))
print("\n\nMovie formats:")
print(eu.codec_dictionary("","","movie"))
Convert a movie from one format to another
eu.convert_movie
# and convert the original evo file to all other movie types:
# out_mov.evo, out_mov.avi, out_mov.mpg, etc.
in_mov = "/path/file.mp4" # full filename with extension
out_pref = "/path/new_file" # file prefix
out_form="AVI" # one of the allowable formats
ret_val = eu.convert_movie(in_mov, out_pref, out_form)
Code Comment Details

#
# This will convert a movie
# opts is a text string: "optname optchoice optname2 optchoice2"
# example for AVI: 'Compression MPEG4V2 BitRate 20000 '
#
def convert_movie(infile, outfile_prefix, out_format='EVO', opts=""):
Get Movie Info Metadata: eu.get_movie_info

in_mov = "C:/Users/ensight/Documents/test.evo"
in_mov_info = eu.get_movie_info(in_mov)
for ky in in_mov_info.keys():
print("# {} {}".format(ky, eu.get_movie_info(in_mov)[ky])
Prints out the following
# nframes 21
# stereo 0
# repeat [0, 0]
# format EVO
# flip 0
# anaglyph 0
EnVe Module
# filename C:/Users/ensight/Documents/test.evo
# realframes 21
# dims [737, 768]
# intensity [1.0, 1.0]
# framerange [0, 20]
# fps 30.0
# tiling [1, 1]
# options
Extract out a Movie Frame: eu.extract_frame()

# Extract second to last frame
# of a movie and write out as PNG
in_mov = "C:/Users/ensight/Documents/test.evo"
out_prefix = "C:/Users/ensight/Documents/test2"
mi = eu.get_movie_info(in_mov)
fn = mi['nframes'] - 1 # second to the last frame
eu.extract_frame(in_mov, out_prefix ,fn, "PNG")
Make a List of Images into a Movie: eu.images_to_mov()

# read in a bunch of tif images
# and write them into each and every one of the
# supported movie formats
#
# get info on all movie codecs
mdict = eu.codec_dictionary("","",'movie')
# This searches out_dir for all the tif files
file_list = eu.search_tree(out_dir,".tif",1)
print(file_list)
mv = "EVO"
eu.images_to_mov(file_list, out_dir+"mov_tiff", mv)
Concatenate List of Movies & Convert Them to a New Format: eu.concatenate_movies()

infile_list = ["/path/mov.avi","/path/mov.mp4",...]
out_file_prefix = "/newpath/new_prefix"
eu.concatenate_movies(infile_list, outfile_prefix, out_format="EVO")
Do a Diff of Two Movies Frame by Frame and Write out a New Movie: eu.movie_compare()
mov1 = "/path/mov.avi"
mov2 = "/path/mov.mp4"
out_diff_prefix = "/path/mov_diff"
eu.movie_compare(mov1,mov2,out_diff_prefix,"EVO")
Convert an Image to a Different Format: eu.convert_image()

img = "/path/img.png"
out_diff_prefix = "/path/new_image"
new_format = "JPG"
eu.convert_image(img,out_diff_prefix,new_format)
Get an Image from EnSight Graphics Window & Return enve Image: eu.get_ens_image()
img = eu.get_ens_image()
Get a Dictionary of Info About an enve Image: eu.get_image_info()

idict = eu.get_image_info(img)
print(idict['dims'])
Compare Two Images by Doing a Diff on the Pixel by Pixel Diff: eu.image_compare()
img = "/path/img.png"
img2 = "/path/img2.png"
outfile = "/path/out_diff.png"
stat_dict = eu.image_compare(img1,img2,outfile)
print(stat_dict)
Save an Image with a Transparent Background: eu.get_ens_image_trans()

outfile = "/path/out_trans_bck.png"
env_img = eu.get_ens_image_trans(outfile,annots=’dark’)
Tiling Two Movies or Images: eu.movies_tile_mtm()
This will write out an .MTM file that can be read into EnVideo to show two movies adjacent to each
other. The default is to write an .MTM file with movies side by side. The movies must have the same
number of frames. Mismatch
infile_list = ["/path/file1.evo","/path/file2.evo"]
out_file_prefix = "/path/file_mtm"
err = eu.movies_tile_mtm(infile_list,out_file_prefix)
The EnVe Movie Object

This section will discuss the portion of the enve module that handles movies. The movie object is
created in READ or WRITE mode. In normal operation, the various movie attributes are set after creation
and then the object is open()ed to begin the I/O process. Once the file is open, some attribute values
will change to match the actual values in the files and some attributes will become read only until the
file is closed. Movie objects are associated with a filename. They contain a number of images that can
be read as well as attributes like dimensions, frames per second and stereo.
The movie object is used to open and read from or write to animation files. A simple function for
reading a movie in one format and writing it to another format is shown below. It allows changing the
options.
import enve
#
# This will convert a movie
# opts is a text string: "optname optchoice optname2 optchoice2"
# example for AVI: 'Compression MPEG4V2 BitRate 20000 '
def convert_movie(infile, outfile_prefix, out_format, opts=""):
EnVe Module
in_mov = enve.movie(enve.MOVIE_READ)
out_mov = enve.movie(enve.MOVIE_WRITE)
in_mov.filename = infile
out_mov.filename = outfile_prefix
in_ret = in_mov.open()
if in_ret != 0:
print("Failure to open input movie")
print("'{}'".format(infile)
return in_ret
else:
out_mov.format = out_format
if len(opts) > 0:
out_mov.options = opts
out_mov.addcount(in_mov)
out_mov.open()
out_mov.append(in_mov)
out_mov.close()
in_mov.close()
#
filename1 = r"C:\Users\ensight\Documents\test.evo"
filename2 = r"C:\Users\ensight\Documents\test_out"
# example options for AVI
options = 'Compression MJPEG BitRate 30000 '
convert_movie(filename1,filename2+"AVI_demo","AVI",options)
# this will step through all the available formats and convert the
# test.evo file to test_out.suffix where suffix is the format suffix
# Note if the output format is an image format then only a single image of the
# last timestep will be saved.
#
clist = enve.codecs()
for cc in clist:
convert_movie(filename1,filename2,cc[0])
Here is an example of loading a series of .PNG images and writing them out as an .EVO movie.
import enve
#
# Sequentially numbered images can be read directly as
# a movie using '#' characters as the numerical field
# and an '@' character where the 'l','r' characters go.
#
# Convert images named: sample00.png, sample01.png, ...
#
mov = enve.movie(enve.MOVIE_READ)
mov.filename = r"d:\Users\rjfrank\Desktop\stereo\sample##.png"
err = mov.open()
if (err == 0):
evo = enve.movie(enve.MOVIE_WRITE)
evo.filename = r"d:\Users\rjfrank\Desktop\stereo\sample_output"
evo.format = "EVO"
evo.stereo = mov.stereo
evo.addcount(mov)
err = evo.open()
if (err == 0):
evo.append(mov)
else:
print("Error: {}".format(evo.errstr()))
evo.close()
mov.close()
else:
print("Error: {}".format(mov.errstr()))
#
# A stereo example: files00l.png, files00r.png, files01l.png,
# files01r.png, ...
#
mov.filename = r"d:\Users\rjfrank\Desktop\stereo\files##@.png"
# once you open the move below, you write the header
err = mov.open()
if (err == 0):
evo.filename = r"d:\Users\rjfrank\Desktop\stereo\sample_output_stereo"
evo.format = "EVO"
evo.addcount(mov)
err = evo.open()
if (err == 0):
evo.append(mov)
else:
evo.close()
mov.close()
else:
print("Error: {}".format(mov.errstr()))
Here is another example that creates a movie.

import enve
#
# Generic examples using naturally ordered images.
# Note: this approach handles the case where the sizes
# of the images might differ as it is not legal to have
# frames of different sizes in a movie. movie.append(image)
# will rescale each image to match the dimensions of the
# output movie.
#
import glob
# Get a list of filenames and sort them alphabetically
wildcard = r"d:\Users\rjfrank\Desktop\stereo\sample*.png"
filenames = glob.glob(wildcard)
filenames.sort()
# start the output movie
evo.filename = r"d:\Users\rjfrank\Desktop\stereo\sample_natural"
evo.format = "EVO"
# set the size of the frames using the first image
# the other images will be scaled to the size of this image
img = enve.image()
err = img.load(filenames[0])
if (err != 0):
print("Unable to set output movie size")
evo.dims = tuple(img.dims)
# set the number of frames
evo.addcount(len(filenames))
# process all images
err = evo.open()
if (err == 0):
for file in filenames:
err = img.load(file)
if (err != 0):
print("Error reading: {}".format(file))
err = evo.append(img)
evo.close()
else:
Here is an example that creates a stereo movie.

import enve
#
# Example of image processing on a movie to create
# another. In this example, if the source movie is
# in stereo, it will swap the right and left images.
#
mov.filename = r"d:\Users\rjfrank\Desktop\stereo\stereo_example.evo"
mov.open()
# Note: the extension is added automatically.
EnVe Module
evo.filename = r"d:\Users\rjfrank\Desktop\stereo\stereo_example_rev"
evo.format = "EVO"
evo.options = "Compression RLE"
# addcount() sets the number of output frames as well
# as the frame size
err = evo.addcount(mov)
if (err < 0):
print("Count error: {}".format(evo.errstr()))
err = evo.open()
if (err < 0):
print("Open error: {}".format(evo.errstr()))
for i in range(mov.nframes):
print("Working on frame: {}".format(i))
# if this is a stereo movie, getframe() will return
# a list of enve.image() objects in [right,left] order.
pair = mov.getframe(i)
# swap the images
pair.reverse()
# add them to the other movie (make sure to use a tuple)
err = evo.append(tuple(pair))
if (err < 0):
print("Save error: {}".format(evo.errstr()))
evo.close()
mov.close()
Now, let's look at each of the enve movie methods and attributes used to create, load, modify and save
enve movies. The following methods and attributes can be listed in EnSight Python as follows:
import enve
dir(enve.movie)
EnVe Module Code Methods
x = enve.movie(enve.MOVIE_READ|enve.MOVIE_WRITE)
Creates an empty movie object in read or write mode. No actual I/O operations will be started
until the open() method is called. The proper usage is to create the movie object, set
attributes on it (e.g. filename, image size, number of frame in the case of writing) and then
open() the file. At that point, the append() and getframe() methods will work. When
done accessing image frames, the file should be close()ed and the object can be destroyed.
err = x.addcount(N|image|movie)
Write movies must know in advance how many frames will be added before the file is
open()ed. This function is used to add frame counts to the movie. The input parameter
can be an integer (number of frames) an image object (adds one frame) or another movie
(open() and in READ mode, which adds the number of frames in the movie). In the latter
two cases, the target movie may change its dimensions or frame rate to match the added
objects. This will happen if the current dimensions or fps are <= 0. The return value is the
number of frames, or -1 on error. x.nframes is updated to reflect this as well. If addcount()
is only called with an integer number of frames, the caller must also set the dims attribute
to set the size of the output movie in pixels.
err = x.append(image|image_tuple|movie[,object=obj][,meth-
od=meth][,smooth=sm])
If a WRITE movie is open(), this method is used to physically add an image, image tuple of
two images for stereo, or the frames in a movie to the current movie. The input frames will
be scaled to match the dimensions of the target. Returns 0 if successful. If the caller specifies
the OBJECT and METHOD keywords to an object reference and the name of a method, this
function will periodically call object.method(n) where n is the number of the frame
currently being worked on. This method should return 1 if the operation is to be aborted or
0 if processing should continue. By default, this method uses nearest neighbor sampling to
scale images. If a higher quality scaling is desired, set the SMOOTH keyword to the value
enve.CVF_SCALE_SMOOTH to select box filtered scaling.
err = x.close()
This method completes all I/O operations with a given movie. The physical file on disk will
be valid after this method is called.
str = x.errstr()
If any of the methods return an error (-1), a string describing the error will be stored in the
movie object. These error strings can be accessed via this method.
image = x.getframe(framenum)
This method extracts a frame from a movie and returns a list of image objects. There may
be one or two images returned (two in the case of a hardware stereo source). If two images
are returned, the first is the left eye image and the second is the right eye image. The
framenum is [0,x.nframes-1]. The returned frame is intensity and repeat adjusted as specified
by those attributes. This method can only be used on a READ movie.
The return is either a list (success) or an int (fail).
On error, this returns the integer -1 so, do the following:

image = x.getframe(framenum)
if type(image) == int:
print("Error")
return image
err = x.open()
This method opens the physical movie file. In the case of a WRITE file, it will begin the
encoding process.
err = x.resetcount()
his function resets the current nframes count on a WRITE movie to 0. This can be called if
the movie is not currently open.
print(x)
Prints basic information about the movie x.
These get and set any of the various movie object attributes.
Movie attributes:
__members__ Returns a list of the attributes this object supports. Read only list.
__methods__ Returns a list of the methods this object supports. Read only list.
filename The filename to use. Read/write string.
stereo This attribute is non-zero if the movie supports HW stereo (on read)
or if the movie has been set to output HW or anaglyph stereo (on
write). Read/write int. If stereo is set to non-zero for a WRITE movie
then the append function should include tuples of images
representing the left and right images.
fps The framerate for movie playback in frames per second. Read/write
float.
EnVe Module
dims The dimensions of the movie frames in pixels. Read/write tuple of

two ints: (dx, dy)
tiling If the output movie should be written as an MTM file (see
Multi-Tiled Movie (MTM) File Format ) this attribute specifies the
number of tiles in the X and Y axis. Read/write tuple of two ints:
(dx, dy)
format This attribute specifies the format for the movie. See: enve.co-
decs() for a list of formats. Read/write string.
framerange For a read movie, this attribute allows one to select a subset of the
input frames to read. For example, (10,20) will cause the movie to
only output frames 10 through 20 inclusive (11 frames).
Note:
Framerange numbers start at 0 and run through

x.realframes-1. Read/write tuple of two ints: (start,
end)
nframes For a read movie, this is the effective number of frames in the file
(int), useable by x.get_frame(framenum)
realframes The number of actual physical images in the file (the repeated
frames are not in the total number of frames).
It is the valid range for getframe(X)). It is equal to:

frameend-framestart+repeatstart+repeatend. Readonly int.
options Format specific options in the form: "op1 value op2 value ...". See
enve.codecs() for a list of format options and the example
script for how to create them. Read/write string.
intensity Frames may have their intensity scaled linearly from the first to the
last frame. This attribute allows this scaling to be set. The default
is (1.0,1.0) or no intensity changes. Read/write tuple of two floats:
(start, end)
repeat When reading from a file, the first and last frames may be repeated
a number of times. This attribute allows the number of additional
times those frames appear. For example, (5,3) will cause the first
frame to be repeated 5 additional times (6 total) and the last frame
3 times (4 total). As a result, nframes will report 8 more frames in
the movie. Note that the intensity interpolation includes these
repeated frames. Read/write tuple of two ints: (start, end)
anaglyph If an output movie has stereo set, this attribute allows that stereo
to be in anaglyph form. Valid values include:
enve.MOVIE_ANAGLYPH_NONE - use HW stereo (shutter glasses)
enve.MOVIE_ANAGLYPH_REDBLUE
enve.MOVIE_ANAGLYPH_BLUERED
enve.MOVIE_ANAGLYPH_REDCYAN
enve.MOVIE_ANAGLYPH_CYANRED
Read/write int.
flip When reading from a file, flip the frames about the X or Y axis in
memory (the original file is unchanged). If your object in your movie
moves left to right, and flip about the Y axis then it will move right
to left. Pixelated text will be flipped as well. Valid values are formed
by 'OR'ing: enve.CVF_FLIP_XAXIS and/or en-
ve.CVF_FLIP_YAXIS
Read/write int.
The EnVe Image Object

The image object is a simple 2D array of pixels. The pixels in an image can be in one of the following
formats:
enve.CVF_IMG_FMT_A - alpha only image
enve.CVF_IMG_FMT_L - luminance only image (grayscale)
enve.CVF_IMG_FMT_LA - luminance+alpha image
enve.CVF_IMG_FMT_RGB - red,green,blue three channel image
enve.CVF_IMG_FMT_RGBA - red,green,blue,alpha four channel image
EnVe image object processing operations
x = enve.image()
Create a new image object. The default image is 100 by 100 in size and a format of
enve.CVF_IMG_FMT_RGB .
print(x)
Prints basic information about the image x.
x == y
The object supports the comparison of two images for pixel by pixel equality
The attributes and methods can be listed separately as follows:
x._methods__
x.__members__
Note:
The following members are not used:
frame, origin, and framenumber.
And, there is no method for closing the file.
EnVe Module
x.close()
Both the methods and the attributes are listed together below in alphabetical order.
dir(enve.image())
x.bitblt(src,spos,ssize,pos,size,mode,backpixel)
This method copies a rectangle of pixels from one image to the target. The two images
must have the same pixel format. The rectangles may lie outside of the source or
destination images. For source pixels that lie outside of the source image, the backpixel
value is used. The source pixels will be scaled as needed (nearest neighbor sampling)
to fill the destination rectangle. The following are variable descriptions: src is an en-
ve.image() object to use as the pixel source, spos is the origin of the pixels in the
source image (a tuple of two ints), ssize is the rectangle (dx,dy) of the pixels in the
source image (a tuple of two ints), pos is the origin location of the pixels in the
destination image (a tuple of two ints), size is the rectangle (dx,dy) of the pixels to
paint in the destination (a tuple of two ints), mode - The operation mode can be a simple
copy (enve.CVF_BITBLT_COPY ), where source pixels replace destination pixels or it
can be a masked copy (enve.CVF_BITBLT_ALPHAMASK ) where source pixels only
replace destination pixels if they have a non-zero alpha channel, and backpixel is a
tuple of 4 integers (Red,Green,Blue,Alpha).
x.blend(src,srcCM,srcAM,dstCM,dstAM,fixedcolor,fixedalpha)
This method blends the pixels of two images together according to four blending mode
functions (a color and alpha for each of the source and destination images). Blending is
performed by weighting each component of the source and destination by a particular
function and then summing the results. The results are then clamped to the range [0,255]
and stored in the destination image. In addition to the images, a fixed color and alpha
value are supplied. These are used by some of the various expression combinations.
fixedcolor is a tuple of four integers ( enve.CVF_IMG_FMT_RGBA ) and
fixedalpha is a single integer.
The formula take the following form:
dst'(RGB)=(dst(RGB)*dstCModeWeight)/255+(src(RGB)*srcCMode-
Weight)/255
dst'(A) =(dst(A) *dstAModeWeight)/255+(src(A) *srcAMode-

Weight)/255
srcCM selects the function for determining srcCModeWeight
srcAM selects the function for determining srcAModeWeight
dstCM selects the function for determining dstCModeWeight
dstAM selects the function for determining dstAModeWeight
The available weight functions include:
enve.CVF_BLEND_ZERO The value 0
enve.CVF_BLEND_ONE The value 255
enve.CVF_BLEND_SCOLOR The value of the source color
enve.CVF_BLEND_SALPHA The value of the source alpha
enve.CVF_BLEND_DCOLOR The value of the destination color
enve.CVF_BLEND_DALPHA The value of the destination alpha
enve.CVF_BLEND_CCOLOR The value of the "fixed" color
enve.CVF_BLEND_CALPHA The value of the "fixed" alpha
enve.CVF_BLEND_MSCOLOR 255 - CVF_BLEND_SCOLOR
enve.CVF_BLEND_MSALPHA 255 - CVF_BLEND_SALPHA
enve.CVF_BLEND_MDCOLOR 255 - CVF_BLEND_DCOLOR
enve.CVF_BLEND_MDALPHA 255 - CVF_BLEND_DALPHA
enve.CVF_BLEND_MCCOLOR 255 - CVF_BLEND_CCOLOR
enve.CVF_BLEND_MCALPHA 255 - CVF_BLEND_CALPHA
x.chromakey(incolor,tolerance,alpha)
This method scans the input image and compares the color of each pixel to the input
pixel color (incolor). If every channel is within tolerance of the target pixel, the
alpha channel for that pixel is replaced by the input alpha value. incolor is a tuple of
3 integers (R,G,B) range [0,255] each. The tolerance is a tuple of 3 integers that are the
tolerance in R,G,B range [0,255] each.
x.colormath(rw,gw,bw,aw)
This method performs simple linear algebra on an image. The math is performed at
floating point resolution and the results clamped to the range [0,255] before being
output. rw,gw,bw and aw are each tuples of 5 floats and each represent the coefficients
of the linear transform for a given output component.
The math implemented is as follows:
R' = R*rw[0]+G*rw[1]+B*rw[2]+A*rw[3]+rw[4]
G' = R*gw[0]+G*gw[1]+B*gw[2]+A*gw[3]+gw[4]
B' = R*bw[0]+G*bw[1]+B*bw[2]+A*bw[3]+bw[4]
A' = R*aw[0]+G*aw[1]+B*aw[2]+A*aw[3]+aw[4]
image = x.diff(input [,absolute=1])

This method computes a new image that is the pixel by pixel (component by component)
difference between image x and image input. By default, the subtraction is performed
as a signed operation which is clamped to [0,255] on output. If the absolute keyword
is set, the output is the absolute value of the difference clamped to the range [0,255].
EnVe Module
x.dims = tuple(int x,int y)

This attribute is used to get and set the image dimensions. Returns the size of the image
in the x and y dimensions. If set, it will resize the image to the new x and y values using
nearest neighbor sampling. Read/write tuple of ints (dx,dy).
str = x.errstr()
If any of the methods return an error (-1), a string describing the error will be stored in
the image object. These error strings can be accessed via this method.
x.flip(int)
This method will flip an image in memory (original file is unchanged) about one or more
axis. If the image is facing left and you flip it about the Y axis then the image will be
facing right. This corresponds to the Horizontal flip toggle in the application. The int
parameter formed by 'OR'ing together the following: enve.CVF_FLIP_XAXIS and
enve.CVF_FLIP_YAXIS, selects the operation.
x.format = enve.CVF_IMG_FMT_RGB
This attribute is not the format of the image in terms of the codec (AVI, TIFF, PNG, etc.).
That format is set using the suffix of the filename when saving the file. The mapping of
the suffices to the format is found in enve.codecs() .
This format refers to the information in each pixel. If this is set to a different value, then
it will change the image format to the new value (interpreting all pixel values).
Valid values:
enve.CVF_IMG_FMT_A - alpha only
enve.CVF_IMG_FMT_L - luminance (grayscale) only
enve.CVF_IMG_FMT_LA - luminance and alpha
enve.CVF_IMG_FMT_RGB - red, green, blue, three channel image
enve.CVF_IMG_FMT_RGBA - red, green, blue, alpha, four channel

image
Read/write int.
x.fromstring(s, dx, dy, format)

This method is the inverse of tostring(). It constructs the contents of the image x
from the pixel data in the raw binary string s. It is assumed that the string source was
something like that output by the enve.image.tostring() method. The dx, dy
and format arguments specify the size and pixel format the image x should take. This
method can be used with packages such as matplotlib or numpy which provide
mechanisms for generating such raw strings.
pv = x.getpixel(xo,yo)
This method will return as a list, the current color at pixel xo,yo in the image. See
setpixel() for a description of the pv.
np_ndarray = x.getpixels()
This method returns an numpy ndarray with dimensions of (xdim * ydim * depth) and
depth is 3 for rgb, 4 for RGBA. So np_ndarray[0,0] might be [0,0,0] for RGB,
and each entry is of type numpy.uint8 . You can put this numpy array back into
setpixels to create a new image.
err = x.load(filename)
This method reads an image file and sets the current image object to its contents. If the
input file is an animation, the first frame is returned. The method returns 0 on success
or a negative integer on error. See enve.codecs() for supported file formats.
x.macclip()
This is a legacy method for the Apple Mac that is no longer used.
x.ppm()
This method returns a string that is the representation of the image as an ASCII PPM
file. This can be useful in interfacing to systems like Qt
err = x.resize(xsize,ysize[,smooth=sm])
This method resizes the current image to the size specified by xsize, ysize. This is
essentially the same as changing the 'dim' attribute on the image object. By default, this
operation is performed using nearest neighbor sampling. The caller may select higher
quality box filtered sampling by setting the smooth keyword equal to the value en-
ve.CVF_SCALE_SMOOTH.
err = x.save(filename[,options=options_string])
This method saves the current image to disk in the specified filename. The filename
must have an extension, because the format is selected by the filename extension. It is
an error to give this a filename without an extension (in contrast to the movie which
uses a prefix without an extension). The target file is overwritten without warning. The
options keyword allows the user to set specific format options (e.g. compression) like
the enve.movie options attribute. The method returns 0 on success, or a negative
integer on error. See enve.codecs() for supported filename extensions and option
strings.
x.setpixel(xo,yo,pixelvalue)
This method will set the color of the pixel at position xo,yo in the image to be the color
specified by the list pixelvalue. Pixelvalue is a list of integer values between 0 and 255
(inclusive). There should be at least as many elements in the list as there are image
components. For example, if x.format = enve.CVF_IMG_FMT_RGB then there
should be three components in pixelvalue (e.g. [255, 135, 135]) representing the red,
green and blue values of the pixel.
x.setpixels(np_ndarray)
This method takes as input a numpy ndarray and it creates and enve image, x. The
np_ndarray is of dimensions of (xdim * ydim * depth) and depth is 3 for rgb, 4 for
RGBA. So np_ndarray[0,0] might be [0,0,0] for RGB, and each entry is of type
numpy.uint8 . You must define x as an enve image and define the dimensions of x
prior to inputting the numpy array into it as follows:
# suppose you have an nd_ndarray of dimensions 736x769, with

[R,G,B] values
EnVe Module
x = enve.image()
x.dims = (736,769)
x.setpixels(np_ndarray)
dict = x.stats()
This method computes basic statistics on the image object. It computes for all pixels
and for all channels (a 10x10 enve.CVF_IMG_FMT_RGB image is considered to have
300 pixels). It returns a dictionary with the keys:
count - the number of pixels in the image
mean - the mean pixel value
sum - the sum of all the pixel values
sumofsquares - the sum of the squares of all of the pixels
variance - the variance of the pixels
minimum - the minimum pixel value
maximum - the maximum pixel value
image = x.subrect((int originx, int originy),(int dx,int dy))
image = x.subrect()
This method extracts a rectangle of pixels from the image and returns a new image. The
first tuple is the offset into the image and the last specifies the dx,dy in pixels. In the
second form, the method simply clones the source image.
x.swizzle(swiz,mask)
This method allows the value of any channel of the image to come from any other
channel of the image. The array swiz selects the input channel for each output channel.
For example, a swiz of (0,1,2,3) will result in no image change. A swiz of (2,1,0,0) will
swap the red and blue channels and place the input red channel in the output alpha
channel as well. The mask array allows individual output channels to be enabled or
disabled for writing. The value in the mask array must be non-zero for the output channel
to be writable. swiz and mask are both tuples of four integers. With some formats, not
all values are used.
s = x.tostring()
This method will return the pixel data in the image as a raw binary Python string. There
is one character in the string for each component of each pixel. For example, if the image
were 100x100 and in enve.CVF_IMG_FMT_RGB format, the resulting string would be
30000 bytes in length.
Note:
The image dimensions and pixel format are not encoded in the string
and that the string is actually raw binary data. This method can be used
with packages such as matplotlib or numpy which provide

mechanisms for interpreting such raw strings.
These get and set object attributes are currently unused.

framenumber Returns an index number that can be
used to store a sequence number for this
frame. Presently, this is unused.
Read/write int.
frame Returns the size of the image frame for
which this image might be a subrect of.
Presently, this is unused. Read/write tuple
of ints (dx,dy).
origin Returns the position (relative to the upper
left corner) of the current image in the
full image frame specified by the frame
attribute. Presently, this is unused.
Read/write tuple of ints (dx,dy).
Additional EnVe Modules

dir(enve) shows the following modules
The first two are the main objects.
image, and movie, and these have been discussed in their own sections. In
addition the following minor objects will be discussed below.
arch, extend, home, indexof, istemplate, uuid, version

and codecs. These will be discussed directly below.
test=enve.arch()
This function returns the architecture on which enve is running. For example,
enve.arch() returns win64, apple_10.5, or linux_2.6_64.
test=enve.extend(string name,int timestep,int imin,int imax)

This function resets the imin and imax of a named movie.
test=enve.home()
This function returns the $CEI location of the EnSight install.
test=enve.indexof(string file,string name,int start,int end)

This function scans from start to end and gets the index of the file when
file==name.
test=enve.istemplate(string file)
This function uses the file string to set a template.
test=enve.uuid(1)
EnVe Module
This function generates a universal, unique identifier based on the platform,

timestamp and a random number. An example might be as follows: ff20e203-
dc86-11e4-9d54-6be85efe571e.
enve.UUID_MAKE_MC - ?
enve.UUID_MAKE_V1 - ?
test=enve.version()
This function generates a list that includes the name and copyright, three digit
and then two digit version of EnVe. For example: ['EnVe Movie Editor,
Copyright 2017-2018 ANSYS, Inc.', '4.1.0', 4.1] .
list=enve.codecs()
EnSight and EnVe use a consistent set of internal codecs for import and export
to ensure compatibility across all platforms. This may mean that EnVe is unable
to import a movie or image created in a third-party application. This function
queries the installed UDILs and returns a list of supported file formats and
associated options. It returns a list structure in the following form:
[
["name","desc",[".ext",...],stereo, multi,
[["optname",opttype,<optvalue>,<optdefault>"optdesc"],...]],
...
]
"name" is the name of the UDIL, this is used as the movie.format attribute.
"desc" is an ASCII description of the UDIL in more detail.
" .ext" is a list of the filename extensions used by this format.
stereo is an integer that is non-zero if the file supports HW stereo movies.
multi is an integer that is non-zero if the format is an animation file that places
all frames in a single file.
The final list is a list of custom options that can be set for the format.
"optname " is the name of an option.
"opttype " is the type of choice: a boolean, integer, float, or choice from a list.
The types can be as follows:
enve.CVF_UDIL_BOOLEAN
enve.CVF_UDIL_INT
enve.CVF_UDIL_FLOAT
enve.CVF_UDIL_CHOICE .
" optvalue " are different for each type:
" optdefault " are different for each type:

Type Value Default
enve.CVF_UDIL_BOOLEAN "0|1" int
enve.CVF_UDIL_INT [int_min,int_max] int
enve.CVF_UDIL_FLOAT [flt_min,flt_max] float
enve.CVF_UDIL_CHOICE ["opt0","opt1",...] int (index into list)
" optdesc " is a full text description of this option.
To list all the codecs see the following:

for f in enve.codecs():
print("{} ({})".format(f[1],f[0]))
For an example,
print(enve.codecs()[8])
['PNG', 'PNG Image', ['.png'], 0, 0, [['Compression', 4, ['None', 'Fast',
'Best', 'Default'], 3, 'Compression method']]]
Example EnSight Python to print out of all of the codecs.

import enve
clist = enve.codecs()
for cc in clist:
print(cc)
print("\n")
print("name {}".format(cc[0]))
print("desc {}".format(cc[1]))
print ".ext", cc[2] -> print(".ext {}".format(cc[2]))
if cc[3] > 0:
print("supports stereo")
if cc[4] > 0:
print("all frames in single file")
else:
print("frames in separate files")
print("Codec options:")
opts = ""
for copt in cc[5]:
print("optname {}".format(copt[0]))
opts += copt[0] + " "
print(" detailed description {}".format(copt[4]))
if copt[1] == enve.CVF_UDIL_BOOLEAN:
print(" Boolean choice")
opts += str(copt[3]) + " "
elif copt[1] == enve.CVF_UDIL_INT:
print(" Integer choice")
elif copt[1] == enve.CVF_UDIL_FLOAT:
print(" Float choice")
elif copt[1] == enve.CVF_UDIL_CHOICE:
print(" General choice")
opts += copt[2][copt[3]] + " "
else:
print(" unknown choice {}".format(copt[1]))
print(" list of choices {}".format(copt[2]))
print(" default choice {}".format(copt[3]))
if len(opts) > 0:
print("example mov.options = '{}'".format(opts))
else:
EnVe Module
print("no mov.options available for this format ")

print("\n\n")
Example output from the above EnSight Python code

['AVI', 'Microsoft AVI Movie', ['.avi'], 0, 1, [['Compres-
sion', 4, ['MJPEG', 'RAW', 'MPEG4V2'], 2, 'Compression
method'], ['BitRate', 1, [0, 40000], 20000, 'Stream
bitrate (kbits/sec)']]]
name AVI
desc Microsoft AVI Movie
.ext ['.avi']
all frames in single file
Codec options:
optname Compression
detailed description Compression method
General choice
list of choices ['MJPEG', 'RAW', 'MPEG4V2']
default choice 2
optname BitRate
detailed description Stream bitrate (kbits/sec)
Integer choice
list of choices [0, 40000]
default choice 20000
example mov.options = 'Compression MPEG4V2 BitRate 20000 '
["copyright", "ver",ver] = enve.version()

This function returns a copyright notice and the version of the enve API as a text
string and a floating point number.
9.2. EnVe Application

The EnVe video editor is a useful, interactive movie editing application built using the Python Qt GUI
to demonstrate a subset of the EnVe Module Interface. It is appropriately called EnVe (EnSight Video
editor). Note you can modify and convert images with this application, but it is designed for movies.
This can be started by opening a cmd window and typing enve or by double clicking on the EnVe
2020 R1 icon.
Simply read in movies that you would like to sequence, convert format, change resolution, or apply
fade in / fade out effects. EnVe can read in formats supported by the current UDIL libraries in the EnSight
install. Also, we only guarantee that to read in data formats that were written by ANSYS tools. For ex-
ample, we can read an AVI file we wrote, but not necessarily an AVI file that came from the web. This
is true of a lot of the multi-codec formats. See the previous examples of listing the codecs.
Using the EnVe Application Interactively

1. There are three ways of importing movies and images into EnVe:
• Drag and Drop the media onto the Input movies dialog.
• Clicking Add.
• Selecting File → Add movie (This menu is also used to import images).
EnVe Application
2. Choose File → Import image sequence as a movie... and choose the first file in the sequence to add them
all
OR
simply select all the files and drag them onto the Input movies field.
Note:
Choose File → Import image sequence as a movie…. and choose the first file in the se-
quence to add them all or simply select all the files and drag them onto the Input movies
field.
EnVe Module
This is your sequential list of input movies.
EnVe Application
Note:
If the filenames contain L and R then stereo is assumed: file001l.png, file001r.png,

...
This area has info on the output movie.
Choose the output file prefix.
Note:
If you add an extension (e.g. .MP4), it will be removed.
Choose the output format, format options, stereo option, frames per second, smoothing option, output
dimensions, and/or tiling. EnVe adds the extension based on the output format.
EnVe Module
1. HW Stereo same as EnSight interleaved stereo: two images each frame.
Other options are anaglyph stereo using colors.
2. Click on Format to see all the codecs available.
EnVe codecs are guaranteed to be compatible with all EnSight/EnVideo output on any platform, but
may not be able to import all images and movies generated outside the EnSight ecosystem.
3. Params include format, format options, stereo type, frames per sec (-1 is format default), smoothing toggle,
dimensions (0 is use input movie dimensions) and MTM is multi-tile (movie is divided into nxm tiles and a
.MTM master text file is written.
See Multi-Tiled Movie (MTM) File Format.
EnVe Application
1. Toggle to flip image
2. Enter how many frames to repeat at beginning and end of the selected movies guardrail.evo above.
3. Choose intensity for a fade of the selected input movie(s).
Note:
You must press Enter after each field entry!
EnVe Module
1. Copy the visible frame to the clipboard for use elsewhere.
2. Click to generate output movie with extension appropriate for format.
3. Use slider to look at your movie frame by frame, or to choose a frame for cropping.
4. Crop start to make the current frame as the first in your output movie. Move the slider again to the right.
Crop end to make that frame the final frame in your output movie. Crop reset to use the whole movie.
EnVe Application
EnVe Application Stereo Utilities
EnVe has five other useful stereo utilities completely unrelated to the input movie that you have chosen,
or the output movie or parameters that you have chosen.
Pick one of these options and you will be prompted for an input stereo movie and output prefix (these
utilities will ignore the extension even if you add it onto the prefix). EnVe will write out an EVO movie
using the option you have chosen with an .EVO extension.
Using the EnVe Application in Batch

EnVe can be run with no graphical user interface using a python file. Python modules can only be
loaded from the sys.path location. EnVe does not include all of the directories in the sys.path
that are available in EnSight. EnVe does load the enve module implicitly and can load other python
modules only from $CEI/enve201. As such the ens_utils.py high-level utilities are available to
be run only with EnSight, and running enve in batch requires the use of lower-level enve routines,
thus requires a bit of programming. To run enve without a graphical user interface using a python file,
type in the following from the command line:
%enve201 -nogui filename.py
Shown below is an example python that can be run in batch to convert all of the EnVideo format (.EVO)
files to .AVI format. Simply copy/paste this into a file named enve_convert.py and run it as shown
below.
Note:
The enve module is implicitly imported into EnVe.
#
# convert evo format movies found in the
# current working directory to avi using EnVe
#
# batch execute like this:
# %enve194 -nogui enve_convert.py
#
#
import os
import glob
# The input movies are expected to be *.evo
files = glob.glob('*.evo')
# Common target format options: AVI, MPEG, MOV, GIF, EVO

# Set this variable to your format choice from the above list
EnVe Module
targetFormat = "AVI"
for m in files:
if not os.path.exists(m):
print("++ Attention, this file doesn't exist: {}".format(m))
continue
m1 = enve.movie(enve.MOVIE_READ)
m1.filename = m
m1.open()
convertedFile = m[:-4]
m2 = enve.movie(enve.MOVIE_WRITE)
m2.filename = convertedFile
m2.format = targetFormat
m2.addcount(m1)
print(("++ converting {} to {} to {}".format(m1.filename, m2.filename, str("."+targetFormat)))

m2.open()
m2.append(m1); m2.close()
m1.close()
print("\n++ enveConvert is done")
Using the EnVe Module in EnSight in Batch

Alternatively you can do the same thing using EnSight in batch using the ens_utils.py routines to
make much simpler code.
%ensight201 -batch -p movie_convert.py
Shown below is the simpler code

#
# Run as ensight -batch -p movie_convert.py
# to convert every evo movie in the current directory
# to avi format
#
file_list = eu.get_file_list('./*.evo')
for fil in file_list:
fdict = eu.split_filename(fil)
print("++ converting {} to {}".format(fil, str(fdict['file prefix']+'.avi')))
eu.convert_movie(fil,fdict['file prefix']+'.avi')
print("\n++ movieConvert is done")
9.3. Helper Modules
'cei' module
This module includes a number of common functions that are not generally EnSight specific. They are
used in tools like EnVe, but can be used by any EnSight Python application.
CeiPrintDlg() class for PyQt based rendering and printing of the main window (in printdlg.py)
CeiQtImageFormatOptions() class for prompting the user for UDIL selection/options (in qtimg-
formats.py)
CeiQtSaveImage() class to prompt the user for a complete set of image size/saving options, including
the render and save) (in qtimgformats.py)
Helper Modules
CeiPlot() classes to wrapper matplotlib. Create a graph and save it to disk (in plots.py)
CeiQtPlotWindow() class providing a dockable Qt4 widget that contains a CeiPlot object, including
copy and print operations (in qtplots.py)
CEItranslate() class that acts as a repository for .GM translation files and allows for dynamic
changing of the language for all objects as well as a method to get a language menu (in qtlan-
guage.py)
ceisplash() class to manage a splash screen from a .SVG file (in ceisplash.py)
CeiLogging() and logging shortcuts (in ceilogging.py)
CeiQtGenericDialog() class that generates dynamic dialogs from simple lists and prompts the
user for values. It can handle things like text, checkboxes, ints, floats, variables, parts, option menus,
strings, filenames, etc (in qtgenericdlg.py)

Interface Manual

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Interface Manual

Uploaded by

Copyright:

Available Formats

ANSYS EnSight Interface Manual

ANSYS, Inc. Release 2020 R1

© 2020 ANSYS, Inc. Unauthorized use, distribution or duplication is prohibited.

U.S. Government Rights

Published in the U.S.A.

2.3.42. USERD_set_var_extract_gui_data ......................................................................................... 43

3.4.35. USERD_get_nsided_conn ................................................................................................... 101

4.5.2.34. USERD_get_uelem_conn ........................................................................................... 235

1.1. User Defined Reader APIs

Two versions of this API are available.

API 1.0 deals with:

• global coordinate array and corresponding

• – global node id array

– global nodal variables

• for each part:

– local element connectivities (grouped by type) & corresponding

– local element ids

– local elemental variables

All of this leads to a considerable amount of temporary memory and processing, in

• for each part:

• part coordinates & corresponding

• part node ids

• part nodal variables

• part element connectivities (grouped by type) & corresponding

• part element ids

• part elemental variables

Therefore, some of its advantages and new features are:

• Less memory, more efficient, and faster - as indicated above.

• Tensor and complex variables are supported

• Exit routine provided, for cleanup operations at close of EnSight

• Geometry and variables can be provided on different time lines (timesets).

• Material handling is supported

• Nsided and Nfaced elements are supported

• Structured ranges can be specified

• Failed elements is supported

• Material Species is supported

• Rigid Body values can be supplied from the reader.

1.2. How to Produce a User Defined Reader

$CEI/ensight201/src/readers/test3 - structured and unstructured example

$CEI/ensight201/src/readers/test3s - structured example reader

$CEI/ensight201/src/readers/test3u - unstructured example reader

2. Produce the dynamic shared library.

Example 1.4: For UNIX

i.e. (WIN64 Cygwin) (using nmake)

i.e. (WIN64 Cygwin) (using nmake)

make mkdir lib

Machine OS Shared Library Name LD Command used in Makefile

Machine Type Environment Variable to Set

As always, ANSYS support is available if you need it.

[filename_2] - Only if your reader uses two fields

<toggle flags> - Only if your reader implements extra GUI

<pulldown flags> - one flag value per line

<field contents> - one field string per line

> checker -p <playfile>

And <playfile> would be a simple ascii file with 3 [0r 4] lines:

line 1: the path

line 3: [filename_2] (if two_fields is TRUE)

line 3 or 4: 0 or 1, for swapbytes (0 is FALSE, 1 is TRUE)

remaining lines 0 or 1 for toggle disable enabled

one line for each toggle

0 - num_pulldown_values for pulldown choice

one line for each pulldown

one line for each field