API 3.0 Routines, Requirements and Descriptions
Routine Name |
Code and Description | Description |
|---|---|---|
| USERD_attribute |
O Optional | Unusual routine in that 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_constant_per_part_data |
O Optional, unless model constants used |
Returns constant per part variable values for desired time step for parts that have them |
| USERD_get_dataset_query_file_info |
OB Optional, but commonly used |
Get info about files in the dataset |
| USERD_get_descrip_lines |
R Required |
File associated description line |
| USERD_get_elem_ids |
OBN Optional, but Generally needed |
Retrieves element ids for the elements in an elemset |
| USERD_get_elem_var_info |
OB Optional, but needed if elem vars used |
Retrieves the var_index and number of values from given elemset var |
| USERD_get_elem_var_values |
Optional, but needed if elem vars used |
Retrieves the variable values for the elements in a given
elemset. Return |
| USERD_get_element_label_status |
OB Optional, but needed if element labels used |
Answers the question as to whether element labels will be provided. |
| USERD_get_elemsets_in_geom |
R Required |
Retrieve list of elemsets in a given geom |
| USERD_get_extra_data |
O Optional |
General routine that can be used for custom extra data |
| USERD_get_geom_info |
R Required | Retrieve the info for a given geom |
| USERD_get_geom_timeset_number |
R Required | Get the timeset number to be used for geometry |
| USERD_get_geoms_in_part |
R Required | Retrieve list of geoms in a given part |
| USERD_get_matf_escalars_desc |
O Optional |
Gets material scalars description (Youngs method) |
| USERD_get_matf_set_info |
O Optional |
Get material set ids and names |
| USERD_get_matf_set_type |
O Optional |
Gets the materials set type |
| USERD_get_matf_var_info |
O Optional |
Get material set var ids and names |
| USERD_get_matsp_info |
O Optional |
Gets material species id, description, etc. |
| USERD_get_max_time_steps |
O Optional |
Update the number of timesteps periodically during the EnSight session. For example while solving is ongoing |
| USERD_get_maxsize_info |
O Optional |
Get maximum part sizes for efficient memory allocation |
| USERD_get_metadata |
O Optional |
General routine for custom XML metadata |
| USERD_get_model_constant_info |
O Optional, Unless
|
Get info about a model constant |
| USERD_get_model_constant_val |
O Optional, Unless
|
Get the value of a constant at a time step |
| USERD_get_model_extents |
O Optional |
Get the model bounding box extents |
| USERD_get_node_coords |
R Required | Retrieve coords for the nodes in a given nodeset |
| USERD_get_node_ids |
OBN Optional, but Generally needed |
Retrieves node ids for the nodes in a nodeset |
| USERD_get_node_label_status |
OB Optional, but commonly used |
Answers the question as to whether node labels will be provided. |
| USERD_get_node_var_info |
OBN Optional, but Generally needed for vars |
Retrieves the var index, and number of values for a nodeset var |
| USERD_get_node_var_values |
OBN Optional, but Generally needed for vars |
Retrieves the variable values for the nodes of a nodeset var. Return Z_UNDEF if undefined. |
| USERD_get_num_of_time_steps |
R Required |
Get number of time steps in a given timeset |
| USERD_ get_num_xy_queries |
O Optional |
Get the number of xy queries available |
| USERD_get_number_of_files_in_dataset |
OB Optional, but commonly used |
Get the total number of files in the dataset. |
| USERD_get_number_of_material_sets |
O Optional |
Get the number of material sets in the model |
| USERD_get_number_of_materials |
O Optional |
Get number of materials in the material set |
| USERD_get_number_of_model_constants |
OB Optional, but needed if model constants used |
Retrieve number of model constants in model |
| USERD_get_number_of_model_parts |
R Required | Get total number of unstructured and structured parts in the model |
| USERD_get_number_of_species |
O Optional |
Get number of species |
| USERD_get_number_of_timesets |
R Required | Get number of timesets used in the model |
| USERD_get_number_of_vars |
OBN Optional, but Generally needed for vars |
Retrieves the number of non-constant vars in model |
| USERD_get_part_info |
R Required |
Retrieve the info for a given part |
| USERD_get_selem_ghost_flags |
OBN Needed only for structured model |
Retrieves the ghost flags for elements in a given structured elemset |
| USERD_get_selem_info |
OBN Needed only for structured model |
Retrieves info for a given structured elemset |
| USERD_get_snode_iblanking |
OBN Needed only for structured model |
Retrieves the iblanking value for nodes in a structured nodeset |
| USERD_get_snode_info |
OBN Needed only for structured model |
Retrieve the info for a given structured nodeset |
| USERD_get_sol_times |
R Required |
Get solution times for the time steps of a given timeset |
| USERD_get_timeset_description |
R Required |
Get description associated with a given timeset |
| USERD_get_uelem_conn |
OBN Needed for unstructured model |
Retrieves the unstructured connectives for a given elemset |
| USERD_get_uelem_faces_per_elem |
OBN Needed for unstructured model |
Retrieves the list of the number of faces per element for a given unstructured elemset |
| USERD_get_uelem_info |
OBN Needed for unstructured model |
Retrieves info for a given unstructured elemset |
| USERD_get_uelem_nodes_per_face |
OBN Needed for unstructured model |
Retrieves the list of number of nodes per face for a given elemset |
| USERD_get_unode_info |
OBN Needed for unstructured model |
Retrieves the info for a given unstructured nodeset |
| USERD_get_uns_failed_params |
O Optional | Allows the default filtering/failing of elements based on a variable value |
| USERD_get_var_info |
OBN Optional, but Needed if
|
Retrieves the info for a given variable |
| USERD_get_var_value_at_xyz_specific |
O Optional |
Get variable value at a particular xyz location at a given time |
| USERD_get_vglyph_counts |
O Optional |
Retrieves number of vectors and timelines for vglyphs |
| USERD_get_vglyph_timeline_info |
O Optional |
Retrieves vglyph timeline info |
| USERD_get_vglyph_timeline_times |
O Optional |
Retrieves vglyph timeline times |
| USERD_get_vglyph_vector_info |
O Optional |
Retrieves vglyph vector metadata |
| USERD_get_vglyph_vector_values |
O Optional |
Retrieves vglyph vector values |
| USERD_get_vglyph_vector_xyzloc |
O Optional |
Retrieves vglyph vector xyz locations |
| USERD_get_xy_query_data |
O Optional, Unless
|
Retrieves xy query xy data values |
| USERD_get_xy_query_info |
O Optional, Unless
|
Retrieves xy query plot metadata (titles, etc.) |
| USERD_load_matf_data |
O Optional |
Get the different material lists for given material set, part, and element type. |
| USERD_reader_close |
R Required | Last routine called upon exit: free allocated memory |
| USERD_reader_close |
R Required |
Free associated memory and the handle |
| USERD_reader_open |
R Required |
Creates the handle |
| USERD_rigidbody_existence |
O Optional | Return TRUE if Rigid body data exists for this model |
| USERD_rigidbody_values |
O Optional, Unless
| Retrieve |
| USERD_set_block_range_and_stride |
O Optional |
Send reader the blocks min/max/stride |
| USERD_set_filenames |
R Required |
Receive the geometry and results filenames and set up things for the reader |
| USERD_set_right_side |
O Optional |
Tell reader if at right side of an interpolation interval |
| USERD_set_time_set_and_step |
R Required |
Set current time step in desired timeset |
| USERD_size_matf_data |
O Optional | Get length of the different material lists |
| USERD_stop_part_building |
OB Optional, but commonly used |
Called when part builder is closed |