Detailed Description

TokaMaker G-S solver class.

Public Member Functions
	__init__ (self, debug_level=0, nthreads=2)
	Initialize TokaMaker object.

	alam (self)

	alam (self, value)

	area_integral (self, field, reg_mask=-1)
	Compute area integral of field over a specified region.

	calc_loopvoltage (self)
	Get plasma loop voltage.

	diverted (self)

	eig_td (self, omega=-1.E4, neigs=4, include_bounds=True, pm=False)
	Compute eigenvalues for the linearized time-dependent system.

	eig_wall (self, neigs=4, pm=False)
	Compute eigenvalues ( $ 1 / \tau_{L/R} $) for conducting structures.

	get_coil_currents (self)
	Get currents in each coil [A] and coil region [A-turns].

	get_coil_Lmat (self)
	Get mutual inductance matrix between coils.

	get_conductor_currents (self, psi, cell_centered=False)
	Get toroidal current density in conducting regions for a given $ \psi $.

	get_conductor_source (self, dpsi_dt)
	Get toroidal current density in conducting regions for a $ d \psi / dt $ source.

	get_delstar_curr (self, psi)
	Get toroidal current density from $ \psi $ through $ \Delta^{*} $ operator.

	get_field_eval (self, field_type)
	Create field interpolator for vector potential.

	get_globals (self)
	Get global plasma parameters.

	get_profiles (self, psi=None, psi_pad=1.E-8, npsi=50)
	Get G-S source profiles.

	get_psi (self, normalized=True)
	Get poloidal flux values on node points.

	get_q (self, psi=None, psi_pad=0.02, npsi=50)
	Get q-profile at specified or uniformly spaced points.

	get_stats (self, lcfs_pad=0.01, li_normalization='std', geom_type='max')
	Get information (Ip, q, kappa, etc.) about current G-S equilbirium.

	get_targets (self)
	Get global target values.

	get_vfixed (self)
	Get required vacuum flux values to balance fixed boundary equilibrium.

	get_xpoints (self)
	Get X-points.

	init_psi (self, r0=-1.0, z0=0.0, a=0.0, kappa=0.0, delta=0.0, curr_source=None)
	Initialize $\psi$ using uniform current distributions.

	load_profiles (self, f_file='f_prof.in', foffset=None, p_file='p_prof.in', eta_file='eta_prof.in', f_NI_file='f_NI_prof.in')
	Load flux function profiles ( $F*F'$ and $P'$) from files.

	plot_constraints (self, fig, ax, isoflux_color='tab:red', isoflux_marker='+', saddle_color='tab:green', saddle_marker='x')
	Plot geometry constraints.

	plot_eddy (self, fig, ax, psi=None, dpsi_dt=None, nlevels=40, colormap='jet', clabel=r ' $J_w$[$A/m^2$]', symmap=False)
	Plot contours of $\hat{\psi}$.

	plot_machine (self, fig, ax, vacuum_color='whitesmoke', cond_color='gray', limiter_color='k', coil_color='gray', coil_colormap=None, coil_symmap=False, coil_scale=1.0, coil_clabel=r ' $I_C$[A]', colorbar=None)
	Plot machine geometry.

	plot_psi (self, fig, ax, psi=None, normalized=True, plasma_color=None, plasma_nlevels=8, plasma_levels=None, plasma_colormap=None, plasma_linestyles=None, vacuum_color='darkgray', vacuum_nlevels=8, vacuum_levels=None, vacuum_colormap=None, vacuum_linestyles=None, xpoint_color='k', xpoint_marker='x', opoint_color='k', opoint_marker=' *')
	Plot contours of $\hat{\psi}$.

	pnorm (self)

	pnorm (self, value)

	print_info (self, lcfs_pad=0.01, li_normalization='std', geom_type='max')
	Print information (Ip, q, etc.) about current G-S equilbirium.

	reset (self)
	Reset G-S object to enable loading a new mesh and coil configuration.

	sauter_fc (self, psi=None, psi_pad=0.02, npsi=50)
	Evaluate Sauter trapped particle fractions at specified or uniformly spaced points.

	save_eqdsk (self, filename, nr=65, nz=65, rbounds=None, zbounds=None, run_info='', lcfs_pad=0.01, rcentr=None, truncate_eq=True, limiter_file='')
	Save current equilibrium to gEQDSK format.

	set_coil_bounds (self, coil_bounds)
	Set hard constraints on coil currents.

	set_coil_currents (self, currents)
	Set coil currents.

	set_coil_reg (self, reg_mat, reg_targets=None, reg_weights=None)
	Set regularization matrix for coils when isoflux and/or saddle constraints are used.

	set_coil_vsc (self, coil_gains)
	Define a vertical stability coil set from one or more coils.

	set_flux (self, locations, targets, weights=None)
	Set explicit flux constraint points $ \psi(x_i) $.

	set_isoflux (self, isoflux, weights=None, grad_wt_lim=-1.0)
	Set isoflux constraint points (all points lie on a flux surface)

	set_profiles (self, ffp_prof=None, foffset=None, pp_prof=None, ffp_NI_prof=None)
	Set flux function profiles ( $F*F'$ and $P'$) using a piecewise linear definition.

	set_psi (self, psi)
	Set poloidal flux values on node points.

	set_psi_dt (self, psi0, dt)
	Set reference poloidal flux and time step for eddy currents in .solve()

	set_resistivity (self, eta_prof=None)
	Set flux function profile $\eta$ using a piecewise linear definition.

	set_saddles (self, saddles, weights=None)
	Set saddle constraint points (poloidal field should vanish at each point)

	set_targets (self, Ip=None, Ip_ratio=None, pax=None, estore=None, R0=None, V0=None, retain_previous=False)
	Set global target values.

	setup (self, order=2, F0=0.0, full_domain=False)
	Setup G-S solver.

	setup_mesh (self, r=None, lc=None, reg=None, mesh_file=None)
	Setup mesh for static and time-dependent G-S calculations.

	setup_regions (self, cond_dict={}, coil_dict={})
	Define mesh regions (coils and conductors)

	setup_td (self, dt, lin_tol, nl_tol, pre_plasma=False)
	Setup the time-dependent G-S solver.

	solve (self, vacuum=False)
	Solve G-S equation with specified constraints, profiles, etc.

	step_td (self, time, dt)
	Compute eigenvalues for the time-dependent system.

	trace_surf (self, psi)
	Trace surface for a given poloidal flux.

	update_settings (self)
	Update settings after changes to values in python.

	vac_solve (self, psi=None, rhs_source=None)
	Solve for vacuum solution (no plasma), with present coil currents and optional other currents.

Public Attributes
	alam

	coil_sets
	Coil set definitions, including sub-coils.

	gs_obj
	Internal Grad-Shafranov object (gs_eq)

	lc
	Mesh triangles [nc,3].

	lim_contour
	Limiting contour.

	lim_contours

	lim_point
	Limiting point (limter or active X-point) [2].

	lim_pts

	nc
	Number of cells in mesh.

	ncoils
	Number of coils in mesh.

	np
	Number of points in mesh.

	nregs
	Number of regions in mesh.

	nvac
	Number of vacuum regions in mesh.

	o_point
	Location of O-point (magnetic axis) [2].

	pnorm

	psi_bounds
	Bounding values for $\psi$ ( $\psi_a$, $\psi_0$) [2].

	psi_convention
	Normalized flux convention (0 -> tokamak, 1 -> spheromak)

	r
	Mesh vertices [np,3] (last column should be all zeros)

	reg
	Mesh regions [nc].

	settings
	General settings object.

	x_points
	Location of X-points [20,2].

Protected Member Functions
	_update_oft_in (self)
	Update input file (`oftpyin`) with current settings.

Protected Attributes
	_alam
	F*F' normalization value [1] (use alam property)

	_coil_dict
	Coil definition dictionary.

	_cond_dict
	Conductor definition dictionary.

	_diverted
	Diverted (limited) flag [1] (use diverted property)

	_estore_target
	Stored energy target value (use set_targets)

	_F0
	Vacuum F value.

	_flux_targets
	Flux constraint points (use set_flux)

	_Ip_ratio_target
	Plasma current target ratio I_p(FF') / I_p(P') (use set_targets)

	_Ip_target
	Plasma current target value (use set_targets)

	_isoflux_targets
	Isoflux constraint points (use set_isoflux)

	_oft_in_dict
	Input file settings.

	_pax_target
	Axis pressure target value (use set_targets)

	_pnorm
	Pressure normalization value [1] (use pnorm property)

	_R0_target
	R0 target value (use set_targets)

	_saddle_targets
	Saddle constraint points (use set_saddles)

	_V0_target
	V0 target value (use set_targets)

	_vac_dict
	Vacuum definition dictionary.

Constructor & Destructor Documentation

◆ init()

__init__	(	self,
		debug_level = `0`,
		nthreads = `2`
	)

Initialize TokaMaker object.

Parameters

debug_level Level of debug printing (0-3)

Member Function Documentation

◆ _update_oft_in()

_update_oft_in ( self )

protected

Update input file (oftpyin) with current settings.

◆ alam() [1/2]

alam ( self )

◆ alam() [2/2]

alam	(	self,
		value
	)

◆ area_integral()

area_integral	(	self,
		field,
		reg_mask = `-1`
	)

Compute area integral of field over a specified region.

Parameters

field	Field to integrate [np,]
reg_mask	ID of region for integration (negative for whole mesh)

Returns: $ \int f dA $

◆ calc_loopvoltage()

calc_loopvoltage ( self )

Get plasma loop voltage.

Parameters

eta	Dictionary object containing resistivity profile ['y'] and sampled locations in normalized Psi ['x']
ffp_NI	Dictionary object containing non-inductive FF' profile ['y'] and sampled locations in normalized Psi ['x']

Returns: Vloop [Volts]

◆ diverted()

diverted ( self )

◆ eig_td()

eig_td	(	self,
		omega = `-1.E4`,
		neigs = `4`,
		include_bounds = `True`,
		pm = `False`
	)

Compute eigenvalues for the linearized time-dependent system.

Parameters

omega	Growth rate localization point (eigenvalues closest to this value will be found)
neigs	Number of eigenvalues to compute
include_bounds	Include bounding flux terms for constant normalized profiles?
pm	Print solver statistics and raw eigenvalues?

Returns: eigenvalues[neigs], eigenvectors[neigs,:]

◆ eig_wall()

eig_wall	(	self,
		neigs = `4`,
		pm = `False`
	)

Compute eigenvalues ( $ 1 / \tau_{L/R} $) for conducting structures.

Parameters

neigs	Number of eigenvalues to compute
pm	Print solver statistics and raw eigenvalues?

Returns: eigenvalues[neigs], eigenvectors[neigs,:]

◆ get_coil_currents()

get_coil_currents ( self )

Get currents in each coil [A] and coil region [A-turns].

Returns: Coil currents [ncoils], Coil currents by region [nregs]

◆ get_coil_Lmat()

get_coil_Lmat ( self )

Get mutual inductance matrix between coils.

Note: This is the inductance in terms of A-turns. To get in terms of current in a single of the $n$ windings you must multiply by $n_i*n_j$.

Returns: L[ncoils+1,ncoils+1]

◆ get_conductor_currents()

get_conductor_currents	(	self,
		psi,
		cell_centered = `False`
	)

Get toroidal current density in conducting regions for a given $ \psi $.

Parameters

psi	Psi corresponding to field with conductor currents (eg. from time-dependent simulation)
cell_centered	Get currents at cell centers

◆ get_conductor_source()

get_conductor_source	(	self,
		dpsi_dt
	)

Get toroidal current density in conducting regions for a $ d \psi / dt $ source.

Parameters

dpsi_dt dPsi/dt source eddy currents (eg. from linear stability)

◆ get_delstar_curr()

get_delstar_curr	(	self,
		psi
	)

Get toroidal current density from $ \psi $ through $ \Delta^{*} $ operator.

Parameters

psi	$ \psi $ corresponding to desired current density

Returns: $ J_{\phi} = \textrm{M}^{-1} \Delta^{*} \psi $

◆ get_field_eval()

get_field_eval	(	self,
		field_type
	)

Create field interpolator for vector potential.

Parameters

field_type Field to interpolate, must be one of ("B", "psi", "F", or "P")

Returns: Field interpolation object

◆ get_globals()

get_globals ( self )

Get global plasma parameters.

Returns: Ip, [R_Ip, Z_Ip], $\int dV$, $\int P dV$, diamagnetic flux, enclosed toroidal flux

◆ get_profiles()

get_profiles	(	self,
		psi = `None`,
		psi_pad = `1.E-8`,
		npsi = `50`
	)

Get G-S source profiles.

Parameters

psi	Explicit sampling locations in $\hat{\psi}$
psi_pad	End padding (axis and edge) for uniform sampling (ignored if `psi` is not None)
npsi	Number of points for uniform sampling (ignored if `psi` is not None)

Returns: $\hat{\psi}$, $F(\hat{\psi})$, $F'(\hat{\psi})$, $P(\hat{\psi})$, $P'(\hat{\psi})$

◆ get_psi()

get_psi	(	self,
		normalized = `True`
	)

Get poloidal flux values on node points.

Parameters

normalized Normalize (and offset) poloidal flux

Returns: $\hat{\psi} = \frac{\psi-\psi_0}{\psi_a-\psi_0} $ or $\psi$

◆ get_q()

get_q	(	self,
		psi = `None`,
		psi_pad = `0.02`,
		npsi = `50`
	)

Get q-profile at specified or uniformly spaced points.

Parameters

psi	Explicit sampling locations in $\hat{\psi}$
psi_pad	End padding (axis and edge) for uniform sampling (ignored if `psi` is not None)
npsi	Number of points for uniform sampling (ignored if `psi` is not None)

Returns: $\hat{\psi}$, $q(\hat{\psi})$, $[<R>,<1/R>]$, length of last surface, [r(R_min),r(R_max)], [r(z_min),r(z_max)]

◆ get_stats()

get_stats	(	self,
		lcfs_pad = `0.01`,
		li_normalization = `'std'`,
		geom_type = `'max'`
	)

Get information (Ip, q, kappa, etc.) about current G-S equilbirium.

See eq. 1 for ‘li_normalization='std’and eq 2. forli_normalization='iter'` in Jackson et al.

Parameters

lcfs_pad	Padding at LCFS for boundary calculations
li_normalization	Form of normalized $ l_i $ ('std', 'ITER')
geom_type	Method for computing geometric major/minor radius ('max': Use LCFS extrema, 'mid': Use axis plane extrema)

Returns: Dictionary of equilibrium parameters

◆ get_targets()

get_targets ( self )

Get global target values.

Returns: Dictionary of global target values

◆ get_vfixed()

get_vfixed ( self )

Get required vacuum flux values to balance fixed boundary equilibrium.

Returns: sampling points [:,2], flux values [:]

◆ get_xpoints()

get_xpoints ( self )

Get X-points.

Returns: X-points, is diverted?

◆ init_psi()

init_psi	(	self,
		r0 = `-1.0`,
		z0 = `0.0`,
		a = `0.0`,
		kappa = `0.0`,
		delta = `0.0`,
		curr_source = `None`
	)

Initialize $\psi$ using uniform current distributions.

If r0>0 then a uniform current density inside a surface bounded by a curve of the form defined in oftpy.create_isoflux is used. If r0<0 then a uniform current density over the entire plasma region is used.

Parameters

r0	Major radial position for flux surface-based approach
z0	Vertical position for flux surface-based approach
a	Minor radius for flux surface-based approach
kappa	Elongation for flux surface-based approach
delta	Triangularity for flux surface-based approach
curr_source	Current source for arbitrary current distribution

◆ load_profiles()

load_profiles	(	self,
		f_file = `'f_prof.in'`,
		foffset = `None`,
		p_file = `'p_prof.in'`,
		eta_file = `'eta_prof.in'`,
		f_NI_file = `'f_NI_prof.in'`
	)

Load flux function profiles ( $F*F'$ and $P'$) from files.

Parameters

f_file	File containing $F*F'$ (or $F'$ if `mode=0`) definition
foffset	Value of $F0=R0*B0$
p_file	File containing $P'$ definition
eta_file	File containing $\eta$ definition
f_NI_file	File containing non-inductive $F*F'$ definition

◆ plot_constraints()

plot_constraints	(	self,
		fig,
		ax,
		isoflux_color = `'tab:red'`,
		isoflux_marker = `'+'`,
		saddle_color = `'tab:green'`,
		saddle_marker = `'x'`
	)

Plot geometry constraints.

Parameters

fig	Figure to add to
ax	Axis to add to
isoflux_color	Color of isoflux points (None to disable)
saddle_color	Color of saddle points (None to disable)

◆ plot_eddy()

plot_eddy	(	self,
		fig,
		ax,
		psi = `None`,
		dpsi_dt = `None`,
		nlevels = `40`,
		colormap = `'jet'`,
		clabel = `r'$J_w$ [$A/m^2$]'`,
		symmap = `False`
	)

Plot contours of $\hat{\psi}$.

Parameters

fig	Figure to add to
ax	Axis to add to
psi	Psi corresponding to eddy currents (eg. from time-dependent simulation)
dpsi_dt	dPsi/dt source eddy currents (eg. from linear stability)
nlevels	Number contour lines used for shading (with "psi" only)
colormap	Colormap to use for shadings
clabel	Label for colorbar (None to disable colorbar)

Returns: Colorbar object

◆ plot_machine()

plot_machine	(	self,
		fig,
		ax,
		vacuum_color = `'whitesmoke'`,
		cond_color = `'gray'`,
		limiter_color = `'k'`,
		coil_color = `'gray'`,
		coil_colormap = `None`,
		coil_symmap = `False`,
		coil_scale = `1.0`,
		coil_clabel = `r'$I_C$ [A]'`,
		colorbar = `None`
	)

Plot machine geometry.

Parameters

fig	Figure to add to
ax	Axis to add to
vacuum_color	Color to shade vacuum region (None to disable)
cond_color	Color for conducting regions (None to disable)
limiter_color	Color for limiter contour (None to disable)
coil_color	Color for coil regions (None to disable)
coil_colormap	Colormap for coil current values
coil_symmap	Make coil current colorscale symmetric
coil_scale	Scale for coil currents when plotting
coil_clabel	Label for coil current colorbar (None to disable colorbar)
colorbar	Colorbar instance to overwrite (None to add)

Returns: Colorbar instance for coil colors or None

◆ plot_psi()

plot_psi	(	self,
		fig,
		ax,
		psi = `None`,
		normalized = `True`,
		plasma_color = `None`,
		plasma_nlevels = `8`,
		plasma_levels = `None`,
		plasma_colormap = `None`,
		plasma_linestyles = `None`,
		vacuum_color = `'darkgray'`,
		vacuum_nlevels = `8`,
		vacuum_levels = `None`,
		vacuum_colormap = `None`,
		vacuum_linestyles = `None`,
		xpoint_color = `'k'`,
		xpoint_marker = `'x'`,
		opoint_color = `'k'`,
		opoint_marker = `'*'`
	)

Plot contours of $\hat{\psi}$.

Parameters

fig	Figure to add to
ax	Axis to add to
psi	Flux values to plot (otherwise `self.get_psi()` is called)
normalized	Retreive normalized flux, or assume normalized psi if passed as argument
plasma_color	Color for plasma contours
plasma_nlevels	Number of plasma contours
plasma_levels	Explicit levels for plasma contours
plasma_colormap	Colormap for plasma contours (cannot be specified with `plasma_color`)
plasma_linestyles	Linestyle for plasma contours
vacuum_color	Color for plasma contours
vacuum_nlevels	Number of plasma contours
vacuum_levels	Explicit levels for plasma contours (cannot be specified with `vacuum_color`)
vacuum_colormap	Colormap for plasma contours
vacuum_linestyles	Linestyle for vacuum contours
xpoint_color	Color for X-point markers (None to disable)
xpoint_marker	Colormap for plasma contours
opoint_color	Colormap for plasma contours (None to disable)
opoint_marker	Colormap for plasma contours

◆ pnorm() [1/2]

pnorm ( self )

◆ pnorm() [2/2]

pnorm	(	self,
		value
	)

◆ print_info()

print_info	(	self,
		lcfs_pad = `0.01`,
		li_normalization = `'std'`,
		geom_type = `'max'`
	)

Print information (Ip, q, etc.) about current G-S equilbirium.

Parameters

lcfs_pad	Padding at LCFS for boundary calculations
li_normalization	Form of normalized $ l_i $ ('std', 'ITER')
geom_type	Method for computing geometric major/minor radius ('max': Use LCFS extrema, 'mid': Use axis plane extrema)

◆ reset()

reset ( self )

Reset G-S object to enable loading a new mesh and coil configuration.

◆ sauter_fc()

sauter_fc	(	self,
		psi = `None`,
		psi_pad = `0.02`,
		npsi = `50`
	)

Evaluate Sauter trapped particle fractions at specified or uniformly spaced points.

Parameters

psi	Explicit sampling locations in $\hat{\psi}$
psi_pad	End padding (axis and edge) for uniform sampling (ignored if `psi` is not None)
npsi	Number of points for uniform sampling (ignored if `psi` is not None)

Returns: $ f_c $, [ $<R>,<1/R>,<a>$], [ $<|B|>,<|B|^2>$]

◆ save_eqdsk()

save_eqdsk	(	self,
		filename,
		nr = `65`,
		nz = `65`,
		rbounds = `None`,
		zbounds = `None`,
		run_info = `''`,
		lcfs_pad = `0.01`,
		rcentr = `None`,
		truncate_eq = `True`,
		limiter_file = `''`
	)

Save current equilibrium to gEQDSK format.

Parameters

filename	Filename to save equilibrium to
nr	Number of radial sampling points
nz	Number of vertical sampling points
rbounds	Extents of grid in R
zbounds	Extents of grid in Z
run_info	Run information for gEQDSK file (maximum of 40 characters)
lcfs_pad	Padding in normalized flux at LCFS
rcentr	`RCENTR` value for gEQDSK file (if `None`, geometric axis is used)
truncate_eq	Truncate equilibrium at `lcfs_pad`, if `False` $ q(\hat{\psi} > 1-pad) = q(1-pad) $
limiter_file	File containing limiter contour to use instead of TokaMaker limiter

◆ set_coil_bounds()

set_coil_bounds	(	self,
		coil_bounds
	)

Set hard constraints on coil currents.

Can be used with or without regularization terms (see set_coil_reg).

Parameters

coil_bounds Minimum and maximum allowable coil currents [ncoils+1,2]

◆ set_coil_currents()

set_coil_currents	(	self,
		currents
	)

Set coil currents.

Parameters

currents Current in each coil [A]

◆ set_coil_reg()

set_coil_reg	(	self,
		reg_mat,
		reg_targets = `None`,
		reg_weights = `None`
	)

Set regularization matrix for coils when isoflux and/or saddle constraints are used.

Can be used to enforce "soft" constraints on coil currents. For hard constraints see set_coil_bounds.

Parameters

reg_mat	Regularization matrix [nregularize,ncoils+1]
reg_targets	Regularization targets [nregularize] (default: 0)
reg_weights	Weights for regularization terms [nregularize] (default: 1)

◆ set_coil_vsc()

set_coil_vsc	(	self,
		coil_gains
	)

Define a vertical stability coil set from one or more coils.

Parameters

coil_gains Gains for each coil (absolute scale is arbitrary)

◆ set_flux()

set_flux	(	self,
		locations,
		targets,
		weights = `None`
	)

Set explicit flux constraint points $ \psi(x_i) $.

Parameters

locations	List of points defining constraints [:,2]
targets	Target $ \psi $ value at each point [:]
weights	Weight to be applied to each constraint point [:] (default: 1)

◆ set_isoflux()

set_isoflux	(	self,
		isoflux,
		weights = `None`,
		grad_wt_lim = `-1.0`
	)

Set isoflux constraint points (all points lie on a flux surface)

To constraint points more uniformly in space additional weighting based on the gradient of $\psi$ at each point can also be included by setting grad_wt_lim>0. When set the actual weight will be $w_i * min(grad_wt_lim,|\nabla \psi|_{max} / |\nabla \psi|_i)$

Parameters

isoflux	List of points defining constraints [:,2]
weights	Weight to be applied to each constraint point [:] (default: 1)
grad_wt_lim	Limit on gradient-based weighting (negative to disable)

◆ set_profiles()

set_profiles	(	self,
		ffp_prof = `None`,
		foffset = `None`,
		pp_prof = `None`,
		ffp_NI_prof = `None`
	)

Set flux function profiles ( $F*F'$ and $P'$) using a piecewise linear definition.

Parameters

ffp_prof	Dictionary object containing FF' profile ['y'] and sampled locations in normalized Psi ['x']
foffset	Value of $F0=R0*B0$
pp_prof	Dictionary object containing P' profile ['y'] and sampled locations in normalized Psi ['x']
ffp_NI_prof	Dictionary object containing non-inductive FF' profile ['y'] and sampled locations in normalized Psi ['x']

◆ set_psi()

set_psi	(	self,
		psi
	)

Set poloidal flux values on node points.

Parameters

psi	Poloidal flux values (should not be normalized!)

◆ set_psi_dt()

set_psi_dt	(	self,
		psi0,
		dt
	)

Set reference poloidal flux and time step for eddy currents in .solve()

Parameters

psi0	Reference poloidal flux at t-dt (unnormalized)
dt	Time since reference poloidal flux

◆ set_resistivity()

set_resistivity	(	self,
		eta_prof = `None`
	)

Set flux function profile $\eta$ using a piecewise linear definition.

Arrays should have the form array[i,:] = ( $\hat{\psi}_i$, $f(\hat{\psi}_i)$) and span $\hat{\psi}_i = [0,1]$.

Parameters

eta_prof Values defining $\eta$ [:,2]

◆ set_saddles()

set_saddles	(	self,
		saddles,
		weights = `None`
	)

Set saddle constraint points (poloidal field should vanish at each point)

Parameters

saddles	List of points defining constraints [:,2]
weights	Weight to be applied to each constraint point [:] (default: 1)

◆ set_targets()

set_targets	(	self,
		Ip = `None`,
		Ip_ratio = `None`,
		pax = `None`,
		estore = `None`,
		R0 = `None`,
		V0 = `None`,
		retain_previous = `False`
	)

Set global target values.

Note: Values that are not specified are reset to their defaults on each call unless retain_previous=True.

Parameters

alam	Scale factor for $F*F'$ term (disabled if `Ip` is set)
pnorm	Scale factor for $P'$ term (disabled if `pax`, `estore`, or `R0` are set)
Ip	Target plasma current [A] (disabled if <0)
Ip_ratio	Amplitude of net plasma current contribution from FF' compared to P' (disabled if <-1.E98)
pax	Target axis pressure [Pa] (disabled if <0 or if `estore` is set)
estore	Target sotred energy [J] (disabled if <0)
R0	Target major radius for magnetic axis (disabled if <0 or if `pax` or `estore` are set)
V0	Target vertical position for magnetic axis (disabled if <-1.E98)
retain_previous	Keep previously set targets unless explicitly updated? (default: False)

◆ setup()

setup	(	self,
		order = `2`,
		F0 = `0.0`,
		full_domain = `False`
	)

Setup G-S solver.

Parameters

order	Order of FE representation to use
F0	Vacuum $F(\psi)$ value (B0*R0)

◆ setup_mesh()

setup_mesh	(	self,
		r = `None`,
		lc = `None`,
		reg = `None`,
		mesh_file = `None`
	)

Setup mesh for static and time-dependent G-S calculations.

A mesh should be specified by passing "r", "lc", and optionally "reg" or using a "mesh_file". When a region is specified the following ordering should apply:

1: Plasma region
2: Vacuum/air regions
3+: Conducting regions and coils

Parameters

r	Mesh point list [np,2]
lc	Mesh cell list [nc,3] (base one)
reg	Mesh region list [nc] (base one)
mesh_file	Filename containing mesh to load (native format only)

◆ setup_regions()

setup_regions	(	self,
		cond_dict = `{}`,
		coil_dict = `{}`
	)

Define mesh regions (coils and conductors)

Parameters

cond_dict Dictionary specifying conducting regions

◆ setup_td()

setup_td	(	self,
		dt,
		lin_tol,
		nl_tol,
		pre_plasma = `False`
	)

Setup the time-dependent G-S solver.

Parameters

dt	Starting time step
lin_tol	Tolerance for linear solver
nl_tol	Tolerance for non-linear solver
pre_plasma	Use plasma contributions in preconditioner (default: False)

◆ solve()

solve	(	self,
		vacuum = `False`
	)

Solve G-S equation with specified constraints, profiles, etc.

◆ step_td()

step_td	(	self,
		time,
		dt
	)

Compute eigenvalues for the time-dependent system.

Parameters

time	Growth rate enhancement point (should be approximately expected value)
dt	Number of eigenvalues to compute

Returns: new time, new dt, # of NL iterations, # of linear iterations, # of retries

◆ trace_surf()

trace_surf	(	self,
		psi
	)

Trace surface for a given poloidal flux.

Parameters

psi	Flux surface to trace $\hat{\psi}$

Returns: $r(\hat{\psi})$

◆ update_settings()

update_settings ( self )

Update settings after changes to values in python.

◆ vac_solve()

vac_solve	(	self,
		psi = `None`,
		rhs_source = `None`
	)

Solve for vacuum solution (no plasma), with present coil currents and optional other currents.

Parameters

psi	Boundary values for vacuum solve
rhs_source	Current source (optional)

Member Data Documentation

◆ _alam

_alam

protected

F*F' normalization value [1] (use alam property)

◆ _coil_dict

_coil_dict

protected

Coil definition dictionary.

◆ _cond_dict

_cond_dict

protected

Conductor definition dictionary.

◆ _diverted

_diverted

protected

Diverted (limited) flag [1] (use diverted property)

◆ _estore_target

_estore_target

protected

Stored energy target value (use set_targets)

◆ _F0

_F0

protected

Vacuum F value.

◆ _flux_targets

_flux_targets

protected

Flux constraint points (use set_flux)

◆ _Ip_ratio_target

_Ip_ratio_target

protected

Plasma current target ratio I_p(FF') / I_p(P') (use set_targets)

◆ _Ip_target

_Ip_target

protected

Plasma current target value (use set_targets)

◆ _isoflux_targets

_isoflux_targets

protected

Isoflux constraint points (use set_isoflux)

◆ _oft_in_dict

_oft_in_dict

protected

Input file settings.

◆ _pax_target

_pax_target

protected

Axis pressure target value (use set_targets)

◆ _pnorm

_pnorm

protected

Pressure normalization value [1] (use pnorm property)

◆ _R0_target

_R0_target

protected

R0 target value (use set_targets)

◆ _saddle_targets

_saddle_targets

protected

Saddle constraint points (use set_saddles)

◆ _V0_target

_V0_target

protected

V0 target value (use set_targets)

◆ _vac_dict

_vac_dict

protected

Vacuum definition dictionary.

◆ alam

alam

◆ coil_sets

coil_sets

Coil set definitions, including sub-coils.

◆ gs_obj

gs_obj

Internal Grad-Shafranov object (gs_eq)

◆ lc

lc

Mesh triangles [nc,3].

◆ lim_contour

lim_contour

Limiting contour.

◆ lim_contours

lim_contours

◆ lim_point

lim_point

Limiting point (limter or active X-point) [2].

◆ lim_pts

lim_pts

◆ nc

nc

Number of cells in mesh.

◆ ncoils

ncoils

Number of coils in mesh.

◆ np

np

Number of points in mesh.

◆ nregs

nregs

Number of regions in mesh.

◆ nvac

nvac

Number of vacuum regions in mesh.

◆ o_point

o_point

Location of O-point (magnetic axis) [2].

◆ pnorm

pnorm

◆ psi_bounds

psi_bounds

Bounding values for $\psi$ ( $\psi_a$, $\psi_0$) [2].

◆ psi_convention

psi_convention

Normalized flux convention (0 -> tokamak, 1 -> spheromak)

◆ r

r

Mesh vertices [np,3] (last column should be all zeros)

◆ reg

reg

Mesh regions [nc].

◆ settings

settings

General settings object.

◆ x_points

x_points

Location of X-points [20,2].

The documentation for this class was generated from the following file:

/home/runner/work/OpenFUSIONToolkit/OpenFUSIONToolkit/src/python/OpenFUSIONToolkit/TokaMaker/_core.py

psi	Explicit sampling locations in \(\hat{\psi}\)
psi_pad	End padding (axis and edge) for uniform sampling (ignored if `psi` is not None)
npsi	Number of points for uniform sampling (ignored if `psi` is not None)

f_file	File containing \(F*F'\) (or \(F'\) if `mode=0`) definition
foffset	Value of \(F0=R0*B0\)
p_file	File containing \(P'\) definition
eta_file	File containing $\eta$ definition
f_NI_file	File containing non-inductive \(F*F'\) definition

alam	Scale factor for \(F*F'\) term (disabled if `Ip` is set)
pnorm	Scale factor for \(P'\) term (disabled if `pax`, `estore`, or `R0` are set)
Ip	Target plasma current [A] (disabled if <0)
Ip_ratio	Amplitude of net plasma current contribution from FF' compared to P' (disabled if <-1.E98)
pax	Target axis pressure [Pa] (disabled if <0 or if `estore` is set)
estore	Target sotred energy [J] (disabled if <0)
R0	Target major radius for magnetic axis (disabled if <0 or if `pax` or `estore` are set)
V0	Target vertical position for magnetic axis (disabled if <-1.E98)
retain_previous	Keep previously set targets unless explicitly updated? (default: False)

order	Order of FE representation to use
F0	Vacuum \(F(\psi)\) value (B0*R0)

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _update_oft_in()

◆ alam() [1/2]

◆ alam() [2/2]

◆ area_integral()

◆ calc_loopvoltage()

◆ diverted()

◆ eig_td()

◆ eig_wall()

◆ get_coil_currents()

◆ get_coil_Lmat()

◆ get_conductor_currents()

◆ get_conductor_source()

◆ get_delstar_curr()

◆ get_field_eval()

◆ get_globals()

◆ get_profiles()

◆ get_psi()

◆ get_q()

◆ get_stats()

◆ get_targets()

◆ get_vfixed()

◆ get_xpoints()

◆ init_psi()

◆ load_profiles()

◆ plot_constraints()

◆ plot_eddy()

◆ plot_machine()

◆ plot_psi()

◆ pnorm() [1/2]

◆ pnorm() [2/2]

◆ print_info()

◆ reset()

◆ sauter_fc()

◆ save_eqdsk()

◆ set_coil_bounds()

◆ set_coil_currents()

◆ set_coil_reg()

◆ set_coil_vsc()

◆ set_flux()

◆ set_isoflux()

◆ set_profiles()

◆ set_psi()

◆ set_psi_dt()

◆ set_resistivity()

◆ set_saddles()

◆ set_targets()

◆ setup()

◆ setup_mesh()

◆ setup_regions()

◆ setup_td()

◆ solve()

◆ step_td()

◆ trace_surf()

◆ update_settings()

◆ vac_solve()

Member Data Documentation

◆ _alam

◆ _coil_dict

◆ _cond_dict

◆ _diverted

◆ _estore_target

◆ _F0

◆ _flux_targets

◆ _Ip_ratio_target

◆ _Ip_target

◆ _isoflux_targets

◆ _oft_in_dict

◆ _pax_target

◆ _pnorm

◆ _R0_target

◆ _saddle_targets

◆ _V0_target

◆ init()