2.1. Quick Index of Library Routines

Routine NameBrief Description
Generally Needed for UNSTRUCTURED Data
USERD_get_element_connectivities_for_partpart's element connectivities
USERD_get_element_ids_for_partpart's element ids
USERD_get_global_coordsglobal node coordinates
USERD_get_global_node_idsglobal node ids
USERD_get_number_of_global_nodesnumber of global nodes
USERD_get_scalar_valuesglobal scalar variables
USERD_get_vector_valuesglobal vector variables
Generally Needed for STRUCTURED (BLOCK) Data
USERD_get_block_coords_by_componentblock coordinates
USERD_get_block_iblankingblock iblanking values
USERD_get_block_scalar_valuesblock scalar variables
USERD_get_block_vector_values_by_componentblock vector variables
Generally Needed for Either or Both Kinds of Data
USERD_bkupread/write archive routine
USERD_get_changing_geometry_statuschanging geometry flag
USERD_get_constant_valueconstant variable's value
USERD_get_dataset_query_file_infoinfo about each model file
USERD_get_description_linesfile associated descrip lines
USERD_get_element_label_statuselement labels flag
USERD_get_name_of_readername of reader for GUI
USERD_get_node_label_statusnode labels flag
USERD_get_number_of_files_in_datasetnumber of files in model
USERD_get_number_of_model_partsnumber of model parts
USERD_get_number_of_time_stepsnumber of time steps
USERD_get_number_of_variablesnumber of variables
USERD_get_part_build_infopart type/descrip etc.
USERD_get_reader_descripprovide GUI more description (optional)
USERD_get_solution_timessolution time values
USERD_get_variable_infovariable type/descrip etc.
USERD_get_variable_value_at_specificnode's or element's variable value over time
USERD_set_filenamesfilenames entered in GUI
USERD_set_time_stepcurrent time step
USERD_stop_part_buildingcleanup routine
Optional Routines Added for Later Releases of EnSight
USERD_get_extra_gui_defaultsdefault values for the extra GUI members
USERD_get_extra_gui_numbersnumber of toggles, pulldowns and fields
USERD_get_num_xy_queriesnumber of xy queries
USERD_get_reader_releaserelease string of reader
USERD_get_var_extract_gui_defaultsdefault values for the var_extract members
USERD_get_var_extract_gui_numbersnumber of toggles, pulldowns and fields
USERD_get_xy_query_datagets xy query xy values
USERD_get_xy_query_infogets xy query names, titles, num pairs, etc.
USERD_prefer_auto_distributetells whether reader will distribute for SOS
USERD_set_extra_gui_datareturns Extra GUI answers provided by user
USERD_set_filename_button_labelssets Get File button text
USERD_set_var_extract_gui_datareturns var extract answers provided by user
USERD_set_var_extract_gui_datareturns var extract answers provided by user
USERD_get_max_time_stepsMaximum number of timesteps when dynamically adding timesteps (for example, if solution is ongoing)
USERD_get_var_by_component_given_coordsget variable component value at a given coord location