B_GS.h File Reference

Header file for B_GS.c. More...

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

Go to the source code of this file.

Data Structures
struct	B_GS_data
	Analytic magnetic field parameters on the target. More...

Functions
int	B_GS_init (B_GS_data *data, real R0, real z0, real raxis, real zaxis, real B_phi0, real psi0, real psi1, real psi_mult, real c[14], int Nripple, real a0, real alpha0, real delta0)
	Initialize magnetic field data.
void	B_GS_free (B_GS_data *data)
	Free allocated resources.
void	B_GS_offload (B_GS_data *data)
	Offload data to the accelerator.
a5err	B_GS_eval_B (real B[3], real r, real phi, real z, B_GS_data *Bdata)
	Evaluate magnetic field.
DECLARE_TARGET_END a5err	B_GS_eval_psi (real *psi, real r, real phi, real z, B_GS_data *Bdata)
	Evaluate poloidal flux psi.
DECLARE_TARGET_END a5err	B_GS_eval_psi_dpsi (real psi_dpsi[4], real r, real phi, real z, B_GS_data *Bdata)
	Evaluate poloidal flux psi and its derivatives.
DECLARE_TARGET_END a5err	B_GS_eval_rho_drho (real rho_drho[4], real r, real phi, real z, B_GS_data *Bdata)
	Evaluate normalized poloidal flux rho and its derivatives.
DECLARE_TARGET_END a5err	B_GS_eval_B_dB (real B_dB[12], real r, real phi, real z, B_GS_data *Bdata)
	Evaluate magnetic field and its derivatives.
DECLARE_TARGET_END a5err	B_GS_get_axis_rz (real rz[2], B_GS_data *Bdata)
	Return magnetic axis R-coordinate.

Detailed Description

Header file for B_GS.c.

Definition in file B_GS.h.

Function Documentation

B_GS_init()

int B_GS_init	(	B_GS_data *	data,
		real	R0,
		real	z0,
		real	raxis,
		real	zaxis,
		real	B_phi0,
		real	psi0,
		real	psi1,
		real	psi_mult,
		real	c[14],
		int	Nripple,
		real	a0,
		real	alpha0,
		real	delta0 )

Initialize magnetic field data.

Parameters

data	pointer to the data struct
R0	major radius R coordinate [m]
z0	midplane z coordinate [m]
raxis	magnetic axis R coordinate [m]
zaxis	magnetic axis z coordinate [m]
B_phi0	on-axis toroidal field [T]
psi0	poloidal flux at axis [Vs/m]
psi1	poloidal flux at separatrix [Vs/m]
psi_mult	psi multiplier
psi_coeff	coefficients for evaluating psi
Nripple	number of toroidal field coils
a0	minor radius
alpha0	ripple r-dependency delta ~ (r/a0)^alpha0
delta0	ripple strength

Returns

zero to indicate success

Definition at line 96 of file B_GS.c.

B_GS_free()

void B_GS_free

(

B_GS_data *

data

)

Free allocated resources.

Parameters

data	pointer to the data struct

Definition at line 150 of file B_GS.c.

B_GS_offload()

void B_GS_offload

(

B_GS_data *

data

)

Offload data to the accelerator.

Parameters

data	pointer to the data struct

Definition at line 159 of file B_GS.c.

B_GS_eval_B()

a5err B_GS_eval_B	(	real	B[3],
		real	r,
		real	phi,
		real	z,
		B_GS_data *	Bdata )

Evaluate magnetic field.

Parameters

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

Returns

zero to indicate success

Definition at line 327 of file B_GS.c.

B_GS_eval_psi()

DECLARE_TARGET_END a5err B_GS_eval_psi	(	real *	psi,
		real	r,
		real	phi,
		real	z,
		B_GS_data *	Bdata )

Evaluate poloidal flux psi.

Parameters

psi	pointer where psi [V*s*m^-1] value will be stored
r	R coordinate [m]
phi	phi coordinate [rad]
z	z coordinate [m]
Bdata	pointer to magnetic field data struct

Returns

zero to indicate success

Definition at line 174 of file B_GS.c.

B_GS_eval_psi_dpsi()

DECLARE_TARGET_END a5err B_GS_eval_psi_dpsi	(	real	psi_dpsi[4],
		real	r,
		real	phi,
		real	z,
		B_GS_data *	Bdata )

Evaluate poloidal flux psi and its derivatives.

Parameters

psi_dpsi	pointer for storing psi [V*s*m^-1] and its derivatives
r	R coordinate [m]
phi	phi coordinate [rad]
z	z coordinate [m]
Bdata	pointer to magnetic field data struct

Returns

zero to indicate success

Definition at line 227 of file B_GS.c.

B_GS_eval_rho_drho()

DECLARE_TARGET_END a5err B_GS_eval_rho_drho	(	real	rho_drho[4],
		real	r,
		real	phi,
		real	z,
		B_GS_data *	Bdata )

Evaluate normalized poloidal flux rho and its derivatives.

Parameters

rho_drho	pointer where rho and its derivatives will be stored
r	R coordinate [m]
phi	phi coordinate [rad]
z	z coordinate [m]
Bdata	pointer to magnetic field data struct

Returns

zero to indicate success

Definition at line 296 of file B_GS.c.

B_GS_eval_B_dB()

DECLARE_TARGET_END a5err B_GS_eval_B_dB	(	real	B_dB[12],
		real	r,
		real	phi,
		real	z,
		B_GS_data *	Bdata )

Evaluate magnetic field and its derivatives.

Parameters

B_dB	pointer to array where the field and its derivatives are stored
r	R coordinate [m]
phi	phi coordinate [deg]
z	z coordinate [m]
Bdata	pointer to magnetic field data struct

Returns

zero to indicate success

Definition at line 406 of file B_GS.c.

B_GS_get_axis_rz()

DECLARE_TARGET_END a5err B_GS_get_axis_rz	(	real	rz[2],
		B_GS_data *	Bdata )

Return magnetic axis R-coordinate.

Parameters

rz	pointer where axis R and z [m] values will be stored
Bdata	pointer to magnetic field data struct

Returns

Zero a5err value as this function can't fail.

Definition at line 557 of file B_GS.c.