neutral.h File Reference

Header file for neutral.c. More...

#include "ascot5.h"
#include "error.h"
#include "neutral/N0_1D.h"
#include "neutral/N0_3D.h"

Go to the source code of this file.

Data Structures
struct	neutral_data
	Neutral simulation data. More...

Typedefs
typedef enum neutral_type	neutral_type
	Neutral data types.

Enumerations
enum	neutral_type { neutral_type_1D , neutral_type_3D }
	Neutral data types. More...

Functions
void	neutral_free (neutral_data *data)
	Free allocated resources.
void	neutral_offload (neutral_data *data)
	Offload data to the accelerator.
a5err	neutral_eval_n0 (real *n0, real rho, real r, real phi, real z, real t, neutral_data *ndata)
	Evaluate neutral density.
a5err	neutral_eval_t0 (real *t0, real rho, real r, real phi, real z, real t, neutral_data *ndata)
	Evaluate neutral temperature.
int	neutral_get_n_species (neutral_data *ndata)
	Get the number of neutral species.

Detailed Description

Header file for neutral.c.

Contains a list declaring all neutral_types, and declaration of neutral_offload_data and neutral_data structs.

Definition in file neutral.h.

Enumeration Type Documentation

neutral_type

enum neutral_type

Neutral data types.

Enumerator
neutral_type_1D	Linearly-interpolated 1D neutral data
neutral_type_3D	Linearly-interpolated 3D neutral data

Definition at line 19 of file neutral.h.

Function Documentation

neutral_free()

void neutral_free

(

neutral_data *

data

)

Free allocated resources.

Parameters

data	pointer to data struct

Definition at line 29 of file neutral.c.

neutral_offload()

void neutral_offload

(

neutral_data *

data

)

Offload data to the accelerator.

Parameters

data	pointer to the data struct

Definition at line 45 of file neutral.c.

neutral_eval_n0()

a5err neutral_eval_n0	(	real *	n0,
		real	rho,
		real	r,
		real	phi,
		real	z,
		real	t,
		neutral_data *	ndata )

Evaluate neutral density.

This function evaluates the neutral density n0 at the given coordinates.

This is a SIMD function.

Parameters

n0	pointer where neutral density is stored [m^-3]
rho	normalized poloidal flux coordinate
r	R coordinate [m]
phi	phi coordinate [deg]
z	z coordinate [m]
t	time coordinate [s]
ndata	pointer to neutral density data struct

Returns

Non-zero a5err value if evaluation failed, zero otherwise

Definition at line 73 of file neutral.c.

neutral_eval_t0()

a5err neutral_eval_t0	(	real *	t0,
		real	rho,
		real	r,
		real	phi,
		real	z,
		real	t,
		neutral_data *	ndata )

Evaluate neutral temperature.

This function evaluates the neutral temperature t0 at the given coordinates.

This is a SIMD function.

Parameters

t0	pointer where neutral temperature is stored [J]
rho	normalized poloidal flux coordinate
r	R coordinate [m]
phi	phi coordinate [deg]
z	z coordinate [m]
t	time coordinate [s]
ndata	pointer to neutral temperature data struct

Returns

Non-zero a5err value if evaluation failed, zero otherwise

Definition at line 115 of file neutral.c.

neutral_get_n_species()

int neutral_get_n_species

(

neutral_data *

ndata

)

Get the number of neutral species.

Retrieve the number of how many neutral species the data contains.

This is a SIMD function.

Parameters

ndata

pointer to neutral data struct

Returns

The number of neutral species

Definition at line 151 of file neutral.c.