Functions

Reading and Writing Datasets
[H5Part C API]

Functions

h5_err_t H5PartWriteDataFloat64 (h5_file_t *f, const char *name, const h5_float64_t *data)
h5_err_t H5PartWriteDataFloat32 (h5_file_t *f, const char *name, const h5_float32_t *data)
h5_err_t H5PartWriteDataInt64 (h5_file_t *f, const char *name, const h5_int64_t *data)
h5_err_t H5PartWriteDataInt32 (h5_file_t *f, const char *name, const h5_int32_t *data)
h5_err_t H5PartReadDataFloat64 (h5_file_t *f, const char *name, h5_float64_t *data)
h5_err_t H5PartReadDataFloat32 (h5_file_t *f, const char *name, h5_float32_t *data)
h5_err_t H5PartReadDataInt64 (h5_file_t *f, const char *name, h5_int64_t *data)
h5_err_t H5PartReadDataInt32 (h5_file_t *f, const char *name, h5_int32_t *data)

Function Documentation

h5_err_t H5PartWriteDataFloat64 ( h5_file_t *  f,
const char *  name,
const h5_float64_t *  data 
)

Write array of 64 bit floating point data to file.

After setting the number of particles with H5PartSetNumParticles() and the current timestep using H5SetStep(), you can start writing datasets into the file. Each dataset has a name associated with it (chosen by the user) in order to facilitate later retrieval. The name of the dataset is specified in the parameter name, which must be a null-terminated string.

There are no restrictions on naming of datasets, but it is useful to arrive at some common naming convention when sharing data with other groups.

The writing routines also implicitly store the datatype of the array so that the array can be reconstructed properly on other systems with incompatible type representations.

All data that is written after setting the timestep is associated with that timestep. While the number of particles can change for each timestep, you cannot change the number of particles in the middle of a given timestep.

The data is committed to disk before the routine returns.

Returns:
H5_SUCCESS or error code
Parameters:
[in]fHandle to open file
[in]nameName to associate array with
[in]dataArray to commit to disk
h5_err_t H5PartWriteDataFloat32 ( h5_file_t *  f,
const char *  name,
const h5_float32_t *  data 
)

Write array of 32 bit floating point data to file.

After setting the number of particles with H5PartSetNumParticles() and the current timestep using H5SetStep(), you can start writing datasets into the file. Each dataset has a name associated with it (chosen by the user) in order to facilitate later retrieval. The name of the dataset is specified in the parameter name, which must be a null-terminated string.

There are no restrictions on naming of datasets, but it is useful to arrive at some common naming convention when sharing data with other groups.

The writing routines also implicitly store the datatype of the array so that the array can be reconstructed properly on other systems with incompatible type representations.

All data that is written after setting the timestep is associated with that timestep. While the number of particles can change for each timestep, you cannot change the number of particles in the middle of a given timestep.

The data is committed to disk before the routine returns.

Returns:
H5_SUCCESS or error code
Parameters:
[in]fHandle to open file
[in]nameName to associate array with
[in]dataArray to commit to disk
h5_err_t H5PartWriteDataInt64 ( h5_file_t *  f,
const char *  name,
const h5_int64_t *  data 
)

Write array of 64 bit integer data to file.

After setting the number of particles with H5PartSetNumParticles() and the current timestep using H5SetStep(), you can start writing datasets into the file. Each dataset has a name associated with it (chosen by the user) in order to facilitate later retrieval. The name of the dataset is specified in the parameter name, which must be a null-terminated string.

There are no restrictions on naming of datasets, but it is useful to arrive at some common naming convention when sharing data with other groups.

The writing routines also implicitly store the datatype of the array so that the array can be reconstructed properly on other systems with incompatible type representations.

All data that is written after setting the timestep is associated with that timestep. While the number of particles can change for each timestep, you cannot change the number of particles in the middle of a given timestep.

The data is committed to disk before the routine returns.

Returns:
H5_SUCCESS or error code
Parameters:
[in]fHandle to open file
[in]nameName to associate array with
[in]dataArray to commit to disk
h5_err_t H5PartWriteDataInt32 ( h5_file_t *  f,
const char *  name,
const h5_int32_t *  data 
)

Write array of 32 bit integer data to file.

After setting the number of particles with H5PartSetNumParticles() and the current timestep using H5SetStep(), you can start writing datasets into the file. Each dataset has a name associated with it (chosen by the user) in order to facilitate later retrieval. The name of the dataset is specified in the parameter name, which must be a null-terminated string.

There are no restrictions on naming of datasets, but it is useful to arrive at some common naming convention when sharing data with other groups.

The writing routines also implicitly store the datatype of the array so that the array can be reconstructed properly on other systems with incompatible type representations.

All data that is written after setting the timestep is associated with that timestep. While the number of particles can change for each timestep, you cannot change the number of particles in the middle of a given timestep.

The data is committed to disk before the routine returns.

Returns:
H5_SUCCESS or error code
Parameters:
[in]fHandle to open file
[in]nameName to associate array with
[in]dataArray to commit to disk
h5_err_t H5PartReadDataFloat64 ( h5_file_t *  f,
const char *  name,
h5_float64_t *  data 
)

Read array of 64 bit floating point data from file.

When retrieving datasets from disk, you ask for them by name. There are no restrictions on naming of arrays, but it is useful to arrive at some common naming convention when sharing data with other groups.

Returns:
H5_SUCCESS or error code
Parameters:
[in]fHandle to open file
[in]nameName to associate dataset with
[out]dataArray of data
h5_err_t H5PartReadDataFloat32 ( h5_file_t *  f,
const char *  name,
h5_float32_t *  data 
)

Read array of 32 bit floating point data from file.

When retrieving datasets from disk, you ask for them by name. There are no restrictions on naming of arrays, but it is useful to arrive at some common naming convention when sharing data with other groups.

Returns:
H5_SUCCESS or error code
Parameters:
[in]fHandle to open file
[in]nameName to associate dataset with
[out]dataArray of data
h5_err_t H5PartReadDataInt64 ( h5_file_t *  f,
const char *  name,
h5_int64_t *  data 
)

Read array of 64 bit integer data from file.

When retrieving datasets from disk, you ask for them by name. There are no restrictions on naming of arrays, but it is useful to arrive at some common naming convention when sharing data with other groups.

Returns:
H5_SUCCESS or error code
Parameters:
[in]fHandle to open file
[in]nameName to associate dataset with
[out]dataArray of data
h5_err_t H5PartReadDataInt32 ( h5_file_t *  f,
const char *  name,
h5_int32_t *  data 
)

Read array of 32 bit integer data from file.

When retrieving datasets from disk, you ask for them by name. There are no restrictions on naming of arrays, but it is useful to arrive at some common naming convention when sharing data with other groups.

Returns:
H5_SUCCESS or error code
Parameters:
[in]fHandle to open file
[in]nameName to associate dataset with
[out]dataArray of data