ex_get_glob_var_time.c File Reference

#include "exodusII.h"

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

Function Documentation

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
	)

Deprecated:

Use ex_get_var_time()(exoid, EX_GLOBAL, global_var_index, 1, beg_time_step, end_time_step, glob_var_vals)

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

	exoid	exodus file ID returned from a previous call to ex_create() or ex_open().
	glob_var_index	The index of the desired global variable. The first variable has an index of 1.
	beg_time_step	The 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_step	The 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_vals	Returned 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);