applications/utilities/postProcessing/graphics/ensightFoamReader/global_extern_proto.h

   1 /*--------------------------------------------------------------*/
   2 /* Prototype Header file for EnSight External Reader            */
   3 /* DSO Library Routines                                         */
   4 /*                                                              */
   5 /* intended to be included from global_extern.h only            */
   6 /*--------------------------------------------------------------*/
   7 /*  *************************************************************
   8  *   Copyright 1998 Computational Engineering International, Inc.
   9  *   All Rights Reserved.
  10  *
  11  *        Restricted Rights Legend
  12  *
  13  *   Use, duplication, or disclosure of this
  14  *   software and its documentation by the
  15  *   Government is subject to restrictions as
  16  *   set forth in subdivision [(b)(3)(ii)] of
  17  *   the Rights in Technical Data and Computer
  18  *   Software clause at 52.227-7013.
  19  *  *************************************************************
  20  */
  21 #ifndef GLOBAL_EXTERN_PROTO_H
  22 #define GLOBAL_EXTERN_PROTO_H
  23
  24 #ifdef WIN32
  25 #define W32IMPORT __declspec( dllimport )
  26 #define W32EXPORT __declspec( dllexport )
  27 #else
  28 #define W32IMPORT extern
  29 #define W32EXPORT extern
  30 #endif
  31
  32 /*----------------------
  33  * Same in All Versions
  34  *----------------------*/
  35 W32IMPORT int
  36 USERD_get_number_of_model_parts( void );
  37
  38 W32IMPORT int
  39 USERD_get_block_coords_by_component(int block_number,
  40                                     int which_component,
  41                                     float *coord_array);
  42
  43 W32IMPORT int
  44 USERD_get_block_iblanking(int block_number,
  45                           int *iblank_array);
  46
  47 W32IMPORT int
  48 USERD_get_block_scalar_values(int block_number,
  49                               int which_scalar,
  50                               float *scalar_array);
  51
  52 W32IMPORT int
  53 USERD_get_block_vector_values_by_component(int block_number,
  54                                            int which_vector,
  55                                            int which_component,
  56                                            float *vector_array);
  57
  58 W32IMPORT int
  59 USERD_get_name_of_reader(char reader_name[Z_MAX_USERD_NAME],
  60                          int *two_fields);
  61
  62 W32IMPORT int
  63 USERD_get_reader_descrip(char descrip[Z_MAXFILENP]);
  64
  65 W32IMPORT int
  66 USERD_set_filenames(char filename_1[],
  67                     char filename_2[],
  68                     char the_path[],
  69                     int swapbytes);
  70
  71 W32IMPORT int
  72 USERD_get_number_of_files_in_dataset( void );
  73
  74 W32IMPORT int
  75 USERD_get_dataset_query_file_info(Z_QFILES *qfiles);
  76
  77 W32IMPORT int
  78 USERD_get_changing_geometry_status( void );
  79
  80 W32IMPORT int
  81 USERD_get_node_label_status( void );
  82
  83 W32IMPORT int
  84 USERD_get_element_label_status( void );
  85
  86 W32IMPORT int
  87 USERD_get_number_of_variables( void );
  88
  89 W32IMPORT void
  90 USERD_stop_part_building( void );
  91
  92 W32IMPORT int
  93 USERD_bkup(FILE *archive_file,
  94            int backup_type);
  95
  96
  97
  98 /*-----------------------
  99  * For Version 1.000 Only
 100  *-----------------------*/
 101 #if defined USERD_API_100
 102
 103 W32IMPORT int
 104 USERD_get_number_of_global_nodes( void );
 105
 106 W32IMPORT int
 107 USERD_get_global_coords(CRD *coord_array);
 108
 109 W32IMPORT int
 110 USERD_get_global_node_ids(int *nodeid_array);
 111
 112 W32IMPORT int
 113 USERD_get_element_connectivities_for_part(int part_number,
 114                                           int **conn_array[Z_MAXTYPE]);
 115
 116 W32IMPORT int
 117 USERD_get_element_ids_for_part(int part_number,
 118                                int *elemid_array[Z_MAXTYPE]);
 119
 120 W32IMPORT int
 121 USERD_get_vector_values(int which_vector,
 122                         int which_part,
 123                         int which_type,
 124                         float *vector_array);
 125
 126 W32IMPORT int
 127 USERD_get_part_build_info(int *part_id,
 128                           int *part_types,
 129                           char *part_descriptions[Z_BUFL],
 130                           int *number_of_elements[Z_MAXTYPE],
 131                           int *ijk_dimensions[3],
 132                           int *iblanking_options[6]);
 133
 134 W32IMPORT int
 135 USERD_get_scalar_values(int which_scalar,
 136                         int which_part,
 137                         int which_type,
 138                         float *scalar_array);
 139
 140 W32IMPORT int
 141 USERD_get_variable_info(char **var_description,
 142                         char **var_filename,
 143                         int *var_type,
 144                         int *var_classify);
 145
 146 W32IMPORT int
 147 USERD_get_description_lines(int which_type,
 148                             int which_var,
 149                             char line1[Z_BUFL],
 150                             char line2[Z_BUFL]);
 151
 152 W32IMPORT int
 153 USERD_get_variable_value_at_specific(int which_var,
 154                                      int which_node_or_elem,
 155                                      int which_part,
 156                                      int which_elem_type,
 157                                      int time_step,
 158                                      float values[3]);
 159
 160 W32IMPORT float
 161 USERD_get_constant_value(int which_var);
 162
 163 W32IMPORT int
 164 USERD_get_solution_times(float *solution_times);
 165 W32IMPORT void
 166 USERD_set_time_step(int time_step);
 167
 168 W32IMPORT int
 169 USERD_get_number_of_time_steps(void);
 170
 171 #endif
 172
 173
 174 /*----------------------
 175  * New For Version 2.000
 176  *----------------------*/
 177 #if !defined USERD_API_100
 178
 179 W32IMPORT int
 180 USERD_get_part_coords(int part_number,
 181                       float **coord_array);
 182
 183 W32IMPORT int
 184 USERD_get_part_node_ids(int part_number,
 185                         int *nodeid_array);
 186
 187 W32IMPORT int
 188 USERD_get_part_elements_by_type(int part_number,
 189                                 int element_type,
 190                                 int **conn_array);
 191 W32IMPORT int
 192 USERD_get_part_element_ids_by_type(int part_number,
 193                                    int element_type,
 194                                    int *elemid_array);
 195
 196 W32IMPORT int
 197 USERD_get_reader_version(char version_number[Z_MAX_USERD_NAME]);
 198
 199 W32IMPORT int
 200 USERD_get_reader_release(char version_number[Z_MAX_USERD_NAME]);
 201
 202 W32IMPORT int
 203 USERD_get_var_by_component(int which_variable,
 204                            int which_part,
 205                            int var_type,
 206                            int which_type,
 207                            int complex,
 208                            int component,
 209                            float *var_array);
 210
 211 W32IMPORT int
 212 USERD_get_maxsize_info(int *max_number_of_nodes,
 213                        int *max_number_of_elements[Z_MAXTYPE],
 214                        int *max_ijk_dimensions[3]);
 215
 216 W32IMPORT void
 217 USERD_exit_routine( void );
 218
 219 W32IMPORT int
 220 USERD_get_gold_variable_info(char **var_description,
 221                              char **var_filename,
 222                              int *var_type,
 223                              int *var_classify,
 224                              int *var_complex,
 225                              char **var_ifilename,
 226                              float *var_freq,
 227                              int *var_contran,
 228                              int *var_timeset);
 229 W32IMPORT int
 230 USERD_get_model_extents( float extents[6] );
 231
 232 W32IMPORT int
 233 USERD_get_descrip_lines(int which_type,
 234                         int which_var,
 235                         int imag_data,
 236                         char line1[Z_BUFL],
 237                         char line2[Z_BUFL]);
 238
 239 W32IMPORT int
 240 USERD_get_var_value_at_specific(int which_var,
 241                                 int which_node_or_elem,
 242                                 int which_part,
 243                                 int which_elem_type,
 244                                 int time_step,
 245                                 float values[3],
 246                                 int imag_data);
 247
 248 W32IMPORT float
 249 USERD_get_constant_val(int which_var, int imag_data);
 250
 251 W32IMPORT int
 252 USERD_get_geom_timeset_number(void);
 253
 254 W32IMPORT int
 255 USERD_get_number_of_timesets(void);
 256
 257 W32IMPORT int
 258 USERD_get_timeset_description(int timeset_number,
 259                               char timeset_description[Z_BUFL]);
 260
 261 W32IMPORT int
 262 USERD_get_sol_times(int timeset_number,
 263                     float *solution_times);
 264 W32IMPORT void
 265 USERD_set_time_set_and_step(int timeset_number,
 266                             int time_step);
 267 W32IMPORT int
 268 USERD_get_num_of_time_steps(int timeset_number);
 269
 270 W32IMPORT int
 271 USERD_get_border_availability(int part_number,
 272                               int number_of_elements[Z_MAXTYPE]);
 273
 274 W32IMPORT int
 275 USERD_get_border_elements_by_type(int part_number,
 276                                   int element_type,
 277                                   int **conn_array,
 278                                   short *parent_element_type,
 279                                   int *parent_element_num);
 280
 281 W32IMPORT void
 282 USERD_set_server_number(int serv_num,
 283                         int tot_servs);
 284
 285 #endif
 286
 287
 288 /*----------------------
 289  * New For Version 2.010
 290  *----------------------*/
 291 #if defined USERD_API_201 || defined USERD_API_202 || defined USERD_API_203
 292 W32IMPORT int
 293 USERD_get_ghosts_in_model_flag( void );
 294
 295 W32IMPORT int
 296 USERD_get_ghosts_in_block_flag(int block_number);
 297
 298 W32IMPORT int
 299 USERD_get_block_ghost_flags(int block_number,
 300                             int *ghost_flags);
 301 #endif
 302
 303 /*--------------------------
 304  * Modified at Version 2.030
 305  *--------------------------*/
 306 #if defined USERD_API_201 || defined USERD_API_202
 307
 308 W32IMPORT int
 309 USERD_get_gold_part_build_info(int *part_id,
 310                                int *part_types,
 311                                char *part_descriptions[Z_BUFL],
 312                                int *number_of_nodes,
 313                                int *number_of_elements[Z_MAXTYPE],
 314                                int *ijk_dimensions[3],
 315                                int *iblanking_options[6]);
 316 #endif
 317
 318 #if defined USERD_API_203
 319 W32IMPORT int
 320 USERD_get_gold_part_build_info(int *part_id,
 321                                int *part_types,
 322                                char *part_descriptions[Z_BUFL],
 323                                int *number_of_nodes,
 324                                int *number_of_elements[Z_MAXTYPE],
 325                                int *ijk_dimensions[9],
 326                                int *iblanking_options[6]);
 327 #endif
 328
 329
 330 /*----------------------
 331  * New For Version 2.030
 332  *----------------------*/
 333 #if defined USERD_API_203
 334 W32IMPORT int
 335 USERD_get_number_of_material_sets( void );
 336
 337 W32IMPORT int
 338 USERD_get_matf_set_info(int *mat_set_ids,
 339                         char **mat_set_name);
 340
 341 W32IMPORT int
 342 USERD_get_number_of_materials( int set_index );
 343
 344 W32IMPORT int
 345 USERD_get_matf_var_info(int set_index,
 346                         int *mat_ids,
 347                         char **mat_desc);
 348
 349 W32IMPORT int
 350 USERD_size_matf_data(int set_index,
 351                      int part_id,
 352                      int wtyp,
 353                      int mat_type,
 354                      int *matf_size );
 355
 356 W32IMPORT int
 357 USERD_load_matf_data( int set_index,
 358                       int part_id,
 359                       int wtyp,
 360                       int mat_type,
 361                       int *ids_list,
 362                       float *val_list );
 363
 364 W32IMPORT int
 365 USERD_get_nsided_conn( int part_number,
 366                        int *nsided_conn_array );
 367
 368 W32IMPORT int
 369 USERD_get_nfaced_nodes_per_face( int part_number,
 370                                  int *nfaced_npf_array );
 371
 372 W32IMPORT int
 373 USERD_get_nfaced_conn( int part_number,
 374                        int *nfaced_conn_array );
 375
 376
 377 #endif
 378
 379
 380 /*--------------------------------------------------------------------*/
 381 #endif /*GLOBAL_EXTERN_PROTO_H*/
 382