hist.h File Reference

Header file for hist.c. More...

#include <stdlib.h>
#include "../ascot5.h"
#include "../particle.h"

Go to the source code of this file.

Data Structures
struct	hist_axis
	Coordinate axis for the histogram. More...
struct	histogram
	Histogram parameters. More...

Macros
#define	HIST_ALLDIM   16

Enumerations
enum	hist_coordinate {   R , PHI , Z , RHO ,   THETA , PPAR , PPERP , PR ,   PPHI , PZ , EKIN , XI ,   MU , PTOR , TIME , CHARGE }
	Quantities that can be used as histogram axis coordinates. More...

Functions
int	hist_init (histogram *data, int dimensions, hist_coordinate *coordinates, real *binmin, real *binmax, size_t *nbin)
	Initialize the histogram object.
void	hist_free (histogram *data)
	Free allocated resources.
void	hist_offload (histogram *data)
	Offload the data to the accelerator.
void	hist_update_fo (histogram *hist, particle_simd_fo *p_f, particle_simd_fo *p_i)
	Update the histogram in the particle picture.
void	hist_update_gc (histogram *hist, particle_simd_gc *p_f, particle_simd_gc *p_i)
	Update the histogram in the GC picture.

Detailed Description

Header file for hist.c.

Definition in file hist.h.

Macro Definition Documentation

HIST_ALLDIM

#define HIST_ALLDIM   16

Definition at line 12 of file hist.h.

Enumeration Type Documentation

hist_coordinate

enum hist_coordinate

Quantities that can be used as histogram axis coordinates.

Enumerator
R	The R coordinate in cylindrical basis [m].
PHI	The phi coordinate in cylindrical basis [rad].
Z	The z coordinate in cylindrical basis [m].
RHO	Square root of normalized poloidal flux [1].
THETA	Poloidal angle [rad].
PPAR	Momentum component parallel to the magnetic field [kg*m/s].
PPERP	Momentum component orthogonal to the magnetic field [kg*m/s].
PR	Momentum R-component [kg*m/s].
PPHI	Momentum phi-component [kg*m/s].
PZ	Momentum z-component [kg*m/s].
EKIN	Kinetic energy [J].
XI	Pitch [1].
MU	Magnetic moment [J/T].
PTOR	Canonical toroidal angular momentum [kg*m/s].
TIME	Time instant (laboratory time) [s].
CHARGE	Charge state [e].

Definition at line 17 of file hist.h.

Function Documentation

hist_init()

int hist_init	(	histogram *	data,
		int	dimensions,
		hist_coordinate *	coordinates,
		real *	binmin,
		real *	binmax,
		size_t *	nbin )

Initialize the histogram object.

Definition at line 20 of file hist.c.

hist_free()

void hist_free

(

histogram *

data

)

Free allocated resources.

Definition at line 66 of file hist.c.

hist_offload()

void hist_offload

(

histogram *

data

)

Offload the data to the accelerator.

Definition at line 74 of file hist.c.

hist_update_fo()

void hist_update_fo	(	histogram *	hist,
		particle_simd_fo *	p_f,
		particle_simd_fo *	p_i )

Update the histogram in the particle picture.

Definition at line 83 of file hist.c.

hist_update_gc()

void hist_update_gc	(	histogram *	hist,
		particle_simd_gc *	p_f,
		particle_simd_gc *	p_i )

Update the histogram in the GC picture.

Definition at line 201 of file hist.c.