OpenFUSIONToolkit.TokaMaker.util Namespace Reference

Detailed Description

Python interface for TokaMaker Grad-Shafranov functionality.

Authors

Chris Hansen

Date

May 2023

Functions
	compute_forces_components (tMaker_obj, psi, cell_centered=False)
	Compute terms needed for evaluating forces in passively conducting regions.
	create_isoflux (npts, r0, z0, a, kappa, delta, kappaL=None, deltaL=None)
	Create isoflux points using simple analytic form.
	create_power_flux_fun (npts, alpha, gamma)
	Build power law flux function of the form \( (1-\hat{\psi}^{\alpha})^{\gamma} \).
	create_spline_flux_fun (npts, x, y, axis_bc=[1, 0.0], edge_bc=[1, 0.0], normalize=True)
	Build cubic spline flux function.
	eval_green (x, xc)
	Evaluate Green's function for a toroidal filament.
	read_eqdsk (filename)
	Read gEQDSK file.

Function Documentation

compute_forces_components()

compute_forces_components	(		tMaker_obj,
			psi,
			cell_centered = False
	)

Compute terms needed for evaluating forces in passively conducting regions.

Parameters

tMaker_obj	TokaMaker equilibrium object
psi	\( \psi \) corresponding to desired currents
cell_centered	Evaluate at cell centers instead of node points?

Returns

J_cond, B_cond, mask, R

create_isoflux()

create_isoflux	(		npts,
			r0,
			z0,
			a,
			kappa,
			delta,
			kappaL = None,
			deltaL = None
	)

Create isoflux points using simple analytic form.

Parameters

npts	Number of points to sample (evenly spaced in \(\theta\))
r0	Major radial position for magnetic axis
z0	Vertical position for magnetic axis
a	Minor radius
kappa	Elongation (upper only if kappaL is set)
delta	Triangularity (upper only if deltaL is set)
kappaL	Lower elongation (default: kappa)
deltaL	Lower triangularity (default: delta)

Returns

Point list [npts,2]

create_power_flux_fun()

create_power_flux_fun	(		npts,
			alpha,
			gamma
	)

Build power law flux function of the form \( (1-\hat{\psi}^{\alpha})^{\gamma} \).

Parameters

npts	Number of points for definition
alpha	Inner exponent
gamma	Outer exponent

Returns

Flux function definition dictionary

create_spline_flux_fun()

create_spline_flux_fun	(		npts,
			x,
			y,
			axis_bc = [1,0.0],
			edge_bc = [1,0.0],
			normalize = True
	)

Build cubic spline flux function.

Parameters

npts	Number of points for definition
x	Location of spline "knots" in normalized flux
y	Value of flux function at spline "knots"
axis_bc	SciPy BC specification on axis ( \( \hat{\psi} = 0 \))
edge_bc	SciPy BC specification on LCFS ( \( \hat{\psi} = 1 \))

Returns

Flux function definition dictionary

eval_green()

eval_green	(		x,
			xc
	)

Evaluate Green's function for a toroidal filament.

Parameters

x	Observation point [2]
xc	Coil location [:,2]

Returns

\(\psi(x)\) due to a coil with unit current [A] at xc

read_eqdsk()

read_eqdsk

(

filename

)

Read gEQDSK file.

Parameters

filename

Path to gEQDSK file

Returns

Dictionary containing gEQDSK information