hdf5_options.c File Reference

Read options from HDF5 file. More...

#include <stdlib.h>
#include <hdf5.h>
#include <hdf5_hl.h>
#include "../ascot5.h"
#include "../consts.h"
#include "../diag.h"
#include "../diag/diag_orb.h"
#include "../diag/dist_5D.h"
#include "../diag/dist_6D.h"
#include "../diag/dist_rho5D.h"
#include "../diag/dist_rho6D.h"
#include "../diag/dist_com.h"
#include "../endcond.h"
#include "../math.h"
#include "../simulate.h"
#include "hdf5_helpers.h"
#include "hdf5_options.h"

Go to the source code of this file.

Macros
#define	OPTPATH
#define	OPTPATH   "/options/opt_XXXXXXXXXX/"
#define	OPTPATH   "/options/opt_XXXXXXXXXX/"
#define	OPTPATH   "/options/opt_XXXXXXXXXX/"
#define	OPTPATH   "/options/opt_XXXXXXXXXX/"
#define	OPTPATH   "/options/opt_XXXXXXXXXX/"
#define	OPTPATH   "/options/opt_XXXXXXXXXX/"
#define	OPTPATH   "/options/opt_XXXXXXXXXX/"
#define	OPTPATH   "/options/opt_XXXXXXXXXX/"

Functions
int	hdf5_options_read_dist5D (hid_t file, dist_5D_data *dist, char *qid)
	Helper function to read dist5D settings from HDF5 file.
int	hdf5_options_read_dist6D (hid_t file, dist_6D_data *dist, char *qid)
	Helper function to read dist6D settings from HDF5 file.
int	hdf5_options_read_distrho5D (hid_t file, dist_rho5D_data *dist, char *qid)
	Helper function to read distrho5D settings from HDF5 file.
int	hdf5_options_read_distrho6D (hid_t file, dist_rho6D_data *dist, char *qid)
	Helper function to read distrho6D settings from HDF5 file.
int	hdf5_options_read_distCOM (hid_t file, dist_COM_data *dist, char *qid)
	Helper function to read COM dist settings from HDF5 file.
int	hdf5_options_read_diagorb (hid_t file, diag_orb_data *diagorb, char *qid)
	Helper function to read orbit diagnostics settings from HDF5 file.
int	hdf5_options_read_diagtrcof (hid_t file, diag_transcoef_data *diagtrcof, char *qid)
	Helper function to read transport coefficient settings from HDF5 file.
int	hdf5_options_read (hid_t file, sim_data *sim, char *qid)
	Read options and diagnostics settings from HDF5 file.

Detailed Description

Read options from HDF5 file.

Definition in file hdf5_options.c.

Macro Definition Documentation

OPTPATH [1/9]

#define OPTPATH

Macro that is used to store paths to data groups

Definition at line 22 of file hdf5_options.c.

OPTPATH [2/9]

#define OPTPATH   "/options/opt_XXXXXXXXXX/"

Macro that is used to store paths to data groups

Definition at line 22 of file hdf5_options.c.

OPTPATH [3/9]

#define OPTPATH   "/options/opt_XXXXXXXXXX/"

Macro that is used to store paths to data groups

Definition at line 22 of file hdf5_options.c.

OPTPATH [4/9]

#define OPTPATH   "/options/opt_XXXXXXXXXX/"

Macro that is used to store paths to data groups

Definition at line 22 of file hdf5_options.c.

OPTPATH [5/9]

#define OPTPATH   "/options/opt_XXXXXXXXXX/"

Macro that is used to store paths to data groups

Definition at line 22 of file hdf5_options.c.

OPTPATH [6/9]

#define OPTPATH   "/options/opt_XXXXXXXXXX/"

Macro that is used to store paths to data groups

Definition at line 22 of file hdf5_options.c.

OPTPATH [7/9]

#define OPTPATH   "/options/opt_XXXXXXXXXX/"

Macro that is used to store paths to data groups

Definition at line 22 of file hdf5_options.c.

OPTPATH [8/9]

#define OPTPATH   "/options/opt_XXXXXXXXXX/"

Macro that is used to store paths to data groups

Definition at line 22 of file hdf5_options.c.

OPTPATH [9/9]

#define OPTPATH   "/options/opt_XXXXXXXXXX/"

Macro that is used to store paths to data groups

Definition at line 22 of file hdf5_options.c.

Function Documentation

hdf5_options_read_dist5D()

int hdf5_options_read_dist5D	(	hid_t	file,
		dist_5D_data *	dist,
		char *	qid )

Helper function to read dist5D settings from HDF5 file.

Parameters

file	the file where settings are read
dist	pointer to dist5D diagnostics offload data
qid	QID of the options to be read

Returns

zero if reading succeeded.

Definition at line 274 of file hdf5_options.c.

hdf5_options_read_dist6D()

int hdf5_options_read_dist6D	(	hid_t	file,
		dist_6D_data *	dist,
		char *	qid )

Helper function to read dist6D settings from HDF5 file.

Parameters

file	the file where settings are read
dist	pointer to dist6D diagnostics offload data
qid	QID of the options to be read

Returns

zero if reading succeeded.

Definition at line 351 of file hdf5_options.c.

hdf5_options_read_distrho5D()

int hdf5_options_read_distrho5D	(	hid_t	file,
		dist_rho5D_data *	dist,
		char *	qid )

Helper function to read distrho5D settings from HDF5 file.

Parameters

file	the file where settings are read
dist	pointer to distrho5D diagnostics offload data
qid	QID of the options to be read

Returns

zero if reading succeeded.

Definition at line 436 of file hdf5_options.c.

hdf5_options_read_distrho6D()

int hdf5_options_read_distrho6D	(	hid_t	file,
		dist_rho6D_data *	dist,
		char *	qid )

Helper function to read distrho6D settings from HDF5 file.

Parameters

file	the file where settings are read
dist	pointer to distrho6D diagnostics offload data
qid	QID of the options to be read

Returns

zero if reading succeeded.

Definition at line 515 of file hdf5_options.c.

hdf5_options_read_distCOM()

int hdf5_options_read_distCOM	(	hid_t	file,
		dist_COM_data *	dist,
		char *	qid )

Helper function to read COM dist settings from HDF5 file.

Parameters

file	the file where settings are read
dist	pointer to distCOM diagnostics offload data
qid	QID of the options to be read

Returns

zero if reading succeeded.

Definition at line 602 of file hdf5_options.c.

hdf5_options_read_diagorb()

int hdf5_options_read_diagorb	(	hid_t	file,
		diag_orb_data *	diagorb,
		char *	qid )

Helper function to read orbit diagnostics settings from HDF5 file.

Parameters

file	the file where settings are read
diagorb	pointer to orbit diagnostics offload data
qid	QID of the options to be read

Returns

zero if reading succeeded.

Definition at line 644 of file hdf5_options.c.

hdf5_options_read_diagtrcof()

int hdf5_options_read_diagtrcof	(	hid_t	file,
		diag_transcoef_data *	diagtrcof,
		char *	qid )

Helper function to read transport coefficient settings from HDF5 file.

Parameters

file	the file where settings are read
diagtrcof	pointer to orbit diagnostics offload data
qid	QID of the options to be read

Returns

zero if reading succeeded.

Definition at line 735 of file hdf5_options.c.

hdf5_options_read()

int hdf5_options_read	(	hid_t	file,
		sim_data *	sim,
		char *	qid )

Read options and diagnostics settings from HDF5 file.

This function reads options with given qid from HDF5 file. The file is opened and closed outside of this function.

The options are read directly to simulation offload data.

Parameters

file	the file where data is read
sim	pointer to simulation offload data
qid	QID of the options to be read

Returns

zero if reading succeeded.

Definition at line 47 of file hdf5_options.c.