hdf5_orbit.h File Reference

Header file for hdf5_orbit.c. More...

#include <hdf5.h>
#include "../ascot5.h"
#include "../diag/diag_orb.h"

Go to the source code of this file.

Functions
int	hdf5_orbit_write (hid_t f, char *path, diag_orb_offload_data *diag, real *orbits)
	Write orbit diagnostics data to a HDF5 file.

Detailed Description

Header file for hdf5_orbit.c.

Definition in file hdf5_orbit.h.

Function Documentation

hdf5_orbit_write()

int hdf5_orbit_write	(	hid_t	f,
		char *	path,
		diag_orb_offload_data *	data,
		real *	orbits )

Write orbit diagnostics data to a HDF5 file.

Parameters

f	hdf5 file
path	path to group which is created here and where the data is stored
data	orbit diagnostics offload data
orbits	array storing the orbit data (format same as in init() in diag_orb.c)

Returns

zero on success

Definition at line 34 of file hdf5_orbit.c.