ExodusII 6.05
Loading...
Searching...
No Matches

Topics

 Exodus error return codes - exerrval return values
 

Data Structures

struct  ex_init_params
 
struct  ex_block
 
struct  ex_set
 
struct  ex_block_params
 
struct  ex_set_specs
 
struct  ex_var_params
 

Macros

#define EXODUS_EXPORT   extern
 
#define ex_create(path, mode, comp_ws, io_ws)   ex_create_int(path, mode, comp_ws, io_ws, EX_API_VERS_NODOT)
 
#define ex_open(path, mode, comp_ws, io_ws, version)   ex_open_int(path, mode, comp_ws, io_ws, version, EX_API_VERS_NODOT)
 

Typedefs

typedef struct ex_init_params ex_init_params
 
typedef struct ex_block ex_block
 
typedef struct ex_set ex_set
 
typedef struct ex_block_params ex_block_params
 
typedef struct ex_set_specs ex_set_specs
 
typedef struct ex_var_params ex_var_params
 

Functions

int ex_close (int exoid)
 
int ex_copy (int in_exoid, int out_exoid)
 
int ex_create_int (const char *path, int cmode, int *comp_ws, int *io_ws, int my_version)
 
int ex_create_group (int parent_id, const char *group_name)
 
int ex_get_group_id (int exoid, const char *group_name, int *group_id)
 
int ex_get_group_ids (int exoid, int *num_children, int *child_ids)
 
int ex_get_all_times (int exoid, void *time_values)
 
int ex_get_coord_names (int exoid, char **coord_names)
 
int ex_get_coord (int exoid, void *x_coor, void *y_coor, void *z_coor)
 
int ex_get_n_coord (int exoid, int64_t start_node_num, int64_t num_nodes, void *x_coor, void *y_coor, void *z_coor)
 
int ex_get_partial_coord (int exoid, int64_t start_node_num, int64_t num_nodes, void *x_coor, void *y_coor, void *z_coor)
 
int ex_get_ids (int exoid, ex_entity_type obj_type, void_int *ids)
 
int ex_get_coordinate_frames (int exoid, int *nframes, void_int *cf_ids, void *pt_coordinates, char *tags)
 
int ex_get_glob_vars (int exoid, int time_step, int num_glob_vars, void *glob_var_vals)
 
int ex_get_glob_var_time (int exoid, int glob_var_index, int beg_time_step, int end_time_step, void *glob_var_vals)
 
int ex_get_info (int exoid, char **info)
 
int ex_put_init_ext (int exoid, const ex_init_params *param)
 
int ex_get_init_ext (int exoid, ex_init_params *param)
 
int ex_get_init (int exoid, char *title, void_int *num_dim, void_int *num_nodes, void_int *num_elem, void_int *num_elem_blk, void_int *num_node_sets, void_int *num_side_sets)
 
int ex_put_init (int exoid, const char *title, int64_t num_dim, int64_t num_nodes, int64_t num_elem, int64_t num_elem_blk, int64_t num_node_sets, int64_t num_side_sets)
 
int ex_get_map_param (int exoid, int *num_node_maps, int *num_elem_maps)
 
int ex_get_name (int exoid, ex_entity_type obj_type, ex_entity_id entity_id, char *name)
 
int ex_get_names (int exoid, ex_entity_type obj_type, char **names)
 
int ex_get_n_nodal_var (int exoid, int time_step, int nodal_var_index, int64_t start_node, int64_t num_nodes, void *nodal_var_vals)
 
int ex_get_partial_nodal_var (int exoid, int time_step, int nodal_var_index, int64_t start_node, int64_t num_nodes, void *nodal_var_vals)
 
int ex_get_prop_array (int exoid, ex_entity_type obj_type, const char *prop_name, void_int *values)
 
int ex_get_prop (int exoid, ex_entity_type obj_type, ex_entity_id obj_id, const char *prop_name, void_int *value)
 
int ex_get_partial_num_map (int exoid, ex_entity_type map_type, ex_entity_id map_id, int64_t ent_start, int64_t ent_count, void_int *elem_map)
 
int ex_get_prop_names (int exoid, ex_entity_type obj_type, char **prop_names)
 
int ex_get_qa (int exoid, char *qa_record[][4])
 
int ex_get_time (int exoid, int time_step, void *time_value)
 
int ex_get_variable_names (int exoid, ex_entity_type obj_type, int num_vars, char *var_names[])
 
int ex_get_variable_name (int exoid, ex_entity_type obj_type, int var_num, char *var_name)
 
int ex_get_variable_param (int exoid, ex_entity_type obj_type, int *num_vars)
 
int ex_get_object_truth_vector (int exoid, ex_entity_type var_type, ex_entity_id object_id, int num_var, int *var_vector)
 
int ex_get_truth_table (int exoid, ex_entity_type obj_type, int num_blk, int num_var, int *var_tab)
 
int ex_open_int (const char *path, int mode, int *comp_ws, int *io_ws, float *version, int my_version)
 
int ex_add_attr (int exoid, ex_entity_type obj_type, ex_entity_id obj_id, int64_t num_attr_per_entry)
 
int ex_put_attr_param (int exoid, ex_entity_type obj_type, ex_entity_id obj_id, int num_attrs)
 
int ex_get_attr_param (int exoid, ex_entity_type obj_type, ex_entity_id obj_id, int *num_attrs)
 
int ex_put_all_var_param (int exoid, int num_g, int num_n, int num_e, int *elem_var_tab, int num_m, int *nset_var_tab, int num_s, int *sset_var_tab)
 
int ex_put_concat_elem_block (int exoid, const void_int *elem_blk_id, char *elem_type[], const void_int *num_elem_this_blk, const void_int *num_nodes_per_elem, const void_int *num_attr, int define_maps)
 
int ex_put_coord_names (int exoid, char *coord_names[])
 
int ex_put_coord (int exoid, const void *x_coor, const void *y_coor, const void *z_coor)
 
int ex_put_n_coord (int exoid, int64_t start_node_num, int64_t num_nodes, const void *x_coor, const void *y_coor, const void *z_coor)
 
int ex_put_partial_coord (int exoid, int64_t start_node_num, int64_t num_nodes, const void *x_coor, const void *y_coor, const void *z_coor)
 
int ex_put_id_map (int exoid, ex_entity_type obj_type, const void_int *map)
 
int ex_put_partial_id_map (int exoid, ex_entity_type obj_type, int64_t start_entity_num, int64_t num_entities, const void_int *map)
 
int ex_put_n_elem_num_map (int exoid, int64_t start_ent, int64_t num_ents, const void_int *map)
 
int ex_put_n_node_num_map (int exoid, int64_t start_ent, int64_t num_ents, const void_int *map)
 
int ex_put_partial_elem_num_map (int exoid, int64_t start_ent, int64_t num_ents, const void_int *map)
 
int ex_put_partial_node_num_map (int exoid, int64_t start_ent, int64_t num_ents, const void_int *map)
 
int ex_get_id_map (int exoid, ex_entity_type obj_type, void_int *map)
 
int ex_get_partial_id_map (int exoid, ex_entity_type map_type, int64_t start_entity_num, int64_t num_entities, void_int *map)
 
int ex_put_coordinate_frames (int exoid, int nframes, const void_int *cf_ids, void *pt_coordinates, const char *tags)
 
int ex_put_info (int exoid, int num_info, char *info[])
 
int ex_put_map_param (int exoid, int num_node_maps, int num_elem_maps)
 
int ex_put_name (int exoid, ex_entity_type obj_type, ex_entity_id entity_id, const char *name)
 
int ex_put_names (int exoid, ex_entity_type obj_type, char *names[])
 
int ex_put_n_one_attr (int exoid, ex_entity_type obj_type, ex_entity_id obj_id, int64_t start_num, int64_t num_ent, int attrib_index, const void *attrib)
 
int ex_put_partial_one_attr (int exoid, ex_entity_type obj_type, ex_entity_id obj_id, int64_t start_num, int64_t num_ent, int attrib_index, const void *attrib)
 
int ex_put_prop (int exoid, ex_entity_type obj_type, ex_entity_id obj_id, const char *prop_name, ex_entity_id value)
 
int ex_put_prop_array (int exoid, ex_entity_type obj_type, const char *prop_name, const void_int *values)
 
int ex_put_prop_names (int exoid, ex_entity_type obj_type, int num_props, char **prop_names)
 
int ex_put_qa (int exoid, int num_qa_records, char *qa_record[][4])
 
int ex_put_time (int exoid, int time_step, const void *time_value)
 
int ex_put_variable_name (int exoid, ex_entity_type obj_type, int var_num, const char *var_name)
 
int ex_put_variable_names (int exoid, ex_entity_type obj_type, int num_vars, char *var_names[])
 
int ex_put_variable_param (int exoid, ex_entity_type obj_type, int num_vars)
 
int ex_put_truth_table (int exoid, ex_entity_type obj_type, int num_blk, int num_var, int *var_tab)
 
int ex_update (int exoid)
 
int ex_get_num_props (int exoid, ex_entity_type obj_type)
 
int ex_large_model (int exoid)
 
size_t ex_header_size (int exoid)
 
void ex_err (const char *module_name, const char *message, int err_num)
 
void ex_get_err (const char **msg, const char **func, int *errcode)
 
int ex_opts (int options)
 
int ex_inquire (int exoid, int inquiry, void_int *, float *, char *)
 
int64_t ex_inquire_int (int exoid, int inquiry)
 
int ex_int64_status (int exoid)
 
int ex_set_int64_status (int exoid, int mode)
 
int ex_set_max_name_length (int exoid, int length)
 
int ex_set_option (int exoid, ex_option_type option, int option_value)
 
int ex_put_num_map (int exoid, ex_entity_type map_type, ex_entity_id map_id, const void_int *map)
 
int ex_get_num_map (int exoid, ex_entity_type map_type, ex_entity_id map_id, void_int *map)
 
int ex_put_block (int exoid, ex_entity_type blk_type, ex_entity_id blk_id, const char *entry_descrip, int64_t num_entries_this_blk, int64_t num_nodes_per_entry, int64_t num_edges_per_entry, int64_t num_faces_per_entry, int64_t num_attr_per_entry)
 
int ex_get_block (int exoid, ex_entity_type blk_type, ex_entity_id blk_id, char *elem_type, void_int *num_entries_this_blk, void_int *num_nodes_per_entry, void_int *num_edges_per_entry, void_int *num_faces_per_entry, void_int *num_attr_per_entry)
 
int ex_get_block_param (int exoid, ex_block *block)
 
int ex_put_block_param (int exoid, const ex_block block)
 
int ex_get_block_params (int exoid, size_t block_count, struct ex_block **blocks)
 
int ex_put_block_params (int exoid, size_t block_count, const struct ex_block *blocks)
 
int ex_put_concat_all_blocks (int exoid, const ex_block_params *param)
 
int ex_put_entity_count_per_polyhedra (int exoid, ex_entity_type blk_type, ex_entity_id blk_id, const int *entity_counts)
 
int ex_get_entity_count_per_polyhedra (int exoid, ex_entity_type blk_type, ex_entity_id blk_id, int *entity_counts)
 
int ex_put_conn (int exoid, ex_entity_type blk_type, ex_entity_id blk_id, const void_int *node_conn, const void_int *elem_edge_conn, const void_int *elem_face_conn)
 
int ex_get_conn (int exoid, ex_entity_type blk_type, ex_entity_id blk_id, void_int *nodeconn, void_int *edgeconn, void_int *faceconn)
 
int ex_get_n_conn (int exoid, ex_entity_type blk_type, ex_entity_id blk_id, int64_t start_num, int64_t num_ent, void_int *nodeconn, void_int *edgeconn, void_int *faceconn)
 
int ex_get_partial_conn (int exoid, ex_entity_type blk_type, ex_entity_id blk_id, int64_t start_num, int64_t num_ent, void_int *nodeconn, void_int *edgeconn, void_int *faceconn)
 
int ex_put_attr (int exoid, ex_entity_type blk_type, ex_entity_id blk_id, const void *attrib)
 
int ex_put_partial_attr (int exoid, ex_entity_type blk_type, ex_entity_id blk_id, int64_t start_entity, int64_t num_entity, const void *attrib)
 
int ex_get_attr (int exoid, ex_entity_type obj_type, ex_entity_id obj_id, void *attrib)
 
int ex_get_n_attr (int exoid, ex_entity_type obj_type, ex_entity_id obj_id, int64_t start_num, int64_t num_ent, void *attrib)
 
int ex_get_partial_attr (int exoid, ex_entity_type obj_type, ex_entity_id obj_id, int64_t start_num, int64_t num_ent, void *attrib)
 
int ex_put_one_attr (int exoid, ex_entity_type obj_type, ex_entity_id obj_id, int attrib_index, const void *attrib)
 
int ex_get_one_attr (int exoid, ex_entity_type obj_type, ex_entity_id obj_id, int attrib_index, void *attrib)
 
int ex_get_n_one_attr (int exoid, ex_entity_type obj_type, ex_entity_id obj_id, int64_t start_num, int64_t num_ent, int attrib_index, void *attrib)
 
int ex_get_partial_one_attr (int exoid, ex_entity_type obj_type, ex_entity_id obj_id, int64_t start_num, int64_t num_ent, int attrib_index, void *attrib)
 
int ex_put_attr_names (int exoid, ex_entity_type blk_type, ex_entity_id blk_id, char **names)
 
int ex_get_attr_names (int exoid, ex_entity_type obj_type, ex_entity_id obj_id, char **names)
 
int ex_put_set_param (int exoid, ex_entity_type set_type, ex_entity_id set_id, int64_t num_entries_in_set, int64_t num_dist_fact_in_set)
 
int ex_get_set_param (int exoid, ex_entity_type set_type, ex_entity_id set_id, void_int *num_entry_in_set, void_int *num_dist_fact_in_set)
 
int ex_put_set (int exoid, ex_entity_type set_type, ex_entity_id set_id, const void_int *set_entry_list, const void_int *set_extra_list)
 
int ex_put_partial_set (int exoid, ex_entity_type set_type, ex_entity_id set_id, int64_t offset, int64_t count, const void_int *set_entry_list, const void_int *set_extra_list)
 
int ex_get_set (int exoid, ex_entity_type set_type, ex_entity_id set_id, void_int *set_entry_list, void_int *set_extra_list)
 
int ex_put_set_dist_fact (int exoid, ex_entity_type set_type, ex_entity_id set_id, const void *set_dist_fact)
 
int ex_get_set_dist_fact (int exoid, ex_entity_type set_type, ex_entity_id set_id, void *set_dist_fact)
 
int ex_get_partial_set_dist_fact (int exoid, ex_entity_type set_type, ex_entity_id set_id, int64_t offset, int64_t num_to_put, void *set_dist_fact)
 
int ex_put_concat_sets (int exoid, ex_entity_type set_type, const struct ex_set_specs *set_specs)
 
int ex_get_concat_sets (int exoid, ex_entity_type set_type, struct ex_set_specs *set_specs)
 
int ex_put_sets (int exoid, size_t set_count, const struct ex_set *sets)
 
int ex_get_sets (int exoid, size_t set_count, struct ex_set *sets)
 
int ex_put_all_var_param_ext (int exoid, const ex_var_params *vp)
 
int ex_put_var (int exoid, int time_step, ex_entity_type var_type, int var_index, ex_entity_id obj_id, int64_t num_entries_this_obj, const void *var_vals)
 
int ex_put_n_var (int exoid, int time_step, ex_entity_type var_type, int var_index, ex_entity_id obj_id, int64_t start_index, int64_t num_entities, const void *var_vals)
 
int ex_put_partial_var (int exoid, int time_step, ex_entity_type var_type, int var_index, ex_entity_id obj_id, int64_t start_index, int64_t num_entities, const void *var_vals)
 
int ex_get_var (int exoid, int time_step, ex_entity_type var_type, int var_index, ex_entity_id obj_id, int64_t num_entry_this_obj, void *var_vals)
 
int ex_get_n_var (int exoid, int time_step, ex_entity_type var_type, int var_index, ex_entity_id obj_id, int64_t start_index, int64_t num_entities, void *var_vals)
 
int ex_get_n_elem_var (int exoid, int time_step, int elem_var_index, ex_entity_id elem_blk_id, int64_t num_elem_this_blk, int64_t start_elem_num, int64_t num_elem, void *elem_var_vals)
 
int ex_get_partial_var (int exoid, int time_step, ex_entity_type var_type, int var_index, ex_entity_id obj_id, int64_t start_index, int64_t num_entities, void *var_vals)
 
int ex_get_partial_elem_var (int exoid, int time_step, int elem_var_index, ex_entity_id elem_blk_id, int64_t num_elem_this_blk, int64_t start_elem_num, int64_t num_elem, void *elem_var_vals)
 
int ex_get_var_time (int exoid, ex_entity_type var_type, int var_index, int64_t id, int beg_time_step, int end_time_step, void *var_vals)
 
int ex_cvt_nodes_to_sides (int exoid, void_int *num_elem_per_set, void_int *num_nodes_per_set, void_int *side_sets_elem_index, void_int *side_sets_node_index, void_int *side_sets_elem_list, void_int *side_sets_node_list, void_int *side_sets_side_list)
 
int ex_put_nodal_var (int exoid, int time_step, int nodal_var_index, int64_t num_nodes, const void *nodal_var_vals)
 
int ex_put_n_nodal_var (int exoid, int time_step, int nodal_var_index, int64_t start_node, int64_t num_nodes, const void *nodal_var_vals)
 
int ex_put_partial_nodal_var (int exoid, int time_step, int nodal_var_index, int64_t start_node, int64_t num_nodes, const void *nodal_var_vals)
 
int ex_get_partial_elem_map (int exoid, ex_entity_id map_id, int64_t ent_start, int64_t ent_count, void_int *elem_map)
 
int ex_put_partial_elem_map (int exoid, ex_entity_id map_id, int64_t ent_start, int64_t ent_count, const void_int *elem_map)
 
int ex_put_partial_num_map (int exoid, ex_entity_type map_type, ex_entity_id map_id, int64_t ent_start, int64_t ent_count, const void_int *map)
 
int ex_put_partial_set_dist_fact (int exoid, ex_entity_type set_type, ex_entity_id set_id, int64_t offset, int64_t num_to_put, const void *set_dist_fact)
 
int ex_get_concat_side_set_node_count (int exoid, int *side_set_node_cnt_list)
 
int ex_get_side_set_node_list_len (int exoid, ex_entity_id side_set_id, void_int *side_set_node_list_len)
 
int ex_get_side_set_node_count (int exoid, ex_entity_id side_set_id, int *side_set_node_cnt_list)
 
int ex_get_side_set_node_list (int exoid, ex_entity_id side_set_id, void_int *side_set_node_cnt_list, void_int *side_set_node_list)
 
int ex_get_init_info (int exoid, int *num_proc, int *num_proc_in_f, char *ftype)
 
int ex_put_init_info (int exoid, int num_proc, int num_proc_in_f, char *ftype)
 
int ex_get_init_global (int exoid, void_int *num_nodes_g, void_int *num_elems_g, void_int *num_elem_blks_g, void_int *num_node_sets_g, void_int *num_side_sets_g)
 
int ex_put_init_global (int exoid, int64_t num_nodes_g, int64_t num_elems_g, int64_t num_elem_blks_g, int64_t num_node_sets_g, int64_t num_side_sets_g)
 
int ex_get_loadbal_param (int exoid, void_int *num_int_nodes, void_int *num_bor_nodes, void_int *num_ext_nodes, void_int *num_int_elems, void_int *num_bor_elems, void_int *num_node_cmaps, void_int *num_elem_cmaps, int processor)
 
int ex_put_loadbal_param (int exoid, int64_t num_int_nodes, int64_t num_bor_nodes, int64_t num_ext_nodes, int64_t num_int_elems, int64_t num_bor_elems, int64_t num_node_cmaps, int64_t num_elem_cmaps, int processor)
 
int ex_put_loadbal_param_cc (int exoid, void_int *num_int_nodes, void_int *num_bor_nodes, void_int *num_ext_nodes, void_int *num_int_elems, void_int *num_bor_elems, void_int *num_node_cmaps, void_int *num_elem_cmaps)
 
int ex_get_ns_param_global (int exoid, void_int *ns_ids_glob, void_int *ns_n_cnt_glob, void_int *ns_df_cnt_glob)
 
int ex_put_ns_param_global (int exoid, void_int *global_ids, void_int *global_n_cnts, void_int *global_df_cnts)
 
int ex_get_ss_param_global (int exoid, void_int *ss_ids_glob, void_int *ss_s_cnt_glob, void_int *ss_df_cnt_glob)
 
int ex_put_ss_param_global (int exoid, void_int *global_ids, void_int *global_el_cnts, void_int *global_df_cnts)
 
int ex_get_eb_info_global (int exoid, void_int *el_blk_ids, void_int *el_blk_cnts)
 
int ex_put_eb_info_global (int exoid, void_int *el_blk_ids, void_int *el_blk_cnts)
 
int ex_get_n_side_set (int exoid, ex_entity_id side_set_id, int64_t start_side_num, int64_t num_sides, void_int *side_set_elem_list, void_int *side_set_side_list)
 
int ex_put_n_side_set (int exoid, ex_entity_id side_set_id, int64_t start_side_num, int64_t num_sides, const void_int *side_set_elem_list, const void_int *side_set_side_list)
 
int ex_get_n_side_set_df (int exoid, ex_entity_id side_set_id, int64_t start_num, int64_t num_df_to_get, void *side_set_df)
 
int ex_put_n_side_set_df (int exoid, ex_entity_id side_set_id, int64_t start_num, int64_t num_df_to_get, void *side_set_df)
 
int ex_get_n_node_set (int exoid, ex_entity_id node_set_id, int64_t start_node_num, int64_t num_node, void_int *node_set_node_list)
 
int ex_put_n_node_set (int exoid, ex_entity_id node_set_id, int64_t start_node_num, int64_t num_node, const void_int *node_set_node_list)
 
int ex_get_n_node_set_df (int exoid, ex_entity_id node_set_id, int64_t start_num, int64_t num_df_to_get, void *node_set_df)
 
int ex_put_n_node_set_df (int exoid, ex_entity_id node_set_id, int64_t start_num, int64_t num_df_to_get, void *node_set_df)
 
int ex_get_n_elem_conn (int exoid, ex_entity_id elem_blk_id, int64_t start_elem_num, int64_t num_elems, void_int *connect)
 
int ex_put_n_elem_conn (int exoid, ex_entity_id elem_blk_id, int64_t start_elem_num, int64_t num_elems, const void_int *connect)
 
int ex_get_n_elem_attr (int exoid, ex_entity_id elem_blk_id, int64_t start_elem_num, int64_t num_elems, void *attrib)
 
int ex_put_n_elem_attr (int exoid, ex_entity_id elem_blk_id, int64_t start_elem_num, int64_t num_elems, void *attrib)
 
int ex_get_partial_side_set (int exoid, ex_entity_id side_set_id, int64_t start_side_num, int64_t num_sides, void_int *side_set_elem_list, void_int *side_set_side_list)
 
int ex_put_partial_side_set (int exoid, ex_entity_id side_set_id, int64_t start_side_num, int64_t num_sides, const void_int *side_set_elem_list, const void_int *side_set_side_list)
 
int ex_get_partial_side_set_df (int exoid, ex_entity_id side_set_id, int64_t start_num, int64_t num_df_to_get, void *side_set_df)
 
int ex_put_partial_side_set_df (int exoid, ex_entity_id side_set_id, int64_t start_num, int64_t num_df_to_get, void *side_set_df)
 
int ex_get_partial_node_set (int exoid, ex_entity_id node_set_id, int64_t start_node_num, int64_t num_node, void_int *node_set_node_list)
 
int ex_put_partial_node_set (int exoid, ex_entity_id node_set_id, int64_t start_node_num, int64_t num_node, const void_int *node_set_node_list)
 
int ex_get_partial_node_set_df (int exoid, ex_entity_id node_set_id, int64_t start_num, int64_t num_df_to_get, void *node_set_df)
 
int ex_put_partial_node_set_df (int exoid, ex_entity_id node_set_id, int64_t start_num, int64_t num_df_to_get, void *node_set_df)
 
int ex_get_partial_elem_conn (int exoid, ex_entity_id elem_blk_id, int64_t start_elem_num, int64_t num_elems, void_int *connect)
 
int ex_put_partial_elem_conn (int exoid, ex_entity_id elem_blk_id, int64_t start_elem_num, int64_t num_elems, const void_int *connect)
 
int ex_get_partial_elem_attr (int exoid, ex_entity_id elem_blk_id, int64_t start_elem_num, int64_t num_elems, void *attrib)
 
int ex_put_partial_elem_attr (int exoid, ex_entity_id elem_blk_id, int64_t start_elem_num, int64_t num_elems, void *attrib)
 
int ex_get_elem_type (int exoid, ex_entity_id elem_blk_id, char *elem_type)
 
int ex_put_elem_var_slab (int exoid, int time_step, int elem_var_index, ex_entity_id elem_blk_id, int64_t start_pos, int64_t num_vals, void *elem_var_vals)
 
int ex_put_nodal_var_slab (int exoid, int time_step, int nodal_var_index, int64_t start_pos, int64_t num_vals, void *nodal_var_vals)
 
int ex_get_n_elem_num_map (int exoid, int64_t start_ent, int64_t num_ents, void_int *elem_map)
 
int ex_get_n_node_num_map (int exoid, int64_t start_ent, int64_t num_ents, void_int *node_map)
 
int ex_get_partial_elem_num_map (int exoid, int64_t start_ent, int64_t num_ents, void_int *elem_map)
 
int ex_get_partial_node_num_map (int exoid, int64_t start_ent, int64_t num_ents, void_int *node_map)
 
int ex_get_processor_node_maps (int exoid, void_int *node_mapi, void_int *node_mapb, void_int *node_mape, int processor)
 
int ex_put_processor_node_maps (int exoid, void_int *node_mapi, void_int *node_mapb, void_int *node_mape, int processor)
 
int ex_get_processor_elem_maps (int exoid, void_int *elem_mapi, void_int *elem_mapb, int processor)
 
int ex_put_processor_elem_maps (int exoid, void_int *elem_mapi, void_int *elem_mapb, int processor)
 
int ex_get_cmap_params (int exoid, void_int *node_cmap_ids, void_int *node_cmap_node_cnts, void_int *elem_cmap_ids, void_int *elem_cmap_elem_cnts, int processor)
 
int ex_put_cmap_params (int exoid, void_int *node_map_ids, void_int *node_map_node_cnts, void_int *elem_map_ids, void_int *elem_map_elem_cnts, int64_t processor)
 
int ex_put_cmap_params_cc (int exoid, void_int *node_map_ids, void_int *node_map_node_cnts, void_int *node_proc_ptrs, void_int *elem_map_ids, void_int *elem_map_elem_cnts, void_int *elem_proc_ptrs)
 
int ex_get_node_cmap (int exoid, ex_entity_id map_id, void_int *node_ids, void_int *proc_ids, int processor)
 
int ex_put_node_cmap (int exoid, ex_entity_id map_id, void_int *node_ids, void_int *proc_ids, int processor)
 
int ex_get_elem_cmap (int exoid, ex_entity_id map_id, void_int *elem_ids, void_int *side_ids, void_int *proc_ids, int processor)
 
int ex_put_elem_cmap (int exoid, ex_entity_id map_id, void_int *elem_ids, void_int *side_ids, void_int *proc_ids, int processor)
 
int ex_get_nodal_var (int exoid, int time_step, int nodal_var_index, int64_t num_nodes, void *nodal_var_vals)
 
int ex_get_nodal_var_time (int exoid, int nodal_var_index, int64_t node_number, int beg_time_step, int end_time_step, void *nodal_var_vals)
 
int ex_get_concat_node_sets (int exoid, void_int *node_set_ids, void_int *num_nodes_per_set, void_int *num_df_per_set, void_int *node_sets_node_index, void_int *node_sets_df_index, void_int *node_sets_node_list, void *node_sets_dist_fact)
 
int ex_get_concat_side_sets (int exoid, void_int *side_set_ids, void_int *num_elem_per_set, void_int *num_dist_per_set, void_int *side_sets_elem_index, void_int *side_sets_dist_index, void_int *side_sets_elem_list, void_int *side_sets_side_list, void *side_sets_dist_fact)
 
int ex_get_elem_attr (int exoid, ex_entity_id elem_blk_id, void *attrib)
 
int ex_get_elem_attr_names (int exoid, ex_entity_id elem_blk_id, char **names)
 
int ex_get_elem_blk_ids (int exoid, void_int *ids)
 
int ex_get_elem_block (int exoid, ex_entity_id elem_blk_id, char *elem_type, void_int *num_elem_this_blk, void_int *num_nodes_per_elem, void_int *num_attr)
 
int ex_get_elem_conn (int exoid, ex_entity_id elem_blk_id, void_int *connect)
 
int ex_get_elem_map (int exoid, ex_entity_id map_id, void_int *elem_map)
 
int ex_get_elem_num_map (int exoid, void_int *elem_map)
 
int ex_get_elem_var (int exoid, int time_step, int elem_var_index, ex_entity_id elem_blk_id, int64_t num_elem_this_blk, void *elem_var_vals)
 
int ex_get_elem_var_tab (int exoid, int num_elem_blk, int num_elem_var, int *elem_var_tab)
 
int ex_get_elem_var_time (int exoid, int elem_var_index, int64_t elem_number, int beg_time_step, int end_time_step, void *elem_var_vals)
 
int ex_get_map (int exoid, void_int *elem_map)
 
int ex_get_node_map (int exoid, ex_entity_id map_id, void_int *node_map)
 
int ex_get_node_num_map (int exoid, void_int *node_map)
 
int ex_get_node_set_param (int exoid, ex_entity_id node_set_id, void_int *num_nodes_in_set, void_int *num_df_in_set)
 
int ex_get_node_set (int exoid, ex_entity_id node_set_id, void_int *node_set_node_list)
 
int ex_get_node_set_dist_fact (int exoid, ex_entity_id node_set_id, void *node_set_dist_fact)
 
int ex_get_node_set_ids (int exoid, void_int *ids)
 
int ex_get_nset_var_tab (int exoid, int num_nodesets, int num_nset_var, int *nset_var_tab)
 
int ex_get_nset_var (int exoid, int time_step, int nset_var_index, ex_entity_id nset_id, int64_t num_node_this_nset, void *nset_var_vals)
 
int ex_get_one_elem_attr (int exoid, ex_entity_id elem_blk_id, int attrib_index, void *attrib)
 
int ex_get_side_set (int exoid, ex_entity_id side_set_id, void_int *side_set_elem_list, void_int *side_set_side_list)
 
int ex_get_side_set_dist_fact (int exoid, ex_entity_id side_set_id, void *side_set_dist_fact)
 
int ex_get_side_set_ids (int exoid, void_int *ids)
 
int ex_get_side_set_param (int exoid, ex_entity_id side_set_id, void_int *num_side_in_set, void_int *num_dist_fact_in_set)
 
int ex_get_sset_var (int exoid, int time_step, int sset_var_index, ex_entity_id sset_id, int64_t num_side_this_sset, void *sset_var_vals)
 
int ex_get_sset_var_tab (int exoid, int num_sidesets, int num_sset_var, int *sset_var_tab)
 
int ex_get_var_names (int exoid, const char *var_type, int num_vars, char *var_names[])
 
int ex_get_var_name (int exoid, const char *var_type, int var_num, char *var_name)
 
int ex_get_var_param (int exoid, const char *var_type, int *num_vars)
 
int ex_get_var_tab (int exoid, const char *var_type, int num_blk, int num_var, int *var_tab)
 
int ex_put_concat_node_sets (int exoid, void_int *node_set_ids, void_int *num_nodes_per_set, void_int *num_dist_per_set, void_int *node_sets_node_index, void_int *node_sets_df_index, void_int *node_sets_node_list, void *node_sets_dist_fact)
 
int ex_put_concat_side_sets (int exoid, void_int *side_set_ids, void_int *num_elem_per_set, void_int *num_dist_per_set, void_int *side_sets_elem_index, void_int *side_sets_dist_index, void_int *side_sets_elem_list, void_int *side_sets_side_list, void *side_sets_dist_fact)
 
int ex_put_concat_var_param (int exoid, int num_g, int num_n, int num_e, int num_elem_blk, int *elem_var_tab)
 
int ex_put_elem_attr_names (int exoid, ex_entity_id elem_blk_id, char *names[])
 
int ex_put_elem_attr (int exoid, ex_entity_id elem_blk_id, const void *attrib)
 
int ex_put_elem_block (int exoid, ex_entity_id elem_blk_id, const char *elem_type, int64_t num_elem_this_blk, int64_t num_nodes_per_elem, int64_t num_attr)
 
int ex_put_elem_conn (int exoid, ex_entity_id elem_blk_id, const void_int *connect)
 
int ex_put_elem_map (int exoid, ex_entity_id map_id, const void_int *elem_map)
 
int ex_put_elem_num_map (int exoid, const void_int *elem_map)
 
int ex_put_elem_var (int exoid, int time_step, int elem_var_index, ex_entity_id elem_blk_id, int64_t num_elem_this_blk, const void *elem_var_vals)
 
int ex_put_elem_var_tab (int exoid, int num_elem_blk, int num_elem_var, int *elem_var_tab)
 
int ex_put_glob_vars (int exoid, int time_step, int num_glob_vars, const void *glob_var_vals)
 
int ex_put_map (int exoid, const void_int *elem_map)
 
int ex_put_node_map (int exoid, ex_entity_id map_id, const void_int *node_map)
 
int ex_put_node_num_map (int exoid, const void_int *node_map)
 
int ex_put_node_set (int exoid, ex_entity_id node_set_id, const void_int *node_set_node_list)
 
int ex_put_node_set_dist_fact (int exoid, ex_entity_id node_set_id, const void *node_set_dist_fact)
 
int ex_put_node_set_param (int exoid, ex_entity_id node_set_id, int64_t num_nodes_in_set, int64_t num_dist_in_set)
 
int ex_put_nset_var (int exoid, int time_step, int nset_var_index, ex_entity_id nset_id, int64_t num_nodes_this_nset, const void *nset_var_vals)
 
int ex_put_nset_var_tab (int exoid, int num_nset, int num_nset_var, int *nset_var_tab)
 
int ex_put_one_elem_attr (int exoid, ex_entity_id elem_blk_id, int attrib_index, const void *attrib)
 
int ex_put_side_set (int exoid, ex_entity_id side_set_id, const void_int *side_set_elem_list, const void_int *side_set_side_list)
 
int ex_put_side_set_dist_fact (int exoid, ex_entity_id side_set_id, const void *side_set_dist_fact)
 
int ex_put_side_set_param (int exoid, ex_entity_id side_set_id, int64_t num_side_in_set, int64_t num_dist_fact_in_set)
 
int ex_put_sset_var (int exoid, int time_step, int sset_var_index, ex_entity_id sset_id, int64_t num_faces_this_sset, const void *sset_var_vals)
 
int ex_put_sset_var_tab (int exoid, int num_sset, int num_sset_var, int *sset_var_tab)
 
int ex_put_var_name (int exoid, const char *var_type, int var_num, const char *var_name)
 
int ex_put_var_names (int exoid, const char *var_type, int num_vars, char *var_names[])
 
int ex_put_var_param (int exoid, const char *var_type, int num_vars)
 
int ex_put_var_tab (int exoid, const char *var_type, int num_blk, int num_var, int *var_tab)
 
char * ex_name_of_object (ex_entity_type obj_type)
 
ex_entity_type ex_var_type_to_ex_entity_type (char var_type)
 
int ex_get_idx (int neid, const char *ne_var_name, int64_t *index, int pos)
 

Variables

int exerrval
 
int exoptval
 

Detailed Description

Macro Definition Documentation

◆ ex_create

#define ex_create ( path,
mode,
comp_ws,
io_ws )   ex_create_int(path, mode, comp_ws, io_ws, EX_API_VERS_NODOT)

◆ ex_open

#define ex_open ( path,
mode,
comp_ws,
io_ws,
version )   ex_open_int(path, mode, comp_ws, io_ws, version, EX_API_VERS_NODOT)

◆ EXODUS_EXPORT

#define EXODUS_EXPORT   extern

Typedef Documentation

◆ ex_block

typedef struct ex_block ex_block

◆ ex_block_params

typedef struct ex_block_params ex_block_params

◆ ex_init_params

typedef struct ex_init_params ex_init_params

◆ ex_set

typedef struct ex_set ex_set

◆ ex_set_specs

typedef struct ex_set_specs ex_set_specs

◆ ex_var_params

typedef struct ex_var_params ex_var_params

Function Documentation

◆ ex_add_attr()

int ex_add_attr ( int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int64_t num_attr_per_entry )
extern

◆ ex_close()

int ex_close ( int exoid)
extern

The function ex_close() updates and then closes an open exodus file.

Returns
In case of an error, ex_close() returns a negative number; a warning will return a positive number. Possible causes of errors include:
Parameters
exoidexodus file ID returned from a previous call to ex_create() or ex_open().

The following code segment closes an open exodus file:

int error,exoid;
error = ex_close (exoid);
int ex_close(int exoid)
Definition ex_close.c:76

◆ ex_copy()

int ex_copy ( int in_exoid,
int out_exoid )
extern
Undocumented

efficiently copies all non-transient information (attributes, dimensions, and variables from an opened EXODUS file to another opened EXODUS file. Will not overwrite a dimension or variable already defined in the new file.

Parameters
in_exoidexodus file id for input file
out_exoidexodus file id for output file

◆ ex_create_group()

int ex_create_group ( int parent_id,
const char * group_name )
extern

◆ ex_create_int()

int ex_create_int ( const char * path,
int cmode,
int * comp_ws,
int * io_ws,
int my_version )
extern

◆ ex_cvt_nodes_to_sides()

int ex_cvt_nodes_to_sides ( int exoid,
void_int * num_elem_per_set,
void_int * num_nodes_per_set,
void_int * side_sets_elem_index,
void_int * side_sets_node_index,
void_int * side_sets_elem_list,
void_int * side_sets_node_list,
void_int * side_sets_side_list )
extern

The function ex_cvt_nodes_to_sides() is used to convert a side set node list to a side set side list. This routine is provided for application programs that utilize side sets defined by nodes (as was done previous to release 2.0) rather than local faces or edges. The application program must allocate memory for the returned array of sides. The length of this array is the same as the length of the concatenated side sets element list, which can be determined with a call to ex_inquire() or ex_inquire_int().

Returns
In case of an error, ex_cvt_nodes_to_sides() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • a warning value is returned if no side sets are stored in the file.
  • because the faces of a wedge require a different number of nodes to describe them (quadrilateral vs. triangular faces), the function will abort with a fatal return code if a wedge is encountered in the side set element list.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]num_elem_per_setArray containing the number of sides for each set. The number of sides is equal to the number of elements for each set.
[in]num_nodes_per_setArray containing the number of nodes for each set.
[in]side_sets_elem_indexArray containing indices into the side_sets_elem_list which are the locations of the first element for each set. These indices are 0-based. Unused.
[in]side_sets_node_indexArray containing indices into the side_sets_node_list which are the locations of the first node for each set. These indices are 0-based. Unused.
[in]side_sets_elem_listArray containing the elements for all side sets. Internal element IDs are used in this list (see Section LocalElementIds).
[in]side_sets_node_listArray containing the nodes for all side sets. Internal node IDs are used in this list (see Section LocalNodeIds).
[out]side_sets_side_listReturned array containing the sides for all side sets.

The following code segment will convert side sets described by nodes to side sets described by local side numbers:

int error, exoid, ids[2], num_side_per_set[2],
num_nodes_per_set[2], elem_ind[2], node_ind[2],
elem_list[4], node_list[8], el_lst_len, *side_list;
ids[0] = 30 ; ids[1] = 31;
num_side_per_set[0] = 2; num_side_per_set[1] = 2;
num_nodes_per_set[0] = 4; num_nodes_per_set[1] = 4;
elem_ind[0] = 0; elem_ind[1] = 2;
node_ind[0] = 0; node_ind[1] = 4;
\comment{side set #1}
elem_list[0] = 2; elem_list[1] = 2;
node_list[0] = 8; node_list[1] = 5;
node_list[2] = 6; node_list[3] = 7;
\comment{side set #2}
elem_list[2] = 1; elem_list[3] = 2;
node_list[4] = 2; node_list[5] = 3;
node_list[6] = 7; node_list[7] = 8;
el_lst_len = ex_inquire_int(exoid, EX_INQ_SS_ELEM_LEN);
\comment{side set element list is same length as side list}
side_list = (int *) calloc (el_lst_len, sizeof(int));
ex_cvt_nodes_to_sides(exoid, num_side_per_set, num_nodes_per_set,
elem_ind, node_ind, elem_list,
node_list, side_list);
int ex_cvt_nodes_to_sides(int exoid, void_int *num_elem_per_set, void_int *num_nodes_per_set, void_int *side_sets_elem_index, void_int *side_sets_node_index, void_int *side_sets_elem_list, void_int *side_sets_node_list, void_int *side_sets_side_list)
Definition ex_cvt_nodes_to_sides.c:188
int64_t ex_inquire_int(int exoid, int inquiry)
Definition ex_inquire.c:1109
@ EX_INQ_SS_ELEM_LEN
Definition exodusII.h:141

Algorithm:

  Read elem_block_ids --> elem_blk_id[array]

  Read element block parameters --> elem_blk_parms[array]

  Determine total number of elements in side set by summing num_elem_per_set

  Build side set element to side set node list index --> ss_elem_node_ndx[array]

  For each element in the side_set_elem_list  {
    If Jth element is not in current element block (e.g. J>elem_ctr) {
      get element block parameters (num_elem_in_blk, ...)
      elem_ctr += num_elem_in_blk

      free old connectity array space
      allocate connectivity array: size=num_elem_in_blk*num_nodes_per_elem
      get connectivity array
    }

    If Jth element is in current element block (e.g. J<=elem_ctr) {
      For each node in element (linear search of up to num_nodes_per_elem) {
        If side set element node[1] == element node[i] {
          Case element type = Hex {
            If side set element node[2] == element node[Hex_table[i,1]]
              Jth side = Hex_table[i,2]

             break
          }
          Case element type = Wedge {
            If side set element node[2] == element node[Wedge_table[i,1]]
              Jth side = Wedge_table[i,2]

            break
          }
        }
      }
    }
  }

◆ ex_err()

void ex_err ( const char * module_name,
const char * message,
int err_num )
extern

◆ ex_get_all_times()

int ex_get_all_times ( int exoid,
void * time_values )
extern

The function ex_get_all_times() reads the time values for all time steps. Memory must be allocated for the time values array before this function is invoked. The storage requirements (equal to the number of time steps) can be determined by using the ex_inquire() or ex_inquire_int() routines.

Because time values are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_get_all_times() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • no time steps have been stored in the file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[out]time_valuesReturned array of times. These are the time values at all time steps.

The following code segment will read the time values for all time steps stored in the data file:

int error, exoid, num_time_steps;
float *time_values;
\comment{determine how many time steps are stored}
num_time_steps = ex_inquire_int(exoid, EX_INQ_TIME);
\comment{read time values at all time steps}
time_values = (float *) calloc(num_time_steps, sizeof(float));
error = ex_get_all_times(exoid, time_values);
int ex_get_all_times(int exoid, void *time_values)
Definition ex_get_all_times.c:81
@ EX_INQ_TIME
Definition exodusII.h:144

◆ ex_get_attr()

int ex_get_attr ( int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
void * attrib )
extern
Undocumented
reads the attributes for an edge, face, or element block

◆ ex_get_attr_names()

int ex_get_attr_names ( int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
char ** names )
extern

◆ ex_get_attr_param()

int ex_get_attr_param ( int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int * num_attrs )
extern
Undocumented
retrieves the number of attributes.

◆ ex_get_block()

int ex_get_block ( int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
char * elem_type,
void_int * num_entries_this_blk,
void_int * num_nodes_per_entry,
void_int * num_edges_per_entry,
void_int * num_faces_per_entry,
void_int * num_attr_per_entry )
extern
Deprecated
Use ex_get_block_param()
Undocumented
exgblk - read block parameters

entry conditions - input parameters: int idexo exodus file id int blk_type block type (edge,face,element) int blk_id block id

exit conditions - char* elem_type element type name int* num_entries_this_blk number of elements in this element block int* num_nodes_per_entry number of nodes per element block int* num_attr_per_entry number of attributes

revision history -

◆ ex_get_block_param()

int ex_get_block_param ( int exoid,
ex_block * block )
extern
Undocumented
exgblk - read block parameters

entry conditions - input parameters: int idexo exodus file id int blk_type block type (edge,face,element) int blk_id block id

exit conditions - char* elem_type element type name int* num_entries_this_blk number of elements in this element block int* num_nodes_per_entry number of nodes per element block int* num_attr_per_entry number of attributes

revision history -

◆ ex_get_block_params()

int ex_get_block_params ( int exoid,
size_t block_count,
struct ex_block ** blocks )
extern

Reads the parameters describing element/face/edge blocks

Parameters
exoidexodus file id
block_countnumber of blocks being queried
blockarray of ex_block structures describing block counts

the id and type fields of the block(s) must be defined to specify which blocks to access; all other fileds will be filled in based on data from the file

◆ ex_get_cmap_params()

int ex_get_cmap_params ( int exoid,
void_int * node_cmap_ids,
void_int * node_cmap_node_cnts,
void_int * elem_cmap_ids,
void_int * elem_cmap_elem_cnts,
int processor )
extern

◆ ex_get_concat_node_sets()

int ex_get_concat_node_sets ( int exoid,
void_int * node_set_ids,
void_int * num_nodes_per_set,
void_int * num_df_per_set,
void_int * node_sets_node_index,
void_int * node_sets_df_index,
void_int * node_sets_node_list,
void * node_sets_dist_fact )
extern
Deprecated
Use ex_get_concat_sets()(exoid, EX_NODE_SET, set_specs) instead

The function ex_get_concat_node_sets() reads the node set ID's, node set node count array, node set distribution factors count array, node set node pointers array, node set distribution factors pointer array, node set node list, and node set distribution factors for all of the node sets. `‘Concatenated node sets’' refers to the arrays required to define all of the node sets (ID array, counts arrays, pointers arrays, node list array, and distribution factors array) as described in Section 3.10 on page 11.

Because the distribution factors are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

The length of each of the returned arrays can be determined by invoking ex_inquire() or ex_inquire_int().

Returns
In case of an error, ex_get_concat_node_sets() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • a warning value is returned if no node sets are stored in the file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[out]node_set_idsReturned array containing the node set ID for each set.
[out]num_nodes_per_setReturned array containing the number of nodes for each set.
[out]num_df_per_setReturned array containing the number of distribution factors for each set.
[out]node_sets_node_indexReturned array containing the indices into the node_set_node_list which are the locations of the first node for each set. These indices are 0-based.
[out]node_sets_df_indexReturned array containing the indices into the node_set_dist_fact which are the locations of the first distribution factor for each set. These indices are 0-based.
[out]node_sets_node_listReturned array containing the nodes for all sets. Internal node IDs are used in this list (see Section LocalNodeIds).
[out]node_sets_dist_factReturned array containing the distribution factors for all sets.

As an example, the following code segment will read concatenated node sets:

int error, exoid, num_node_sets, list_len, *ids,
*num_nodes_per_set, *num_df_per_set, *node_ind,
*df_ind, *node_list;
float *dist_fact
\comment{read concatenated node sets}
num_node_sets = ex_inquire_int(exoid, EX_INQ_NODE_SETS);
ids = (int *) calloc(num_node_sets, sizeof(int));
num_nodes_per_set = (int *) calloc(num_node_sets, sizeof(int));
num_df_per_set = (int *) calloc(num_node_sets, sizeof(int));
node_ind = (int *) calloc(num_node_sets, sizeof(int));
df_ind = (int *) calloc(num_node_sets, sizeof(int));
node_list = (int *) calloc(list_len, sizeof(int));
list_len = ex_inquire_int(exoid, EX_INQ_NS_DF_LEN);
dist_fact = (float *) calloc(list_len, sizeof(float));
error = ex_get_concat_node_sets (exoid, ids, num_nodes_per_set,
num_df_per_set, node_ind, df_ind,
node_list, dist_fact);
int ex_get_concat_node_sets(int exoid, void_int *node_set_ids, void_int *num_nodes_per_set, void_int *num_df_per_set, void_int *node_sets_node_index, void_int *node_sets_df_index, void_int *node_sets_node_list, void *node_sets_dist_fact)
Definition ex_get_concat_node_sets.c:122
@ EX_INQ_NS_NODE_LEN
Definition exodusII.h:138
@ EX_INQ_NODE_SETS
Definition exodusII.h:137
@ EX_INQ_NS_DF_LEN
Definition exodusII.h:148

◆ ex_get_concat_sets()

int ex_get_concat_sets ( int exoid,
ex_entity_type set_type,
struct ex_set_specs * set_specs )
extern
Undocumented
exgcss - ex_get_concat_sets

reads the set ID's, set entry count array, set entry pointers array, set entry list, set extra list, and set distribution factors for all sets of the specified type.

entry conditions - input parameters: int exoid exodus file id ex_entity_type set_type type of set

exit conditions - struct ex_set_specs* set_specs set specs structure

revision history -

◆ ex_get_concat_side_set_node_count()

int ex_get_concat_side_set_node_count ( int exoid,
int * side_set_node_cnt_list )
extern

◆ ex_get_concat_side_sets()

int ex_get_concat_side_sets ( int exoid,
void_int * side_set_ids,
void_int * num_elem_per_set,
void_int * num_dist_per_set,
void_int * side_sets_elem_index,
void_int * side_sets_dist_index,
void_int * side_sets_elem_list,
void_int * side_sets_side_list,
void * side_sets_dist_fact )
extern
Undocumented
reads the side set ID's, side set element count array, side set node count array, side set element pointers array, side set node pointers array, side set element list, side set node list, and side set distribution factors
Deprecated
Use ex_get_concat_sets()(exoid, EX_SIDE_SET, set_specs) instead

◆ ex_get_conn()

int ex_get_conn ( int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
void_int * nodeconn,
void_int * edgeconn,
void_int * faceconn )
extern
Undocumented
exgconn - exodusII read edge/face/element block connectivity

entry conditions - expelb must be called first to establish element block parameters. input parameters: int exoid exodus file id int blk_type block type (edge, face, element) int blk_id block id

exit conditions - int* nodeconn nodal connectivity array int* edgeconn edge connectivity array (where applicable) int* faceconn face connectivity array (where applicable)

◆ ex_get_coord()

int ex_get_coord ( int exoid,
void * x_coor,
void * y_coor,
void * z_coor )
extern

The function ex_get_coord() reads the nodal coordinates of the nodes. Memory must be allocated for the coordinate arrays (x_coor, y_coor, and z_coor) before this call is made. The length of each of these arrays is the number of nodes in the mesh.

Because the coordinates are floating point values, the application code must declare the arrays passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_get_coord() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • a warning value is returned if nodal coordinates were not stored.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[out]x_coorReturned X coordinates of the nodes. If this is NULL, the X-coordinates will not be read.
[out]y_coorReturned Y coordinates of the nodes. These are returned only if num_dim > 1; otherwise, pass in NULL. If this is NULL, the Y-coordinates will not be read.
[out]z_coorReturned Z coordinates of the nodes. These are returned only if num_dim > 2; otherwise, pass in NULL. If this is NULL, the Z-coordinates will not be read.

The following code segment will read the nodal coordinates from an open exodus file :

int error, exoid;
double *x, *y, *z;
\comment{read nodal coordinates values from database}
x = (double *)calloc(num_nodes, sizeof(double));
y = (double *)calloc(num_nodes, sizeof(double));
if (num_dim >= 3)
z = (double *)calloc(num_nodes, sizeof(double));
else
z = 0;
error = ex_get_coord(exoid, x, y, z);
\comment{Do the same as the previous call in three separate calls}
error = ex_get_coord(exoid, x, NULL, NULL);
error = ex_get_coord(exoid, NULL, y, NULL);
if (num_dim >= 3)
error = ex_get_coord(exoid, NULL, NULL, z);
#define NULL
Definition exodusII_int.h:86
int ex_get_coord(int exoid, void *x_coor, void *y_coor, void *z_coor)
Definition ex_get_coord.c:97

◆ ex_get_coord_names()

int ex_get_coord_names ( int exoid,
char ** coord_names )
extern

The function ex_get_coord_names() reads the names (MAX_STR_LENGTH -characters in length) of the coordinate arrays from the database. Memory must be allocated for the character strings before this function is invoked.

Returns
In case of an error, ex_get_coord_names() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • a warning value is returned if coordinate names were not stored.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[out]coord_namesReturned pointer to a vector containing num_dim names of the nodal coordinate arrays.

The following code segment will read the coordinate names from an open exodus file :

int error, exoid;
char *coord_names[3];
for (i=0; i < num_dim; i++) {
coord_names[i] = (char *)calloc((MAX_STR_LENGTH+1), sizeof(char));
}
error = ex_get_coord_names (exoid, coord_names);
int ex_get_coord_names(int exoid, char **coord_names)
Definition ex_get_coord_names.c:75
#define MAX_STR_LENGTH
Definition exodusII.h:256

◆ ex_get_coordinate_frames()

int ex_get_coordinate_frames ( int exoid,
int * nframes,
void_int * cf_ids,
void * pt_coordinates,
char * tags )
extern

Coordinate frames are stored in the database as a series of three points (defined in the basic cartesian coordinate system). The first of these points describes the origin of the new system. The second point lies on the 3 axis (or Z axis) of the frame. The third point is in the 1-3 (xz) plane. Each coordinate frame is identified by a unique, integer coordinate ID, and by a character tag indicating whether the frame is rectangular cartesian "R", cylindrical "C, or spherical "S". Because the coordinates are floating point values, the application code must declare the arrays passed to be the appropriate type "float" or "double" to match the compute word size passed in ex_create() or ex_open().

Parameters
exoidexodus file id
[in,out]nframesif 'cf_ids' is NULL, then nframes is returned with the number of defined coordinate frames. Else it is the number of coordinate frames to read.
[out]cf_idsThe (nframes) coordinate frame Ids. If cf_ids is NULL, no data will be returned in this or any other array. Only nframes will be modified. Otherwise, space must be allocated to store 'nframes' integers before making this call.
[out]pt_coordinatesThe (9*nframes) coordinates of the three points defining each coordinate axis. The first three values are the origin of the first frame. The next three values are the coordinates of a point on the 3rd axis of the first frame. The next three values are the coordinates of a point in the plane of the 1-3 axis. The pattern is repeated for each frame. If 'cf_ids' is null, no data will be returned in this array. Otherwise, space must be allocated for 9*nframes floating point values. The size of the allocation depends upon the compute word size.
[out]tagsThe (nframes) character tags associated with each coordinate frame. If 'cf_ids' is NULL, no data will be returned in this array. Otherwise, space must be allocated for 'nframes' characters.

◆ ex_get_eb_info_global()

int ex_get_eb_info_global ( int exoid,
void_int * el_blk_ids,
void_int * el_blk_cnts )
extern

◆ ex_get_elem_attr()

int ex_get_elem_attr ( int exoid,
ex_entity_id elem_blk_id,
void * attrib )
extern
Deprecated
Use ex_get_attr()(exoid, EX_ELEM_BLOCK, elem_blk_id, attrib) instead

The function ex_get_elem_attr() reads the attributes for an element block. Memory must be allocated for(num_attr x num_elem_this_blk) attributes before this routine is called.

Because the attributes are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_get_elem_attr() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • invalid element block ID.
  • a warning value is returned if no attributes are stored in the file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]elem_blk_idThe element block ID.
[out]attribSize [num_elem_this_blk*num_attr]. Returned list of(num_attr x num_elem_this_blk) attributes for the element block, with the num_attr index cycling faster.

Refer to the code example in ex_get_elem_block() for an example of reading the element attributes for an element block.

◆ ex_get_elem_attr_names()

int ex_get_elem_attr_names ( int exoid,
ex_entity_id elem_blk_id,
char ** names )
extern

reads the attribute names for an element block

Deprecated
Use ex_get_attr_names()(exoid, EX_ELEM_BLOCK, elem_blk_id, names) instead

◆ ex_get_elem_blk_ids()

int ex_get_elem_blk_ids ( int exoid,
void_int * ids )
extern
Deprecated
Use ex_get_ids()(exoid, EX_ELEM_BLOCK, ids) instead

The function ex_get_elem_blk_ids() reads the IDs of all of the element blocks. Memory must be allocated for the returned array of ({num_elem_blk}) IDs before this function is invoked. The required size(num_elem_blk) can be determined via a call to ex_inquire() or ex_inquire_int().

Returns
In case of an error, ex_get_elem_blk_ids() returns a negative number; a warning will return a positive number. Possible causes of errors include:
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[out]idsReturned array of the element blocks IDs. The order of the IDs in this array reflects the sequence that the element blocks were introduced into the file.

The following code segment reads all the element block IDs:

int error, exoid, *idelbs, num_elem_blk;
idelbs = (int *) calloc(num_elem_blk, sizeof(int));
error = ex_get_elem_blk_ids (exoid, idelbs);
\comment{Same result using non-deprecated functions}
error = ex_get_ids (exoid, EX_ELEM_BLOCK, idelbs);
int ex_get_elem_blk_ids(int exoid, void_int *ids)
Definition ex_get_elem_blk_ids.c:74
int ex_get_ids(int exoid, ex_entity_type obj_type, void_int *ids)
Definition ex_get_ids.c:48
@ EX_ELEM_BLOCK
Definition exodusII.h:218

◆ ex_get_elem_block()

int ex_get_elem_block ( int exoid,
ex_entity_id elem_blk_id,
char * elem_type,
void_int * num_elem_this_blk,
void_int * num_nodes_per_elem,
void_int * num_attr )
extern
Deprecated
Use ex_get_block()(exoid, EX_ELEM_BLOCK, elem_blk_id, elem_type, num_elem_this_blk, num_nodes_per_elem, num_attr) instead

The function ex_get_elem_block() reads the parameters used to describe an element block. IDs of all element blocks stored can be determined by calling ex_get_elem_blk_ids().

Returns
In case of an error, ex_get_elem_block() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • element block with specified ID is not stored in the data file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]elem_blk_idThe element block ID.
[out]elem_typeReturned element typetype of elements in the element block. The maximum length of this string is MAX_STR_LENGTH .
[out]num_elem_this_blkReturned number of elements in the element block.
[out]num_nodes_per_elemReturned number of nodes per element in the element block.
[out]num_attrReturned number of attributes per element in the element block.

As an example, the following code segment will read the parameters for the element block with an ID of 10 and read the connectivity and element attributes arrays from an open exodus file :

#include "exodusII.h"
int id, error, exoid, num_el_in_blk, num_nod_per_el, num_attr,
*connect;
float *attrib;
char elem_type[MAX_STR_LENGTH+1];
\comment{read element block parameters}
id = 10;
error = ex_get_elem_block(exoid, id, elem_type, &num_el_in_blk,
&num_nod_per_elem, &num_attr);
\comment{read element connectivity}
connect = (int *) calloc(num_nod_per_el*num_el_in_blk,
sizeof(int));
error = ex_get_elem_conn(exoid, id, connect);
\comment{read element block attributes}
attrib = (float *) calloc (num_attr * num_el_in_blk, sizeof(float));
error = ex_get_elem_attr (exoid, id, attrib);
\comment{Same result using non-deprecated functions}
error = ex_get_block(exoid, EX_ELEM_BLOCK, id, elem_type, &num_el_in_blk,
&num_nod_per_elem, 0, 0, &num_attr);
error = ex_get_conn (exoid, EX_ELEM_BLOCK, id, connect);
error = ex_get_attr (exoid, EX_ELEM_BLOCK, id, attrib);
int ex_get_attr(int exoid, ex_entity_type obj_type, ex_entity_id obj_id, void *attrib)
Definition ex_get_attr.c:63
int ex_get_elem_block(int exoid, ex_entity_id elem_blk_id, char *elem_type, void_int *num_elem_this_blk, void_int *num_nodes_per_elem, void_int *num_attr)
Definition ex_get_elem_block.c:95
int ex_get_elem_attr(int exoid, ex_entity_id elem_blk_id, void *attrib)
Definition ex_get_elem_attr.c:68
int ex_get_block(int exoid, ex_entity_type blk_type, ex_entity_id blk_id, char *elem_type, void_int *num_entries_this_blk, void_int *num_nodes_per_entry, void_int *num_edges_per_entry, void_int *num_faces_per_entry, void_int *num_attr_per_entry)
Definition ex_get_block.c:64
int ex_get_elem_conn(int exoid, ex_entity_id elem_blk_id, void_int *connect)
Definition ex_get_elem_conn.c:62
int ex_get_conn(int exoid, ex_entity_type blk_type, ex_entity_id blk_id, void_int *nodeconn, void_int *edgeconn, void_int *faceconn)
Definition ex_get_conn.c:61

◆ ex_get_elem_cmap()

int ex_get_elem_cmap ( int exoid,
ex_entity_id map_id,
void_int * elem_ids,
void_int * side_ids,
void_int * proc_ids,
int processor )
extern

◆ ex_get_elem_conn()

int ex_get_elem_conn ( int exoid,
ex_entity_id elem_blk_id,
void_int * connect )
extern
Deprecated
Use ex_get_conn()(exoid, EX_ELEM_BLOCK, elem_blk_id, connect, 0, 0) instead

The function ex_get_elem_conn() reads the connectivity array for an element block. Memory must be allocated for the connectivity array(num_elem_this_blk * num_nodes_per_elem in length) before this routine is called.

Returns
In case of an error, ex_get_elem_conn() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • an element block with the specified ID is not stored in the file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]elem_blk_idThe element block ID.
[out]connectSize [num_elem_this_blk,num_nodes_per_elem]. Returned connectivity array; a list of nodes (internal node IDs; See Section LocalNodeIds) that define each element. The node index cycles faster than the element index.

Refer to the code example in ex_get_elem_block() for an example of reading the connectivity for an element block.

◆ ex_get_elem_map()

int ex_get_elem_map ( int exoid,
ex_entity_id map_id,
void_int * elem_map )
extern

reads the element map with specified ID

Deprecated
Use ex_get_num_map()(exoid, EX_ELEM_MAP, map_id, elem_map) instead

◆ ex_get_elem_num_map()

int ex_get_elem_num_map ( int exoid,
void_int * elem_map )
extern
Deprecated
Use ex_get_id_map()(exoid, EX_ELEM_MAP, elem_map)

The function ex_get_elem_num_map() reads the optional element number map from the database. See Section LocalElementIds for a description of the element number map. If an element number map is not stored in the data file, a default array (1,2,3,. .. num_elem) is returned. Memory must be allocated for the element number map array ({num_elem} in length) before this call is made.

Returns
In case of an error, ex_get_elem_num_map() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • if an element number map is not stored, a default map and a warning value are returned.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[out]elem_mapReturned element number map.

The following code will read an element number map from an open exodus file :

int *elem_map, error, exoid;
\comment{read element number map}
elem_map = (int *) calloc(num_elem, sizeof(int));
error = ex_get_elem_num_map (exoid, elem_map);
\comment{Equivalent using non-deprecated function}
error = ex_get_id_map(exoid, EX_ELEM_MAP, elem_map);
int ex_get_id_map(int exoid, ex_entity_type obj_type, void_int *map)
Definition ex_get_id_map.c:60
int ex_get_elem_num_map(int exoid, void_int *elem_map)
Definition ex_get_elem_num_map.c:85
@ EX_ELEM_MAP
Definition exodusII.h:223

◆ ex_get_elem_type()

int ex_get_elem_type ( int exoid,
ex_entity_id elem_blk_id,
char * elem_type )
extern

◆ ex_get_elem_var()

int ex_get_elem_var ( int exoid,
int time_step,
int elem_var_index,
ex_entity_id elem_blk_id,
int64_t num_elem_this_blk,
void * elem_var_vals )
extern
Deprecated
Use ex_get_var()(exoid, time_step, EX_ELEM_BLOCK, elem_var_index, elem_blk_id, num_elem_this_blk, elem_var_vals) instead

The function ex_get_elem_var() reads the values of a single element variable for one element block at one time step. Memory must be allocated for the element variable values array before this function is invoked.

Because element variables are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_get_elem_var() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • variable does not exist for the desired element block.
  • invalid element block.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]time_stepThe time step number, as described under ex_put_time(), at which the element variable values are desired. This is essentially an index (in the time dimension) into the element variable values array stored in the database. The first time step is 1.
[in]elem_var_indexThe index of the desired element variable. The first variable has an index of 1.
[in]elem_blk_idThe desired element block ID.
[in]num_elem_this_blkThe number of elements in this element block.
[out]elem_var_valsReturned array of num_elem_this_blk values of the elem_var_index element variable for the element block with ID of elem_blk_id at the time_step time step.

As an example, the following code segment will read the var_index-th element variable at one time step stored in an exodus file :

int *ids, num_elem_blk, error, exoid, *num_elem_in_block,
step, var_ind;
float *var_vals;
ids = (int *) calloc(num_elem_blk, sizeof(int));
error = ex_get_elem_blk_ids (exoid, ids);
step = 1; \comment{read at the first time step}
for (i=0; i < num_elem_blk; i++) {
var_vals = (float *) calloc (num_elem_in_block[i], sizeof(float));
error = ex_get_elem_var (exoid, step, var_ind, ids[i],
num_elem_in_block[i], var_vals);
\comment{Using non-deprecated function:}
error = ex_get_var (exoid, step, EX_ELEM_BLOCK, var_ind, ids[i],
num_elem_in_block[i], var_vals);
free (var_values);
}
int ex_get_var(int exoid, int time_step, ex_entity_type var_type, int var_index, ex_entity_id obj_id, int64_t num_entry_this_obj, void *var_vals)
Definition ex_get_var.c:75
int ex_get_elem_var(int exoid, int time_step, int elem_var_index, ex_entity_id elem_blk_id, int64_t num_elem_this_blk, void *elem_var_vals)
Definition ex_get_elem_var.c:107

◆ ex_get_elem_var_tab()

int ex_get_elem_var_tab ( int exoid,
int num_elem_blk,
int num_elem_var,
int * elem_var_tab )
extern
Deprecated
Use ex_get_truth_table()(exoid, EX_ELEM_BLOCK, num_elem_blk, num_elem_var, elem_var_tab)

The function ex_get_elem_var_tab() reads the exodus element variable truth table from the database. For a description of the truth table, see the usage of the function ex_put_elem_var_tab(). Memory must be allocated for the truth table(num_elem_blk x num_elem_var in length) before this function is invoked. If the truth table is not stored in the file, it will be created based on information in the file and then returned.

Returns
In case of an error, ex_get_elem_var_tab() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • data file not initialized properly with call to ex_put_init().
  • the specified number of element blocks is different than the number specified in a call to ex_put_init().
  • there are no element variables stored in the file or the specified number of element variables doesn't match the number specified in a call to ex_put_variable_param().
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]num_elem_blkThe number of element blocks.
[in]num_elem_varThe number of element variables.
[out]elem_var_tabSize [num_elem_blk,num_elem_var]. Returned 2-dimensional array (with the num_elem_var index cycling faster) containing the element variable truth table.

As an example, the following coding will read the element variable truth table from an opened exodus file :

int *truth_tab, num_elem_blk, num_ele_vars, error, exoid;
truth_tab = (int *) calloc ((num_elem_blk*num_ele_vars),
sizeof(int));
error = ex_get_elem_var_tab (exoid, num_elem_blk, num_ele_vars,
truth_tab);
int ex_get_elem_var_tab(int exoid, int num_elem_blk, int num_elem_var, int *elem_var_tab)
Definition ex_get_elem_var_tab.c:99

◆ ex_get_elem_var_time()

int ex_get_elem_var_time ( int exoid,
int elem_var_index,
int64_t elem_number,
int beg_time_step,
int end_time_step,
void * elem_var_vals )
extern
Deprecated
Use ex_get_var_time()(exoid, EX_ELEM_BLOCK, elem_var_index, elem_number, beg_time_step, end_time_step, elem_var_vals)

The function ex_get_elem_var_time() reads the values of an element variable for a single element through a specified number of time steps. Memory must be allocated for the element variable values array before this function is invoked.

Because element variables are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_get_elem_var_time() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • data file not initialized properly with call to ex_put_init().
  • ex_put_elem_block() not called previously to specify parameters for all element blocks.
  • variable does not exist for the desired element or results haven't been written.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]elem_var_indexThe index of the desired element variable. The first variable has an index of 1.
[in]elem_numberThe internal ID (see Section LocalElementIds) of the desired element. The first element is 1.
[in]beg_time_stepThe beginning time step for which an element variable value is desired. This is not a time value but rather a time step number, as described under ex_put_time(). The first time step is 1.
[in]end_time_stepThe last time step for which an element variable value is desired. If negative, the last time step in the database will be used. The first time step is 1.
[out]elem_var_valsreturned array of(end_time_step {-} beg_time_step + 1) values of the elem_number-th element for the elem_var_index-th element variable.

For example, the following coding will read the values of the var_index-th element variable for element number 2 from the first time step to the last time step:

int error, exoid, num_time_steps, var_index, elem_num,
beg_time, end_time;
float *var_values;
\comment{determine how many time steps are stored}
num_time_steps = ex_inquire_int(exoid, EX_INQ_TIME);
\comment{read an element variable through time}
var_values = (float *) calloc (num_time_steps, sizeof(float));
var_index = 2;
elem_num = 2;
beg_time = 1;
end_time = -1;
error = ex_get_elem_var_time (exoid, var_index, elem_num,
beg_time, end_time, var_values);
\comment{Using non-deprecated function:}
error = ex_get_elem_var_time (exoid, EX_ELEM_BLOCK, var_index, elem_num,
beg_time, end_time, var_values);
int ex_get_elem_var_time(int exoid, int elem_var_index, int64_t elem_number, int beg_time_step, int end_time_step, void *elem_var_vals)
Definition ex_get_elem_var_time.c:131

◆ ex_get_entity_count_per_polyhedra()

int ex_get_entity_count_per_polyhedra ( int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
int * entity_counts )
extern

reads in the number of entities (nodes/faces) per polyhedra (nsided/nfaced) in this element block.

Parameters
exoidexodus file id
blk_typetype of block (face, or element)
blk_idblock identifer
entity_countsentity_per_polyhedra count array

◆ ex_get_err()

void ex_get_err ( const char ** msg,
const char ** func,
int * errcode )
extern

◆ ex_get_glob_var_time()

int ex_get_glob_var_time ( int exoid,
int glob_var_index,
int beg_time_step,
int end_time_step,
void * glob_var_vals )
extern

The function ex_get_glob_var_time() reads the values of a single global variable through a specified number of time steps. Memory must be allocated for the global variable values array before this function is invoked.

Because global variables are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_get_glob_var_time() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • specified global variable does not exist.
  • a warning value is returned if no global variables are stored in the file.
Parameters
exoidexodus file ID returned from a previous call to ex_create() or ex_open().
glob_var_indexThe index of the desired global variable. The first variable has an index of 1.
beg_time_stepThe beginning time step for which a global variable value is desired. This is not a time value but rather a time step number, as described under ex_put_time(). The first time step is 1.
end_time_stepThe last time step for which a global variable value is desired. If negative, the last time step in the database will be used. The first time step is 1.
[out]glob_var_valsReturned array of (end_time_step - beg_time_step + 1) values for the glob_var_index$^{th}$ global variable.

The following is an example of using this function:

int error, exoid, num_time_steps, var_index;
int beg_time, end_time;
float *var_values;
num_time_steps = ex_inquire_int(exoid, EX_INQ_TIME);
var_index = 1;
beg_time = 1;
end_time = -1;
var_values = (float *) calloc (num_time_steps, sizeof(float));
error = ex_get_glob_var_time(exoid, var_index, beg_time,
end_time, var_values);
int ex_get_glob_var_time(int exoid, int glob_var_index, int beg_time_step, int end_time_step, void *glob_var_vals)
Definition ex_get_glob_var_time.c:97

◆ ex_get_glob_vars()

int ex_get_glob_vars ( int exoid,
int time_step,
int num_glob_vars,
void * glob_var_vals )
extern

The function ex_get_glob_vars() reads the values of all the global variables for a single time step. Memory must be allocated for the global variables values array before this function is invoked.

Because global variables are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

In case of an error, ex_get_glob_vars() returns a negative number; a warning will return a positive number. Possible causes of errors include:

  • data file not properly opened with call to ex_create() or ex_open()
  • no global variables stored in the file.
  • a warning value is returned if no global variables are stored in the file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]time_stepThe time step, as described under ex_put_time(), at which the global variable values are desired. This is essentially an index (in the time dimension) into the global variable values array stored in the database. The first time step is 1.
[in]num_glob_varsThe number of global variables stored in the database.
[out]glob_var_valsReturned array of num_glob_vars global variable values for the time_step'th time step.

The following is an example code segment that reads all the global variables at one time step:

int num_glo_vars, error, time_step;
float *var_values;

error = ex_get_variable_param (idexo, EX_GLOBAL, &num_glo_vars);
var_values = (float *) calloc (num_glo_vars, sizeof(float));
error = ex_get_glob_vars (idexo, time_step, num_glo_vars, 
                          var_values);

◆ ex_get_group_id()

int ex_get_group_id ( int parent_id,
const char * group_name,
int * group_id )
extern

Given an exoid and group name (NULL gets root group), return id of that group. If the name is NULL, return the root group. If the name contains "/", then the name is assumed to be a full path name and all groups in the file are searched. Otherwise, the name is assumed to be the name of a child group of exoid

◆ ex_get_group_ids()

int ex_get_group_ids ( int parent_id,
int * num_groups,
int * group_ids )
extern

Given a file or group 'parent' id, return the number of child groups and the ids of the child groups below the parent. If num_groups is NULL, do not return count; if group_ids is NULL, do not return ids.

◆ ex_get_id_map()

int ex_get_id_map ( int exoid,
ex_entity_type obj_type,
void_int * map )
extern

◆ ex_get_ids()

int ex_get_ids ( int exoid,
ex_entity_type obj_type,
void_int * ids )
extern

◆ ex_get_idx()

int ex_get_idx ( int neid,
const char * ne_var_name,
int64_t * index,
int pos )
extern

◆ ex_get_info()

int ex_get_info ( int exoid,
char ** info )
extern

The function ex_get_info() reads information records from the database. The records are MAX_LINE_LENGTH-character strings. Memory must be allocated for the information records before this call is made. The number of records can be determined by invoking ex_inquire() or ex_inquire_int().

Returns
In case of an error, ex_get_info() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • a warning value is returned if no information records were stored.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[out]infoReturned array containing the information records.

The following code segment will determine the number of information records and read them from an open exodus file :

int error, exoid, num_info;
char *info[MAXINFO];
\comment{read information records}
num_info = ex_inquire_int (exoid,EX_INQ_INFO);
for (i=0; i < num_info; i++) {
info[i] = (char *) calloc ((MAX_LINE_LENGTH+1), sizeof(char));
}
error = ex_get_info (exoid, info);
int ex_get_info(int exoid, char **info)
Definition ex_get_info.c:76
@ EX_INQ_INFO
Definition exodusII.h:143
#define MAX_LINE_LENGTH
Definition exodusII.h:261

◆ ex_get_init()

int ex_get_init ( int exoid,
char * title,
void_int * num_dim,
void_int * num_nodes,
void_int * num_elem,
void_int * num_elem_blk,
void_int * num_node_sets,
void_int * num_side_sets )
extern

The function ex_get_init() reads the initializationinitialization parameters from an opened exodus file.

Returns
In case of an error, ex_get_init() returns a negative number; a warning will return a positive number. Possible causes of errors include:
Parameters
exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[out]titleReturned database title. String length may be up to MAX_LINE_LENGTH bytes.
[out]num_dimReturned dimensionality of the database. This is the number of coordinates per node.
[out]num_nodesReturned number of nodal points.
[out]num_elemReturned number of elements
[out]num_elem_blkReturned number of element blocks
[out]num_node_setsReturned number of node sets
[out]num_side_setsReturned number of side sets
See also
ex_get_init_ext()

The following code segment will read the initialization parameters from the open exodus file:

int num_dim, num_nodes, num_elem, num_elem_blk,
num_node_sets, num_side_sets, error, exoid;
char title[MAX_LINE_LENGTH+1];
\comment{read database parameters}
error = ex_get_init (exoid, title, &num_dim, &num_nodes,
&num_elem, &num_elem_blk, &num_node_sets, &num_side_sets);
int ex_get_init(int exoid, char *title, void_int *num_dim, void_int *num_nodes, void_int *num_elem, void_int *num_elem_blk, void_int *num_node_sets, void_int *num_side_sets)
Definition ex_get_init.c:100

◆ ex_get_init_ext()

int ex_get_init_ext ( int exoid,
ex_init_params * info )
extern

reads the initialization parameters from an opened EXODUS II file

Parameters
exoidexodus file id
[out]infoex_init_params structure containing metadata for mesh.
See also
ex_get_init()

◆ ex_get_init_global()

int ex_get_init_global ( int exoid,
void_int * num_nodes_g,
void_int * num_elems_g,
void_int * num_elem_blks_g,
void_int * num_node_sets_g,
void_int * num_side_sets_g )
extern

◆ ex_get_init_info()

int ex_get_init_info ( int exoid,
int * num_proc,
int * num_proc_in_f,
char * ftype )
extern

◆ ex_get_loadbal_param()

int ex_get_loadbal_param ( int exoid,
void_int * num_int_nodes,
void_int * num_bor_nodes,
void_int * num_ext_nodes,
void_int * num_int_elems,
void_int * num_bor_elems,
void_int * num_node_cmaps,
void_int * num_elem_cmaps,
int processor )
extern

◆ ex_get_map()

int ex_get_map ( int exoid,
void_int * elem_map )
extern
Deprecated
Use ex_get_num_map() instead.

The function ex_get_map() reads the element order map from the database. See #ElementOrderMap for a description of the element order map. If an element order map is not stored in the data file, a default array (1,2,3,. .. num_elem) is returned. Memory must be allocated for the element map array ({num_elem} in length) before this call is made.

Returns
In case of an error, ex_get_map() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • if an element order map is not stored, a default map and a warning value are returned.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[out]elem_mapReturned element order map.

The following code will read an element order map from an open exodus file :

int *elem_map, error, exoid;
\comment{read element order map}
elem_map = (int *)calloc(num_elem, sizeof(int));
error = ex_get_map(exoid, elem_map);
int ex_get_map(int exoid, void_int *elem_map)
Definition ex_get_map.c:77

◆ ex_get_map_param()

int ex_get_map_param ( int exoid,
int * num_node_maps,
int * num_elem_maps )
extern

◆ ex_get_n_attr()

int ex_get_n_attr ( int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int64_t start_num,
int64_t num_ent,
void * attrib )
extern
Deprecated
Use ex_get_partial_attr() instead reads the specified attribute for a subsect of a block
Parameters
exoidexodus file id
obj_typeobject type (edge, face, elem block)
obj_idobject id (edge, face, elem block ID)
start_numthe starting index of the attributes to be returned.
num_entthe number of entities to read attributes for.
attrib_indexindex of attribute to write
attribarray of attributes

◆ ex_get_n_conn()

int ex_get_n_conn ( int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
int64_t start_num,
int64_t num_ent,
void_int * nodeconn,
void_int * edgeconn,
void_int * faceconn )
extern

◆ ex_get_n_coord()

int ex_get_n_coord ( int exoid,
int64_t start_node_num,
int64_t num_nodes,
void * x_coor,
void * y_coor,
void * z_coor )
extern
  \deprecated Use ex_get_partial_coord() instead

reads the coordinates of the nodes. Memory must be allocated for the coordinate arrays (x_coor, y_coor, and z_coor) before this call is made. The length of each of these arrays is the number of nodes in the mesh. Because the coordinates are floating point values, the application code must declare the arrays passed to be the appropriate type "float" or "double" to match the compute word size passed in ex_create() or ex_open()

Parameters
exoidexodus file id
start_node_numthe starting index of the coordinates to be returned.
num_nodesthe number of nodes to read coordinates for.
[out]x_coorReturned X coordinates of the nodes. These are returned only if x_coor is non-NULL.
[out]y_coorReturned Y coordinates of the nodes. These are returned only if y_coor is non-NULL.
[out]z_coorReturned Z coordinates of the nodes. These are returned only if z_coor is non-NULL.

◆ ex_get_n_elem_attr()

int ex_get_n_elem_attr ( int exoid,
ex_entity_id elem_blk_id,
int64_t start_elem_num,
int64_t num_elems,
void * attrib )
extern

◆ ex_get_n_elem_conn()

int ex_get_n_elem_conn ( int exoid,
ex_entity_id elem_blk_id,
int64_t start_elem_num,
int64_t num_elems,
void_int * connect )
extern
Deprecated
use ex_get_partial_conn() reads the connectivity array for an element block

◆ ex_get_n_elem_num_map()

int ex_get_n_elem_num_map ( int exoid,
int64_t start_ent,
int64_t num_ents,
void_int * elem_map )
extern

◆ ex_get_n_elem_var()

int ex_get_n_elem_var ( int exoid,
int time_step,
int elem_var_index,
ex_entity_id elem_blk_id,
int64_t num_elem_this_blk,
int64_t start_elem_num,
int64_t num_elem,
void * elem_var_vals )
extern

◆ ex_get_n_nodal_var()

int ex_get_n_nodal_var ( int exoid,
int time_step,
int nodal_var_index,
int64_t start_node,
int64_t num_nodes,
void * var_vals )
extern

◆ ex_get_n_node_num_map()

int ex_get_n_node_num_map ( int exoid,
int64_t start_ent,
int64_t num_ents,
void_int * node_map )
extern

◆ ex_get_n_node_set()

int ex_get_n_node_set ( int exoid,
ex_entity_id node_set_id,
int64_t start_node_num,
int64_t num_nodes,
void_int * node_set_node_list )
extern

◆ ex_get_n_node_set_df()

int ex_get_n_node_set_df ( int exoid,
ex_entity_id node_set_id,
int64_t start_num,
int64_t num_df_to_get,
void * node_set_dist_fact )
extern

◆ ex_get_n_one_attr()

int ex_get_n_one_attr ( int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int64_t start_num,
int64_t num_ent,
int attrib_index,
void * attrib )
extern
Deprecated
Use ex_get_partial_one_attr() instead.

reads the specified attribute for a subsect of a block

Parameters
exoidexodus file id
obj_typeobject type (edge, face, elem block)
obj_idobject id (edge, face, elem block ID)
start_numthe starting index of the attributes to be returned.
num_entthe number of entities to read attributes for.
attrib_indexindex of attribute to write
attribarray of attributes

◆ ex_get_n_side_set()

int ex_get_n_side_set ( int exoid,
ex_entity_id side_set_id,
int64_t start_side_num,
int64_t num_sides,
void_int * side_set_elem_list,
void_int * side_set_side_list )
extern

◆ ex_get_n_side_set_df()

int ex_get_n_side_set_df ( int exoid,
ex_entity_id side_set_id,
int64_t start_num,
int64_t num_df_to_get,
void * side_set_dist_fact )
extern

◆ ex_get_n_var()

int ex_get_n_var ( int exoid,
int time_step,
ex_entity_type var_type,
int var_index,
ex_entity_id obj_id,
int64_t start_index,
int64_t num_entities,
void * var_vals )
extern
Deprecated
Use ex_get_partial_var() instead.

reads the values of a single variable for a partial block at one time step from the database; assume the first time step and variable index and start_index are 1

Parameters
exoidexodus file id
time_steptime step number
var_typetype (edge block, face block, edge set, ... )
var_indexelement variable index
obj_idelement block id
start_indexindex of first entity in block to read (1-based)
num_entitiesnumber of entries to read in this block/set
var_valsthe values to read

◆ ex_get_name()

int ex_get_name ( int exoid,
ex_entity_type obj_type,
ex_entity_id entity_id,
char * name )
extern

◆ ex_get_names()

int ex_get_names ( int exoid,
ex_entity_type obj_type,
char ** names )
extern

◆ ex_get_nodal_var()

int ex_get_nodal_var ( int exoid,
int time_step,
int nodal_var_index,
int64_t num_nodes,
void * nodal_var_vals )
extern

The function ex_get_nodal_var() reads the values of a single nodal variable for a single time step. Memory must be allocated for the nodal variable values array before this function is invoked.

Because nodal variables are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_get_nodal_var() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • specified nodal variable does not exist.
  • a warning value is returned if no nodal variables are stored in the file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]time_stepThe time step, as described under ex_put_time(), at which the nodal variable values are desired. This is essentially an index (in the time dimension) into the nodal variable values array stored in the database. The first time step is 1.
[in]nodal_var_indexThe index of the desired nodal variable. The first variable has an index of 1.
[in]num_nodesThe number of nodal points.
[out]nodal_var_valsReturned array of num_nodes values of the nodal_var_index-th nodal variable for the time_step-th time step.

For example, the following demonstrates how this function would be used:

int num_nodes, time_step, var_index;
float *var_values;
\comment{read the second nodal variable at the first time step}
time_step = 1;
var_index = 2;
var_values = (float *) calloc (num_nodes, sizeof(float));
error = ex_get_nodal_var(exoid, time_step, var_index, num_nodes,
var_values);
int ex_get_nodal_var(int exoid, int time_step, int nodal_var_index, int64_t num_nodes, void *nodal_var_vals)
Definition ex_get_nodal_var.c:95

◆ ex_get_nodal_var_time()

int ex_get_nodal_var_time ( int exoid,
int nodal_var_index,
int64_t node_number,
int beg_time_step,
int end_time_step,
void * nodal_var_vals )
extern

The function ex_get_nodal_var_time() reads the values of a nodal variable for a single node through a specified number of time steps. Memory must be allocated for the nodal variable values array before this function is invoked.

Because nodal variables are floating point values, the application code must declare the array passed to be the appropriate type (float or `‘double’') to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_get_nodal_var_time() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • specified nodal variable does not exist.
  • a warning value is returned if no nodal variables are stored in the file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]nodal_var_indexThe index of the desired nodal variable. The first variable has an index of 1.
[in]node_numberThe internal ID (see Section LocalNodeIds) of the desired node. The first node is 1.
[in]beg_time_stepThe beginning time step for which a nodal variable value is desired. This is not a time value but rather a time step number, as described under ex_put_time(). The first time step is 1.
[in]end_time_stepThe last time step for which a nodal variable value is desired. If negative, the last time step in the database will be used. The first time step is 1.
[out]nodal_var_valsReturned array of(end_time_step {-} beg_time_step +1) values of the node_number-th node for the nodal_var_index-th nodal variable.

For example, the following code segment will read the values of the first nodal variable for node number one for all time steps stored in the data file:

int num_time_steps, var_index, node_num, beg_time, end_time, error, exoid;
float *var_values;
\comment{determine how many time steps are stored}
num_time_steps = ex_inquire_int(exoid, EX_INQ_TIME);
\comment{read a nodal variable through time}
var_values = (float *) calloc (num_time_steps, sizeof(float));
var_index = 1; node_num = 1; beg_time = 1; end_time = -1;
error = ex_get_nodal_var_time(exoid, var_index, node_num, beg_time,
end_time, var_values);
int ex_get_nodal_var_time(int exoid, int nodal_var_index, int64_t node_number, int beg_time_step, int end_time_step, void *nodal_var_vals)
Definition ex_get_nodal_var_time.c:103

◆ ex_get_node_cmap()

int ex_get_node_cmap ( int exoid,
ex_entity_id map_id,
void_int * node_ids,
void_int * proc_ids,
int processor )
extern

◆ ex_get_node_map()

int ex_get_node_map ( int exoid,
ex_entity_id map_id,
void_int * node_map )
extern

reads the node map with specified ID

Deprecated
Use ex_get_num_map()(exoid, EX_NODE_MAP, map_id, node_map

◆ ex_get_node_num_map()

int ex_get_node_num_map ( int exoid,
void_int * node_map )
extern
Deprecated
Use ex_get_id_map()(exoid, EX_NODE_MAP, node_map)

The function ex_get_node_num_map() reads the optional node number mapnode number map from the database. See Section LocalNodeIds for a description of the node number map. If a node number map is not stored in the data file, a default array (1,2,3,. .. num_nodes) is returned. Memory must be allocated for the node number map array (num_nodes in length) before this call is made.

Returns
In case of an error, ex_get_node_num_map() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • if a node number map is not stored, a default map and a warning value are returned.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[out]node_mapReturned node number map.

The following code will read a node number map from an open exodus file :

int *node_map, error, exoid;
\comment{read node number map}
node_map = (int *)calloc(num_nodes, sizeof(int));
error = ex_get_node_num_map(exoid, node_map);
\comment{Equivalent using non-deprecated function}
error = ex_get_id_map(exoid, EX_NODE_MAP, node_map);
int ex_get_node_num_map(int exoid, void_int *node_map)
Definition ex_get_node_num_map.c:88
@ EX_NODE_MAP
Definition exodusII.h:224

◆ ex_get_node_set()

int ex_get_node_set ( int exoid,
ex_entity_id node_set_id,
void_int * node_set_node_list )
extern

reads the node list for a single node set

Deprecated
Use ex_get_set()(exoid, EX_NODE_SET, node_set_id, node_set_node_list, NULL)

◆ ex_get_node_set_dist_fact()

int ex_get_node_set_dist_fact ( int exoid,
ex_entity_id node_set_id,
void * node_set_dist_fact )
extern
Deprecated
Use ex_get_set_dist_fact()(exoid, EX_NODE_SET, node_set_id, node_set_dist_fact)

The function ex_get_node_set_dist_fact() returns the node set distribution factors for a single node set. Memory must be allocated for the list of distribution factors(num_dist_in_set in length) before this function is invoked.

Because the distribution factors are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_get_node_set_dist_fact() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • a warning value is returned if no distribution factors were stored.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]node_set_idThe node set ID.
[out]node_set_dist_factReturned array containing the distribution factors in the node set.

Refer to the description of ex_get_node_set_param() for a sample code segment to read a node set's distribution factors.

◆ ex_get_node_set_ids()

int ex_get_node_set_ids ( int exoid,
void_int * ids )
extern
Deprecated
Use ex_get_ids()(exoid, EX_NODE_SET, ids)

The function ex_get_node_set_ids() reads the IDs of all of the node sets. Memory must be allocated for the returned array of ({num_node_sets}) IDs before this function is invoked.

Returns
In case of an error, ex_get_node_set_ids() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • a warning value is returned if no node sets are stored in the file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[out]idsReturned array of the node sets IDs. The order of the IDs in this array reflects the sequence the node sets were introduced into the file.

As an example, the following code will read all of the node set IDs from an open data file:

int *ids, num_node_sets, error, exoid;
\comment{read node sets IDs}
ids = (int *) calloc(num_node_sets, sizeof(int));
error = ex_get_node_set_ids (exoid, ids);
\comment{Same result using non-deprecated functions.}
error = ex_get_ids (exoid, EX_NODE_SET, ids);
int ex_get_node_set_ids(int exoid, void_int *ids)
Definition ex_get_node_set_ids.c:71
@ EX_NODE_SET
Definition exodusII.h:213

◆ ex_get_node_set_param()

int ex_get_node_set_param ( int exoid,
ex_entity_id node_set_id,
void_int * num_nodes_in_set,
void_int * num_df_in_set )
extern
Deprecated
Use ex_get_set_param()(exoid, EX_NODE_SET, node_set_id, num_nodes_in_set, num_df_in_set)

The function ex_get_node_set_param() reads the number of nodes which describe a single node set and the number of distribution factors for the node set.

Returns
In case of an error, ex_get_node_set_param() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • a warning value is returned if no node sets are stored in the file.
  • incorrect node set ID.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]node_set_idThe node set ID.
[out]num_nodes_in_setReturned number of nodes in the node set.
[out]num_df_in_setReturned number of distribution factors in the node set.

The following code segment will read a node set from an open exodus file :

int error, exoid, id, num_nodes_in_set, num_df_in_set, *node_list;
float *dist_fact;
\comment{read node set parameters}
id = 100;
error = ex_get_node_set_param(exoid, id, &num_nodes_in_set,
&num_df_in_set);
\comment{read node set node list}
node_list = (int *) calloc(num_nodes_in_set, sizeof(int));
error = ex_get_node_set(exoid, id, node_list);
\comment{read node set distribution factors}
if (num_df_in_set > 0) {
dist_fact = (float *) calloc(num_nodes_in_set, sizeof(float));
error = ex_get_node_set_dist_fact(exoid, id, dist_fact);
}
\comment{Same result using non-deprecated functions}
error = ex_get_set_param(exoid, EX_NODE_SET, id, &num_nodes_in_set, &num_df_in_set);
error = ex_get_set(exoid, EX_NODE_SET, id, node_list);
if (num_df_in_set > 0) {
error = ex_get_set_dist_fact(exoid, EX_NODE_SET, id, dist_fact);
}
int ex_get_node_set_dist_fact(int exoid, ex_entity_id node_set_id, void *node_set_dist_fact)
Definition ex_get_node_set_dist_fact.c:64
int ex_get_set(int exoid, ex_entity_type set_type, ex_entity_id set_id, void_int *set_entry_list, void_int *set_extra_list)
Definition ex_get_set.c:65
int ex_get_set_param(int exoid, ex_entity_type set_type, ex_entity_id set_id, void_int *num_entry_in_set, void_int *num_dist_fact_in_set)
Definition ex_get_set_param.c:68
int ex_get_node_set(int exoid, ex_entity_id node_set_id, void_int *node_set_node_list)
Definition ex_get_node_set.c:60
int ex_get_set_dist_fact(int exoid, ex_entity_type set_type, ex_entity_id set_id, void *set_dist_fact)
Definition ex_get_set_dist_fact.c:63
int ex_get_node_set_param(int exoid, ex_entity_id node_set_id, void_int *num_nodes_in_set, void_int *num_df_in_set)
Definition ex_get_node_set_param.c:90

◆ ex_get_ns_param_global()

int ex_get_ns_param_global ( int exoid,
void_int * ns_ids_glob,
void_int * ns_n_cnt_glob,
void_int * ns_df_cnt_glob )
extern

◆ ex_get_nset_var()

int ex_get_nset_var ( int exoid,
int time_step,
int nset_var_index,
ex_entity_id nset_id,
int64_t num_node_this_nset,
void * nset_var_vals )
extern

reads the values of a single nodeset variable for one nodeset at one time step in the database; assume the first time step and nodeset variable index is 1

Deprecated
Use ex_get_var()(exoid, time_step, EX_NODE_SET, nset_var_index, nset_id, num_node_this_nset, nset_var_vals) instead

◆ ex_get_nset_var_tab()

int ex_get_nset_var_tab ( int exoid,
int num_nodesets,
int num_nset_var,
int * nset_var_tab )
extern

reads the EXODUS II nodeset variable truth table from the database

Deprecated
Use ex_get_truth_table()(exoid, EX_NODE_SET, num_nodesets, num_nset_var, nset_var_tab)

◆ ex_get_num_map()

int ex_get_num_map ( int exoid,
ex_entity_type map_type,
ex_entity_id map_id,
void_int * map )
extern

◆ ex_get_num_props()

int ex_get_num_props ( int exoid,
ex_entity_type obj_type )
extern

◆ ex_get_object_truth_vector()

int ex_get_object_truth_vector ( int exoid,
ex_entity_type obj_type,
ex_entity_id entity_id,
int num_var,
int * var_vec )
extern

reads the EXODUS II specified variable truth vector from the database

◆ ex_get_one_attr()

int ex_get_one_attr ( int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int attrib_index,
void * attrib )
extern

◆ ex_get_one_elem_attr()

int ex_get_one_elem_attr ( int exoid,
ex_entity_id elem_blk_id,
int attrib_index,
void * attrib )
extern

reads the attributes for an element block

Deprecated
Use ex_get_one_attr()(exoid, EX_ELEM_BLOCK, elem_blk_id, attrib_index, attrib)

◆ ex_get_partial_attr()

int ex_get_partial_attr ( int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int64_t start_num,
int64_t num_ent,
void * attrib )
extern

reads the specified attribute for a subsect of a block

Parameters
exoidexodus file id
obj_typeobject type (edge, face, elem block)
obj_idobject id (edge, face, elem block ID)
start_numthe starting index of the attributes to be returned.
num_entthe number of entities to read attributes for.
attrib_indexindex of attribute to write
attribarray of attributes

◆ ex_get_partial_conn()

int ex_get_partial_conn ( int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
int64_t start_num,
int64_t num_ent,
void_int * nodeconn,
void_int * edgeconn,
void_int * faceconn )
extern

◆ ex_get_partial_coord()

int ex_get_partial_coord ( int exoid,
int64_t start_node_num,
int64_t num_nodes,
void * x_coor,
void * y_coor,
void * z_coor )
extern

reads the coordinates of the nodes. Memory must be allocated for the coordinate arrays (x_coor, y_coor, and z_coor) before this call is made. The length of each of these arrays is the number of nodes in the mesh. Because the coordinates are floating point values, the application code must declare the arrays passed to be the appropriate type "float" or "double" to match the compute word size passed in ex_create() or ex_open()

Parameters
exoidexodus file id
start_node_numthe starting index of the coordinates to be returned.
num_nodesthe number of nodes to read coordinates for.
[out]x_coorReturned X coordinates of the nodes. These are returned only if x_coor is non-NULL.
[out]y_coorReturned Y coordinates of the nodes. These are returned only if y_coor is non-NULL.
[out]z_coorReturned Z coordinates of the nodes. These are returned only if z_coor is non-NULL.

◆ ex_get_partial_elem_attr()

int ex_get_partial_elem_attr ( int exoid,
ex_entity_id elem_blk_id,
int64_t start_elem_num,
int64_t num_elems,
void * attrib )
extern

◆ ex_get_partial_elem_conn()

int ex_get_partial_elem_conn ( int exoid,
ex_entity_id elem_blk_id,
int64_t start_elem_num,
int64_t num_elems,
void_int * connect )
extern
Deprecated
use ex_get_partial_conn() reads the connectivity array for an element block

◆ ex_get_partial_elem_map()

int ex_get_partial_elem_map ( int exoid,
ex_entity_id map_id,
int64_t ent_start,
int64_t ent_count,
void_int * elem_map )
extern

◆ ex_get_partial_elem_num_map()

int ex_get_partial_elem_num_map ( int exoid,
int64_t start_ent,
int64_t num_ents,
void_int * elem_map )
extern

◆ ex_get_partial_elem_var()

int ex_get_partial_elem_var ( int exoid,
int time_step,
int elem_var_index,
ex_entity_id elem_blk_id,
int64_t num_elem_this_blk,
int64_t start_elem_num,
int64_t num_elem,
void * elem_var_vals )
extern

◆ ex_get_partial_id_map()

int ex_get_partial_id_map ( int exoid,
ex_entity_type map_type,
int64_t start_entity_num,
int64_t num_entities,
void_int * map )
extern

◆ ex_get_partial_nodal_var()

int ex_get_partial_nodal_var ( int exoid,
int time_step,
int nodal_var_index,
int64_t start_node,
int64_t num_nodes,
void * nodal_var_vals )
extern

◆ ex_get_partial_node_num_map()

int ex_get_partial_node_num_map ( int exoid,
int64_t start_ent,
int64_t num_ents,
void_int * node_map )
extern

◆ ex_get_partial_node_set()

int ex_get_partial_node_set ( int exoid,
ex_entity_id node_set_id,
int64_t start_node_num,
int64_t num_node,
void_int * node_set_node_list )
extern

◆ ex_get_partial_node_set_df()

int ex_get_partial_node_set_df ( int exoid,
ex_entity_id node_set_id,
int64_t start_num,
int64_t num_df_to_get,
void * node_set_df )
extern

◆ ex_get_partial_num_map()

int ex_get_partial_num_map ( int exoid,
ex_entity_type map_type,
ex_entity_id map_id,
int64_t ent_start,
int64_t ent_count,
void_int * elem_map )
extern

◆ ex_get_partial_one_attr()

int ex_get_partial_one_attr ( int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int64_t start_num,
int64_t num_ent,
int attrib_index,
void * attrib )
extern

reads the specified attribute for a subsect of a block

Parameters
exoidexodus file id
obj_typeobject type (edge, face, elem block)
obj_idobject id (edge, face, elem block ID)
start_numthe starting index of the attributes to be returned.
num_entthe number of entities to read attributes for.
attrib_indexindex of attribute to write
attribarray of attributes

◆ ex_get_partial_set_dist_fact()

int ex_get_partial_set_dist_fact ( int exoid,
ex_entity_type set_type,
ex_entity_id set_id,
int64_t offset,
int64_t num_to_put,
void * set_dist_fact )
extern

reads the distribution factors for a single set

◆ ex_get_partial_side_set()

int ex_get_partial_side_set ( int exoid,
ex_entity_id side_set_id,
int64_t start_side_num,
int64_t num_sides,
void_int * side_set_elem_list,
void_int * side_set_side_list )
extern

◆ ex_get_partial_side_set_df()

int ex_get_partial_side_set_df ( int exoid,
ex_entity_id side_set_id,
int64_t start_num,
int64_t num_df_to_get,
void * side_set_df )
extern

◆ ex_get_partial_var()

int ex_get_partial_var ( int exoid,
int time_step,
ex_entity_type var_type,
int var_index,
ex_entity_id obj_id,
int64_t start_index,
int64_t num_entities,
void * var_vals )
extern

reads the values of a single variable for a partial block at one time step from the database; assume the first time step and variable index and start_index are 1

Parameters
exoidexodus file id
time_steptime step number
var_typetype (edge block, face block, edge set, ... )
var_indexelement variable index
obj_idelement block id
start_indexindex of first entity in block to read (1-based)
num_entitiesnumber of entries to read in this block/set
var_valsthe values to read

◆ ex_get_processor_elem_maps()

int ex_get_processor_elem_maps ( int exoid,
void_int * elem_mapi,
void_int * elem_mapb,
int processor )
extern

◆ ex_get_processor_node_maps()

int ex_get_processor_node_maps ( int exoid,
void_int * node_mapi,
void_int * node_mapb,
void_int * node_mape,
int processor )
extern

◆ ex_get_prop()

int ex_get_prop ( int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
const char * prop_name,
void_int * value )
extern

The function ex_get_prop() reads an integer object property value stored for a single element block, node set, or side set.

Returns
In case of an error, ex_get_prop() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • invalid object type specified.
  • a warning value is returned if a property with the specified name is not found.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]obj_typeType of object; use one of the options in the table below.
[in]obj_idThe element block, node set, or side set ID.
[in]prop_nameThe name of the property (maximum length is MAX_STR_LENGTH ) for which the value is desired.
[out]valueReturned value of the property.
EX_NODE_SET Node Set entity type
EX_EDGE_BLOCK Edge Block entity type
EX_EDGE_SET Edge Set entity type
EX_FACE_BLOCK Face Block entity type
EX_FACE_SET Face Set entity type
EX_ELEM_BLOCK Element Block entity type
EX_ELEM_SET Element Set entity type
EX_SIDE_SET Side Set entity type
EX_ELEM_MAP Element Map entity type
EX_NODE_MAP Node Map entity type
EX_EDGE_MAP Edge Map entity type
EX_FACE_MAP Face Map entity type

For an example of code to read an object property, refer to the description for ex_get_prop_names().

◆ ex_get_prop_array()

int ex_get_prop_array ( int exoid,
ex_entity_type obj_type,
const char * prop_name,
void_int * values )
extern

The function ex_get_prop_array() reads an array of integer property values for all element blocks, node sets, or side sets. The order of the values in the array correspond to the order in which the element blocks, node sets, or side sets were introduced into the file. Before this function is invoked, memory must be allocated for the returned array of(num_elem_blk, num_node_sets, or {num_side_sets}) integer values.

This function can be used in place of

Returns
In case of an error, ex_get_prop_array() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • invalid object type specified.
  • a warning value is returned if a property with the specified name is not found.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]obj_typeType of object; use one of the options in the table below.
[in]prop_nameThe name of the property (maximum length of MAX_STR_LENGTH ) for which the values are desired.
[out]valuesReturned array of property values.
EX_NODE_SET Node Set entity type
EX_EDGE_BLOCK Edge Block entity type
EX_EDGE_SET Edge Set entity type
EX_FACE_BLOCK Face Block entity type
EX_FACE_SET Face Set entity type
EX_ELEM_BLOCK Element Block entity type
EX_ELEM_SET Element Set entity type
EX_SIDE_SET Side Set entity type
EX_ELEM_MAP Element Map entity type
EX_NODE_MAP Node Map entity type
EX_EDGE_MAP Edge Map entity type
EX_FACE_MAP Face Map entity type

For an example of code to read an array of object properties, refer to the description for ex_get_prop_names().

◆ ex_get_prop_names()

int ex_get_prop_names ( int exoid,
ex_entity_type obj_type,
char ** prop_names )
extern

The function ex_get_prop_names() returns names of integer properties stored for an element block, node set, or side set. The number of properties (needed to allocate space for the property names) can be obtained via a call to ex_inquire() or ex_inquire_int().

Returns
In case of an error, ex_get_prop_names() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • invalid object type specified.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]obj_typeType of object; use one of the options in the table below.
[out]prop_namesReturned array containing num_props (obtained from call to ex_inquire() or ex_inquire_int()) names (of maximum length MAX_STR_LENGTH ) of properties to be stored. ID, a reserved property name, will be the first name in the array.
EX_NODE_SET Node Set entity type
EX_EDGE_BLOCK Edge Block entity type
EX_EDGE_SET Edge Set entity type
EX_FACE_BLOCK Face Block entity type
EX_FACE_SET Face Set entity type
EX_ELEM_BLOCK Element Block entity type
EX_ELEM_SET Element Set entity type
EX_SIDE_SET Side Set entity type
EX_ELEM_MAP Element Map entity type
EX_NODE_MAP Node Map entity type
EX_EDGE_MAP Edge Map entity type
EX_FACE_MAP Face Map entity type

As an example, the following code segment reads in properties assigned to node sets:

int error, exoid, num_props, *prop_values;
char *prop_names[MAX_PROPS];
\comment{read node set properties}
num_props = ex_inquire_int(exoid, EX_INQ_NS_PROP);
for (i=0; i < num_props; i++) {
prop_names[i] = (char *) malloc ((MAX_STR_LENGTH+1), sizeof(char));
prop_values = (int *) malloc (num_node_sets, sizeof(int));
}
error = ex_get_prop_names(exoid,EX_NODE_SET,prop_names);
for (i=0; i < num_props; i++) {
error = ex_get_prop_array(exoid, EX_NODE_SET, prop_names[i],
prop_values);
}
int ex_get_prop_array(int exoid, ex_entity_type obj_type, const char *prop_name, void_int *values)
Definition ex_get_prop_array.c:113
int ex_get_prop_names(int exoid, ex_entity_type obj_type, char **prop_names)
Definition ex_get_prop_names.c:104
@ EX_INQ_NS_PROP
Definition exodusII.h:146

◆ ex_get_qa()

int ex_get_qa ( int exoid,
char * qa_record[][4] )
extern

The function ex_get_qa() reads the QA records from the database. Each QA record contains four MAX_STR_LENGTH-byte character strings. The character strings are:

  • the analysis code name
  • the analysis code QA descriptor
  • the analysis date
  • the analysis time

Memory must be allocated for the QA records before this call is made. The number of QA records can be determined by invoking ex_inquire().

Returns
In case of an error, ex_get_qa() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • a warning value is returned if no QA records were stored.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[out]qa_recordReturned array containing the QA records.

The following will determine the number of QA records and read them from the open exodus file:

int num_qa_rec, error, exoid
char *qa_record[MAX_QA_REC][4];
\comment{read QA records}
num_qa_rec = ex_inquire_int(exoid, EX_INQ_QA);
for (i=0; i<num_qa_rec; i++) {
for (j=0; j<4; j++)
qa_record[i][j] = (char *) calloc ((MAX_STR_LENGTH+1), sizeof(char));
}
error = ex_get_qa (exoid, qa_record);
int ex_get_qa(int exoid, char *qa_record[][4])
Definition ex_get_qa.c:83
@ EX_INQ_QA
Definition exodusII.h:142

◆ ex_get_set()

int ex_get_set ( int exoid,
ex_entity_type set_type,
ex_entity_id set_id,
void_int * set_entry_list,
void_int * set_extra_list )
extern

reads the set entry list and set extra list for a single set

◆ ex_get_set_dist_fact()

int ex_get_set_dist_fact ( int exoid,
ex_entity_type set_type,
ex_entity_id set_id,
void * set_dist_fact )
extern

reads the distribution factors for a single set

◆ ex_get_set_param()

int ex_get_set_param ( int exoid,
ex_entity_type set_type,
ex_entity_id set_id,
void_int * num_entry_in_set,
void_int * num_dist_fact_in_set )
extern

◆ ex_get_sets()

int ex_get_sets ( int exoid,
size_t set_count,
struct ex_set * sets )
extern

◆ ex_get_side_set()

int ex_get_side_set ( int exoid,
ex_entity_id side_set_id,
void_int * side_set_elem_list,
void_int * side_set_side_list )
extern

reads the side set element list and side set side list for a single side set

Deprecated
Use ex_get_set()(exoid, EX_SIDE_SET, side_set_id, side_set_elem_list, side_set_side_list)

◆ ex_get_side_set_dist_fact()

int ex_get_side_set_dist_fact ( int exoid,
ex_entity_id side_set_id,
void * side_set_dist_fact )
extern

reads the distribution factors for a single side set

Deprecated
Use ex_get_set_dist_fact()(exoid, EX_SIDE_SET, side_set_id, side_set_dist_fact)

◆ ex_get_side_set_ids()

int ex_get_side_set_ids ( int exoid,
void_int * ids )
extern

reads the side set ids from the database

Deprecated
Use ex_get_ids()(exoid, EX_SIDE_SET, ids)

◆ ex_get_side_set_node_count()

int ex_get_side_set_node_count ( int exoid,
ex_entity_id side_set_id,
int * side_set_node_cnt_list )
extern

◆ ex_get_side_set_node_list()

int ex_get_side_set_node_list ( int exoid,
ex_entity_id side_set_id,
void_int * side_set_node_cnt_list,
void_int * side_set_node_list )
extern

◆ ex_get_side_set_node_list_len()

int ex_get_side_set_node_list_len ( int exoid,
ex_entity_id side_set_id,
void_int * side_set_node_list_len )
extern

This routine is designed to read the Exodus II V 2.0 side set side definition and return the length of a ExodusI style side set node list.

Parameters
exoidexodus file id
side_set_idside set id
[out]*side_set_node_list_lenlength of node list

◆ ex_get_side_set_param()

int ex_get_side_set_param ( int exoid,
ex_entity_id side_set_id,
void_int * num_side_in_set,
void_int * num_dist_fact_in_set )
extern

reads the number of sides and the number of distribution factors which describe a single side set

Parameters
exoidexodus file id
side_set_idside set id
[out]num_side_in_setnumber of sides in the side set
[out]num_dist_fact_in_setnumber of distribution factors in the
Deprecated
Use ex_get_set_param()(exoid, EX_SIDE_SET, side_set_id, num_side_in_set, num_dist_fact_in_set)

◆ ex_get_ss_param_global()

int ex_get_ss_param_global ( int exoid,
void_int * ss_ids_glob,
void_int * ss_s_cnt_glob,
void_int * ss_df_cnt_glob )
extern

◆ ex_get_sset_var()

int ex_get_sset_var ( int exoid,
int time_step,
int sset_var_index,
ex_entity_id sset_id,
int64_t num_side_this_sset,
void * sset_var_vals )
extern

reads the values of a single sideset variable for one sideset at one time step in the database; assume the first time step and sideset variable index is 1

Deprecated
Use ex_get_var()(exoid, time_step, EX_SIDE_SET, sset_var_index, sset_id, num_side_this_sset, sset_var_vals) instead

◆ ex_get_sset_var_tab()

int ex_get_sset_var_tab ( int exoid,
int num_sidesets,
int num_sset_var,
int * sset_var_tab )
extern

reads the EXODUS II sideset variable truth table from the database

Deprecated
Use ex_get_truth_table()(exoid, EX_SIDE_SET, num_sidesets, num_sset_var, sset_var_tab)

◆ ex_get_time()

int ex_get_time ( int exoid,
int time_step,
void * time_value )
extern

The function ex_get_time() reads the time value for a specified time step.

Because time values are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_get_time() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • no time steps have been stored in the file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]time_stepThe time step number. This is essentially an index (in the time dimension) into the global, nodal, and element variables arrays stored in the database. The first time step is 1.
[out]time_valueReturned time at the specified time step.

As an example, the following coding will read the time value stored in the data file for time step n:

int n, error, exoid;
float time_value;
\comment{read time value at time step 3}
n = 3;
error = ex_get_time (exoid, n, &time_value);
int ex_get_time(int exoid, int time_step, void *time_value)
Definition ex_get_time.c:79

◆ ex_get_truth_table()

int ex_get_truth_table ( int exoid,
ex_entity_type obj_type,
int num_blk,
int num_var,
int * var_tab )
extern

reads the EXODUS II specified variable truth table from the database

◆ ex_get_var()

int ex_get_var ( int exoid,
int time_step,
ex_entity_type var_type,
int var_index,
ex_entity_id obj_id,
int64_t num_entry_this_obj,
void * var_vals )
extern

◆ ex_get_var_name()

int ex_get_var_name ( int exoid,
const char * var_type,
int var_num,
char * var_name )
extern

reads the name of a particular results variable from the database

Deprecated
use ex_get_variable_name()(exoid, obj_type, var_num, *var_name)

◆ ex_get_var_names()

int ex_get_var_names ( int exoid,
const char * var_type,
int num_vars,
char * var_names[] )
extern

reads the names of the results variables from the database

Deprecated
Use ex_get_variable_names()(exoid, obj_type, num_vars, var_names)

◆ ex_get_var_param()

int ex_get_var_param ( int exoid,
const char * var_type,
int * num_vars )
extern

reads the number of global, nodal, or element variables that are stored in the database

Deprecated
Use ex_get_variable_param()(exoid, obj_type, *num_vars)

◆ ex_get_var_tab()

int ex_get_var_tab ( int exoid,
const char * var_type,
int num_blk,
int num_var,
int * var_tab )
extern

reads the EXODUS II specified variable truth table from the database

Deprecated
Use ex_get_truth_table()(exoid, obj_type, num_blk, num_var, var_tab)

◆ ex_get_var_time()

int ex_get_var_time ( int exoid,
ex_entity_type var_type,
int var_index,
int64_t id,
int beg_time_step,
int end_time_step,
void * var_vals )
extern

◆ ex_get_variable_name()

int ex_get_variable_name ( int exoid,
ex_entity_type obj_type,
int var_num,
char * var_name )
extern

reads the name of a particular results variable from the database

◆ ex_get_variable_names()

int ex_get_variable_names ( int exoid,
ex_entity_type obj_type,
int num_vars,
char * var_names[] )
extern

The function ex_get_variable_names() reads the names of the results variables from the database. Memory must be allocated for the name array before this function is invoked. The names are MAX_STR_LENGTH-characters in length.

Returns
In case of an error, ex_get_variable_names() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • invalid variable type specified.
  • a warning value is returned if no variables of the specified type are stored in the file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]obj_typeVariable indicating the type of variable which is described. Use one of the options in the table below.
[in]num_varsThe number of var_type variables that will be read from the database.
[out]var_namesReturned array of pointers to num_vars variable names.
EX_GLOBAL} Global entity type
EX_NODAL} Nodal entity type
EX_NODE_SET Node Set entity type
EX_EDGE_BLOCK Edge Block entity type
EX_EDGE_SET Edge Set entity type
EX_FACE_BLOCK Face Block entity type
EX_FACE_SET Face Set entity type
EX_ELEM_BLOCK Element Block entity type
EX_ELEM_SET Element Set entity type
EX_SIDE_SET Side Set entity type

As an example, the following code segment will read the names of the nodal variables stored in the data file:

int error, exoid, num_nod_vars;
char *var_names[10];
\comment{read nodal variables parameters and names}
error = ex_get_variable_param(exoid, EX_NODAL, &num_nod_vars);
for (i=0; i < num_nod_vars; i++) {
var_names[i] = (char *) calloc ((MAX_STR_LENGTH+1), sizeof(char));
}
error = ex_get_variable_names(exoid, EX_NODAL, num_nod_vars, var_names);
int ex_get_variable_names(int exoid, ex_entity_type obj_type, int num_vars, char *var_names[])
Definition ex_get_variable_names.c:93
int ex_get_variable_param(int exoid, ex_entity_type obj_type, int *num_vars)
Definition ex_get_variable_param.c:100
@ EX_NODAL
Definition exodusII.h:211

◆ ex_get_variable_param()

int ex_get_variable_param ( int exoid,
ex_entity_type obj_type,
int * num_vars )
extern

The function ex_get_variable_param() reads the number of global, nodal, or element variables stored in the database.

Returns
In case of an error, ex_get_variable_param() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • invalid variable type specified.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]obj_typeVariable indicating the type of variable which is described. Use one of the options in the table below.
[out]num_varsReturned number of var_type variables that are stored in the database.
EX_GLOBAL} Global entity type
EX_NODAL} Nodal entity type
EX_NODE_SET Node Set entity type
EX_EDGE_BLOCK Edge Block entity type
EX_EDGE_SET Edge Set entity type
EX_FACE_BLOCK Face Block entity type
EX_FACE_SET Face Set entity type
EX_ELEM_BLOCK Element Block entity type
EX_ELEM_SET Element Set entity type
EX_SIDE_SET Side Set entity type

As an example, the following coding will determine the number of global variables stored in the data file:

int num_glo_vars, error, exoid;
\comment{read global variables parameters}
error = ex_get_variable_param(exoid, EX_GLOBAL, &num_glo_vars);
@ EX_GLOBAL
Definition exodusII.h:228

◆ ex_header_size()

size_t ex_header_size ( int exoid)
extern

◆ ex_inquire()

int ex_inquire ( int exoid,
int inquiry,
void_int * ret_int,
float * ret_float,
char * ret_char )
extern

◆ ex_inquire_int()

int64_t ex_inquire_int ( int exoid,
int req_info )
extern

A variant of ex_inquire() which queries integer-valued information only.

See also
ex_inquire().
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]req_infoA flag which designates what information is requested. (See ex_inquire() documentation)
Returns
result of inquiry.

As an example, the following will return the number of nodes, elements, and element blocks stored in the exodus file :

#include "exodusII.h"
int exoid;
int num_nodes = ex_inquire_int(exoid, EX_INQ_NODES);
int num_elems = ex_inquire_int(exoid, EX_INQ_ELEM);
int num_block = ex_inquire_int(exoid, EX_INQ_ELEM_BLK);
@ EX_INQ_NODES
Definition exodusII.h:134
@ EX_INQ_ELEM
Definition exodusII.h:135
@ EX_INQ_ELEM_BLK
Definition exodusII.h:136

◆ ex_int64_status()

int ex_int64_status ( int exoid)
extern

◆ ex_large_model()

int ex_large_model ( int exoid)
extern

Determine whether the new large model storage is being used in this file, or old method. Basically, the difference is whether the coordinates and nodal variables are stored in a blob (xyz components together) or as a variable per component per nodal_variable.

◆ ex_name_of_object()

char * ex_name_of_object ( ex_entity_type obj_type)
extern

◆ ex_open_int()

int ex_open_int ( const char * path,
int mode,
int * comp_ws,
int * io_ws,
float * version,
int my_version )
extern

◆ ex_opts()

int ex_opts ( int options)
extern

The function ex_opts() is used to set message reporting options.

Returns
Returns previous value for the message reporting option.
Parameters
[in]optionsInteger option value. Current options are shown in the table below.
EX_ABORT Causes fatal errors to force program exit. (Default is false.)
EX_DEBUG Causes certain messages to print for debug use. (Default is false.)
EX_VERBOSE Causes all error messages to print when true, otherwise no error messages will print. (Default is false.)
Note
Values may be OR'ed together to provide any combination of these capabilities.

For example, the following will cause all messages to print and will cause the program to exit upon receipt of fatal error:

#include "exodusII.h"
int ex_opts(int options)
Definition ex_opts.c:81
@ EX_ABORT
Definition exodusII.h:240
@ EX_VERBOSE
Definition exodusII.h:238

◆ ex_put_all_var_param()

int ex_put_all_var_param ( int exoid,
int num_g,
int num_n,
int num_e,
int * elem_var_tab,
int num_m,
int * nset_var_tab,
int num_s,
int * sset_var_tab )
extern

defines the number of global, nodal, element, nodeset, and sideset variables that will be written to the database

Parameters
exoidexodus file id
num_gglobal variable count
num_nnodal variable count
num_eelement variable count
*elem_var_tabelement variable truth table array
num_mnodeset variable count
*nset_var_tabnodeset variable truth table array
num_ssideset variable count
*sset_var_tabsideset variable truth table array

◆ ex_put_all_var_param_ext()

int ex_put_all_var_param_ext ( int exoid,
const ex_var_params * vp )
extern

writes the number of global, nodal, element, nodeset, and sideset variables that will be written to the database

Parameters
exoidexodus file id
*vppointer to variable parameter info

◆ ex_put_attr()

int ex_put_attr ( int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
const void * attrib )
extern

writes the attributes for an edge/face/element block

Parameters
exoidexodus file id
blk_typeblock type
blk_idblock id
attribarray of attributes

◆ ex_put_attr_names()

int ex_put_attr_names ( int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
char ** names )
extern

◆ ex_put_attr_param()

int ex_put_attr_param ( int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int num_attrs )
extern

defines the number of attributes.

Parameters
exoidexodus file id
obj_typeblock/set type (node, edge, face, elem)
obj_idblock/set id (ignored for NODAL)
num_attrsnumber of attributes

◆ ex_put_block()

int ex_put_block ( int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
const char * entry_descrip,
int64_t num_entries_this_blk,
int64_t num_nodes_per_entry,
int64_t num_edges_per_entry,
int64_t num_faces_per_entry,
int64_t num_attr_per_entry )
extern

writes the parameters used to describe an element/face/edge block

Parameters
exoidexodus file id
blk_typetype of block (edge, face, or element)
blk_idblock identifer
entry_descripstring describing shape of entries in the block
num_entries_this_blknumber of entries(records) in the block
num_nodes_per_entrynumber of nodes per block entry
num_edges_per_entrynumber of edges per block entry
num_faces_per_entrynumber of faces per block entry
num_attr_per_entrynumber of attributes per block entry

◆ ex_put_block_param()

int ex_put_block_param ( int exoid,
const ex_block block )
extern

writes the parameters used to describe an element/face/edge block

Parameters
exoidexodus file id
blockex_block structure describing block counts

◆ ex_put_block_params()

int ex_put_block_params ( int exoid,
size_t block_count,
const struct ex_block * blocks )
extern

writes the parameters used to describe an element/face/edge block

Parameters
exoidexodus file id
block_countnumber of blocks being defined
blockarray of ex_block structures describing block counts

◆ ex_put_cmap_params()

int ex_put_cmap_params ( int exoid,
void_int * node_map_ids,
void_int * node_map_node_cnts,
void_int * elem_map_ids,
void_int * elem_map_elem_cnts,
int64_t processor )
extern

◆ ex_put_cmap_params_cc()

int ex_put_cmap_params_cc ( int exoid,
void_int * node_map_ids,
void_int * node_map_node_cnts,
void_int * node_proc_ptrs,
void_int * elem_map_ids,
void_int * elem_map_elem_cnts,
void_int * elem_proc_ptrs )
extern

◆ ex_put_concat_all_blocks()

int ex_put_concat_all_blocks ( int exoid,
const ex_block_params * param )
extern

writes the parameters used to describe all element, edge, and face blocks

Parameters
exoidexodus file id
paramblock parameters structure

◆ ex_put_concat_elem_block()

int ex_put_concat_elem_block ( int exoid,
const void_int * elem_blk_id,
char * elem_type[],
const void_int * num_elem_this_blk,
const void_int * num_nodes_per_elem,
const void_int * num_attr_this_blk,
int define_maps )
extern

writes the parameters used to describe an element block

Parameters
exoidexodus file id
elem_blk_idelement block id
elem_typeelement type string
num_elem_this_blknumber of elements in the element blk
num_nodes_per_elemnumber of nodes per element block
num_attr_this_blknumber of attributes
define_mapsif != 0, write maps, else don't

◆ ex_put_concat_node_sets()

int ex_put_concat_node_sets ( int exoid,
void_int * node_set_ids,
void_int * num_nodes_per_set,
void_int * num_dist_per_set,
void_int * node_sets_node_index,
void_int * node_sets_df_index,
void_int * node_sets_node_list,
void * node_sets_dist_fact )
extern
Deprecated
Use ex_put_concat_sets()(exoid, EX_NODE_SET, &set_specs)

The function ex_put_concat_node_sets() writes the node set ID's, node sets node count array, node sets distribution factor count array, node sets node list pointers array, node sets distribution factor pointer, node set node list, and node set distribution factors for all of the node sets. `‘Concatenated node sets’' refers to the arrays required to define all of the node sets (ID array, counts arrays, pointers arrays, node list array, and distribution factors array) as described in Section 3.10 on page 11. Writing concatenated node sets is more efficient than writing individual node sets. See #Efficiency for a discussion of efficiency issues.

Because the distribution factors are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_put_concat_node_sets() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • data file opened for read only.
  • data file not initialized properly with call to ex_put_init().
  • the number of node sets specified in a call to ex_put_init() was zero or has been exceeded.
  • a node set with the same ID has already been stored.
  • the number of distribution factors specified for one of the node sets is not zero and is not equal to the number of nodes in the same node set.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]node_set_idsArray containing the node set ID for each set.
[in]num_nodes_per_setArray containing the number of nodes for each set.
[in]num_dist_per_setArray containing the number of distribution factors for each set.
[in]node_sets_node_indexArray containing the indices into the node_set_node_list which are the locations of the first node for each set. These indices are 0-based. Pass NULL for remaining parameters to just set the nodeset parameters and not output nodeset data.
[in]node_sets_df_indexArray containing the indices into the node_set_dist_list which are the locations of the first distribution factor for each set. These indices are 0-based.
[in]node_sets_node_listArray containing the nodes for all sets. Internal node IDs are used in this list (See Section LocalNodeIds).
[in]node_sets_dist_factArray containing the distribution factors for all sets.

For example, the following code will write out two node sets in a concatenated format:

int ids[2], num_nodes_per_set[2], node_ind[2], node_list[8],
num_df_per_set[2], df_ind[2], error, exoid;
float dist_fact[8];
ids[0] = 20; ids[1] = 21;
num_nodes_per_set[0] = 5; num_nodes_per_set[1] = 3;
node_ind[0] = 0; node_ind[1] = 5;
node_list[0] = 100; node_list[1] = 101; node_list[2] = 102;
node_list[3] = 103; node_list[4] = 104;
node_list[5] = 200; node_list[6] = 201; node_list[7] = 202;
num_df_per_set[0] = 5; num_df_per_set[1] = 3;
df_ind[0] = 0; df_ind[1] = 5;
dist_fact[0] = 1.0; dist_fact[1] = 2.0; dist_fact[2] = 3.0;
dist_fact[3] = 4.0; dist_fact[4] = 5.0;
dist_fact[5] = 1.1; dist_fact[6] = 2.1;
dist_fact[7] = 3.1;
error = ex_put_concat_node_sets (exoid, ids, num_nodes_per_set,
num_df_per_set, node_ind, df_ind,
node_list, dist_fact);
int ex_put_concat_node_sets(int exoid, void_int *node_set_ids, void_int *num_nodes_per_set, void_int *num_dist_per_set, void_int *node_sets_node_index, void_int *node_sets_df_index, void_int *node_sets_node_list, void *node_sets_dist_fact)
Definition ex_put_concat_node_sets.c:127

◆ ex_put_concat_sets()

int ex_put_concat_sets ( int exoid,
ex_entity_type set_type,
const struct ex_set_specs * set_specs )
extern

writes the set ID's, set entry count array, set entry pointers array, set entry list, set extra list, and distribution factors list for all the sets of the specified type.

Parameters
exoidexodus file id
set_typetype of set
set_specsset specs structure

◆ ex_put_concat_side_sets()

int ex_put_concat_side_sets ( int exoid,
void_int * side_set_ids,
void_int * num_elem_per_set,
void_int * num_dist_per_set,
void_int * side_sets_elem_index,
void_int * side_sets_dist_index,
void_int * side_sets_elem_list,
void_int * side_sets_side_list,
void * side_sets_dist_fact )
extern

writes the side set ID's, side set element count array, side set element pointers array, side set element list, side set side list, and distribution factors list.

Parameters
exoidexodus file id
side_set_idsarray of side set ids
num_elem_per_setnumber of elements/sides/faces per set
num_dist_per_setnumber of distribution factors per set
side_sets_elem_indexindex array of elements into elem list
side_sets_dist_indexindex array of df into df list
side_sets_elem_listarray of elements
side_sets_side_listarray of sides/faces
side_sets_dist_factarray of distribution factors
Deprecated
Use ex_put_concat_sets()(exoid, EX_SIDE_SET, set_specs)

◆ ex_put_concat_var_param()

int ex_put_concat_var_param ( int exoid,
int num_g,
int num_n,
int num_e,
int num_elem_blk,
int * elem_var_tab )
extern

writes the number of global, nodal, and element variables that will be written to the database

Parameters
exoidint exodus file id
num_gint global variable count
num_nint nodal variable count
num_eint element variable count
num_elem_blkint number of element blocks
elem_var_tabint* element variable truth table array
Deprecated
Use ex_put_all_var_param()(exoid, num_g, num_n, num_e, elem_var_tab, 0, 0, 0, 0)

◆ ex_put_conn()

int ex_put_conn ( int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
const void_int * node_conn,
const void_int * elem_edge_conn,
const void_int * elem_face_conn )
extern

writes the connectivity array for a block

Parameters
exoidexodus file id
blk_typetype of block
blk_idid of block
node_connnode-element connectivity
elem_edge_connelement-edge connectivity (NULL if none)
elem_face_connelement-face connectivity (NULL if none)

◆ ex_put_coord()

int ex_put_coord ( int exoid,
const void * x_coor,
const void * y_coor,
const void * z_coor )
extern

The function ex_put_coord() writes the nodal coordinates of the nodes in the model. The function ex_put_init() must be invoked before this call is made.

Because the coordinates are floating point values, the application code must declare the arrays passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_put_coord() returns a negative number; a warning will return a positive number. Possible causes of errors include:
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]x_coorThe X-coordinates of the nodes. If this is NULL, the X-coordinates will not be written.
[in]y_coorThe Y-coordinates of the nodes. These are stored only if num_dim > 1; otherwise, pass in NULL. If this is NULL, the Y-coordinates will not be written.
[in]z_coorThe Z-coordinates of the nodes. These are stored only if num_dim > 2; otherwise, pass in NULL. If this is NULL, the Z-coordinates will not be written.

The following will write the nodal coordinates to an open exodus file :

int error, exoid;
// \comment{if file opened with compute word size of sizeof(float)}
float x[8], y[8], z[8];
// \comment{write nodal coordinates values to database}
x[0] = 0.0; y[0] = 0.0; z[0] = 0.0;
x[1] = 0.0; y[1] = 0.0; z[1] = 1.0;
x[2] = 1.0; y[2] = 0.0; z[2] = 1.0;
x[3] = 1.0; y[3] = 0.0; z[3] = 0.0;
x[4] = 0.0; y[4] = 1.0; z[4] = 0.0;
x[5] = 0.0; y[5] = 1.0; z[5] = 1.0;
x[6] = 1.0; y[6] = 1.0; z[6] = 1.0;
x[7] = 1.0; y[7] = 1.0; z[7] = 0.0;
error = ex_put_coord(exoid, x, y, z);
// \comment{Do the same as the previous call in three separate calls}
error = ex_put_coord(exoid, x, NULL, NULL);
error = ex_put_coord(exoid, NULL, y, NULL);
error = ex_put_coord(exoid, NULL, NULL, z);
int ex_put_coord(int exoid, const void *x_coor, const void *y_coor, const void *z_coor)
Definition ex_put_coord.c:115

◆ ex_put_coord_names()

int ex_put_coord_names ( int exoid,
char * coord_names[] )
extern

The function ex_put_coord_names() writes the names (MAX_STR_LENGTH-characters in length) of the coordinate arrays to the database. Memory must be allocated for the character strings before this function is invoked.

In case of an error, ex_put_coord_names() returns a negative number; a warning will return a positive number. Possible causes of errors include:

Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]coord_namesArray containing num_dim names of length MAX_STR_LENGTH
of the nodal coordinate arrays.

The following coding will write the coordinate names to an open exodus file :

int error, exoid;
char *coord_names[3];
coord_names[0] = "xcoor";
coord_names[1] = "ycoor";
coord_names[2] = "zcoor";
error = ex_put_coord_names (exoid, coord_names);
int ex_put_coord_names(int exoid, char *coord_names[])
Definition ex_put_coord_names.c:76

◆ ex_put_coordinate_frames()

int ex_put_coordinate_frames ( int exoid,
int nframes,
const void_int * cf_ids,
void * pt_coordinates,
const char * tags )
extern

◆ ex_put_eb_info_global()

int ex_put_eb_info_global ( int exoid,
void_int * el_blk_ids,
void_int * el_blk_cnts )
extern

◆ ex_put_elem_attr()

int ex_put_elem_attr ( int exoid,
ex_entity_id elem_blk_id,
const void * attrib )
extern
Deprecated
Use ex_put_attr()(exoid, EX_ELEM_BLOCK, elem_blk_id, attrib)

The function ex_put_elem_attr() writes the attributes for an element block. Each element in the element block must have the same number of attributes, so there are(num_attr x num_elem_this_blk) attributes for each element block. The function ex_put_elem_block() must be invoked before this call is made.

Because the attributes are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_put_elem_attr() returns a negative number; a warning will return a positive number. Possible causes of errors include:
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]elem_blk_idThe element block ID.
[in]attribSize [num_elem_this_blk*num_attr] The list of attributes for the element block. The num_attr index cycles faster.

Refer to the code example in ex_put_elem_block() for an example of writing the attributes array for an element block.

◆ ex_put_elem_attr_names()

int ex_put_elem_attr_names ( int exoid,
ex_entity_id elem_blk_id,
char * names[] )
extern

writes the attribute names for an element block

Parameters
exoidexodus file id
elem_blk_idelement block id
names[]ptr array of attribute names
Deprecated
Use ex_put_attr_names()(exoid, EX_ELEM_BLOCK, elem_blk_id, names)

◆ ex_put_elem_block()

int ex_put_elem_block ( int exoid,
ex_entity_id elem_blk_id,
const char * elem_type,
int64_t num_elem_this_blk,
int64_t num_nodes_per_elem,
int64_t num_attr_per_elem )
extern
Deprecated
Use ex_put_block()(exoid, EX_ELEM_BLOCK, elem_blk_id, elem_type, num_elem_this_blk, num_nodes_per_elem, 0, 0, num_attr_per_elem)

The function ex_put_elem_block() writes the parameters used to describe an element block.

Returns
In case of an error, ex_put_elem_block() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • data file opened for read only.
  • data file not initialized properly with call to ex_put_init().
  • an element block with the same ID has already been specified.
  • the number of element blocks specified in the call to ex_put_init() has been exceeded.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]elem_blk_idThe element block ID.
[in]elem_typeThe type of elements in the element block. The maximum length of this string is MAX_STR_LENGTH .
[in]num_elem_this_blkThe number of elements in the element block.
[in]num_nodes_per_elemThe number of nodes per element in the element block.
[in]num_attr_per_elemThe number of attributes per element in the element block.

For example, the following code segment will initialize an element block with an ID of 10, write out the connectivity array, and write out the element attributes array:

int id, error, exoid, num_elem_in_blk, num_nodes_per_elem, *connect, num_attr;
float *attrib;
\comment{write element block parameters}
id = 10;
num_elem_in_blk = 2;
num_nodes_per_elem = 4; \comment{elements are 4-node shells}
num_attr = 1; \comment{one attribute per element}
error = ex_put_elem_block(exoid, id, "SHELL", num_elem_in_blk,
num_nodes_per_elem, num_attr);
\comment{write element connectivity}
connect = (int *)calloc(num_elem_in_blk*num_nodes_per_elem, sizeof(int));
\comment{fill connect with node numbers; nodes for first elemen}
connect[0] = 1; connect[1] = 2; connect[2] = 3; connect[3] = 4;
\comment{nodes for second element}
connect[4] = 5; connect[5] = 6; connect[6] = 7; connect[7] = 8;
error = ex_put_elem_conn (exoid, id, connect);
\comment{write element block attributes}
attrib = (float *) calloc (num_attr*num_elem_in_blk, sizeof(float));
for (i=0, cnt=0; i < num_elem_in_blk; i++) {
for (j=0; j < num_attr; j++, cnt++) {
attrib[cnt] = 1.0;
}
}
error = ex_put_elem_attr (exoid, id, attrib);
\comment{Same result using non-deprecated code}
error = ex_put_block(exoid, EX_ELEM_BLOCK, id, "SHELL", num_elem_in_blk,
num_nodes_per_elem, 0, 0, num_attr);
error = ex_put_conn (exoid, EX_ELEM_BLOCK, id, connect);
error = ex_put_attr (exoid, EX_ELEM_BLOCK, id, attrib);
int ex_put_conn(int exoid, ex_entity_type blk_type, ex_entity_id blk_id, const void_int *node_conn, const void_int *elem_edge_conn, const void_int *elem_face_conn)
Definition ex_put_conn.c:69
int ex_put_elem_attr(int exoid, ex_entity_id elem_blk_id, const void *attrib)
Definition ex_put_elem_attr.c:72
int ex_put_elem_conn(int exoid, ex_entity_id elem_blk_id, const void_int *connect)
Definition ex_put_elem_conn.c:65
int ex_put_attr(int exoid, ex_entity_type blk_type, ex_entity_id blk_id, const void *attrib)
Definition ex_put_attr.c:67
int ex_put_elem_block(int exoid, ex_entity_id elem_blk_id, const char *elem_type, int64_t num_elem_this_blk, int64_t num_nodes_per_elem, int64_t num_attr)
Definition ex_put_elem_block.c:128
int ex_put_block(int exoid, ex_entity_type blk_type, ex_entity_id blk_id, const char *entry_descrip, int64_t num_entries_this_blk, int64_t num_nodes_per_entry, int64_t num_edges_per_entry, int64_t num_faces_per_entry, int64_t num_attr_per_entry)
Definition ex_put_block.c:73

◆ ex_put_elem_cmap()

int ex_put_elem_cmap ( int exoid,
ex_entity_id map_id,
void_int * elem_ids,
void_int * side_ids,
void_int * proc_ids,
int processor )
extern

◆ ex_put_elem_conn()

int ex_put_elem_conn ( int exoid,
ex_entity_id elem_blk_id,
const void_int * connect )
extern
Deprecated
Use ex_put_conn()(exoid, EX_ELEM_BLOCK, elem_blk_id, connect, 0, 0)

The function ex_put_elem_conn() writes the connectivity array for an element block. The function ex_put_elem_block() must be invoked before this call is made.

Returns
In case of an error, ex_put_elem_conn() returns a negative number; a warning will return a positive number. Possible causes of errors include:
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]elem_blk_idThe element block ID.
[in]connectSize [num_elem_this_blk,num_nodes_per_elem], The connectivity array; a list of nodes (internal node IDs; See Section LocalNodeIds) that define each element in the element block. The node index cycles faster than the element index.

Refer to the code example in ex_put_elem_block() for an example of writing the connectivity array for an element block.

◆ ex_put_elem_map()

int ex_put_elem_map ( int exoid,
ex_entity_id map_id,
const void_int * elem_map )
extern

writes an element map; this is a vector of integers of length number of elements

Parameters
exoidexodus file id
map_idelement map id
elem_mapelement map
Deprecated
Use ex_put_num_map()(exoid, EX_ELEM_MAP, map_id, elem_map)

◆ ex_put_elem_num_map()

int ex_put_elem_num_map ( int exoid,
const void_int * elem_map )
extern
Deprecated
Use ex_put_id_map()(exoid, EX_ELEM_MAP, elem_map)

The function ex_put_elem_num_map() writes out the optional element number map to the database. See Section LocalElementIds for a description of the element number map. The function ex_put_init() must be invoked before this call is made.

Returns
In case of an error, ex_put_elem_num_map() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • data file opened for read only.
  • data file not initialized properly with call to ex_put_init().
  • an element number map already exists in the file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]elem_mapThe element number map.

The following code generates a default element number map and outputs it to an open exodus file. This is a trivial case and included just for illustration. Since this map is optional, it should be written out only if it contains something other than the default map.

int error, exoid;
int *elem_map = (int *)calloc(num_elem, sizeof(int));
for (i=1; i <= num_elem; i++)
elem_map[i-1] = i;
error = ex_put_elem_num_map(exoid, elem_map);
\comment{Equivalent using non-deprecated function}
error = ex_put_id_map(exoid, EX_ELEM_MAP, elem_map);
int ex_put_elem_num_map(int exoid, const void_int *elem_map)
Definition ex_put_elem_num_map.c:77
int ex_put_id_map(int exoid, ex_entity_type obj_type, const void_int *map)
Definition ex_put_id_map.c:66

◆ ex_put_elem_var()

int ex_put_elem_var ( int exoid,
int time_step,
int elem_var_index,
ex_entity_id elem_blk_id,
int64_t num_elem_this_blk,
const void * elem_var_vals )
extern
Deprecated
Use ex_put_var()(exoid, time_step, EX_ELEM_BLOCK, elem_var_index, elem_blk_id, num_elem_this_blk, elem_var_vals)

The function ex_put_elem_var() writes the values of a single element variable for one element block at one time step. It is recommended, but not required, to write the element variable truth table (with ex_put_elem_var_tab() before this function is invoked for better efficiency. See #Efficiency for a discussion of efficiency issues.

Because element variables are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_put_elem_var() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • data file opened for read only.
  • data file not initialized properly with call to ex_put_init().
  • invalid element block ID.
  • ex_put_elem_block() not called previously to specify parameters for this element block.
  • ex_put_variable_param() not called previously specifying the number of element variables.
  • an element variable truth table was stored in the file but contains a zero (indicating no valid element variable) for the specified element block and element variable.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]time_stepThe time step number, as described under ex_put_time(). This is essentially a counter that is incremented only when results variables are output. The first time step is 1.
[in]elem_var_indexThe index of the element variable. The first variable has an index of 1.
[in]elem_blk_idThe element block ID.
[in]num_elem_this_blkThe number of elements in the given element block.
[in]elem_var_valsArray of num_elem_this_blk values of the elem_var_index-th element variable for the element block with ID of elem_blk_id at the time_step-th time step.

The following coding will write out all of the element variables for a single time step n to an open exodus file :

int num_ele_vars, num_elem_blk, *num_elem_in_block,error,
exoid, n, *ebids;
float *elem_var_vals;
\comment{write element variables}
for (k=1; k <= num_ele_vars; k++) {
for (j=0; j < num_elem_blk; j++) {
elem_var_vals = (float *)
calloc(num_elem_in_block[j], sizeof(float));
for (m=0; m < num_elem_in_block[j]; m++) {
\comment{simulation code fills this in}
elem_var_vals[m] = 10.0;
}
error = ex_put_elem_var (exoid, n, k, ebids[j],
num_elem_in_block[j], elem_var_vals);
\comment {Using non-deprecated function:}
error = ex_put_var (exoid, n, EX_ELEM_BLOCK, k, ebids[j],
num_elem_in_block[j], elem_var_vals);
free (elem_var_vals);
}
}
int ex_put_elem_var(int exoid, int time_step, int elem_var_index, ex_entity_id elem_blk_id, int64_t num_elem_this_blk, const void *elem_var_vals)
Definition ex_put_elem_var.c:134
int ex_put_var(int exoid, int time_step, ex_entity_type var_type, int var_index, ex_entity_id obj_id, int64_t num_entries_this_obj, const void *var_vals)
Definition ex_put_var.c:222

◆ ex_put_elem_var_slab()

int ex_put_elem_var_slab ( int exoid,
int time_step,
int elem_var_index,
ex_entity_id elem_blk_id,
int64_t start_pos,
int64_t num_vals,
void * elem_var_vals )
extern

◆ ex_put_elem_var_tab()

int ex_put_elem_var_tab ( int exoid,
int num_elem_blk,
int num_elem_var,
int * elem_var_tab )
extern
Deprecated
Use ex_put_truth_table()(exoid, EX_ELEM_BLOCK, num_elem_blk, num_elem_var, elem_var_tab)

The function ex_put_elem_var_tab() writes the exodus element variable truth table to the database. The element variable truth table indicates whether a particular element result is written for the elements in a particular element block. A 0 (zero) entry indicates that no results will be output for that element variable for that element block. A non-zero entry indicates that the appropriate results will be output.

Although writing the element variable truth table is optional, it is encouraged because it creates at one time all the necessary

variables in which to hold the exodus element variable
values. This results in significant time savings. See
Section #Efficiency for a discussion of efficiency issues.
The function ex_put_variable_param() must be called before this
routine in order to define the number of element variables.
\return In case of an error, ex_put_elem_var_tab() returns a negative
number; a warning will return a positive number. Possible causes of
errors include:
- data file not properly opened with call to ex_create() or ex_open()
- data file opened for read only.
- data file not initialized properly with call to ex_put_init().
- the specified number of element blocks is different than the
number specified in a call to ex_put_init().
- ex_put_elem_block() not called previously to specify
element block parameters.
- ex_put_variable_param() not called previously to specify
the number of element variables or was called but with a different
number of element variables.
- ex_put_elem_var() previously called.
\param[in] exoid exodus file ID returned from a previous call to ex_create() or ex_open().
\param[in] num_elem_blk The number of element blocks.
\param[in] num_elem_var The number of element variables.
\param[in] elem_var_tab Size [num_elem_blk,num_elem_var]. A 2-dimensional array
(with the \c num_elem_var index cycling faster)
containing the element variable truth table.
The following coding will create, populate, and write an element
variable truth table to an opened exodus file (NOTE: all element
variables are valid for all element blocks in this example.):
\code
int *truth_tab, num_elem_blk, num_ele_vars, error, exoid;
\comment{write element variable truth table}
truth_tab = (int *)calloc((num_elem_blk*num_ele_vars), sizeof(int));
for (i=0, k=0; i < num_elem_blk; i++) {
for (j=0; j < num_ele_vars; j++) {
truth_tab[k++] = 1;
}
}
error = ex_put_elem_var_tab(exoid, num_elem_blk, num_ele_vars,
truth_tab);

◆ ex_put_entity_count_per_polyhedra()

int ex_put_entity_count_per_polyhedra ( int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
const int * entity_counts )
extern

writes out the number of entities (nodes/faces) per polyhedra (nsided/nfaced) in this element block to the database.

Parameters
exoidexodus file id
blk_typetype of block (face, or element)
blk_idblock identifer
entity_countsentity_per_polyhedra count array

◆ ex_put_glob_vars()

int ex_put_glob_vars ( int exoid,
int time_step,
int num_glob_vars,
const void * glob_var_vals )
extern
Deprecated
Use ex_put_var()(exoid, time_step, EX_GLOBAL, 1, 0, num_glob_vars, glob_var_vals)

The function ex_put_glob_vars() writes the values of all the global variables for a single time step. The function ex_put_variable_param() must be invoked before this call is made.

Because global variables are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_put_glob_vars() returns a negative number; a warning will return a positive number. Possible causes of errors include:
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]time_stepThe time step number, as described under ex_put_time(). This is essentially a counter that is incremented when results variables are output. The first time step is 1.
[in]num_glob_varsThe number of global variables to be written to the database.
[in]glob_var_valsArray of num_glob_vars global variable values for the time_step-th time step.

As an example, the following coding will write the values of all the global variables at one time step to an open exodus II file:

int num_glo_vars, error, exoid, time_step;
float *glob_var_vals
\comment{write global variables}
for (j=0; j < num_glo_vars; j++) {
\comment{application code fills this array}
glob_var_vals[j] = 10.0;
}
error = ex_put_glob_vars (exoid, time_step, num_glo_vars, glob_var_vals);
\comment{Using non-deprecated functions:}
error = ex_put_var (exoid, time_step, EX_GLOBAL, 1, 0, num_glo_vars, glob_var_vals);
int ex_put_glob_vars(int exoid, int time_step, int num_glob_vars, const void *glob_var_vals)
Definition ex_put_glob_vars.c:107

◆ ex_put_id_map()

int ex_put_id_map ( int exoid,
ex_entity_type map_type,
const void_int * map )
extern

writes out the entity numbering map to the database; this allows the entity numbers to be non-contiguous. This map is used for mapping between local and global entity ids.

Parameters
exoidexodus file id
map_type
mapelement numbering map array

◆ ex_put_info()

int ex_put_info ( int exoid,
int num_info,
char * info[] )
extern

The function ex_put_info() writes information records to the database. The records are MAX_LINE_LENGTH-character strings.

In case of an error, ex_put_info() returns a negative number; a warning will return a positive number. Possible causes of errors include:

  • data file not properly opened with call to ex_create() or ex_open()
  • data file opened for read only.
  • information records already exist in file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]num_infoThe number of information records.
[in]infoArray containing the information records. To only define the number of info records instead of defining and outputting, pass NULL for info argument.

The following code will write out three information records to an open exodus file -

int error, exoid, num_info;
char *info[3];
\comment{write information records}
num_info = 3;
info[0] = "This is the first information record.";
info[1] = "This is the second information record.";
info[2] = "This is the third information record.";
error = ex_put_info(exoid, num_info, info);
int ex_put_info(int exoid, int num_info, char *info[])
Definition ex_put_info.c:103

The following code will first tell the database that there are three information records, and then later actually output those records.

int error, exoid, num_info;
char *info[3];
\comment{Define the number of information records that will be written
later.}
num_info = 3;
error = ex_put_info(exoid, num_info, NULL);
\comment{Now, actually write the information records}
info[0] = "This is the first information record.";
info[1] = "This is the second information record.";
info[2] = "This is the third information record.";
error = ex_put_info(exoid, num_info, info);

◆ ex_put_init()

int ex_put_init ( int exoid,
const char * title,
int64_t num_dim,
int64_t num_nodes,
int64_t num_elem,
int64_t num_elem_blk,
int64_t num_node_sets,
int64_t num_side_sets )
extern

The function ex_put_init() writes the initialization parameters to the exodus file. This function must be called once (and only once) before writing any data to the file.

Returns
In case of an error, ex_put_init() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • data file opened for read only.
  • this routine has been called previously.
Parameters
exoidexodus file ID returned from a previous call to ex_create() or ex_open().
titleDatabase title. Maximum length is MAX_LINE_LENGTH.
num_dimThe dimensionality of the database. This is the number of coordinates per node.
num_nodesThe number of nodal points.
num_elemThe number of elements.
num_elem_blkThe number of element blocks.
num_node_setsThe number of node sets.
num_side_setsThe number of side sets.

The following code segment will initialize an open exodus file with the specified parameters:

int num_dim, num_nods, num_el, num_el_blk, num_ns, num_ss, error, exoid;
\comment{initialize file with parameters}
num_dim = 3; num_nods = 46; num_el = 5; num_el_blk = 5;
num_ns = 2; num_ss = 5;
error = ex_put_init (exoid, "This is the title", num_dim,
num_nods, num_el,num_el_blk, num_ns, num_ss);
int ex_put_init(int exoid, const char *title, int64_t num_dim, int64_t num_nodes, int64_t num_elem, int64_t num_elem_blk, int64_t num_node_sets, int64_t num_side_sets)
Definition ex_put_init.c:78

◆ ex_put_init_ext()

int ex_put_init_ext ( int exoid,
const ex_init_params * model )
extern

writes the initialization parameters to the EXODUS II file

Parameters
exoidexodus file id
modelfinite element model parameters

◆ ex_put_init_global()

int ex_put_init_global ( int exoid,
int64_t num_nodes_g,
int64_t num_elems_g,
int64_t num_elem_blks_g,
int64_t num_node_sets_g,
int64_t num_side_sets_g )
extern

◆ ex_put_init_info()

int ex_put_init_info ( int exoid,
int num_proc,
int num_proc_in_f,
char * ftype )
extern

◆ ex_put_loadbal_param()

int ex_put_loadbal_param ( int exoid,
int64_t num_int_nodes,
int64_t num_bor_nodes,
int64_t num_ext_nodes,
int64_t num_int_elems,
int64_t num_bor_elems,
int64_t num_node_cmaps,
int64_t num_elem_cmaps,
int processor )
extern

◆ ex_put_loadbal_param_cc()

int ex_put_loadbal_param_cc ( int exoid,
void_int * num_int_nodes,
void_int * num_bor_nodes,
void_int * num_ext_nodes,
void_int * num_int_elems,
void_int * num_bor_elems,
void_int * num_node_cmaps,
void_int * num_elem_cmaps )
extern

◆ ex_put_map()

int ex_put_map ( int exoid,
const void_int * elem_map )
extern
Deprecated
Use ex_put_num_map() instead.

The function ex_put_map() writes out the optional element order map to the database. See #ElementOrderMap for a description of the element order map. The function ex_put_init() must be invoked before this call is made.

In case of an error, ex_put_map() returns a negative number; a warning will return a positive number. Possible causes of errors include:

  • data file not properly opened with call to ex_create() or ex_open()
  • data file opened for read only.
  • data file not initialized properly with call to ex_put_init().
  • an element map already exists in the file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]elem_mapThe element order map.

The following code generates a default element order map and outputs it to an open exodus file. This is a trivial case and included just for illustration. Since this map is optional, it should be written out only if it contains something other than the default map.

int error, exoid;
int *elem_map = (int *)calloc(num_elem, sizeof(int));
for (i=0; i < num_elem; i++) {
elem_map[i] = i+1;
}
error = ex_put_map(exoid, elem_map);
int ex_put_map(int exoid, const void_int *elem_map)
Definition ex_put_map.c:90

◆ ex_put_map_param()

int ex_put_map_param ( int exoid,
int num_node_maps,
int num_elem_maps )
extern

defines the number of node and element maps. It is more efficient to define both of these at the same time; however, they can be defined in separate calls by setting only one of the counts to a non-zero value. It is an error to redefine the number of node or element maps.

Parameters
exoidexodus file id
num_node_mapsnumber of node maps
num_elem_mapsnumber of element maps

◆ ex_put_n_coord()

int ex_put_n_coord ( int exoid,
int64_t start_node_num,
int64_t num_nodes,
const void * x_coor,
const void * y_coor,
const void * z_coor )
extern
Deprecated
Use ex_put_partial_coord() instead. writes the coordinates of some of the nodes in the model Only writes the 'non-null' arrays.
Parameters
exoidexodus file id
start_node_numthe starting index (1-based) of the coordinates to be written
num_nodesthe number of nodes to write coordinates for.
x_coorx coord array
y_coory coord array
z_coorz coord array

◆ ex_put_n_elem_attr()

int ex_put_n_elem_attr ( int exoid,
ex_entity_id elem_blk_id,
int64_t start_elem_num,
int64_t num_elems,
void * attrib )
extern

◆ ex_put_n_elem_conn()

int ex_put_n_elem_conn ( int exoid,
ex_entity_id elem_blk_id,
int64_t start_elem_num,
int64_t num_elems,
const void_int * connect )
extern

◆ ex_put_n_elem_num_map()

int ex_put_n_elem_num_map ( int exoid,
int64_t start_ent,
int64_t num_ents,
const void_int * map )
extern

◆ ex_put_n_nodal_var()

int ex_put_n_nodal_var ( int exoid,
int time_step,
int nodal_var_index,
int64_t start_node,
int64_t num_nodes,
const void * nodal_var_vals )
extern

writes the values of a single nodal variable for a partial block at one single time step to the database; assume the first time step and nodal variable index is 1

Parameters
exoidexodus file id
time_stepwhole time step number
nodal_var_indexindex of desired nodal variable
start_nodeindex of first node to write data for (1-based)
num_nodesnumber of nodal points
nodal_var_valsarray of nodal variable values

◆ ex_put_n_node_num_map()

int ex_put_n_node_num_map ( int exoid,
int64_t start_ent,
int64_t num_ents,
const void_int * map )
extern

◆ ex_put_n_node_set()

int ex_put_n_node_set ( int exoid,
ex_entity_id node_set_id,
int64_t start_node_num,
int64_t num_node,
const void_int * node_set_node_list )
extern

◆ ex_put_n_node_set_df()

int ex_put_n_node_set_df ( int exoid,
ex_entity_id node_set_id,
int64_t start_num,
int64_t num_df_to_get,
void * node_set_dist_fact )
extern

◆ ex_put_n_one_attr()

int ex_put_n_one_attr ( int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int64_t start_num,
int64_t num_ent,
int attrib_index,
const void * attrib )
extern
Deprecated
Use ex_put_partial_one_attr() instead. writes the specified attribute for a block
Parameters
exoidexodus file id
obj_typeobject type (edge, face, elem block)
obj_idobject id (edge, face, elem block ID)
start_numthe starting index of the attributes to be written
num_entthe number of entities to write attributes for.
attrib_indexindex of attribute to write
attribarray of attributes

◆ ex_put_n_side_set()

int ex_put_n_side_set ( int exoid,
ex_entity_id side_set_id,
int64_t start_side_num,
int64_t num_sides,
const void_int * side_set_elem_list,
const void_int * side_set_side_list )
extern

/deprecated use ex_put_partial_set() instead

◆ ex_put_n_side_set_df()

int ex_put_n_side_set_df ( int exoid,
ex_entity_id side_set_id,
int64_t start_num,
int64_t num_df_to_get,
void * side_set_dist_fact )
extern

◆ ex_put_n_var()

int ex_put_n_var ( int exoid,
int time_step,
ex_entity_type var_type,
int var_index,
ex_entity_id obj_id,
int64_t start_index,
int64_t num_entities,
const void * var_vals )
extern
Deprecated
use ex_put_partial_var() instead writes the values of a single variable for a partial block at one time step to the database; assume the first time step and variable index are 1
Parameters
exoidexodus file id
time_steptime step number
var_typetype (edge block, face block, edge set, ... )
var_indexelement variable index
obj_idelement block id
start_indexindex of first entity in block to write (1-based)
num_entitiesnumber of entries in this block/set
var_valsthe values to be written

◆ ex_put_name()

int ex_put_name ( int exoid,
ex_entity_type obj_type,
ex_entity_id entity_id,
const char * name )
extern

writes the name of the specified entity to the database. The entity with id entity_id must exist before calling ex_put_name().

Parameters
exoidexodus file id
obj_typeobject type
entity_idid of entity name to write
nameptr to entity name

◆ ex_put_names()

int ex_put_names ( int exoid,
ex_entity_type obj_type,
char * names[] )
extern

writes the entity names to the database

Parameters
exoidexodus file id
obj_typeobject type
namesptr array of entity names

◆ ex_put_nodal_var()

int ex_put_nodal_var ( int exoid,
int time_step,
int nodal_var_index,
int64_t num_nodes,
const void * nodal_var_vals )
extern

The function ex_put_nodal_var() writes the values of a single nodal variable for a single time step. The function ex_put_variable_param() must be invoked before this call is made.

Because nodal variables are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_put_nodal_var() returns a negative number; a warning will return a positive number. Possible causes of errors include:
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]time_stepThe time step number, as described under ex_put_time(). This is essentially a counter that is incremented when results variables are output. The first time step is 1.
[in]nodal_var_indexThe index of the nodal variable. The first variable has an index of 1.
[in]num_nodesThe number of nodal points.
[in]nodal_var_valsArray of num_nodes values of the nodal_var_index-th nodal variable for the time_step-th time step.

As an example, the following code segment writes all the nodal variables for a single time step:

int num_nod_vars, num_nodes, error, exoid, time_step;
float *nodal_var_vals;
\comment{write nodal variables}
nodal_var_vals = (float *) calloc(num_nodes, sizeof(float));
for (k=1; k <= num_nod_vars; k++) {
for (j=0; j < num_nodes; j++) {
\comment{application code fills in this array}
nodal_var_vals[j] = 10.0;
}
error = ex_put_nodal_var(exoid, time_step, k, num_nodes,
nodal_var_vals);
}
int ex_put_nodal_var(int exoid, int time_step, int nodal_var_index, int64_t num_nodes, const void *nodal_var_vals)
Definition ex_put_nodal_var.c:98

◆ ex_put_nodal_var_slab()

int ex_put_nodal_var_slab ( int exoid,
int time_step,
int nodal_var_index,
int64_t start_pos,
int64_t num_vals,
void * nodal_var_vals )
extern

◆ ex_put_node_cmap()

int ex_put_node_cmap ( int exoid,
ex_entity_id map_id,
void_int * node_ids,
void_int * proc_ids,
int processor )
extern

◆ ex_put_node_map()

int ex_put_node_map ( int exoid,
ex_entity_id map_id,
const void_int * node_map )
extern

writes an node map; this is a vector of integers of length number of nodes

Parameters
exoidexodus file id
map_idnode map id
node_mapnode map
Deprecated
Use ex_put_num_map()(exoid, EX_NODE_MAP, map_id, node_map)

◆ ex_put_node_num_map()

int ex_put_node_num_map ( int exoid,
const void_int * node_map )
extern
Deprecated
Use ex_put_id_map()(exoid, EX_NODE_MAP, node_map)

The function ex_put_node_num_map() writes out the optional node number map to the database. See Section LocalNodeIds for a description of the node number map. The function ex_put_init() must be invoked before this call is made.

Returns
In case of an error, ex_put_node_num_map() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • data file opened for read only.
  • data file not initialized properly with call to ex_put_init().
  • a node number map already exists in the file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]node_mapThe node number map.

The following code generates a default node number map and outputs it to an open exodus file. This is a trivial case and included just for illustration. Since this map is optional, it should be written out only if it contains something other than the default map.

int error, exoid;
int *node_map = (int *)calloc(num_nodes, sizeof(int));
for (i=1; i <= num_nodes; i++)
node_map[i-1] = i;
error = ex_put_node_num_map(exoid, node_map);
\comment{Equivalent using non-deprecated function}
error = ex_put_id_map(exoid, EX_NODE_MAP, node_map);
int ex_put_node_num_map(int exoid, const void_int *node_map)
Definition ex_put_node_num_map.c:76

◆ ex_put_node_set()

int ex_put_node_set ( int exoid,
ex_entity_id node_set_id,
const void_int * node_set_node_list )
extern
Deprecated
Use ex_put_set()(exoid, EX_NODE_SET, node_set_id, node_set_node_list, NULL)

The function ex_put_node_set() writes the node list for a single node set. The function ex_put_node_set_param() must be called before this routine is invoked.

Returns
In case of an error, ex_put_node_set() returns a negative number; a warning will return a positive number. Possible causes of errors include:
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]node_set_idThe node set ID.
[in]node_set_node_listArray containing the node list for the node set. Internal node IDs are used in this list (See Section LocalNodeIds).

Refer to the description of ex_put_node_set_param() for a sample code segment to write out a node set.

◆ ex_put_node_set_dist_fact()

int ex_put_node_set_dist_fact ( int exoid,
ex_entity_id node_set_id,
const void * node_set_dist_fact )
extern
Deprecated
Use ex_put_set_dist_fact()(exoid, EX_NODE_SET, node_set_id, node_set_dist_fact)

The function ex_put_node_set_dist_fact() writes node set distribution factors for a single node set. The function ex_put_node_set_param() must be called before this routine is invoked.

Because the distribution factors are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_put_node_set_dist_fact() returns a negative number; a warning will return a positive number. Possible causes of errors include:
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]node_set_idThe node set ID.
[in]node_set_dist_factArray containing the distribution factors in the node set.

Refer to the description of ex_put_node_set_param() for a sample code segment to write out the distribution factors for a node set.

◆ ex_put_node_set_param()

int ex_put_node_set_param ( int exoid,
ex_entity_id node_set_id,
int64_t num_nodes_in_set,
int64_t num_dist_in_set )
extern
Deprecated
Use ex_put_set_param()(exoid, EX_NODE_SET, node_set_id, num_nodes_in_set, num_dist_in_set)

The function ex_put_node_set_param() writes the node set ID, the number of nodes which describe a single node set, and the number of node set distribution factors for the node set.

Returns
In case of an error, ex_put_node_set_param() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • data file opened for read only.
  • data file not initialized properly with call to ex_put_init().
  • the number of node sets specified in the call to ex_put_init() was zero or has been exceeded.
  • a node set with the same ID has already been stored.
  • the specified number of distribution factors is not zero and is not equal to the number of nodes.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]node_set_idThe node set ID.
[in]num_nodes_in_setThe number of nodes in the node set.
[in]num_dist_in_setThe number of distribution factors in the node set. This should be either 0 (zero) for no factors, or should equal num_nodes_in_set.

The following code segment will write out a node set to an open exodus file :

int id, num_nodes_in_set, num_dist_in_set, error, exoid, *node_list;
float *dist_fact;
\comment{write node set parameters}
id = 20; num_nodes_in_set = 5; num_dist_in_set = 5;
error = ex_put_node_set_param(exoid, id, num_nodes_in_set,
num_dist_in_set);
\comment{write node set node list}
node_list = (int *) calloc (num_nodes_in_set, sizeof(int));
node_list[0] = 100; node_list[1] = 101; node_list[2] = 102;
node_list[3] = 103; node_list[4] = 104;
error = ex_put_node_set(exoid, id, node_list);
\comment{write node set distribution factors}
dist_fact = (float *) calloc (num_dist_in_set, sizeof(float));
dist_fact[0] = 1.0; dist_fact[1] = 2.0; dist_fact[2] = 3.0;
dist_fact[3] = 4.0; dist_fact[4] = 5.0;
error = ex_put_node_set_dist_fact(exoid, id, dist_fact);
\comment{Same result using non-deprecated functions}
error = ex_put_set_param(exoid, EX_NODE_SET, id, num_nodes_in_set, num_dist_in_set);
error = ex_put_set(exoid, EX_NODE_SET, id, node_list);
error = ex_put_set_dist_fact(exoid, EX_NODE_SET, id, dist_fact);
int ex_put_set_param(int exoid, ex_entity_type set_type, ex_entity_id set_id, int64_t num_entries_in_set, int64_t num_dist_fact_in_set)
Definition ex_put_set_param.c:68
int ex_put_node_set_dist_fact(int exoid, ex_entity_id node_set_id, const void *node_set_dist_fact)
Definition ex_put_node_set_dist_fact.c:67
int ex_put_set_dist_fact(int exoid, ex_entity_type set_type, ex_entity_id set_id, const void *set_dist_fact)
Definition ex_put_set_dist_fact.c:67
int ex_put_node_set_param(int exoid, ex_entity_id node_set_id, int64_t num_nodes_in_set, int64_t num_dist_in_set)
Definition ex_put_node_set_param.c:96
int ex_put_node_set(int exoid, ex_entity_id node_set_id, const void_int *node_set_node_list)
Definition ex_put_node_set.c:63
int ex_put_set(int exoid, ex_entity_type set_type, ex_entity_id set_id, const void_int *set_entry_list, const void_int *set_extra_list)
Definition ex_put_set.c:70

◆ ex_put_ns_param_global()

int ex_put_ns_param_global ( int exoid,
void_int * global_ids,
void_int * global_n_cnts,
void_int * global_df_cnts )
extern

◆ ex_put_nset_var()

int ex_put_nset_var ( int exoid,
int time_step,
int nset_var_index,
ex_entity_id nset_id,
int64_t num_nodes_this_nset,
const void * nset_var_vals )
extern

writes the values of a single nodeset variable for one nodeset at one time step to the database; assume the first time step and nodeset variable index are 1

Parameters
exoidexodus file id
time_steptime step number
nset_var_indexnodeset variable index
nset_idnodeset id
num_nodes_this_nsetnumber of nodes in this nodeset
nset_var_valsthe values to be written
Deprecated
Use ex_put_var()(exoid, time_step, EX_NODE_SET, nset_var_index, nset_id, num_nodes_this_nset, nset_var_vals)

◆ ex_put_nset_var_tab()

int ex_put_nset_var_tab ( int exoid,
int num_nset,
int num_nset_var,
int * nset_var_tab )
extern

writes the EXODUS II nodeset variable truth table to the database; also, creates netCDF variables in which to store EXODUS II nodeset variable values; although this table isn't required (because the netCDF variables can also be created in ex_put_nset_var), this call will save tremendous time because all of the variables are defined at once while the file is in define mode, rather than going in and out of define mode (causing the entire file to be copied over and over) which is what occurs when the nodeset variable values variables are defined in ex_put_nset_var

Parameters
exoidexodus file id
num_nsetnumber of nodesets
num_nset_varnumber of nodeset variables
nset_var_tabnodeset variable truth table array
Deprecated
Use ex_put_truth_table()(exoid, EX_NODE_SET, num_nset, num_nset_var, nset_var_tab)

◆ ex_put_num_map()

int ex_put_num_map ( int exoid,
ex_entity_type map_type,
ex_entity_id map_id,
const void_int * map )
extern

writes a map; this is a vector of integers of the same length as the number of entries in the source object (nodes, edges, faces, or elements in the file).

Parameters
exoidexodus file id
map_typetype of map (node,edge,face,elem)
map_idid to associate with new map
mapmap set value array

◆ ex_put_one_attr()

int ex_put_one_attr ( int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int attrib_index,
const void * attrib )
extern

writes the specified attribute for a block

Parameters
exoidexodus file id
obj_typeobject type (edge, face, elem block)
obj_idobject id (edge, face, elem block ID)
attrib_indexindex of attribute to write
attribarray of attributes

◆ ex_put_one_elem_attr()

int ex_put_one_elem_attr ( int exoid,
ex_entity_id elem_blk_id,
int attrib_index,
const void * attrib )
extern

writes the specified attribute for an element block

Parameters
exoidexodus file id
elem_blk_idelement block id
attrib_indexindex of attribute to write
attribarray of attributes
Deprecated
Use ex_put_one_attr()(exoid, EX_ELEM_BLOCK, elem_blk_id, attrib_index, attrib)

◆ ex_put_partial_attr()

int ex_put_partial_attr ( int exoid,
ex_entity_type blk_type,
ex_entity_id blk_id,
int64_t start_entity,
int64_t num_entity,
const void * attrib )
extern

writes the attributes for an edge/face/element block

Parameters
exoidexodus file id
blk_typeblock type
blk_idblock id
attribarray of attributes

◆ ex_put_partial_coord()

int ex_put_partial_coord ( int exoid,
int64_t start_node_num,
int64_t num_nodes,
const void * x_coor,
const void * y_coor,
const void * z_coor )
extern

writes the coordinates of some of the nodes in the model Only writes the 'non-null' arrays.

Parameters
exoidexodus file id
start_node_numthe starting index (1-based) of the coordinates to be written
num_nodesthe number of nodes to write coordinates for.
x_coorx coord array
y_coory coord array
z_coorz coord array

◆ ex_put_partial_elem_attr()

int ex_put_partial_elem_attr ( int exoid,
ex_entity_id elem_blk_id,
int64_t start_elem_num,
int64_t num_elems,
void * attrib )
extern

◆ ex_put_partial_elem_conn()

int ex_put_partial_elem_conn ( int exoid,
ex_entity_id elem_blk_id,
int64_t start_elem_num,
int64_t num_elems,
const void_int * connect )
extern

◆ ex_put_partial_elem_map()

int ex_put_partial_elem_map ( int exoid,
ex_entity_id map_id,
int64_t ent_start,
int64_t ent_count,
const void_int * elem_map )
extern

writes an element map; this is a vector of integers of length number of elements

Deprecated
Use ex_put_partial_num_map()(exoid, EX_ELEM_MAP, map_id, ent_start, ent_count, elem_map) instead

◆ ex_put_partial_elem_num_map()

int ex_put_partial_elem_num_map ( int exoid,
int64_t start_ent,
int64_t num_ents,
const void_int * map )
extern

◆ ex_put_partial_id_map()

int ex_put_partial_id_map ( int exoid,
ex_entity_type map_type,
int64_t start_entity_num,
int64_t num_entities,
const void_int * map )
extern

writes out a portion of the entity numbering map to the database; this allows the entity numbers to be non-contiguous. This map is used for mapping between local and global entity ids.

Parameters
exoidexodus file id
map_type
start_entity_num
num_entities
mapelement numbering map array

◆ ex_put_partial_nodal_var()

int ex_put_partial_nodal_var ( int exoid,
int time_step,
int nodal_var_index,
int64_t start_node,
int64_t num_nodes,
const void * nodal_var_vals )
extern

writes the values of a single nodal variable for a partial block at one single time step to the database; assume the first time step and nodal variable index is 1

Parameters
exoidexodus file id
time_stepwhole time step number
nodal_var_indexindex of desired nodal variable
start_nodeindex of first node to write data for (1-based)
num_nodesnumber of nodal points
nodal_var_valsarray of nodal variable values

◆ ex_put_partial_node_num_map()

int ex_put_partial_node_num_map ( int exoid,
int64_t start_ent,
int64_t num_ents,
const void_int * map )
extern

◆ ex_put_partial_node_set()

int ex_put_partial_node_set ( int exoid,
ex_entity_id node_set_id,
int64_t start_node_num,
int64_t num_node,
const void_int * node_set_node_list )
extern

◆ ex_put_partial_node_set_df()

int ex_put_partial_node_set_df ( int exoid,
ex_entity_id node_set_id,
int64_t start_num,
int64_t num_df_to_get,
void * node_set_df )
extern

◆ ex_put_partial_num_map()

int ex_put_partial_num_map ( int exoid,
ex_entity_type map_type,
ex_entity_id map_id,
int64_t ent_start,
int64_t ent_count,
const void_int * map )
extern

writes a map; this is a vector of integers of length number of mesh objects of that type (element, node, face, edge)

◆ ex_put_partial_one_attr()

int ex_put_partial_one_attr ( int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
int64_t start_num,
int64_t num_ent,
int attrib_index,
const void * attrib )
extern

writes the specified attribute for a block

Parameters
exoidexodus file id
obj_typeobject type (edge, face, elem block)
obj_idobject id (edge, face, elem block ID)
start_numthe starting index of the attributes to be written
num_entthe number of entities to write attributes for.
attrib_indexindex of attribute to write
attribarray of attributes

◆ ex_put_partial_set()

int ex_put_partial_set ( int exoid,
ex_entity_type set_type,
ex_entity_id set_id,
int64_t offset,
int64_t num_to_put,
const void_int * set_entry_list,
const void_int * set_extra_list )
extern

writes the set entry list and set extra list for a single set

Parameters
exoidexodus file id
set_typeset type
set_idset id
*set_entry_listarray of entries in set. Set to NULL to not write.
*set_extra_listarray of extras in set. Set to NULL to not write.

◆ ex_put_partial_set_dist_fact()

int ex_put_partial_set_dist_fact ( int exoid,
ex_entity_type set_type,
ex_entity_id set_id,
int64_t offset,
int64_t num_to_put,
const void * set_dist_fact )
extern

writes the partial distribution factors for a single set

Parameters
exoidexodus file id
set_typeset type
set_idset id
offsetindex (1-based) of first dist factor to write
num_to_putnumber of dist factors to write.
*set_dist_factarray of dist factors for set

◆ ex_put_partial_side_set()

int ex_put_partial_side_set ( int exoid,
ex_entity_id side_set_id,
int64_t start_side_num,
int64_t num_sides,
const void_int * side_set_elem_list,
const void_int * side_set_side_list )
extern

◆ ex_put_partial_side_set_df()

int ex_put_partial_side_set_df ( int exoid,
ex_entity_id side_set_id,
int64_t start_num,
int64_t num_df_to_get,
void * side_set_df )
extern

◆ ex_put_partial_var()

int ex_put_partial_var ( int exoid,
int time_step,
ex_entity_type var_type,
int var_index,
ex_entity_id obj_id,
int64_t start_index,
int64_t num_entities,
const void * var_vals )
extern

writes the values of a single variable for a partial block at one time step to the database; assume the first time step and variable index are 1

Parameters
exoidexodus file id
time_steptime step number
var_typetype (edge block, face block, edge set, ... )
var_indexelement variable index
obj_idelement block id
start_indexindex of first entity in block to write (1-based)
num_entitiesnumber of entries in this block/set
var_valsthe values to be written

◆ ex_put_processor_elem_maps()

int ex_put_processor_elem_maps ( int exoid,
void_int * elem_mapi,
void_int * elem_mapb,
int processor )
extern

◆ ex_put_processor_node_maps()

int ex_put_processor_node_maps ( int exoid,
void_int * node_mapi,
void_int * node_mapb,
void_int * node_mape,
int processor )
extern

◆ ex_put_prop()

int ex_put_prop ( int exoid,
ex_entity_type obj_type,
ex_entity_id obj_id,
const char * prop_name,
ex_entity_id value )
extern

The function ex_put_prop() stores an integer object property value to a single element block, node set, or side set. Although it is not necessary to invoke ex_put_prop_names(), since ex_put_prop() will allocate space within the data file if it hasn't been previously allocated, it is more efficient to use ex_put_prop_names() if there is more than one property to store.

See also
Efficiency for a discussion of efficiency issues.

It should be noted that the interpretation of the values of the integers stored as properties is left to the application code. In general, a zero (0) means the object does not have the specified property (or is not in the specified group); a nonzero value means the object does have the specified property. When space is allocated for the properties using ex_put_prop_names() or ex_put_prop(), the properties are initialized to zero (0).

Because the ID of an element block, node set, or side set is just another property (named ID), this routine can be used to change the value of an ID. This feature must be used with caution, though, because changing the ID of an object to the ID of another object of the same type (element block, node set, or side set) would cause two objects to have the same ID, and thus only the first would be accessible. Therefore, ex_put_prop() issues a warning if a user attempts to give two objects the same ID.

Returns
In case of an error, ex_put_prop() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • data file opened for read only.
  • data file not initialized properly with call to ex_put_init().
  • invalid object type specified.
  • a warning is issued if a user attempts to change the ID of an object to the ID of an existing object of the same type.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]obj_typeType of object; use one of the options in the table below.
[in]obj_idThe element block, node set, or side set ID.
[in]prop_nameThe name of the property for which the value will be stored. Maximum length of this string is MAX_STR_LENGTH .
[in]valueThe value of the property.
EX_NODE_SET Node Set entity type
EX_EDGE_BLOCK Edge Block entity type
EX_EDGE_SET Edge Set entity type
EX_FACE_BLOCK Face Block entity type
EX_FACE_SET Face Set entity type
EX_ELEM_BLOCK Element Block entity type
EX_ELEM_SET Element Set entity type
EX_SIDE_SET Side Set entity type
EX_ELEM_MAP Element Map entity type
EX_NODE_MAP Node Map entity type
EX_EDGE_MAP Edge Map entity type
EX_FACE_MAP Face Map entity type

For an example of code to write out an object property, refer to the description for ex_put_prop_names().

◆ ex_put_prop_array()

int ex_put_prop_array ( int exoid,
ex_entity_type obj_type,
const char * prop_name,
const void_int * values )
extern

The function ex_put_prop_array() stores an array of ({num_elem_blk}, num_node_sets, or num_side_sets) integer property values for all element blocks, node sets, or side sets. The order of the values in the array must correspond to the order in which the element blocks, node sets, or side sets were introduced into the file. For instance, if the parameters for element block with ID 20 were written to a file (via ex_put_elem_block()), and then parameters for element block with ID 10, followed by the parameters for element block with ID 30, the first, second, and third elements in the property array would correspond to element block 20, element block 10, and element block 30, respectively.

One should note that this same functionality (writing properties to multiple objects) can be accomplished with multiple calls to ex_put_prop().

Although it is not necessary to invoke ex_put_prop_names(), since ex_put_prop_array() will allocate space within the data file if it hasn't been previously allocated, it is more efficient to use ex_put_prop_names() if there is more than one property to store.

See also
See Efficiency for a discussion of efficiency issues.
Returns
In case of an error, ex_put_prop_array() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • data file opened for read only.
  • data file not initialized properly with call to ex_put_init().
  • invalid object type specified.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]obj_typeType of object; use one of the options in the table below.
[in]prop_nameThe name of the property for which the values will be stored. Maximum length of this string is MAX_STR_LENGTH .
[in]valuesAn array of property values.
EX_NODE_SET Node Set entity type
EX_EDGE_BLOCK Edge Block entity type
EX_EDGE_SET Edge Set entity type
EX_FACE_BLOCK Face Block entity type
EX_FACE_SET Face Set entity type
EX_ELEM_BLOCK Element Block entity type
EX_ELEM_SET Element Set entity type
EX_SIDE_SET Side Set entity type
EX_ELEM_MAP Element Map entity type
EX_NODE_MAP Node Map entity type
EX_EDGE_MAP Edge Map entity type
EX_FACE_MAP Face Map entity type

For an example of code to write an array of object properties, refer to the description for ex_put_prop_names().

◆ ex_put_prop_names()

int ex_put_prop_names ( int exoid,
ex_entity_type obj_type,
int num_props,
char ** prop_names )
extern

The function ex_put_prop_names() writes object property names and allocates space for object property arrays used to assign integer properties to element blocks, node sets, or side sets. The property arrays are initialized to zero (0). Although this function is optional, since ex_put_prop() will allocate space within the data file if it hasn't been previously allocated, it is more efficient to use ex_put_prop_names() if there is more than one property to store.

See also
Efficiency for a discussion of efficiency issues.
Returns
In case of an error, ex_put_prop_names() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • data file opened for read only.
  • data file not initialized properly with call to ex_put_init().
  • invalid object type specified.
  • no object of the specified type is stored in the file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]obj_typeType of object; use one of the options in the table below.
[in]num_propsThe number of integer properties to be assigned to all of the objects of the type specified (element blocks, node sets, or side sets).
[in]prop_namesArray containing num_props names (of maximum length of MAX_STR_LENGTH ) of properties to be stored.
EX_NODE_SET Node Set entity type
EX_EDGE_BLOCK Edge Block entity type
EX_EDGE_SET Edge Set entity type
EX_FACE_BLOCK Face Block entity type
EX_FACE_SET Face Set entity type
EX_ELEM_BLOCK Element Block entity type
EX_ELEM_SET Element Set entity type
EX_SIDE_SET Side Set entity type
EX_ELEM_MAP Element Map entity type
EX_NODE_MAP Node Map entity type
EX_EDGE_MAP Edge Map entity type
EX_FACE_MAP Face Map entity type

For instance, suppose a user wanted to assign the 1st, 3rd, and 5th element blocks (those element blocks stored 1st, 3rd, and 5th, regardless of their ID) to a group (property) called TOP, and the 2nd, 3rd, and 4th element blocks to a group called LSIDE. This could be accomplished with the following code:

char* prop_names[2];
int top_part[] = {1,0,1,0,1};
int lside_part[] = {0,1,1,1,0};
int id[] = {10, 20, 30, 40, 50};
prop_names[0] = "TOP";
prop_names[1] = "LSIDE";
\comment{This call to ex_put_prop_names is optional, but more efficient}
ex_put_prop_names (exoid, EX_ELEM_BLOCK, 2, prop_names);
\comment{The property values can be output individually thus}
for (i=0; i < 5; i++) {
ex_put_prop (exoid, EX_ELEM_BLOCK, id[i], prop_names[0],
top_part[i]);
ex_put_prop (exoid, EX_ELEM_BLOCK, id[i], prop_names[1],
lside_part[i]);
}
\comment{Alternatively, the values can be output as an array}
ex_put_prop_array (exoid, EX_ELEM_BLOCK, prop_names[0],
top_part);
ex_put_prop_array (exoid, EX_ELEM_BLOCK, prop_names[1],
lside_part);
int ex_put_prop_names(int exoid, ex_entity_type obj_type, int num_props, char **prop_names)
Definition ex_put_prop_names.c:125
int ex_put_prop(int exoid, ex_entity_type obj_type, ex_entity_id obj_id, const char *prop_name, ex_entity_id value)
Definition ex_put_prop.c:107
int ex_put_prop_array(int exoid, ex_entity_type obj_type, const char *prop_name, const void_int *values)
Definition ex_put_prop_array.c:100

◆ ex_put_qa()

int ex_put_qa ( int exoid,
int num_qa_records,
char * qa_record[][4] )
extern

The function ex_put_qa() writes the QA records to the database. Each QA record contains four MAX_STR_LENGTH-byte character strings. The character strings are:

  • the analysis code name
  • the analysis code QA descriptor
  • the analysis date
  • the analysis time
Returns
In case of an error, ex_put_qa() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • data file opened for read only.
  • QA records already exist in file.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]num_qa_recordsThe number of QA records.
[in]qa_recordArray containing the QA records. To only define the number of qa records instead of defining and outputting, pass NULL for qa_record argument.

The following code segment will write out two QA records:

int num_qa_rec, error, exoid;
char *qa_record[2][4];
\comment{write QA records}
num_qa_rec = 2;
qa_record[0][0] = "TESTWT1";
qa_record[0][1] = "testwt1";
qa_record[0][2] = "07/07/93";
qa_record[0][3] = "15:41:33";
qa_record[1][0] = "FASTQ";
qa_record[1][1] = "fastq";
qa_record[1][2] = "07/07/93";
qa_record[1][3] = "16:41:33";
error = ex_put_qa (exoid, num_qa_rec, qa_record);
int ex_put_qa(int exoid, int num_qa_records, char *qa_record[][4])
Definition ex_put_qa.c:92

◆ ex_put_set()

int ex_put_set ( int exoid,
ex_entity_type set_type,
ex_entity_id set_id,
const void_int * set_entry_list,
const void_int * set_extra_list )
extern

writes the set entry list and set extra list for a single set

Parameters
exoidexodus file id
set_typeset type
set_idset id
*set_entry_listarray of entries in set. Set to NULL to not write.
*set_extra_listarray of extras in set. Set to NULL to not write.

◆ ex_put_set_dist_fact()

int ex_put_set_dist_fact ( int exoid,
ex_entity_type set_type,
ex_entity_id set_id,
const void * set_dist_fact )
extern

writes the distribution factors for a single set

Parameters
exoidexodus file id
set_typeset type
set_idset id
*set_dist_factarray of dist factors for set

◆ ex_put_set_param()

int ex_put_set_param ( int exoid,
ex_entity_type set_type,
ex_entity_id set_id,
int64_t num_entries_in_set,
int64_t num_dist_fact_in_set )
extern

writes the set id and the number of entries which describe a single set

Parameters
exoidexodus file id
set_typethe type of set
set_idset id
num_entries_in_setnumber of entries in the set
num_dist_fact_in_setnumber of distribution factors in the set

◆ ex_put_sets()

int ex_put_sets ( int exoid,
size_t set_count,
const struct ex_set * sets )
extern

writes the set parameters and optionally set data for 1 or more sets

Parameters
exoidexodus file id
set_countnumber of sets to write
*setsarray of ex_set structures

◆ ex_put_side_set()

int ex_put_side_set ( int exoid,
ex_entity_id side_set_id,
const void_int * side_set_elem_list,
const void_int * side_set_side_list )
extern

writes the side set element list and side set side list for a single side set

Parameters
exoidexodus file id
side_set_idside set id
*side_set_elem_listarray of elements in side set
*side_set_side_listarray of sides in side set
Deprecated
Use ex_put_set()(exoid, EX_SIDE_SET, side_set_id, side_set_elem_list, side_set_side_list)

◆ ex_put_side_set_dist_fact()

int ex_put_side_set_dist_fact ( int exoid,
ex_entity_id side_set_id,
const void * side_set_dist_fact )
extern

writes the distribution factors for a single side set

Parameters
exoidexodus file id
side_set_idside set id
*side_set_dist_factarray of dist factors for side set
Deprecated
Use ex_put_set_dist_fact()(exoid, EX_SIDE_SET, side_set_id, side_set_dist_fact)

◆ ex_put_side_set_param()

int ex_put_side_set_param ( int exoid,
ex_entity_id side_set_id,
int64_t num_side_in_set,
int64_t num_dist_fact_in_set )
extern

writes the side set id and the number of sides (edges or faces) which describe a single side set

Parameters
exoidexodus file id
side_set_idside set id
num_side_in_setnumber of sides in the side set
num_dist_fact_in_setnumber of distribution factors in the side set
Deprecated
Use ex_put_set_param()(exoid, EX_SIDE_SET, side_set_id, num_side_in_set, num_dist_fact_in_set)

◆ ex_put_ss_param_global()

int ex_put_ss_param_global ( int exoid,
void_int * global_ids,
void_int * global_el_cnts,
void_int * global_df_cnts )
extern

◆ ex_put_sset_var()

int ex_put_sset_var ( int exoid,
int time_step,
int sset_var_index,
ex_entity_id sset_id,
int64_t num_faces_this_sset,
const void * sset_var_vals )
extern

writes the values of a single sideset variable for one sideset at one time step to the database; assume the first time step and sideset variable index are 1

Parameters
exoidexodus file id
time_steptime step number
sset_var_indexsideset variable index
sset_idsideset id
num_faces_this_ssetnumber of faces in this sideset
sset_var_valsthe variable values to be written
Deprecated
Use ex_put_var()(exoid, time_step, EX_SIDE_SET, sset_var_index, sset_id, num_faces_this_sset, sset_var_vals)

◆ ex_put_sset_var_tab()

int ex_put_sset_var_tab ( int exoid,
int num_sset,
int num_sset_var,
int * sset_var_tab )
extern

writes the EXODUS II sideset variable truth table to the database; also, creates netCDF variables in which to store EXODUS II sideset variable values; although this table isn't required (because the netCDF variables can also be created in ex_put_sset_var), this call will save tremendous time because all of the variables are defined at once while the file is in define mode, rather than going in and out of define mode (causing the entire file to be copied over and over) which is what occurs when the sideset variable values variables are defined in ex_put_sset_var

Parameters
exoidexodus file id
num_ssetnumber of sidesets
num_sset_varnumber of sideset variables
*sset_var_tabsideset variable truth table array
Deprecated
Use ex_put_truth_table()(exoid, EX_SIDE_SET, num_sset, num_sset_var, sset_var_tab)

◆ ex_put_time()

int ex_put_time ( int exoid,
int time_step,
const void * time_value )
extern

The function ex_put_time() writes the time value for a specified time step.

Because time values are floating point values, the application code must declare the array passed to be the appropriate type (float or double) to match the compute word size passed in ex_create() or ex_open().

Returns
In case of an error, ex_put_time() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • data file opened for read only.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]time_stepThe time step number. This is essentially a counter that is incremented only when results variables are output to the data file. The first time step is 1.
[in]time_valueThe time at the specified time step.

The following code segment will write out the simulation time value at simulation time step n:

int error, exoid, n;
float time_value;
\comment{write time value}
error = ex_put_time (exoid, n, &time_value);
int ex_put_time(int exoid, int time_step, const void *time_value)
Definition ex_put_time.c:77

◆ ex_put_truth_table()

int ex_put_truth_table ( int exoid,
ex_entity_type obj_type,
int num_blk,
int num_var,
int * var_tab )
extern

writes the EXODUS II variable truth table to the database; also, creates netCDF variables in which to store EXODUS II variable values; although this table isn't required (because the netCDF variables can also be created in ex_put_var), this call will save tremendous time because all of the variables are defined at once while the file is in define mode, rather than going in and out of define mode (causing the entire file to be copied over and over) which is what occurs when the variables are defined in ex_put_var

Parameters
exoidexodus file id
obj_typeobject type
num_blknumber of blocks
num_varnumber of variables
*var_tabvariable truth table array

◆ ex_put_var()

int ex_put_var ( int exoid,
int time_step,
ex_entity_type var_type,
int var_index,
ex_entity_id obj_id,
int64_t num_entries_this_obj,
const void * var_vals )
extern

writes the values of a single variable for one entity at one time step to the database; assume the first time step and variable index are 1

Parameters
exoidexodus file id
time_steptime step number
var_typetype (edge block, face block, edge set, ... )
var_indexvariable index
obj_identity block id
num_entries_this_objnumber of entries in this block/set
var_valsthe values to be written

◆ ex_put_var_name()

int ex_put_var_name ( int exoid,
const char * var_type,
int var_num,
const char * var_name )
extern

writes the name of a particular results variable to the database

Parameters
exoidexodus file id
*var_typevariable type: G,N, or E
var_numvariable number name to write 1..num_var
*var_nameptr of variable name
Deprecated
use ex_put_variable_name()(exoid, obj_type, var_num, *var_name)

◆ ex_put_var_names()

int ex_put_var_names ( int exoid,
const char * var_type,
int num_vars,
char * var_names[] )
extern

writes the names of the results variables to the database

Parameters
exoidexodus file id
*var_typevariable type: G,N, or E
num_vars# of variables to read
*var_namesptr array of variable names
Deprecated
Use ex_put_variable_names()(exoid, obj_type, num_vars, var_names)

◆ ex_put_var_param()

int ex_put_var_param ( int exoid,
const char * var_type,
int num_vars )
extern

writes the number and names of global, nodal, or element variables that will be written to the database

Parameters
exoidexodus file id
var_typevariable type G,N, or E
num_varsnumber of variables in database
Deprecated
Use ex_put_variable_param()(exoid, obj_type, num_vars)

◆ ex_put_var_tab()

int ex_put_var_tab ( int exoid,
const char * var_type,
int num_blk,
int num_var,
int * var_tab )
extern

writes the EXODUS II variable truth table to the database; also, creates netCDF variables in which to store EXODUS II variable values; although this table isn't required (because the netCDF variables can also be created in ex_put_var), this call will save tremendous time because all of the variables are defined at once while the file is in define mode, rather than going in and out of define mode (causing the entire file to be copied over and over) which is what occurs when the variables are defined in ex_put_var

Parameters
exoidexodus file id
*var_type'e', 'm', 's' element, nodeset, sideset
num_blknumber of blocks
num_varnumber of variables
*var_tabvariable truth table array
Deprecated
Use ex_put_truth_table()(exoid, obj_type, num_blk, num_var, var_tab)

◆ ex_put_variable_name()

int ex_put_variable_name ( int exoid,
ex_entity_type obj_type,
int var_num,
const char * var_name )
extern

writes the name of a particular results variable to the database

Parameters
exoidexodus file id
obj_typevariable type
var_numvariable number name to write 1..num_var
*var_nameptr of variable name

◆ ex_put_variable_names()

int ex_put_variable_names ( int exoid,
ex_entity_type obj_type,
int num_vars,
char * var_names[] )
extern

The function ex_put_variable_names() writes the names of the results variables to the database. The names are MAX_STR_LENGTH -characters in length. The function ex_put_variable_param() must be called before this function is invoked.

Returns
In case of an error, ex_put_variable_names() returns a negative number; a warning will return a positive number. Possible causes of errors include:
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]obj_typeVariable indicating the type of variable which is described. Use one of the options in the table below.
[in]num_varsThe number of var_type variables that will be written to the database.
[in]var_namesArray of pointers to num_vars variable names.
EX_GLOBAL} Global entity type
EX_NODAL} Nodal entity type
EX_NODE_SET Node Set entity type
EX_EDGE_BLOCK Edge Block entity type
EX_EDGE_SET Edge Set entity type
EX_FACE_BLOCK Face Block entity type
EX_FACE_SET Face Set entity type
EX_ELEM_BLOCK Element Block entity type
EX_ELEM_SET Element Set entity type
EX_SIDE_SET Side Set entity type

The following coding will write out the names associated with the nodal variables:

int num_nod_vars, error, exoid;
char *var_names[2];
\comment{write results variables parameters and names}
num_nod_vars = 2;
var_names[0] = "disx";
var_names[1] = "disy";
error = ex_put_variable_param (exoid, EX_NODAL, num_nod_vars);
error = ex_put_variable_names (exoid, EX_NODAL, num_nod_vars, var_names);
int ex_put_variable_param(int exoid, ex_entity_type obj_type, int num_vars)
Definition ex_put_variable_param.c:153
int ex_put_variable_names(int exoid, ex_entity_type obj_type, int num_vars, char *var_names[])
Definition ex_put_variable_names.c:148

◆ ex_put_variable_param()

int ex_put_variable_param ( int exoid,
ex_entity_type obj_type,
int num_vars )
extern

The function ex_put_variable_param() writes the number of global, nodal, nodeset, sideset, edge, face, or element variables that will be written to the database.

Returns
In case of an error, ex_put_variable_param() returns a negative number; a warning will return a positive number. Possible causes of errors include:
  • data file not properly opened with call to ex_create() or ex_open()
  • data file opened for read only.
  • invalid variable type specified.
  • data file not initialized properly with call to ex_put_init().
  • this routine has already been called with the same variable type; redefining the number of variables is not allowed.
  • a warning value is returned if the number of variables is specified as zero.
Parameters
[in]exoidexodus file ID returned from a previous call to ex_create() or ex_open().
[in]obj_typeVariable indicating the type of variable which is described. Use one of the ex_entity_type types specified in the table below.
[in]num_varsThe number of var_type variables that will be written to the database.
EX_GLOBAL Global entity type
EX_NODAL Nodal entity type
EX_NODE_SET Node Set entity type
EX_EDGE_BLOCK Edge Block entity type
EX_EDGE_SET Edge Set entity type
EX_FACE_BLOCK Face Block entity type
EX_FACE_SET Face Set entity type
EX_ELEM_BLOCK Element Block entity type
EX_ELEM_SET Element Set entity type
EX_SIDE_SET Side Set entity type

For example, the following code segment initializes the data file to store global variables:

int num_glo_vars, error, exoid;
\comment{write results variables parameters}
num_glo_vars = 3;
error = ex_put_variable_param (exoid, EX_GLOBAL, num_glo_vars);

◆ ex_set_int64_status()

int ex_set_int64_status ( int exoid,
int mode )
extern

◆ ex_set_max_name_length()

int ex_set_max_name_length ( int exoid,
int length )
extern

Note that the max name length setting is global at this time; not specific to a particular database; however, the exoid option is passed to give flexibility in the future to implement this on a database-by-database basis.

◆ ex_set_option()

int ex_set_option ( int exoid,
ex_option_type option,
int option_value )
extern

◆ ex_update()

int ex_update ( int exoid)
extern

updates an opened EXODUS II file (or EXODUS II history file)

Parameters
exoidexodus file id

◆ ex_var_type_to_ex_entity_type()

ex_entity_type ex_var_type_to_ex_entity_type ( char var_type)
extern

Variable Documentation

◆ exerrval

int exerrval
extern

shared error return value

◆ exoptval

int exoptval
extern

error reporting flag (default is quiet)