plasma_1D.h File Reference

Header file for plasma_1D.c. More...

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

Go to the source code of this file.

Data Structures
struct	plasma_1D_data
	1D plasma parameters on the target More...

Functions
int	plasma_1D_init (plasma_1D_data *data, int nrho, int nion, real *rho, int *anum, int *znum, real *mass, real *charge, real *Te, real *Ti, real *ne, real *ni, real *vtor)
	Initialize 1D plasma data and check inputs.
void	plasma_1D_free (plasma_1D_data *data)
	Free allocated resources.
void	plasma_1D_offload (plasma_1D_data *data)
	Offload data to the accelerator.
a5err	plasma_1D_eval_temp (real *dens, real rho, int species, plasma_1D_data *pls_data)
	Evaluate plasma temperature.
DECLARE_TARGET_END a5err	plasma_1D_eval_dens (real *temp, real rho, int species, plasma_1D_data *pls_data)
	Evaluate plasma density.
DECLARE_TARGET_END a5err	plasma_1D_eval_densandtemp (real *dens, real *temp, real rho, plasma_1D_data *pls_data)
	Evaluate plasma density and temperature for all species.
DECLARE_TARGET_END a5err	plasma_1D_eval_flow (real *vflow, real rho, real r, plasma_1D_data *pls_data)
	Evalate plasma flow along the field lines.

Detailed Description

Header file for plasma_1D.c.

Definition in file plasma_1D.h.

Function Documentation

plasma_1D_init()

int plasma_1D_init	(	plasma_1D_data *	data,
		int	nrho,
		int	nion,
		real *	rho,
		int *	anum,
		int *	znum,
		real *	mass,
		real *	charge,
		real *	Te,
		real *	Ti,
		real *	ne,
		real *	ni,
		real *	vtor )

Initialize 1D plasma data and check inputs.

Parameters

data	pointer to the data struct

Returns

zero if initialization succes

Definition at line 25 of file plasma_1D.c.

plasma_1D_free()

void plasma_1D_free

(

plasma_1D_data *

data

)

Free allocated resources.

Parameters

data	pointer to the data struct

Definition at line 109 of file plasma_1D.c.

plasma_1D_offload()

void plasma_1D_offload

(

plasma_1D_data *

data

)

Offload data to the accelerator.

Parameters

data	pointer to the data struct

Definition at line 124 of file plasma_1D.c.

plasma_1D_eval_temp()

a5err plasma_1D_eval_temp	(	real *	temp,
		real	rho,
		int	species,
		plasma_1D_data *	pls_data )

Evaluate plasma temperature.

This function evaluates the temperature of a plasma species at the given radial coordinate using linear interpolation.

Parameters

temp	pointer to where evaluated temperature [J] is stored
rho	radial coordinate
species	index of plasma species
pls_data	pointer to plasma data struct

Returns

zero if evaluation succeeded

Definition at line 147 of file plasma_1D.c.

plasma_1D_eval_dens()

DECLARE_TARGET_END a5err plasma_1D_eval_dens	(	real *	dens,
		real	rho,
		int	species,
		plasma_1D_data *	pls_data )

Evaluate plasma density.

This function evaluates the density of a plasma species at the given radial coordinate using linear interpolation.

Parameters

dens	pointer to where evaluated density [m^-3] is stored
rho	radial coordinate
species	index of plasma species
pls_data	pointer to plasma data struct

Returns

zero if evaluation succeeded

Definition at line 187 of file plasma_1D.c.

plasma_1D_eval_densandtemp()

DECLARE_TARGET_END a5err plasma_1D_eval_densandtemp	(	real *	dens,
		real *	temp,
		real	rho,
		plasma_1D_data *	pls_data )

Evaluate plasma density and temperature for all species.

This function evaluates the density and temperature of all plasma species at the given radial coordinate using linear interpolation.

Parameters

dens	pointer to where interpolated densities [m^-3] are stored
temp	pointer to where interpolated temperatures [J] are stored
rho	radial coordinate
pls_data	pointer to plasma data struct

Returns

zero if evaluation succeeded

Definition at line 227 of file plasma_1D.c.

plasma_1D_eval_flow()

DECLARE_TARGET_END a5err plasma_1D_eval_flow	(	real *	vflow,
		real	rho,
		real	r,
		plasma_1D_data *	pls_data )

Evalate plasma flow along the field lines.

Parameters

vflow	pointer where the flow value is stored [m/s]
rho	particle rho coordinate [1]
r	particle R coordinate [m]
pls_data	pointer to plasma data

Definition at line 276 of file plasma_1D.c.