N0_3D.h File Reference

Header file for N0_3D.c. More...

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

Go to the source code of this file.

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

Functions
int	N0_3D_init_offload (N0_3D_offload_data *offload_data, real **offload_array)
	Initialize offload data.
void	N0_3D_free_offload (N0_3D_offload_data *offload_data, real **offload_array)
	Free offload array and reset parameters.
void	N0_3D_init (N0_3D_data *ndata, N0_3D_offload_data *offload_data, real *offload_array)
	Initialize neutral data on target.
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_offload()

int N0_3D_init_offload	(	N0_3D_offload_data *	offload_data,
		real **	offload_array )

Initialize offload data.

Parameters

offload_data	pointer to offload data struct
offload_array	pointer to offload data array

Returns

zero if initialization succeeded

Definition at line 24 of file N0_3D.c.

N0_3D_free_offload()

void N0_3D_free_offload	(	N0_3D_offload_data *	offload_data,
		real **	offload_array )

Free offload array and reset parameters.

This function deallocates the offload_array.

Parameters

offload_data	pointer to offload data struct
offload_array	pointer to pointer to offload array

Definition at line 66 of file N0_3D.c.

N0_3D_init()

void N0_3D_init	(	N0_3D_data *	ndata,
		N0_3D_offload_data *	offload_data,
		real *	offload_array )

Initialize neutral data on target.

This function copies parameters from the offload struct to the struct on target and sets the data pointers on target struct to correct offsets in the offload array.

Any initialization that requires any computations must have been done already when the offload struct was initialized.

Parameters

ndata	pointer to data struct on target
offload_data	pointer to offload data struct
offload_array	pointer to offload array

Definition at line 86 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 129 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 157 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 178 of file N0_3D.c.