OpenFUSIONToolkit.TokaMaker._core Namespace Reference

Detailed Description

Core definitions for TokaMaker Grad-Shafranov functionality.

Authors

Chris Hansen

Date

May 2023

Classes
class	TokaMaker
	TokaMaker G-S solver class. More...

Functions
	create_prof_file (self, filename, profile_dict, name)
	Create profile input file to be read by load_profiles()
	solve_with_bootstrap (self, ne, Te, ni, Ti, inductive_jtor, Zeff, jBS_scale=1.0, Zis=[1.], max_iterations=6, initialize_eq=True)
	Self-consistently compute bootstrap contribution from H-mode profiles, and iterate solution until all functions of Psi converge.
	tokamaker_default_settings (oft_env)
	Initialize settings object with default values.

Variables
	psi_convention

Function Documentation

create_prof_file()

create_prof_file	(		self,
			filename,
			profile_dict,
			name
	)

Create profile input file to be read by load_profiles()

Parameters

filename	Name of input file, see options in set_profiles()
profile_dict	Dictionary object containing profile values ['y'] and sampled locations in normalized Psi ['x']
filename	Name of input quantity, see options in set_profiles()

solve_with_bootstrap()

solve_with_bootstrap	(		self,
			ne,
			Te,
			ni,
			Ti,
			inductive_jtor,
			Zeff,
			jBS_scale = 1.0,
			Zis = [1.],
			max_iterations = 6,
			initialize_eq = True
	)

Self-consistently compute bootstrap contribution from H-mode profiles, and iterate solution until all functions of Psi converge.

Note

if using nis and Zis, dnis_dpsi must be specified in sauter_bootstrap() as a list of impurity gradients over Psi. See https://omfit.io/_modules/omfit_classes/utils_fusion.html for more detailed documentation

if initialize_eq=True, cubic polynomials will be fit to the core of all kinetic profiles in order to flatten the pedestal. This will initialize the G-S solution at an estimated L-mode pressure profile and using the L-mode bootstrap contribution. Initializing the solver in L-mode before raising the pedestal height increases the likelihood that the solver will converge in H-mode.

Parameters

ne	Electron density profile, sampled over psi_norm
Te	Electron temperature profile [eV], sampled over psi_norm
ni	Ion density profile, sampled over psi_norm
Ti	Ion temperature profile [eV], sampled over psi_norm
inductive_jtor	Inductive toroidal current, sampled over psi_norm
Zeff	Effective Z profile, sampled over psi_norm
scale_jBS	Scalar which can scale bootstrap current profile
nis	List of impurity density profiles; NOT USED
Zis	List of impurity profile atomic numbers; NOT USED.
max_iterations	Maximum number of H-mode mygs.solve() iterations
initialize_eq	Initialize equilibrium solve with flattened pedestal.
return_jBS	Return bootstrap profile alongside err_flag

tokamaker_default_settings()

tokamaker_default_settings

(

oft_env

)

Initialize settings object with default values.

Parameters

oft_env

Current runtime environment

Returns

tokamaker_settings_struct object

Variable Documentation

psi_convention

psi_convention