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 corresponding 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

  2. When you choose a reader and a data file(s) and clicks OK

    USERD_reader_open

    USERD_set_filenames

    USERD_get_number_of_timesets

    USERD_get_geom_timeset_number

    USERD_get_timeset_description

    USERD_get_num_of_time_steps

    USERD_get_max_time_steps

    USERD_get_sol_times

    USERD_get_max_time_steps

    USERD_set_time_set_and_step

    USERD_get_node_label_status

    USERD_get_element_label_status

    USERD_get_descrip_lines

  3. Get info about each part

    USERD_get_number_of_model_parts

    USERD_get_part_info

    USERD_get_geoms_in_part

    USERD_get_geom_info

    USERD_get_elemsets_in_geom

    USERD_get_uelem_info

    USERD_get_unode_info

    USERD_get_snode_info

    USERD_get_selem_info

  4. Get the optional XY query data (optional, but if one is present, all must be present).

    USERD_ get_num_xy_queries

    USERD_get_xy_query_info

    USERD_get_xy_query_data

  5. Get variable information

    USERD_get_uns_failed_params

    USERD_get_number_of_model_constants

    USERD_get_number_of_vars

    USERD_get_model_constant_info

  6. For each variable get information

    USERD_get_var_info

    USERD_get_model_constant_val

  7. Loading unstructured parts

    USERD_set_time_set_and_step

    USERD_get_part_info

    USERD_get_geoms_in_part

    USERD_get_geom_info

    USERD_get_unode_info

    USERD_get_node_coords

    USERD_get_node_ids

    USERD_get_elemsets_in_geom

    USERD_get_uelem_info

    USERD_get_elem_ids

    USERD_get_uelem_faces_per_elem (if any NFACED or NSIDED elems)

    USERD_get_uelem_nodes_per_face (if any NFACED or NSIDED elems)

    USERD_get_uelem_conn

  8. Loading structured parts

    USERD_set_time_set_and_step

    USERD_get_part_info

    USERD_get_geoms_in_part

    USERD_get_geom_info

    USERD_get_snode_info

    USERD_get_elemsets_in_geom

    USERD_get_node_coords

    USERD_get_node_ids

    USERD_get_elem_ids

  9. When user activates a nodal variable

    USERD_get_var_info

    USERD_get_descrip_lines

    USERD_get_var_info

    USERD_get_descrip_lines

    USERD_set_time_set_and_step

    USERD_get_part_info

    USERD_get_geoms_in_part

    USERD_get_geom_info

    USERD_get_unode_info -- or --

    USERD_get_snode_info

    USERD_get_node_var_info

    USERD_get_node_var_values

  10. When user activates an elemental variable

    USERD_get_var_info

    USERD_get_descrip_lines

    USERD_get_var_info

    USERD_get_descrip_lines

    USERD_set_time_set_and_step

    USERD_get_part_info

    USERD_get_geoms_in_part

    USERD_get_geom_info

    USERD_get_elemsets_in_geom

    USERD_get_uelem_info

    USERD_get_elem_var_info

    USERD_get_elem_var_values

  11. When user activates a constant per part variable