hdf5_efield.h File Reference

Header file for hdf5_efielc.c. More...

#include <hdf5.h>
#include "../E_field.h"
#include "../Efield/E_TC.h"
#include "../Efield/E_1DS.h"

Go to the source code of this file.

Functions
int	hdf5_efield_init_offload (hid_t f, E_field_offload_data *offload_data, real **offload_array, char *qid)
	Read electric field data from HDF5 file.

Detailed Description

Header file for hdf5_efielc.c.

Definition in file hdf5_efield.h.

Function Documentation

hdf5_efield_init_offload()

int hdf5_efield_init_offload	(	hid_t	f,
		E_field_offload_data *	offload_data,
		real **	offload_array,
		char *	qid )

Read electric field data from HDF5 file.

This function reads electric field data with given qid while also initializing offload data and allocating and filling offload array. The file is opened and closed outside this function.

The electric field data is stored under /efield/ group in ASCOT5 HDF5 file. Several electric fields of same or different type maybe stored there in their respective groups as long as the group name contains QID as an identifier.

Parameters

f	HDF5 file identifier for a file which is opened and closed outside of this function
offload_data	pointer to offload data struct which is initialized here
offload_array	pointer to offload array which is allocated and initialized here
qid	QID of the data that is to be read

Returns

zero if reading and initialization succeeded

Definition at line 57 of file hdf5_efield.c.