plasma_1Dt.h File Reference

Header file for plasma_1Dt.c. More...

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

Go to the source code of this file.

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

Functions
int	plasma_1Dt_init (plasma_1Dt_data *data, int nrho, int ntime, int nion, real *rho, real *time, int *anum, int *znum, real *mass, real *charge, real *Te, real *Ti, real *ne, real *ni, real *vtor)
	Initialize 1Dt plasma data and check inputs.
void	plasma_1Dt_free (plasma_1Dt_data *pls_data)
	Free allocated resources.
void	plasma_1Dt_offload (plasma_1Dt_data *pls_data)
	Offload data to the accelerator.
a5err	plasma_1Dt_eval_temp (real *dens, real rho, real t, int species, plasma_1Dt_data *pls_data)
	Evaluate plasma temperature.
DECLARE_TARGET_END a5err	plasma_1Dt_eval_dens (real *temp, real rho, real t, int species, plasma_1Dt_data *pls_data)
	Evaluate plasma density.
DECLARE_TARGET_END a5err	plasma_1Dt_eval_densandtemp (real *dens, real *temp, real rho, real t, plasma_1Dt_data *pls_data)
	Evaluate plasma density and temperature for all species.
DECLARE_TARGET_END a5err	plasma_1Dt_eval_flow (real *vflow, real rho, real t, real r, plasma_1Dt_data *pls_data)
	Evalate plasma flow along the field lines.

Detailed Description

Header file for plasma_1Dt.c.

Definition in file plasma_1Dt.h.

Function Documentation

plasma_1Dt_init()

int plasma_1Dt_init	(	plasma_1Dt_data *	data,
		int	nrho,
		int	ntime,
		int	nion,
		real *	rho,
		real *	time,
		int *	anum,
		int *	znum,
		real *	mass,
		real *	charge,
		real *	Te,
		real *	Ti,
		real *	ne,
		real *	ni,
		real *	vtor )

Initialize 1Dt plasma data and check inputs.

Parameters

data	pointer to the data struct

Returns

zero if initialization succes

Definition at line 22 of file plasma_1Dt.c.

plasma_1Dt_free()

void plasma_1Dt_free

(

plasma_1Dt_data *

data

)

Free allocated resources.

Parameters

data	pointer to the data struct

Definition at line 124 of file plasma_1Dt.c.

plasma_1Dt_offload()

void plasma_1Dt_offload

(

plasma_1Dt_data *

data

)

Offload data to the accelerator.

Parameters

data	pointer to the data struct

Definition at line 140 of file plasma_1Dt.c.

plasma_1Dt_eval_temp()

a5err plasma_1Dt_eval_temp	(	real *	temp,
		real	rho,
		real	t,
		int	species,
		plasma_1Dt_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
t	time instant
species	index of plasma species
pls_data	pointer to plasma data struct

Returns

zero if evaluation succeeded

Definition at line 165 of file plasma_1Dt.c.

plasma_1Dt_eval_dens()

DECLARE_TARGET_END a5err plasma_1Dt_eval_dens	(	real *	dens,
		real	rho,
		real	t,
		int	species,
		plasma_1Dt_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
t	time instant
species	index of plasma species
pls_data	pointer to plasma data struct

Returns

zero if evaluation succeeded

Definition at line 193 of file plasma_1Dt.c.

plasma_1Dt_eval_densandtemp()

DECLARE_TARGET_END a5err plasma_1Dt_eval_densandtemp	(	real *	dens,
		real *	temp,
		real	rho,
		real	t,
		plasma_1Dt_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
t	time instant
pls_data	pointer to plasma data struct

Returns

zero if evaluation succeeded

Definition at line 220 of file plasma_1Dt.c.

plasma_1Dt_eval_flow()

DECLARE_TARGET_END a5err plasma_1Dt_eval_flow	(	real *	vflow,
		real	rho,
		real	t,
		real	r,
		plasma_1Dt_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]
t	particle time coordinate [s]
r	particle R coordinate [m]
pls_data	pointer to plasma data

Definition at line 320 of file plasma_1Dt.c.