ex_get_nodal_var_time.c File Reference

#include "exodusII.h"

Functions
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)

Function Documentation

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 )

Deprecated

Use ex_get_var_time()(exoid, EX_NODAL, nodal_var_index, node_number, beg_time_step, end_time_step, node_var_vals) 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]	exoid	exodus file ID returned from a previous call to ex_create() or ex_open().
[in]	nodal_var_index	The index of the desired nodal variable. The first variable has an index of 1.
[in]	node_number	The internal ID (see Section LocalNodeIds) of the desired node. The first node is 1.
[in]	beg_time_step	The 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_step	The 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_vals	Returned 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_var_time(exoid, EX_NODAL, var_index, node_num, beg_time,
                              end_time, var_values);