ExodusII
5.15
|
Functions | |
int | ex_get_glob_vars (int exoid, int time_step, int num_glob_vars, void *glob_var_vals) |
This section describes data file utility functions for creating / opening a file, initializing a file with global parameters, reading / writing information text, inquiring on parameters stored in the data file, and error reporting.
int ex_get_glob_vars | ( | int | exoid, |
int | time_step, | ||
int | num_glob_vars, | ||
void * | glob_var_vals | ||
) |
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:
[in] | exoid | exodus file ID returned from a previous call to ex_create() or ex_open(). |
[in] | time_step | The 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_vars | The number of global variables stored in the database. |
[out] | glob_var_vals | Returned 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);