E_TC.c File Reference

Trivial Cartesian Electric field. More...

#include <stdlib.h>
#include "../ascot5.h"
#include "../math.h"
#include "../error.h"
#include "../print.h"
#include "../B_field.h"
#include "E_TC.h"

Go to the source code of this file.

Functions
int	E_TC_init (E_TC_data *data, real exyz[3])
	Initialize electric field data and check inputs.
void	E_TC_free (E_TC_data *data)
	Free allocated resources.
void	E_TC_offload (E_TC_data *data)
	Offload data to the accelerator.
a5err	E_TC_eval_E (real E[3], real r, real phi, real z, E_TC_data *Edata, B_field_data *Bdata)
	Evaluate electric field.

Detailed Description

Trivial Cartesian Electric field.

Electric field that has constant x, y, and z components. Note that this field is defined in Cartesian coordinates and not cylindrical. This field is intended for testing purposes and to act as a dummy input.

Definition in file E_TC.c.

Function Documentation

E_TC_init()

int E_TC_init	(	E_TC_data *	data,
		real	exyz[3] )

Initialize electric field data and check inputs.

Parameters

data	pointer to the data struct
exyz	electric field vector on cartesian basis [V/m]

Returns

Zero to indicate initialization succeeded

Definition at line 25 of file E_TC.c.

E_TC_free()

void E_TC_free

(

E_TC_data *

data

)

Free allocated resources.

Parameters

data	pointer to the data struct

Definition at line 42 of file E_TC.c.

E_TC_offload()

void E_TC_offload

(

E_TC_data *

data

)

Offload data to the accelerator.

Parameters

data	pointer to the data struct

Definition at line 51 of file E_TC.c.

E_TC_eval_E()

a5err E_TC_eval_E	(	real	E[3],
		real	r,
		real	phi,
		real	z,
		E_TC_data *	Edata,
		B_field_data *	Bdata )

Evaluate electric field.

Even though this module represents a Cartesian electric field, the returned values are given in cylindrical coordinates.

Parameters

E	pointer to array where electric field values are stored
r	R coordinate [m]
phi	phi coordinate [deg]
z	z coordinate [m]
Edata	pointer to magnetic field data struct
Bdata	pointer to magnetic field data struct

Returns

Zero to indicate success

Definition at line 70 of file E_TC.c.