N0_3D.h File Reference

Header file for N0_3D.c. More...

#include "../ascot5.h"
#include "../offload.h"
#include "../linint/linint.h"

Go to the source code of this file.

Data Structures
struct	N0_3D_data
	3D neutral parameters on the target More...

Functions
int	N0_3D_init (N0_3D_data *data, int n_r, real r_min, real r_max, int n_phi, real phi_min, real phi_max, int n_z, real z_min, real z_max, int n_species, int *anum, int *znum, int *maxwellian, real *density, real *temperature)
	Initialize neutral data.
void	N0_3D_free (N0_3D_data *data)
	Free allocated resources.
void	N0_3D_offload (N0_3D_data *data)
	Offload data to the accelerator.
a5err	N0_3D_eval_n0 (real *n0, real r, real phi, real z, N0_3D_data *ndata)
	Evaluate neutral density.
a5err	N0_3D_eval_t0 (real *t0, real r, real phi, real z, N0_3D_data *ndata)
	Evaluate neutral temperature.
int	N0_3D_get_n_species (N0_3D_data *ndata)
	Return number of neutral species.

Detailed Description

Header file for N0_3D.c.

Definition in file N0_3D.h.

Function Documentation

N0_3D_init()

int N0_3D_init	(	N0_3D_data *	data,
		int	n_r,
		real	r_min,
		real	r_max,
		int	n_phi,
		real	phi_min,
		real	phi_max,
		int	n_z,
		real	z_min,
		real	z_max,
		int	n_species,
		int *	anum,
		int *	znum,
		int *	maxwellian,
		real *	density,
		real *	temperature )

Initialize neutral data.

Parameters

ndata

pointer to the data struct

Definition at line 21 of file N0_3D.c.

N0_3D_free()

void N0_3D_free

(

N0_3D_data *

data

)

Free allocated resources.

Parameters

offload_data

pointer to the data struct

Definition at line 81 of file N0_3D.c.

N0_3D_offload()

void N0_3D_offload

(

N0_3D_data *

data

)

Offload data to the accelerator.

Parameters

data	pointer to the data struct

Definition at line 96 of file N0_3D.c.

N0_3D_eval_n0()

a5err N0_3D_eval_n0	(	real *	n0,
		real	r,
		real	phi,
		real	z,
		N0_3D_data *	ndata )

Evaluate neutral density.

This function evaluates the neutral density at the given coordinates using trilinear interpolation on the 3D neutral density data.

Parameters

n0	n0 value will be stored in n0[0]
r	r coordinate
phi	phi coordinate
z	z coordinate
ndata	pointer to neutral data struct

Returns

zero if evaluation succeeded

Definition at line 114 of file N0_3D.c.

N0_3D_eval_t0()

a5err N0_3D_eval_t0	(	real *	t0,
		real	r,
		real	phi,
		real	z,
		N0_3D_data *	ndata )

Evaluate neutral temperature.

This function evaluates the neutral temperature at the given coordinates using trilinear interpolation on the 3D neutral temperature data.

Parameters

t0	t0 value will be stored in t0[0]
r	r coordinate
phi	phi coordinate
z	z coordinate
ndata	pointer to neutral data struct

Returns

zero if evaluation succeeded

Definition at line 142 of file N0_3D.c.

N0_3D_get_n_species()

int N0_3D_get_n_species

(

N0_3D_data *

ndata

)

Return number of neutral species.

Parameters

ndata

pointer to neutral data struct

Returns

number of neutral species

Definition at line 163 of file N0_3D.c.