| Routine Name | Optional | Routine Description |
|---|---|---|
| Generally needed for UNSTRUCTURED data | ||
| USERD_get_part_coords | Part's node coordinates | |
| USERD_get_part_coords_in_buffers | X |
Part's node coordinates in buffers. (For unstructured autodistrib for SOS) |
| USERD_get_part_elements_by_type | Part's element connectivities | |
| USERD_get_part_elements_by_type_in_buffers | X |
Part's element connectivities in buffers. (For unstructured autodistrib for SOS) |
| USERD_get_periodic_ghosts_num_pairs | X | Return the number of pairs of nodes for each part periodic symmetry face |
| USERD_get_periodic_ghosts_pairs | X | Return the pairs for each symmetry face |
| Generally needed for BLOCK data | ||
| USERD_get_block_coords_by_component | Block node coordinates | |
| USERD_get_block_ghost_flags | Block ghost cell flags | |
| USERD_get_block_iblanking | Block iblanking values | |
| USERD_set_block_range_and_stride | Sets the min, max, and stride of a block (if doing structured cinching) | |
| USERD_get_ghosts_in_block_flag | Block ghost cell existence? | |
| USERD_get_periodic_ghosts_structured_face_info | X | Returns face info for structured parts with periodic symmetry |
| Generally needed for either or both kinds of data | ||
| USERD_bkup | Archive routine | |
| USERD_exit_routine | Cleanup upon exit routine | |
| USERD_get_border_availability | Part border provided? | |
| USERD_get_border_elements_by_type | Part border conn & parent info | |
| USERD_get_changing_geometry_status | Changing geometry? | |
| USERD_get_constant_per_part_data | X | Returns constant per part variable values |
| USERD_get_constant_val | Constant variable's value | |
| USERD_get_dataset_query_file_info | Info about each model file | |
| USERD_get_descrip_lines | File associated descrip lines | |
| USERD_get_element_label_status | Element labels? | |
| USERD_get_extra_gui_defaults | X | Gets the default values for the extra GUI members |
| USERD_get_extra_gui_numbers | X | Gets the number of toggles, pulldowns and fields |
| USERD_get_geom_timeset_number | Timeset # to use for geom | |
| USERD_get_gold_part_build_info | Gets the info needed for part building process | |
| USERD_get_gold_variable_info | Variable type/descrip etc | |
| USERD_get_ghosts_in_model_flag | Model contains ghost cells? | |
| USERD_get_matf_escalars_desc | X | Gets material scalars description (Youngs method) |
| USERD_get_matf_set_info |
Gets the material set indices and names | |
| USERD_get_matf_set_type | X | Gets the material set type |
| USERD_get_matf_var_info | Gets the material indices and descriptions | |
| USERD_get_matsp_info | Gets material species id, descriptions, etc. | |
| USERD_get_max_time_steps | X | Maximum number of timesteps when dynamically adding timesteps (for example, if solution is ongoing) |
| USERD_get_maxsize_info | Part/block allocation maximums | |
| USERD_get_metadata | provide xml metadata from reader up to EnSight | |
| USERD_get_model_extents | Provide model bounding extents | |
| USERD_get_name_of_reader | Name of reader for GUI | |
| USERD_get_nfaced_conn | 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 | X | Gets the element connectivities for nfaced elements in buffers. (For unstructured autodistrib for SOS) |
| USERD_get_nfaced_nodes_per_face | Gets the number of nodes per face for nfaced elements (utilizes the
number of faces per element obtained in
USERD_get_part_elements_by_type) | |
| USERD_get_node_label_status | Node labels? | |
| USERD_get_nsided_conn | Gets the element connectivities for nsided elements. (utilizes the
number of nodes per element obtained in
USERD_get_part_elements_by_type) | |
| USERD_get_nsided_conn_in_buffers | X | Gets the element connectivities for nsided elements in buffers. (For unstructured autodistrib for SOS) |
| USERD_get_num_of_time_steps | Number of time steps | |
| USERD_get_num_xy_queries | X | Number of xy queries |
| Number of files in model | ||
| USERD_get_number_of_material_sets | Number of material sets | |
| USERD_get_number_of_materials | Number of materials | |
| USERD_get_number_of_model_parts | Number of model parts | |
| USERD_get_number_of_species | Number of species | |
| USERD_get_number_of_timesets | Number of timesets | |
| USERD_get_number_of_variables | Number of variables | |
| USERD_get_part_element_ids_by_type | Part's element ids | |
| USERD_get_part_element_ids_by_type_in_buffers | X | Part's element ids in buffers (For unstructured autodistrib for SOS) |
| USERD_get_part_node_ids | Part's node ids | |
| USERD_get_part_node_ids_in_buffers | X | Part's node ids in buffers (For unstructured autodistrib for SOS) |
| USERD_get_periodic_ghosts_num_symmetry_faces | X | Returns the number of symmetry faces for each part |
| USERD_get_reader_descrip | X | Provide GUI more description |
| USERD_get_reader_release | X | Release string of reader |
| USERD_get_reader_version | Provide reader version number | |
| USERD_get_sol_times | Solution time values | |
| USERD_get_structured_reader_cinching | Tells if the reader will do structured cinching | |
| USERD_get_timeset_description | Description of timeset | |
| USERD_get_uns_failed_params | Gets variable and thresholds/criteria for failure | |
| USERD_get_var_by_component | Part or block variable values | |
| USERD_get_var_by_component_given_coords | X | get variable component value at a given coord location |
| USERD_get_var_by_component_in_buffers | X | Part or block variable values in buffers (For unstructured autodistrib for SOS) |
| USERD_get_var_extract_gui_defaults | X | Gets the default values for the var_extract
members |
| USERD_get_var_extract_gui_numbers | X | Gets the number of toggles, pulldowns and fields |
| USERD_get_var_value_at_specific | Node's or element's variable value over time | |
| USERD_get_var_value_at_xyz_specific | Get variable value over time at specific coordinate location. | |
| USERD_get_vglyph_counts | X | Gets counts for number of vector vglyphs |
| USERD_get_vglyph_timeline_info | X | Gets vector vglyph timeline metadata |
| USERD_get_vglyph_timeline_times | X | Gets vector vglyph timeline times |
| USERD_get_vglyph_vector_info | X | Gets vector vglyph metadata |
| USERD_get_vglyph_vector_values | X | Gets vector vglyph component values |
| USERD_get_vglyph_vector_xyzloc | X | Gets vector vglyph xyz locations |
| USERD_get_xy_query_data | X | Gets xy query xy values |
| USERD_get_xy_query_info | X | Gets xy query names, titles, num pairs, etc. |
| USERD_load_matf_data |
Gets the material ids list, mixed-material ids list, or mixed-material values list | |
| USERD_prefer_auto_distribute | X | Tells whether reader will distribute for SOS |
| USERD_rigidbody_existence | Returns whether rigid body transformation data exists for the model. | |
| USERD_rigidbody_values | Returns the euler and location values for a given part | |
| USERD_set_extra_gui_data | X | Returns the Extra GUI answers provided by the user |
| USERD_set_filename_button_labels | X | Sets button text |
| USERD_set_filenames | Filenames entered in GUI | |
| USERD_set_right_side | 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 | Server which of how many | |
| USERD_set_time_set_and_step | Current timeset and time step | |
| USERD_set_var_extract_gui_data | X | Returns the variable extract answers provided by the user |
| USERD_size_matf_data | Gets the length of either the material ids list, mixed-material ids list, or mixed-material values list | |
| USERD_stop_part_building | Cleanup after part build routine | |
| USERD_use_periodic_ghosts | X | Returns whether any parts have periodic symmetry |