tokamaker_f Module Reference

Detailed Description

Fortran part of Python wrapper for Grad-Shafranov functionality.

Authors

Chris Hansen

Date

May 2023

Data Types
type	tokamaker_recon_settings_type
	Needs docs. More...
type	tokamaker_settings_type
	Needs docs. More...

Functions/Subroutines
subroutine	tokamaker_alloc (gs_obj)
	Needs docs.
subroutine	tokamaker_analyze ()
	Needs docs.
subroutine	tokamaker_apply_field_eval (int_obj, int_type, pt, fbary_tol, cell, dim, field)
	Evaluate a TokaMaker field with an interpolation object created by tokamaker_f::tokamaker_get_field_eval.
subroutine	tokamaker_area_int (vec_vals, reg_ind, result)
	Needs docs.
subroutine	tokamaker_eig_td (omega, neigs, eigs, eig_vecs, include_bounds, pm)
	Needs docs.
subroutine	tokamaker_eig_wall (neigs, eigs, eig_vecs, pm)
	Needs docs.
subroutine	tokamaker_eval_green (n, r, z, rc, zc, vals)
	Needs docs.
subroutine	tokamaker_get_coil_currents (currents, reg_currents)
	Needs docs.
subroutine	tokamaker_get_coil_lmat (lmat)
	Needs docs.
subroutine	tokamaker_get_dels_curr (psi_vals)
	Needs docs.
subroutine	tokamaker_get_field_eval (imode, int_obj, error_str)
	Create an interpolation object for tokamaker fields.
subroutine	tokamaker_get_globals (itor, centroid, vol, pvol, dflux, tflux, bp_vol)
	Needs docs.
subroutine	tokamaker_get_limiter (np, r_loc, nloops, loop_ptr)
	Needs docs.
subroutine	tokamaker_get_mesh (np, r_loc, nc, lc_loc, reg_loc)
	Needs docs.
subroutine	tokamaker_get_profs (npsi, psi_in, f, fp, p, pp)
	Needs docs.
subroutine	tokamaker_get_psi (psi_vals, psi_lim, psi_max)
	Needs docs.
subroutine	tokamaker_get_q (npsi, psi_q, qvals, ravgs, dl, rbounds, zbounds)
	Needs docs.
subroutine	tokamaker_get_refs (o_point, lim_point, x_points, diverted, plasma_bounds, alam, pnorm)
	Needs docs.
subroutine	tokamaker_get_vfixed (npts, pts, fluxes)
	Needs docs.
subroutine	tokamaker_gs_calc_vloop (vloop)
	Needs docs.
subroutine	tokamaker_init_psi (r0, z0, a, kappa, delta, rhs_source, ierr)
	Needs docs.
subroutine	tokamaker_load_profiles (f_file, f_offset, p_file, eta_file, f_ni_file)
	Needs docs.
subroutine	tokamaker_recon_run (vacuum, settings, error_flag)
	Needs docs.
subroutine	tokamaker_reset (error_str)
	Needs docs.
subroutine	tokamaker_sauter_fc (npsi, psi_saut, fc, r_avgs, modb_avgs)
	Needs docs.
subroutine	tokamaker_save_eqdsk (filename, nr, nz, rbounds, zbounds, run_info, psi_pad, rcentr, trunc_eq, lim_filename, error_str)
	Needs docs.
subroutine	tokamaker_set_coil_bounds (coil_bounds)
	Needs docs.
subroutine	tokamaker_set_coil_currents (currents)
	Needs docs.
subroutine	tokamaker_set_coil_regmat (nregularize, coil_reg_mat, coil_reg_targets, coil_reg_weights)
	Needs docs.
subroutine	tokamaker_set_coil_vsc (coil_gains)
	Needs docs.
subroutine	tokamaker_set_flux (locations, targets, weights, ntargets, grad_wt_lim)
	Needs docs.
subroutine	tokamaker_set_isoflux (targets, weights, ntargets, grad_wt_lim)
	Needs docs.
subroutine	tokamaker_set_psi (psi_vals)
	Needs docs.
subroutine	tokamaker_set_psi_dt (psi_vals, dt)
	Needs docs.
subroutine	tokamaker_set_saddles (targets, weights, ntargets)
	Needs docs.
subroutine	tokamaker_set_settings (settings)
	Needs docs.
subroutine	tokamaker_set_targets (ip_target, ip_ratio_target, pax_target, estore_target, r0_target, v0_target)
	Needs docs.
subroutine	tokamaker_setup (order, full_domain, ncoils, error_str)
	Needs docs.
subroutine	tokamaker_setup_regions (coil_file, reg_eta, contig_flag, xpoint_mask, coil_nturns, ncoils)
	Needs docs.
subroutine	tokamaker_setup_td (dt, lin_tol, nl_tol, pre_plasma)
	Needs docs.
subroutine	tokamaker_solve (error_flag)
	Needs docs.
subroutine	tokamaker_step_td (time, dt, nl_its, lin_its, nretry)
	Needs docs.
subroutine	tokamaker_trace_surf (psi_surf, points, npoints)
	Needs docs.
subroutine	tokamaker_vac_solve (psi_in, rhs_source, error_flag)
	Needs docs.

Variables
type(gs_eq), pointer	gs_global => NULL()
	Global G-S object.
type(oft_tmaker_td), pointer	gs_td_global => NULL()
	Global time-dependent object.
integer(i4), dimension(:,:), pointer	lc_plot => NULL()
	Needs docs.
real(r8), dimension(:,:), pointer	r_plot => NULL()
	Needs docs.
integer(i4), dimension(:), pointer	reg_plot => NULL()
	Needs docs.

Function/Subroutine Documentation

tokamaker_alloc()

subroutine tokamaker_alloc

(

type(c_ptr), intent(out)

gs_obj

)

Needs docs.

Parameters

[out]

gs_obj

Needs docs

tokamaker_analyze()

subroutine tokamaker_analyze

Needs docs.

tokamaker_apply_field_eval()

subroutine tokamaker_apply_field_eval	(	type(c_ptr), intent(in), value	int_obj,
		integer(c_int), intent(in), value	int_type,
		real(c_double), dimension(3), intent(in)	pt,
		real(c_double), intent(in), value	fbary_tol,
		integer(c_int), intent(inout)	cell,
		integer(c_int), intent(in), value	dim,
		real(c_double), dimension(dim), intent(out)	field
	)

Evaluate a TokaMaker field with an interpolation object created by tokamaker_f::tokamaker_get_field_eval.

Parameters

[in]	int_obj	Pointer to interpolation object
[in]	int_type	Field type (negative to destroy)
[in]	pt	Location for evaluation [R,Z,0]
[in]	fbary_tol	Tolerance for physical to logical mapping
[in,out]	cell	Cell containing pt (starting guess on input)
[in]	dim	Dimension of field
[out]	field	Field at pt

tokamaker_area_int()

subroutine tokamaker_area_int	(	type(c_ptr), intent(in), value	vec_vals,
		integer(c_int), intent(in), value	reg_ind,
		real(c_double), intent(out)	result
	)

Needs docs.

Parameters

[in]	vec_vals	Needs docs
[in]	reg_ind	Needs docs
[out]	result	Needs docs

tokamaker_eig_td()

subroutine tokamaker_eig_td	(	real(c_double), intent(in), value	omega,
		integer(c_int), intent(in), value	neigs,
		type(c_ptr), intent(in), value	eigs,
		type(c_ptr), intent(in), value	eig_vecs,
		logical(c_bool), intent(in), value	include_bounds,
		logical(c_bool), intent(in), value	pm
	)

Needs docs.

Parameters

[in]	omega	Needs docs
[in]	neigs	Needs docs
[in]	eigs	Needs docs
[in]	eig_vecs	Needs docs
[in]	include_bounds	Needs docs
[in]	pm	Needs docs

tokamaker_eig_wall()

subroutine tokamaker_eig_wall	(	integer(c_int), intent(in), value	neigs,
		type(c_ptr), intent(in), value	eigs,
		type(c_ptr), intent(in), value	eig_vecs,
		logical(c_bool), intent(in), value	pm
	)

Needs docs.

Parameters

[in]	neigs	Needs docs
[in]	eigs	Needs docs
[in]	eig_vecs	Needs docs
[in]	pm	Needs docs

tokamaker_eval_green()

subroutine tokamaker_eval_green	(	integer(c_int), intent(in), value	n,
		type(c_ptr), intent(in), value	r,
		type(c_ptr), intent(in), value	z,
		real(c_double), intent(in), value	rc,
		real(c_double), intent(in), value	zc,
		type(c_ptr), intent(in), value	vals
	)

Needs docs.

Parameters

[in]	n	Needs docs
[in]	rc	Needs docs
[in]	zc	Needs docs
[in]	r	Needs docs
[in]	z	Needs docs
[in]	vals	Needs docs

tokamaker_get_coil_currents()

subroutine tokamaker_get_coil_currents	(	type(c_ptr), intent(in), value	currents,
		type(c_ptr), intent(in), value	reg_currents
	)

Needs docs.

Parameters

[in]	currents	Needs docs
[in]	reg_currents	Needs docs

tokamaker_get_coil_lmat()

subroutine tokamaker_get_coil_lmat

(

type(c_ptr), intent(in), value

lmat

)

Needs docs.

Parameters

[in]

lmat

Needs docs

tokamaker_get_dels_curr()

subroutine tokamaker_get_dels_curr

(

type(c_ptr), intent(in), value

psi_vals

)

Needs docs.

Parameters

[in]

psi_vals

Needs docs

tokamaker_get_field_eval()

subroutine tokamaker_get_field_eval	(	integer(kind=c_int), intent(in), value	imode,
		type(c_ptr), intent(out)	int_obj,
		character(kind=c_char), dimension(80), intent(out)	error_str
	)

Create an interpolation object for tokamaker fields.

Parameters

[in]	imode	Field type
[out]	int_obj	Pointer to interpolation object
[out]	error_str	Error string (unused)

tokamaker_get_globals()

subroutine tokamaker_get_globals	(	real(c_double), intent(out)	itor,
		real(c_double), dimension(2), intent(out)	centroid,
		real(c_double), intent(out)	vol,
		real(c_double), intent(out)	pvol,
		real(c_double), intent(out)	dflux,
		real(c_double), intent(out)	tflux,
		real(c_double), intent(out)	bp_vol
	)

Needs docs.

Parameters

[out]	itor	Needs docs
[out]	centroid	Needs docs
[out]	vol	Needs docs
[out]	pvol	Needs docs
[out]	dflux	Needs docs
[out]	tflux	Needs docs
[out]	bp_vol	Needs docs

tokamaker_get_limiter()

subroutine tokamaker_get_limiter	(	integer(c_int), intent(out)	np,
		type(c_ptr), intent(out)	r_loc,
		integer(c_int), intent(out)	nloops,
		type(c_ptr), intent(out)	loop_ptr
	)

Needs docs.

Parameters

[out]	r_loc	Needs docs
[out]	loop_ptr	Needs docs
[out]	np	Needs docs
[out]	nloops	Needs docs

tokamaker_get_mesh()

subroutine tokamaker_get_mesh	(	integer(c_int), intent(out)	np,
		type(c_ptr), intent(out)	r_loc,
		integer(c_int), intent(out)	nc,
		type(c_ptr), intent(out)	lc_loc,
		type(c_ptr), intent(out)	reg_loc
	)

Needs docs.

Parameters

[out]	lc_loc	Needs docs
[out]	r_loc	Needs docs
[out]	reg_loc	Needs docs
[out]	np	Needs docs
[out]	nc	Needs docs

tokamaker_get_profs()

subroutine tokamaker_get_profs	(	integer(c_int), intent(in), value	npsi,
		real(c_double), dimension(npsi), intent(in)	psi_in,
		real(c_double), dimension(npsi), intent(out)	f,
		real(c_double), dimension(npsi), intent(out)	fp,
		real(c_double), dimension(npsi), intent(out)	p,
		real(c_double), dimension(npsi), intent(out)	pp
	)

Needs docs.

Parameters

[in]	npsi	Needs docs
[in]	psi_in	Needs docs
[out]	f	Needs docs
[out]	fp	Needs docs
[out]	p	Needs docs
[out]	pp	Needs docs

tokamaker_get_psi()

subroutine tokamaker_get_psi	(	type(c_ptr), intent(in), value	psi_vals,
		real(c_double), intent(out)	psi_lim,
		real(c_double), intent(out)	psi_max
	)

Needs docs.

Parameters

[in]	psi_vals	Needs docs
[out]	psi_lim	Needs docs
[out]	psi_max	Needs docs

tokamaker_get_q()

subroutine tokamaker_get_q	(	integer(c_int), intent(in), value	npsi,
		real(c_double), dimension(npsi), intent(in)	psi_q,
		real(c_double), dimension(npsi), intent(out)	qvals,
		real(c_double), dimension(npsi,2), intent(out)	ravgs,
		real(c_double), intent(out)	dl,
		real(c_double), dimension(2,2), intent(out)	rbounds,
		real(c_double), dimension(2,2), intent(out)	zbounds
	)

Needs docs.

Parameters

[in]	npsi	Needs docs
[in]	psi_q	Needs docs
[out]	qvals	Needs docs
[out]	ravgs	Needs docs
[out]	dl	Needs docs
[out]	rbounds	Needs docs
[out]	zbounds	Needs docs

tokamaker_get_refs()

subroutine tokamaker_get_refs	(	type(c_ptr), intent(out)	o_point,
		type(c_ptr), intent(out)	lim_point,
		type(c_ptr), intent(out)	x_points,
		type(c_ptr), intent(out)	diverted,
		type(c_ptr), intent(out)	plasma_bounds,
		type(c_ptr), intent(out)	alam,
		type(c_ptr), intent(out)	pnorm
	)

Needs docs.

Parameters

[out]	o_point	Needs docs
[out]	lim_point	Needs docs
[out]	x_points	Needs docs
[out]	diverted	Needs docs
[out]	plasma_bounds	Needs docs
[out]	alam	Needs docs
[out]	pnorm	Needs docs

tokamaker_get_vfixed()

subroutine tokamaker_get_vfixed	(	integer(c_int), intent(out)	npts,
		type(c_ptr), intent(out)	pts,
		type(c_ptr), intent(out)	fluxes
	)

Needs docs.

Parameters

[out]	npts	Needs docs
[out]	pts	Needs docs
[out]	fluxes	Needs docs

tokamaker_gs_calc_vloop()

subroutine tokamaker_gs_calc_vloop

(

real(c_double), intent(out)

vloop

)

Needs docs.

tokamaker_init_psi()

subroutine tokamaker_init_psi	(	real(c_double), intent(in), value	r0,
		real(c_double), intent(in), value	z0,
		real(c_double), intent(in), value	a,
		real(c_double), intent(in), value	kappa,
		real(c_double), intent(in), value	delta,
		type(c_ptr), intent(in), value	rhs_source,
		integer(c_int), intent(out)	ierr
	)

Needs docs.

Parameters

[in]	r0	Needs docs
[in]	z0	Needs docs
[in]	a	Needs docs
[in]	kappa	Needs docs
[in]	delta	Needs docs
[in]	rhs_source	Current source term (optional)
[out]	ierr	Needs docs

tokamaker_load_profiles()

subroutine tokamaker_load_profiles	(	character(kind=c_char), dimension(80), intent(in)	f_file,
		real(c_double), intent(in), value	f_offset,
		character(kind=c_char), dimension(80), intent(in)	p_file,
		character(kind=c_char), dimension(80), intent(in)	eta_file,
		character(kind=c_char), dimension(80), intent(in)	f_ni_file
	)

Needs docs.

Parameters

[in]	f_file	F*F' prof.in file
[in]	p_file	P' prof.in file
[in]	eta_file	Resistivity (eta) prof.in file
[in]	f_ni_file	Non-inductive F*F' prof.in file
[in]	f_offset	Needs docs

tokamaker_recon_run()

subroutine tokamaker_recon_run	(	logical(c_bool), intent(in), value	vacuum,
		type(tokamaker_recon_settings_type), intent(in)	settings,
		integer(c_int), intent(out)	error_flag
	)

Needs docs.

Parameters

[in]	vacuum	Needs docs
[in]	settings	Needs docs
[out]	error_flag	Needs docs

tokamaker_reset()

subroutine tokamaker_reset

(

character(kind=c_char), dimension(80), intent(out)

error_str

)

Needs docs.

Parameters

[out]

error_str

Needs docs

tokamaker_sauter_fc()

subroutine tokamaker_sauter_fc	(	integer(c_int), intent(in), value	npsi,
		real(c_double), dimension(npsi), intent(in)	psi_saut,
		real(c_double), dimension(npsi), intent(out)	fc,
		real(c_double), dimension(npsi,3), intent(out)	r_avgs,
		real(c_double), dimension(npsi,2), intent(out)	modb_avgs
	)

Needs docs.

Parameters

[in]	npsi	Needs docs
[in]	psi_saut	Needs docs
[out]	fc	Needs docs
[out]	r_avgs	Needs docs
[out]	modb_avgs	Needs docs

tokamaker_save_eqdsk()

subroutine tokamaker_save_eqdsk	(	character(kind=c_char), dimension(80), intent(in)	filename,
		integer(c_int), intent(in), value	nr,
		integer(c_int), intent(in), value	nz,
		real(c_double), dimension(2), intent(in)	rbounds,
		real(c_double), dimension(2), intent(in)	zbounds,
		character(kind=c_char), dimension(40), intent(in)	run_info,
		real(c_double), intent(in), value	psi_pad,
		real(c_double), intent(in), value	rcentr,
		logical(c_bool), intent(in), value	trunc_eq,
		character(kind=c_char), dimension(80), intent(in)	lim_filename,
		character(kind=c_char), dimension(80), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	filename	Needs docs
[in]	run_info	Needs docs
[in]	nr	Needs docs
[in]	nz	Needs docs
[in]	rbounds	Needs docs
[in]	zbounds	Needs docs
[in]	psi_pad	Needs docs
[in]	rcentr	Needs docs
[in]	trunc_eq	Needs docs
[in]	lim_filename	Needs docs
[out]	error_str	Needs docs

tokamaker_set_coil_bounds()

subroutine tokamaker_set_coil_bounds

(

type(c_ptr), intent(in), value

coil_bounds

)

Needs docs.

Parameters

[in]

coil_bounds

Needs docs

tokamaker_set_coil_currents()

subroutine tokamaker_set_coil_currents

(

type(c_ptr), intent(in), value

currents

)

Needs docs.

Parameters

[in]

currents

Needs docs

tokamaker_set_coil_regmat()

subroutine tokamaker_set_coil_regmat	(	integer(c_int), intent(in), value	nregularize,
		type(c_ptr), intent(in), value	coil_reg_mat,
		type(c_ptr), intent(in), value	coil_reg_targets,
		type(c_ptr), intent(in), value	coil_reg_weights
	)

Needs docs.

Parameters

[in]	nregularize	Needs docs
[in]	coil_reg_mat	Needs docs
[in]	coil_reg_targets	Needs docs
[in]	coil_reg_weights	Needs docs

tokamaker_set_coil_vsc()

subroutine tokamaker_set_coil_vsc

(

type(c_ptr), intent(in), value

coil_gains

)

Needs docs.

Parameters

[in]

coil_gains

Needs docs

tokamaker_set_flux()

subroutine tokamaker_set_flux	(	real(c_double), dimension(2,ntargets), intent(in)	locations,
		real(c_double), dimension(ntargets), intent(in)	targets,
		real(c_double), dimension(ntargets), intent(in)	weights,
		integer(c_int), intent(in), value	ntargets,
		real(c_double), intent(in), value	grad_wt_lim
	)

Needs docs.

Parameters

[in]	locations	Needs docs
[in]	targets	Needs docs
[in]	weights	Needs docs
[in]	ntargets	Needs docs
[in]	grad_wt_lim	Needs docs

tokamaker_set_isoflux()

subroutine tokamaker_set_isoflux	(	real(c_double), dimension(2,ntargets), intent(in)	targets,
		real(c_double), dimension(ntargets), intent(in)	weights,
		integer(c_int), intent(in), value	ntargets,
		real(c_double), intent(in), value	grad_wt_lim
	)

Needs docs.

Parameters

[in]	targets	Needs docs
[in]	weights	Needs docs
[in]	ntargets	Needs docs
[in]	grad_wt_lim	Needs docs

tokamaker_set_psi()

subroutine tokamaker_set_psi

(

type(c_ptr), intent(in), value

psi_vals

)

Needs docs.

Parameters

[in]

psi_vals

Needs docs

tokamaker_set_psi_dt()

subroutine tokamaker_set_psi_dt	(	type(c_ptr), intent(in), value	psi_vals,
		real(c_double), intent(in), value	dt
	)

Needs docs.

Parameters

[in]	psi_vals	Needs docs
[in]	dt	Needs docs

tokamaker_set_saddles()

subroutine tokamaker_set_saddles	(	real(c_double), dimension(2,ntargets), intent(in)	targets,
		real(c_double), dimension(ntargets), intent(in)	weights,
		integer(c_int), intent(in), value	ntargets
	)

Needs docs.

Parameters

[in]	targets	Needs docs
[in]	weights	Needs docs
[in]	ntargets	Needs docs

tokamaker_set_settings()

subroutine tokamaker_set_settings

(

type(tokamaker_settings_type), intent(in)

settings

)

Needs docs.

Parameters

[in]

settings

Needs docs

tokamaker_set_targets()

subroutine tokamaker_set_targets	(	real(c_double), intent(in), value	ip_target,
		real(c_double), intent(in), value	ip_ratio_target,
		real(c_double), intent(in), value	pax_target,
		real(c_double), intent(in), value	estore_target,
		real(c_double), intent(in), value	r0_target,
		real(c_double), intent(in), value	v0_target
	)

Needs docs.

Parameters

[in]	ip_target	Needs docs
[in]	ip_ratio_target	Needs docs
[in]	pax_target	Needs docs
[in]	estore_target	Needs docs
[in]	r0_target	Needs docs
[in]	v0_target	Needs docs

tokamaker_setup()

subroutine tokamaker_setup	(	integer(kind=c_int), intent(in), value	order,
		logical(kind=c_bool), intent(in), value	full_domain,
		integer(kind=c_int), intent(out)	ncoils,
		character(kind=c_char), dimension(80), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	order	Needs docs
[in]	full_domain	Needs docs
[out]	ncoils	Needs docs
[out]	error_str	Needs docs

tokamaker_setup_regions()

subroutine tokamaker_setup_regions	(	character(kind=c_char), dimension(80), intent(in)	coil_file,
		type(c_ptr), intent(in), value	reg_eta,
		type(c_ptr), intent(in), value	contig_flag,
		type(c_ptr), intent(in), value	xpoint_mask,
		type(c_ptr), intent(in), value	coil_nturns,
		integer(c_int), intent(in), value	ncoils
	)

Needs docs.

Parameters

[in]	coil_file	Needs docs
[in]	reg_eta	Needs docs
[in]	contig_flag	Needs docs
[in]	xpoint_mask	Needs docs
[in]	coil_nturns	Needs docs
[in]	ncoils	Needs docs

tokamaker_setup_td()

subroutine tokamaker_setup_td	(	real(c_double), intent(in), value	dt,
		real(c_double), intent(in), value	lin_tol,
		real(c_double), intent(in), value	nl_tol,
		logical(c_bool), intent(in), value	pre_plasma
	)

Needs docs.

Parameters

[in]	dt	Needs docs
[in]	lin_tol	Needs docs
[in]	nl_tol	Needs docs
[in]	pre_plasma	Needs docs

tokamaker_solve()

subroutine tokamaker_solve

(

integer(c_int), intent(out)

error_flag

)

Needs docs.

Parameters

[out]

error_flag

Error flag

tokamaker_step_td()

subroutine tokamaker_step_td	(	real(c_double), intent(inout)	time,
		real(c_double), intent(inout)	dt,
		integer(c_int), intent(out)	nl_its,
		integer(c_int), intent(out)	lin_its,
		integer(c_int), intent(out)	nretry
	)

Needs docs.

Parameters

[in,out]	time	Needs docs
[in,out]	dt	Needs docs
[out]	nl_its	Needs docs
[out]	lin_its	Needs docs
[out]	nretry	Needs docs

tokamaker_trace_surf()

subroutine tokamaker_trace_surf	(	real(c_double), intent(in), value	psi_surf,
		type(c_ptr), intent(out)	points,
		integer(c_int), intent(out)	npoints
	)

Needs docs.

Parameters

[in]	psi_surf	Needs docs
[out]	points	Needs docs
[out]	npoints	Needs docs

tokamaker_vac_solve()

subroutine tokamaker_vac_solve	(	type(c_ptr), intent(in), value	psi_in,
		type(c_ptr), intent(in), value	rhs_source,
		integer(c_int), intent(out)	error_flag
	)

Needs docs.

Parameters

[in]	psi_in	Input: BCs for \( \psi \), Output: solution
[in]	rhs_source	Current source term (optional)
[out]	error_flag	Error flag

Variable Documentation

gs_global

type(gs_eq), pointer gs_global => NULL()

Global G-S object.

gs_td_global

type(oft_tmaker_td), pointer gs_td_global => NULL()

Global time-dependent object.

lc_plot

integer(i4), dimension(:,:), pointer lc_plot => NULL()

Needs docs.

r_plot

real(r8), dimension(:,:), pointer r_plot => NULL()

Needs docs.

reg_plot

integer(i4), dimension(:), pointer reg_plot => NULL()

Needs docs.