Defines the base class of the type vmec_class. This module contains all the code necessary to interface V3FIT with VMEC. More...

Data Types
type	vmec_magnetic_cache
	Object to cache data needed to compute magnetic signals. More...

interface	vmec_class
	Base class representing a vmec_equilibrium. More...

interface	vmec_descent_class
	Extended gradient_descent_class. More...

interface	runvmec
	Forward declare the interface for runvmec. More...

Functions/Subroutines
subroutine	vmec_construct_sub (this, file_name, wout_file_name, ne, te, ti, sxrem, phi_offset, z_offset, pol_rad_ratio, iou, eq_comm, recon_comm, state_flags, force_solve)
	Construct a vmec_class object. More...

type(vmec_class) function, pointer	vmec_construct (file_name, wout_file_name, ne, te, ti, sxrem, phi_offset, z_offset, pol_rad_ratio, iou, eq_comm, recon_comm, state_flags, force_solve)
	Construct a vmec_class object. More...

class(vmec_descent_class) function, pointer	vmec_descent_construct (t0, u0, dx, x0)
	Construct a vmec_descent_class. More...

subroutine	vmec_destruct (this)
	Deconstruct a vmec_class object. More...

subroutine	vmec_set_param (this, id, i_index, j_index, value, eq_comm, state_flags)
	Sets the value of a reconstruction equilibrium parameter. More...

subroutine	vmec_set_magnetic_cache_response (this, response_object, state_flags)
	Set magnetic cache for plasma resonce. More...

subroutine	vmec_set_magnetic_cache_point (this, use_axi, state_flags)
	Set magnetic cache initialy. More...

subroutine	vmec_set_magnetic_cache_calc (this)
	Set magnetic cache initialy. More...

subroutine	vmec_set_namelist (this)
	Sets namelist variables from the solved VMEC equilibrium. More...

character(len=data_name_length) function	vmec_get_type (this)
	Gets a discription of the equilibrium type. More...

integer function	vmec_get_param_id (this, param_name)
	Get the id for a reconstruction parameter. More...

real(rprec) function	vmec_get_param_value (this, id, i_index, j_index)
	Get the value of a reconstruction VMEC parameter. More...

character(len=data_name_length) function	vmec_get_param_name (this, id)
	Get the name of a reconstruction VMEC parameter. More...

integer function	vmec_get_gp_ne_num_hyper_param (this)
	Get the number of electron density gp kernel hyper parameters. More...

real(rprec) function, dimension(:), pointer	vmec_get_ne_af (this)
	Gets the electron density profile af array. More...

real(rprec) function	vmec_get_gp_ne_ij (this, i, j)
	Get the electron density gp kernel value for the two indicies. More...

real(rprec) function	vmec_get_gp_ne_pi (this, x_cart, i)
	Get the electron density gp kernel value for the position and index. More...

real(rprec) function	vmec_get_gp_ne_pp (this, x_cart, y_cart)
	Get the electron density gp kernel value for the position and position. More...

real(rprec) function	vmec_get_ne_cart (this, x_cart)
	Gets the electron density at a cartesian position. More...

real(rprec) function	vmec_get_ne_radial (this, s)
	Gets the electron density at a s position. More...

integer function	vmec_get_gp_te_num_hyper_param (this)
	Get the number of electron temperature gp kernel hyper parameters. More...

real(rprec) function, dimension(:), pointer	vmec_get_te_af (this)
	Gets the electron temperature profile af array. More...

real(rprec) function	vmec_get_gp_te_ij (this, i, j)
	Get the electron temperature gp kernel value for the two indicies. More...

real(rprec) function	vmec_get_gp_te_pi (this, x_cart, i)
	Get the electron temperature gp kernel value for the position and index. More...

real(rprec) function	vmec_get_gp_te_pp (this, x_cart, y_cart)
	Get the electron temperature gp kernel value for the position and position. More...

real(rprec) function	vmec_get_te_cart (this, x_cart)
	Gets the electron temperature at a cartesian position. More...

real(rprec) function	vmec_get_te_radial (this, s)
	Gets the electron temperature at a s position. More...

integer function	vmec_get_gp_ti_num_hyper_param (this)
	Get the number of ion temperature gp kernel hyper parameters. More...

real(rprec) function, dimension(:), pointer	vmec_get_ti_af (this)
	Gets the ion temperature profile af array. More...

real(rprec) function	vmec_get_gp_ti_ij (this, i, j)
	Get the ion temperature gp kernel value for the two indicies. More...

real(rprec) function	vmec_get_gp_ti_pi (this, x_cart, i)
	Get the ion temperature gp kernel value for the position and index. More...

real(rprec) function	vmec_get_gp_ti_pp (this, x_cart, y_cart)
	Get the ion temperature gp kernel value for the position and position. More...

real(rprec) function	vmec_get_ti_cart (this, x_cart)
	Gets the ion temperature at a cartesian position. More...

real(rprec) function	vmec_get_ti_radial (this, s)
	Gets the ion temperature at a s position. More...

integer function	vmec_get_gp_sxrem_num_hyper_param (this, index)
	Get the number of soft x-ray emission gp kernel hyper parameters. More...

real(rprec) function, dimension(:), pointer	vmec_get_sxrem_af (this, index)
	Gets the soft x-ray emissivity profile af array. More...

real(rprec) function	vmec_get_gp_sxrem_ij (this, i, j, index)
	Get the soft x-ray emissivity gp kernel value for the two indicies. More...

real(rprec) function	vmec_get_gp_sxrem_pi (this, x_cart, i, index)
	Get the soft x-ray emissivity gp kernel value for the position and index. More...

real(rprec) function	vmec_get_gp_sxrem_pp (this, x_cart, y_cart, index)
	Get the soft x-ray emissivity gp kernel value for the position and position. More...

real(rprec) function	vmec_get_sxrem_cart (this, x_cart, index)
	Gets the soft x-ray emissivity at a cartesian position. More...

real(rprec) function	vmec_get_sxrem_radial (this, s, index)
	Gets the soft x-ray emissivity at a s position. More...

real(rprec) function	vmec_get_p_cart (this, x_cart, normalize)
	Gets the plasma pressure at a cartesian position. More...

real(rprec) function	vmec_get_p_radial (this, s, normalize)
	Gets the plasma pressure at a s position. More...

real(rprec) function, dimension(3)	vmec_get_b_vec (this, x_cart, cyl)
	Gets the magnetic field vector at a position. More...

real(rprec) function	vmec_get_int_b_dphi (this, s, theta)
	Gets the loop integrated magnetic field at a position. More...

real(rprec) function, dimension(3)	vmec_get_suv (this, x_cart)
	Gets VMEC suv position. More...

real(rprec) function	vmec_get_s (this, x_cart)
	Gets VMEC s value at position. More...

real(rprec) function	vmec_get_flux (this, x_cart)
	Gets VMEC normalized flux value at position. More...

integer function	vmec_get_plasma_edge (this, phi, r, z)
	Gets the r and z positions of the outer surface at a toroidal angle. More...

real(rprec) function, dimension(:,:,:), pointer	vmec_get_magnetic_volume_rgrid (this)
	Get volume magnetic volume integration radial grid points. More...

real(rprec) function, dimension(:,:,:), pointer	vmec_get_magnetic_volume_zgrid (this)
	Get volume magnetic volume integration z grid points. More...

real(rprec) function, dimension(:,:,:), pointer	vmec_get_magnetic_volume_jrgrid (this)
	Get volume magnetic volume integration jr grid points. More...

real(rprec) function, dimension(:,:,:), pointer	vmec_get_magnetic_volume_jphigrid (this)
	Get volume magnetic volume integration jphi grid points. More...

real(rprec) function, dimension(:,:,:), pointer	vmec_get_magnetic_volume_jzgrid (this)
	Get volume magnetic volume integration jz grid points. More...

real(rprec) function	vmec_get_volume_int_element (this)
	Get volume integration element. More...

real(rprec) function, dimension(:,:), pointer	vmec_get_con_surface_krgrid (this)
	Get the conducting surface integration kr grid points. More...

real(rprec) function, dimension(:,:), pointer	vmec_get_con_surface_kphigrid (this)
	Get the conducting surface integration kphi grid points. More...

real(rprec) function, dimension(:,:), pointer	vmec_get_con_surface_kzgrid (this)
	Get the conducting surface integration kz grid points. More...

real(rprec) function	vmec_get_area_int_element (this)
	Get area integration element. More...

real(rprec) function, dimension(:), pointer	vmec_get_ext_currents (this, num_currents, scale_currents)
	Get external current. More...

real(rprec) function, dimension(3)	vmec_get_b_vac (this, r_cyl)
	Gets the vacuum magnetic field vector at a position. More...

real(rprec) function, dimension(3)	vmec_get_ext_b_plasma (this, position, axi_only)
	Get external plasma magnetic field. More...

integer function	vmec_get_grid_size (this)
	Get radial grid size. More...

real(rprec) function	vmec_get_grid_start (this)
	Get start of the radial grid. More...

real(rprec) function	vmec_get_grid_stop (this)
	Get radial grid size. More...

logical function	vmec_is_scaler_value (this, id)
	Checks if a parameter id is a scaler value. More...

logical function	vmec_is_1d_array (this, id)
	Checks if a parameter id is a 1d array. More...

logical function	vmec_is_2d_array (this, id)
	Checks if a parameter id is a 2d array. More...

logical function	vmec_is_recon_param (this, id)
	Checks if a parameter id is a reconstruction parameter. More...

logical function	vmec_is_using_point (this)
	Checks if the point magnetics are being used. More...

logical function	vmec_has_vacuum_field (this)
	Determines if vacuum field information is available. More...

logical function	vmec_is_in_plasma (this, x_cart)
	Determines if a point is inside the plasma or outside. More...

type(vertex) function, pointer	vmec_limit_path_to_boundary (this, path)
	Limit an integration path to the boundary. More...

real(rprec) function, dimension(3)	vmec_gradient_descent (this, t, u, dx, x0)
	Gradient descent to minize the vmec_equilibrium::vmec_limit_chi. More...

subroutine	vmec_descent_chi2 (this, chi2)
	Function to compute chi value and it's gradients. More...

logical function	vmec_converge (this, num_iter, iou, eq_comm, state_flags)
	Solves the VMEC equilibrium. More...

subroutine	vmec_read_vac_file (this, index, eq_comm)
	Loads the vacuum magnetic field file. More...

subroutine	vmec_save_state (this)
	Save the internal state of the equilibrium. More...

subroutine	vmec_reset_state (this)
	Reset the internal state of the equilibrium. More...

subroutine	vmec_write (this, iou)
	Write out the equilibrium to an output file. More...

subroutine	vmec_write_input (this, current_step)
	Write the current valid input. More...

subroutine	vmec_def_result (this, result_ncid, maxnsetps_dim_id)
	Define NetCDF variables for the result file. More...

subroutine	vmec_write_init_data (this, result_ncid)
	Write inital data to NetCDF result file. More...

subroutine	vmec_write_step_data (this, result_ncid, current_step)
	Write step data to NetCDF result file. More...

subroutine	vmec_restart (this, result_ncid, current_step)
	Restart vmec from the result file. More...

subroutine	vmec_sync_state (this, recon_comm)
	Syncronize the vmec state to children. More...

subroutine	vmec_sync_child (this, index, recon_comm)
	Syncronize a child vmec state to the parent. More...

subroutine	vmec_reset_boundary (this)
	Reset the fixed boundary coefficients. More...

Variables
integer, parameter	vmec_ac_id = 13
	1D Array of function current profile parameters. Defined in vmec_input.

integer, parameter	vmec_ac_aux_s_id = 14
	1D Array of segment current profile s poitions. Defined in vmec_input.

integer, parameter	vmec_ac_aux_f_id = 15
	1D Array of segment current profile f values. Defined in vmec_input.

integer, parameter	vmec_ai_id = 16
	1D Array of function iotabar profile parameters. Defined in vmec_input.

integer, parameter	vmec_ai_aux_s_id = 17
	1D Array of segment iotabar profile s poitions. Defined in vmec_input.

integer, parameter	vmec_ai_aux_f_id = 18
	1D Array of segment iotabar profile f values. Defined in vmec_input.

integer, parameter	vmec_am_id = 19
	1D Array of function pressure profile parameters. Defined in vmec_input.

integer, parameter	vmec_am_aux_s_id = 20
	1D Array of segment pressure profile s poitions. Defined in vmec_input.

integer, parameter	vmec_am_aux_f_id = 21
	1D Array of segment pressure profile f values. Defined in vmec_input.

integer, parameter	vmec_bloat_id = 22
	Defined in vmec_input.

integer, parameter	vmec_rbc_id = 23
	2D Array of outer boundary R cosine coeffiecents. Defined in vmec_input.

integer, parameter	vmec_zbs_id = 24
	2D Array of outer boundary Z sine coeffiecents. Defined in vmec_input.

integer, parameter	vmec_rbs_id = 25
	2D Array of outer boundary R sine coeffiecents. Defined in vmec_input.

integer, parameter	vmec_zbc_id = 26
	2D Array of outer boundary Z cosine coeffiecents. Defined in vmec_input.

integer, parameter	vmec_extcur_id = 27
	1D Array of external currents. Defined in vmec_input.

integer, parameter	vmec_curtor_id = 28
	The toroidal current. Defined in vmec_input.

integer, parameter	vmec_phiedge_id = 29
	The edge magnetic flux. Defined in vmec_input.

integer, parameter	vmec_pres_scale_id = 30
	The scaling parameter for the pressure. Defined in vmec_input.

integer, parameter	vmec_rmnc_id = 31
	2D Array of surface R cosine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_zmns_id = 32
	2D Array of surface Z sine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_lmns_id = 33
	2D Array of surface lambda cosine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_gmnc_id = 34
	2D Array of surface g cosine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_bsubsmns_id = 35
	2D Array of surface B_s sine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_bsubumnc_id = 36
	2D Array of surface B_u cosine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_bsubvmnc_id = 37
	2D Array of surface B_v cosine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_bsupumnc_id = 38
	2D Array of surface B^u cosine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_bsupvmnc_id = 39
	2D Array of surface B^v cosine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_rmns_id = 40
	2D Array of surface R sine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_zmnc_id = 41
	2D Array of surface Z cosine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_lmnc_id = 42
	2D Array of surface lambda sine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_gmns_id = 43
	2D Array of surface g sine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_bsubsmnc_id = 44
	2D Array of surface B_s cosine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_bsubumns_id = 45
	2D Array of surface B_u sine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_bsubvmns_id = 46
	2D Array of surface B_v sine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_bsupumns_id = 47
	2D Array of surface B^u sine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_bsupvmns_id = 48
	2D Array of surface B^v sine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_phi_id = 49
	Defined in read_wout_mod.

integer, parameter	vmec_iotaf_id = 50
	1D Array of full grid iotabar. Defined in read_wout_mod.

integer, parameter	vmec_iotas_id = 51
	1D Array of half grid iotabar. Defined in read_wout_mod.

integer, parameter	vmec_raxis_cc_id = 52
	1D Array of magnetic axis R cosine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_raxis_cs_id = 53
	1D Array of magnetic axis R sine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_zaxis_cc_id = 54
	1D Array of magnetic axis Z cosine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_zaxis_cs_id = 55
	1D Array of magnetic axis Z sine coeffiecents. Defined in read_wout_mod.

integer, parameter	vmec_qfact_id = 56
	1D Array of full grid safety factor. Defined in read_wout_mod.

integer, parameter	vmec_pres_id = 57
	1D Array of full grid safety factor. Defined in read_wout_mod.

integer, parameter	vmec_presf_id = 58
	1D Array of full grid safety factor. Defined in read_wout_mod.

integer, parameter	vmec_pp_ne_b_id = 59
	1D Array of function density profile parameters. Defined in pprofile_T.

integer, parameter	vmec_pp_ne_as_id = 60
	1D Array of segment density profile s poitions. Defined in pprofile_T.

integer, parameter	vmec_pp_ne_af_id = 61
	1D Array of segment density profile f values. Defined in pprofile_T.

integer, parameter	vmec_pp_sxrem_b_id = 62
	1D Array of function sxrem profile parameters. Defined in pprofile_T.

integer, parameter	vmec_pp_sxrem_as_id = 63
	1D Array of segment sxrem profile s poitions. Defined in pprofile_T.

integer, parameter	vmec_pp_sxrem_af_id = 64
	1D Array of segment sxrem profile f values. Defined in pprofile_T.

integer, parameter	vmec_pp_te_b_id = 65
	1D Array of function electron temperature profile parameters. Defined in pprofile_T.

integer, parameter	vmec_pp_te_as_id = 66
	1D Array of segment electron temperature profile s poitions. Defined in pprofile_T.

integer, parameter	vmec_pp_te_af_id = 67
	1D Array of segment electron temperature profile f values. Defined in pprofile_T.

integer, parameter	vmec_pp_ti_b_id = 68
	1D Array of function ion temperature profile parameters. Defined in pprofile_T.

integer, parameter	vmec_pp_ti_as_id = 69
	1D Array of segment ion temperature profile s poitions. Defined in pprofile_T.

integer, parameter	vmec_pp_ti_af_id = 70
	1D Array of segment ion temperature profile f values. Defined in pprofile_T.

integer, parameter	vmec_vvc_smaleli_id = 71
	Internal inducance. Defined in v3f_vmec_comm. Computed in eqfor.

integer, parameter	vmec_vvc_kappa_p_id = 72
	Mean elongation. Defined in v3f_vmec_comm. Computed in eqfor.

integer, parameter	vmec_betatot_id = 73
	Total Beta. Defined in read_wout_mod.

integer, parameter	vmec_betapol_id = 74
	Poloidal Beta. Defined in read_wout_mod.

integer, parameter	vmec_betator_id = 75
	Toroidal Beta. Defined in read_wout_mod.

integer, parameter	vmec_betaxis_id = 76
	Beta on axis. Defined in read_wout_mod.

integer, parameter	vmec_jcuru_id = 77
	Poloidal current density. Defined in read_wout_mod.

integer, parameter	vmec_jcurv_id = 78
	Toroidal current density. Defined in read_wout_mod.

integer, parameter	vmec_jdotb_id = 79
	Current density in direction of b field. Defined in read_wout_mod.

integer, parameter	vmec_phi_offset_id = 80
	Plasma Phi offset. This is a parameter to allow changing the phi angle of a quasi helical state in an RFP. Defined in vmec_equilibrium.

integer, parameter	vmec_z_offset_id = 81
	Plasma z offset. This is a parameter to allow changing the vertical shift of the plasma.

integer, parameter	magnetic_cache_vc_min_grid_points = 101
	Virtual casing grid points for vacuum field measurements.

real(rprec), parameter	magnetic_cache_vc_grid_dim = 0.01
	Virtual casing grid dimension.

Detailed Description

Defines the base class of the type vmec_class. This module contains all the code necessary to interface V3FIT with VMEC.

Super Class:: equilibrium

Function/Subroutine Documentation

◆ vmec_construct()

type (vmec_class) function, pointer vmec_equilibrium::vmec_construct	(	character (len=*), intent(in)	file_name,
		character (len=*), intent(in)	wout_file_name,
		type (pprofile_class), pointer	ne,
		type (pprofile_class), pointer	te,
		type (pprofile_class), pointer	ti,
		type (pprofile_pointer), dimension(:), pointer	sxrem,
		real (rprec), intent(in)	phi_offset,
		real (rprec), intent(in)	z_offset,
		real (rprec), intent(in)	pol_rad_ratio,
		integer, intent(in)	iou,
		integer, intent(in)	eq_comm,
		integer, intent(in)	recon_comm,
		integer, intent(inout)	state_flags,
		logical, intent(in)	force_solve
	)

Construct a vmec_class object.

Allocates memory and initializes a vmec_class object.

Parameters

[in]	file_name	Filename of the vmec namelist input file.
[in]	wout_file_name	Filename of the vmec wout input file.
[in]	ne	pprofile_T for the electron density.
[in]	te	pprofile_T for the electron temperature.
[in]	ti	pprofile_T for the ion temperature.
[in]	sxrem	pprofile_T for the soft x-ray emissivity.
[in]	phi_offset	Initial phi offset of the plasma relative to the diagnostics in radians.
[in]	z_offset	Initial Z offset of the plasma relative to the machine center.
[in]	pol_rad_ratio	Ratio of poloidal grid to radial grid. Defines the gird sizes when computing magnetic diagnostics.
[in]	iou	Input/output unit to log messages to.
[in]	eq_comm	MPI communicator pool for VMEC.
[in]	recon_comm	MPI communicator pool for reconstruction.
[in,out]	state_flags	Bitwise flags to indicate which parts of the model changed.
[in]	force_solve	If true, forces the equilbirum to resolve every time.
[in]	force_solve	If true, forces the equilbirum to resolve every time.

Returns: A pointer to a constructed vmec_class object.

◆ vmec_construct_sub()

subroutine vmec_equilibrium::vmec_construct_sub	(	class (vmec_class), intent(inout)	this,
		character (len=*), intent(in)	file_name,
		character (len=*), intent(in)	wout_file_name,
		type (pprofile_class), pointer	ne,
		type (pprofile_class), pointer	te,
		type (pprofile_class), pointer	ti,
		type (pprofile_pointer), dimension(:), pointer	sxrem,
		real (rprec), intent(in)	phi_offset,
		real (rprec), intent(in)	z_offset,
		real (rprec), intent(in)	pol_rad_ratio,
		integer, intent(in)	iou,
		integer, intent(in)	eq_comm,
		integer, intent(in)	recon_comm,
		integer, intent(inout)	state_flags,
		logical, intent(in)	force_solve
	)

Construct a vmec_class object.

Initializes a vmec_class object. Runs vmec for one iteration to initialize all the input parameters. Defined in vmec_input.

Parameters

[in,out]	this	A vmec_class instance.
[in]	file_name	Filename of the vmec namelist input file.
[in]	wout_file_name	Filename of the vmec wout input file.
[in]	ne	pprofile_T for the electron density.
[in]	te	pprofile_T for the electron temperature.
[in]	ti	pprofile_T for the ion temperature.
[in]	sxrem	pprofile_T for the soft x-ray emissivity.
[in]	phi_offset	Initial phi offset of the plasma relative to the diagnostics in radians.
[in]	z_offset	Initial Z offset of the plasma relative to the machine center.
[in]	pol_rad_ratio	Ratio of poloidal grid to radial grid. Defines the gird sizes when computing magnetic diagnostics.
[in]	iou	Input/output unit to log messages to.
[in]	eq_comm	MPI communicator pool for VMEC.
[in]	recon_comm	MPI communicator pool for reconstruction.
[in,out]	state_flags	Bitwise flags to indicate which parts of the model changed.
[in]	force_solve	If true, forces the equilbirum to resolve every time.

◆ vmec_converge()

logical function vmec_equilibrium::vmec_converge	(	class (vmec_class), intent(inout)	this,
		integer, intent(inout)	num_iter,
		integer, intent(in)	iou,
		integer, intent(in)	eq_comm,
		integer, intent(in)	state_flags
	)

Solves the VMEC equilibrium.

This method overrides equilibrium::equilibrium_converge. Solves the vmec equilibrium and loads the resulting wout file in preparation of computing modeled signals.

Parameters

[in,out]	this	A vmec_class instance.
[in,out]	num_iter	Counter to track the number of iterations.
[in]	iou	Input/Output unit of the runlog file.
[in]	eq_comm	MPI communicator pool for VMEC.
[in]	state_flags	Bitwise flags to indicate which parts of the model changed.

Returns: True if the convergece was sucessful and false otherwise.

Todo:: FIXME: Put in error reporting here. For now leave this blank until I can figure how v3fit decides if vmec has converged.

◆ vmec_def_result()

subroutine vmec_equilibrium::vmec_def_result	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	result_ncid,
		integer, intent(in)	maxnsetps_dim_id
	)

Define NetCDF variables for the result file.

This method overrides equilibrium::equilibrium_def_result. Defines dimensions and variables for the VMEC contribution of the result file. Multi dimensional arrays need to be transposed so arrays appear in the correct order in non fortran languages.

Parameters

[in]	this	A vmec_class instance.
[in]	result_ncid	NetCDF file id of the result file.
[in]	maxnsetps_dim_id	NetCDF dimension id of the number of steps dimension.

◆ vmec_descent_chi2()

subroutine vmec_equilibrium::vmec_descent_chi2	(	class (vmec_descent_class), intent(in)	this,
		real (rprec), dimension(:), intent(out)	chi2
	)

Function to compute chi value and it's gradients.

Compute the chi and gradient values for the vmec_equilbrium::vmec_limit_path_to_boundary method.

Parameters

[in]	this	A vmec_descent_class instance.
[out]	chi2	χ, dχdt, dχdu

◆ vmec_descent_construct()

class (vmec_descent_class) function, pointer vmec_equilibrium::vmec_descent_construct	(	real (rprec), intent(in)	t0,
		real (rprec), intent(in)	u0,
		real (rprec), dimension(3), intent(in)	dx,
		real (rprec), dimension(3), intent(in)	x0
	)

Construct a vmec_descent_class.

Allocates memory and initializes a vmec_descent_class object.

Parameters

[in]	t0	Inital value of t0.
[in]	u0	Inital value of u0.
[in]	dx	Dx constant.
[in]	x0	X0 constant.

Returns: A pointer to a constructed vmec_descent_class object.

◆ vmec_destruct()

subroutine vmec_equilibrium::vmec_destruct ( type (vmec_class), intent(inout) this )

Deconstruct a vmec_class object.

Deallocates memory and uninitializes a vmec_class object.

Parameters

[in,out] this A vmec_class instance.

◆ vmec_get_area_int_element()

real (rprec) function vmec_equilibrium::vmec_get_area_int_element ( class (vmec_class), intent(in) this )

Get area integration element.

This method overrides equilibrium::equilibrium_get_area_int_element. For vmec this is |J||e^s|*du*dv where J is the jacobian. A 1/J term is integrated into kr, kphi and kz. Since due to the resulting |J|/J term, the the sign of the jacobian must be taken into account.

See also: vmec_equilibrium::vmec_set_magnetic_cache_calc equation 3.

du = 2*Pi/number of u grid
dv = 2*Pi/number of field periods/number of toroidal planes

Parameters

[in] this A vmec_class instance.

Returns: The area integration element.

◆ vmec_get_b_vac()

real (rprec) function, dimension(3) vmec_equilibrium::vmec_get_b_vac	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	r_cyl
	)

Gets the vacuum magnetic field vector at a position.

This interpolated the mgrid field on to the position. This should not be called if free boundary modes was not used.

Parameters

[in]	this	A vmec_class instance.
[in]	r_cyl	Cartesian position to get the magnetic field vector at.

Returns: The vaccum magnetic field vector at x_cart.

◆ vmec_get_b_vec()

real (rprec) function, dimension(3) vmec_equilibrium::vmec_get_b_vec	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		logical, intent(in)	cyl
	)

Gets the magnetic field vector at a position.

This method overrides equilibrium::equilibrium_get_B_vec.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	Cartesian position to get the magnetic field vector at.
[in]	cyl	Flag that specifies if the bfield should be returned in cartesian or cylindical coordinates.

Returns: The magnetic field vector at x_cart.

◆ vmec_get_con_surface_kphigrid()

real (rprec) function, dimension(:,:), pointer vmec_equilibrium::vmec_get_con_surface_kphigrid ( class (vmec_class), intent(in) this )

Get the conducting surface integration kphi grid points.

This method overrides equilibrium::equilibrium_get_con_surface_kphigrid.

Parameters

[in] this A vmec_class instance.

Returns: The radial grid points.

◆ vmec_get_con_surface_krgrid()

real (rprec) function, dimension(:,:), pointer vmec_equilibrium::vmec_get_con_surface_krgrid ( class (vmec_class), intent(in) this )

Get the conducting surface integration kr grid points.

This method overrides equilibrium::equilibrium_get_con_surface_krgrid.

Parameters

[in] this A vmec_class instance.

Returns: The radial grid points.

◆ vmec_get_con_surface_kzgrid()

real (rprec) function, dimension(:,:), pointer vmec_equilibrium::vmec_get_con_surface_kzgrid ( class (vmec_class), intent(in) this )

Get the conducting surface integration kz grid points.

This method overrides equilibrium::equilibrium_get_con_surface_kzgrid.

Parameters

[in] this A vmec_class instance.

Returns: The radial grid points.

◆ vmec_get_ext_b_plasma()

real (rprec) function, dimension(3) vmec_equilibrium::vmec_get_ext_b_plasma	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	position,
		logical, intent(in)	axi_only
	)

Get external plasma magnetic field.

This method overrides equilibrium::equilibrium_get_ext_b_plasma. The b field is returned in cyclindical coordinates. This function does not require shifting the plasma relative to the diagnostics. The plasma has already been shifted when computing the surface currents and prime position.

Parameters

[in]	this	A vmec_class instance.
[in]	position	Position to compute the fields at in cylindrical coordinates.
[in]	axi_only	Gives only the axisymmtric component of the magnetic field.

Returns: The external currents.

◆ vmec_get_ext_currents()

real (rprec) function, dimension(:), pointer vmec_equilibrium::vmec_get_ext_currents	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	num_currents,
		logical, intent(out)	scale_currents
	)

Get external current.

This method overrides equilibrium::equilibrium_get_ext_currents. The array memory containing the external currents is owned by VMEC. Return a pointer to it. if VMEC is run in fixed boundary mode, return a null() pointer.

Parameters

[in]	this	A vmec_class instance.
[in]	num_currents	Forces the number of currents to return if greater than zero.
[out]	scale_currents	Informs the caller that currents need to be scaled.

Returns: The external currents.

◆ vmec_get_flux()

real (rprec) function vmec_equilibrium::vmec_get_flux	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart
	)

Gets VMEC normalized flux value at position.

Converts from cartesian coordinates to VMEC's flux coordinates.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	Cartesian position to get the s position at.

Returns: The normalized flux position at x_cart.

◆ vmec_get_gp_ne_ij()

real (rprec) function vmec_equilibrium::vmec_get_gp_ne_ij	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	i,
		integer, intent(in)	j
	)

Get the electron density gp kernel value for the two indicies.

This method overrides equilibrium::equilibrium_get_gp_ne_ij. If no density profile was created zero is returned.

Parameters

[in]	this	A vmec_class instance.
[in]	i	ith profile position.
[in]	j	jth profile position.

Returns: The value of the gp kernel function for i, j.

◆ vmec_get_gp_ne_num_hyper_param()

integer function vmec_equilibrium::vmec_get_gp_ne_num_hyper_param ( class (vmec_class), intent(in) this )

Get the number of electron density gp kernel hyper parameters.

This method overrides equilibrium::equilibrium_get_gp_ne_num_hyper_param. If no density profile was created zero is returned.

Parameters

[in] this A vmec_class instance.

Returns: Number of kernel hyper parameters.

◆ vmec_get_gp_ne_pi()

real (rprec) function vmec_equilibrium::vmec_get_gp_ne_pi	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		integer, intent(in)	i
	)

Get the electron density gp kernel value for the position and index.

This method overrides equilibrium::equilibrium_get_gp_ne_pi. If no density profile was created zero is returned.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	Cartesian position to get the electron density at.
[in]	i	Profile position index.

Returns: The value of the gp kernel function for x_cart and i.

◆ vmec_get_gp_ne_pp()

real (rprec) function vmec_equilibrium::vmec_get_gp_ne_pp	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		real (rprec), dimension(3), intent(in)	y_cart
	)

Get the electron density gp kernel value for the position and position.

This method overrides equilibrium::equilibrium_get_gp_ne_pp. If no density profile was created zero is returned.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	First cartesian position to get the electron density at.
[in]	y_cart	Second cartesian position to get the electron density at.

Returns: The value of the gp kernel function for x_cart and y_cart.

◆ vmec_get_gp_sxrem_ij()

real (rprec) function vmec_equilibrium::vmec_get_gp_sxrem_ij	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	i,
		integer, intent(in)	j,
		integer, intent(in)	index
	)

Get the soft x-ray emissivity gp kernel value for the two indicies.

This method overrides equilibrium::equilibrium_get_gp_sxrem_ij. If no soft x-ray emissivity profile was created zero is returned.

Parameters

[in]	this	A vmec_class instance.
[in]	i	ith profile position.
[in]	j	jth profile position.
[in]	index	Index of the soft x-ray emissivity profile.

Returns: The value of the gp kernel function for i, j.

◆ vmec_get_gp_sxrem_num_hyper_param()

integer function vmec_equilibrium::vmec_get_gp_sxrem_num_hyper_param	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	index
	)

Get the number of soft x-ray emission gp kernel hyper parameters.

This method overrides equilibrium::equilibrium_get_gp_sxrem_num_hyper_param. If no soft x-ray emission profile was created zero is returned.

Parameters

[in]	this	A vmec_class instance.
[in]	index	Index of the soft x-ray emissivity profile.

Returns: Number of kernel hyper parameters.

◆ vmec_get_gp_sxrem_pi()

real (rprec) function vmec_equilibrium::vmec_get_gp_sxrem_pi	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		integer, intent(in)	i,
		integer, intent(in)	index
	)

Get the soft x-ray emissivity gp kernel value for the position and index.

This method overrides equilibrium::equilibrium_get_gp_sxrem_pi. If no soft x-ray emissivity profile was created zero is returned.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	Cartesian position to get the soft x-ray emissivity at.
[in]	i	Profile position index.
[in]	index	Index of the soft x-ray emissivity profile.

Returns: The value of the gp kernel function for x_cart and i.

◆ vmec_get_gp_sxrem_pp()

real (rprec) function vmec_equilibrium::vmec_get_gp_sxrem_pp	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		real (rprec), dimension(3), intent(in)	y_cart,
		integer, intent(in)	index
	)

Get the soft x-ray emissivity gp kernel value for the position and position.

This method overrides equilibrium::equilibrium_get_gp_sxrem_pp. If no soft x-ray emissivity profile was created zero is returned.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	First cartesian position to get the soft x-ray emissivity at.
[in]	y_cart	Second cartesian position to get the soft x-ray emissivity at.
[in]	index	Index of the soft x-ray emissivity profile.

Returns: The value of the gp kernel function for x_cart and y_cart.

◆ vmec_get_gp_te_ij()

real (rprec) function vmec_equilibrium::vmec_get_gp_te_ij	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	i,
		integer, intent(in)	j
	)

Get the electron temperature gp kernel value for the two indicies.

This method overrides equilibrium::equilibrium_get_gp_te_ij. If no electron temperature profile was created zero is returned.

Parameters

[in]	this	A vmec_class instance.
[in]	i	ith profile position.
[in]	j	jth profile position.

Returns: The value of the gp kernel function for i, j.

◆ vmec_get_gp_te_num_hyper_param()

integer function vmec_equilibrium::vmec_get_gp_te_num_hyper_param ( class (vmec_class), intent(in) this )

Get the number of electron temperature gp kernel hyper parameters.

This method overrides equilibrium::equilibrium_get_gp_te_num_hyper_param. If no electron temperature profile was created zero is returned.

Parameters

[in] this A vmec_class instance.

Returns: Number of kernel hyper parameters.

◆ vmec_get_gp_te_pi()

real (rprec) function vmec_equilibrium::vmec_get_gp_te_pi	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		integer, intent(in)	i
	)

Get the electron temperature gp kernel value for the position and index.

This method overrides equilibrium::equilibrium_get_gp_te_pi. If no electron temperature profile was created zero is returned.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	Cartesian position to get the electron temperature at.
[in]	i	Profile position index.

Returns: The value of the gp kernel function for x_cart and i.

◆ vmec_get_gp_te_pp()

real (rprec) function vmec_equilibrium::vmec_get_gp_te_pp	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		real (rprec), dimension(3), intent(in)	y_cart
	)

Get the electron temperature gp kernel value for the position and position.

This method overrides equilibrium::equilibrium_get_gp_te_pp. If no electron temperature profile was created zero is returned.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	First cartesian position to get the electron temperature at.
[in]	y_cart	Second cartesian position to get the electron temperature at.

Returns: The value of the gp kernel function for x_cart and y_cart.

◆ vmec_get_gp_ti_ij()

real (rprec) function vmec_equilibrium::vmec_get_gp_ti_ij	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	i,
		integer, intent(in)	j
	)

Get the ion temperature gp kernel value for the two indicies.

This method overrides equilibrium::equilibrium_get_gp_ti_ij. If no ion profile was created zero is returned.

Parameters

[in]	this	A vmec_class instance.
[in]	i	ith profile position.
[in]	j	jth profile position.

Returns: The value of the gp kernel function for i, j.

◆ vmec_get_gp_ti_num_hyper_param()

integer function vmec_equilibrium::vmec_get_gp_ti_num_hyper_param ( class (vmec_class), intent(in) this )

Get the number of ion temperature gp kernel hyper parameters.

This method overrides equilibrium::equilibrium_get_gp_ti_num_hyper_param. If no ion temperature profile was created zero is returned.

Parameters

[in] this A vmec_class instance.

Returns: Number of kernel hyper parameters.

◆ vmec_get_gp_ti_pi()

real (rprec) function vmec_equilibrium::vmec_get_gp_ti_pi	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		integer, intent(in)	i
	)

Get the ion temperature gp kernel value for the position and index.

This method overrides equilibrium::equilibrium_get_gp_ti_pi. If no ion temperature profile was created zero is returned.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	Cartesian position to get the ion temperature at.
[in]	i	Profile position index.

Returns: The value of the gp kernel function for x_cart and i.

◆ vmec_get_gp_ti_pp()

real (rprec) function vmec_equilibrium::vmec_get_gp_ti_pp	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		real (rprec), dimension(3), intent(in)	y_cart
	)

Get the ion temperature gp kernel value for the position and position.

This method overrides equilibrium::equilibrium_get_gp_ti_pp. If no ion temperature profile was created zero is returned.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	First cartesian position to get the ion temperature at.
[in]	y_cart	Second cartesian position to get the ion temperature at.

Returns: The value of the gp kernel function for x_cart and y_cart.

◆ vmec_get_grid_size()

integer function vmec_equilibrium::vmec_get_grid_size ( class (vmec_class), intent(in) this )

Get radial grid size.

This method overrides equilibrium::equilibrium_get_grid_size.

Parameters

[in] this A vmec_class instance.

Returns: Size of the radial grid.

◆ vmec_get_grid_start()

real (rprec) function vmec_equilibrium::vmec_get_grid_start ( class (vmec_class), intent(in) this )

Get start of the radial grid.

This method overrides equilibrium::equilibrium_get_grid_start.

Parameters

[in] this A vmec_class instance.

Returns: Start of the radial grid.

◆ vmec_get_grid_stop()

real (rprec) function vmec_equilibrium::vmec_get_grid_stop ( class (vmec_class), intent(in) this )

Get radial grid size.

This method overrides equilibrium::equilibrium_get_grid_size.

Parameters

[in] this A vmec_class instance.

Returns: Size of the radial grid.

◆ vmec_get_int_b_dphi()

real (rprec) function vmec_equilibrium::vmec_get_int_b_dphi	(	class (vmec_class), intent(in)	this,
		real (rprec), intent(in)	s,
		real (rprec), intent(in)	theta
	)

Gets the loop integrated magnetic field at a position.

This method overrides equilibrium::equilibrium_get_Int_B_dphi. This computes Int[B*dl]

Parameters

[in]	this	A vmec_class instance.
[in]	s	S position to integrate about.
[in]	theta	U angle to integrate about.

Returns: The loop integrated magnetic field at x_cart.

◆ vmec_get_magnetic_volume_jphigrid()

real (rprec) function, dimension(:,:,:), pointer vmec_equilibrium::vmec_get_magnetic_volume_jphigrid ( class (vmec_class), intent(in) this )

Get volume magnetic volume integration jphi grid points.

This method overrides equilibrium::equilibrium_get_magnetic_volume_jphigrid.

Parameters

[in] this A vmec_class instance.

Returns: The radial grid points.

◆ vmec_get_magnetic_volume_jrgrid()

real (rprec) function, dimension(:,:,:), pointer vmec_equilibrium::vmec_get_magnetic_volume_jrgrid ( class (vmec_class), intent(in) this )

Get volume magnetic volume integration jr grid points.

This method overrides equilibrium::equilibrium_get_magnetic_volume_jrgrid.

Parameters

[in] this A vmec_class instance.

Returns: The radial grid points.

◆ vmec_get_magnetic_volume_jzgrid()

real (rprec) function, dimension(:,:,:), pointer vmec_equilibrium::vmec_get_magnetic_volume_jzgrid ( class (vmec_class), intent(in) this )

Get volume magnetic volume integration jz grid points.

This method overrides equilibrium::equilibrium_get_magnetic_volume_jzgrid.

Parameters

[in] this A vmec_class instance.

Returns: The radial grid points.

◆ vmec_get_magnetic_volume_rgrid()

real (rprec) function, dimension(:,:,:), pointer vmec_equilibrium::vmec_get_magnetic_volume_rgrid ( class (vmec_class), intent(in) this )

Get volume magnetic volume integration radial grid points.

This method overrides equilibrium::equilibrium_get_magnetic_volume_rgrid.

Parameters

[in] this A vmec_class instance.

Returns: The radial grid points.

◆ vmec_get_magnetic_volume_zgrid()

real (rprec) function, dimension(:,:,:), pointer vmec_equilibrium::vmec_get_magnetic_volume_zgrid ( class (vmec_class), intent(in) this )

Get volume magnetic volume integration z grid points.

This method overrides equilibrium::equilibrium_get_magnetic_volume_zgrid.

Parameters

[in] this A vmec_class instance.

Returns: The radial grid points.

◆ vmec_get_ne_af()

real (rprec) function, dimension(:), pointer vmec_equilibrium::vmec_get_ne_af ( class (vmec_class), intent(in) this )

Gets the electron density profile af array.

This method overrides equilibrium::equilibrium_get_ne_af. If no density profile was created a null pointer is returned.

Parameters

[in] this A vmec_class instance.

Returns: Pointer to the electron density profile af array.

◆ vmec_get_ne_cart()

real (rprec) function vmec_equilibrium::vmec_get_ne_cart	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart
	)

Gets the electron density at a cartesian position.

This method overrides equilibrium::equilibrium_get_ne. If no density profile was created, return zero.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	Cartesian position to get the electron density at.

Returns: The electron density at x_cart.

◆ vmec_get_ne_radial()

real (rprec) function vmec_equilibrium::vmec_get_ne_radial	(	class (vmec_class), intent(in)	this,
		real (rprec), intent(in)	s
	)

Gets the electron density at a s position.

This method overrides equilibrium::equilibrium_get_ne. If no density profile was created, return zero.

Parameters

[in]	this	A vmec_class instance.
[in]	s	Radial position to get the electron density at.

Returns: The electron density at s.

◆ vmec_get_p_cart()

real (rprec) function vmec_equilibrium::vmec_get_p_cart	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		logical, intent(in)	normalize
	)

Gets the plasma pressure at a cartesian position.

This method overrides equilibrium::equilibrium_get_p.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	Cartesian position to get the plasma pressure at.
[in]	normalize	Normalize the pressure value.

Returns: The plasma pressure at x_cart.

◆ vmec_get_p_radial()

real (rprec) function vmec_equilibrium::vmec_get_p_radial	(	class (vmec_class), intent(in)	this,
		real (rprec), intent(in)	s,
		logical, intent(in)	normalize
	)

Gets the plasma pressure at a s position.

This method overrides equilibrium::equilibrium_get_p.

Parameters

[in]	this	A vmec_class instance.
[in]	s	Radial position to get the plasma pressure at.
[in]	normalize	Normalize the pressure value.

Returns: The plasma pressure at s.

◆ vmec_get_param_id()

integer function vmec_equilibrium::vmec_get_param_id	(	class (vmec_class), intent(in)	this,
		character (len=*), intent(in)	param_name
	)

Get the id for a reconstruction parameter.

This method overrides equilibrium::equilibrium_get_param_id.

Parameters

[in]	this	A vmec_class instance.
[in]	param_name	Name of a reconstruction parameter.

Returns: The id for a reconstruction parameter.

◆ vmec_get_param_name()

character(len=data_name_length) function vmec_equilibrium::vmec_get_param_name	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	id
	)

Get the name of a reconstruction VMEC parameter.

This method overrides equilibrium::equilibrium_get_param_name.

Parameters

[in]	this	A vmec_class instance.
[in]	id	ID of the parameter.

Returns: The name of the parameter.

◆ vmec_get_param_value()

real (rprec) function vmec_equilibrium::vmec_get_param_value	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	id,
		integer, intent(in)	i_index,
		integer, intent(in)	j_index
	)

Get the value of a reconstruction VMEC parameter.

This method overrides equilibrium::equilibrium_get_param_value.

Parameters

[in]	this	A vmec_class instance.
[in]	id	ID of the parameter.
[in]	i_index	The ith index of the parameter.
[in]	j_index	The jth index of the parameter.

Returns: The value of the parameter.

◆ vmec_get_plasma_edge()

integer function vmec_equilibrium::vmec_get_plasma_edge	(	class (vmec_class), intent(in)	this,
		real (rprec), intent(in)	phi,
		real (rprec), dimension(:), pointer	r,
		real (rprec), dimension(:), pointer	z
	)

Gets the r and z positions of the outer surface at a toroidal angle.

This method overrides equilibrium::equilibrium_get_plasma_edge.

Parameters

[in]	this	A vmec_class instance.
[in]	phi	Toroidal angle to determine the outer surface at.
[in,out]	r	The radial postions of the other surface in a single toroidal angle.
[in,out]	z	The Z postions of the other surface in a single toroidal angle.

Returns: The number of elements in the r and z arrays.

◆ vmec_get_s()

real (rprec) function vmec_equilibrium::vmec_get_s	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart
	)

Gets VMEC s value at position.

Converts from cartesian coordinates to VMEC's flux coordinates.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	Cartesian position to get the s position at.

Returns: The s position at x_cart.

◆ vmec_get_suv()

real (rprec) function, dimension(3) vmec_equilibrium::vmec_get_suv	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart
	)

Gets VMEC suv position.

Converts from cartesian coordinates to vmec's flux coordinates.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	Cartesian position to get the s position at.

Returns: The s position at x_cart.

◆ vmec_get_sxrem_af()

real (rprec) function, dimension(:), pointer vmec_equilibrium::vmec_get_sxrem_af	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	index
	)

Gets the soft x-ray emissivity profile af array.

This method overrides equilibrium::equilibrium_get_sxrem_af. If no temperature profile was created a null pointer is returned.

Parameters

[in]	this	A vmec_class instance.
[in]	index	Index of the soft x-ray emissivity profile.

Returns: Pointer to the electron temperature profile af array.

◆ vmec_get_sxrem_cart()

real (rprec) function vmec_equilibrium::vmec_get_sxrem_cart	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		integer, intent(in)	index
	)

Gets the soft x-ray emissivity at a cartesian position.

This method overrides equilibrium::equilibrium_get_sxrem. If no soft x-ray emissivity profile was created, return zero.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	Cartesian position to get the soft x-ray emissivity at.
[in]	index	Index of the soft x-ray emissivity profile.

Returns: The soft x-ray emissivity at x_cart.

◆ vmec_get_sxrem_radial()

real (rprec) function vmec_equilibrium::vmec_get_sxrem_radial	(	class (vmec_class), intent(in)	this,
		real (rprec), intent(in)	s,
		integer, intent(in)	index
	)

Gets the soft x-ray emissivity at a s position.

This method overrides equilibrium::equilibrium_get_sxrem. If no soft x-ray emissivity profile was created, return zero.

Parameters

[in]	this	A vmec_class instance.
[in]	s	Radial position to get the soft x-ray emissivity at.
[in]	index	Index of the soft x-ray emissivity profile.

Returns: The soft x-ray emissivity at s.

◆ vmec_get_te_af()

real (rprec) function, dimension(:), pointer vmec_equilibrium::vmec_get_te_af ( class (vmec_class), intent(in) this )

Gets the electron temperature profile af array.

This method overrides equilibrium::equilibrium_get_te_af. If no electron temperature profile was created a null pointer is returned.

Parameters

[in] this A vmec_class instance.

Returns: Pointer to the electron temperature profile af array.

◆ vmec_get_te_cart()

real (rprec) function vmec_equilibrium::vmec_get_te_cart	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart
	)

Gets the electron temperature at a cartesian position.

This method overrides equilibrium::equilibrium_get_te. If no electron temperature profile was created, return zero.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	Cartesian position to get the electron temperature at.

Returns: The electron temperature at x_cart.

◆ vmec_get_te_radial()

real (rprec) function vmec_equilibrium::vmec_get_te_radial	(	class (vmec_class), intent(in)	this,
		real (rprec), intent(in)	s
	)

Gets the electron temperature at a s position.

This method overrides equilibrium::equilibrium_get_te. If no electron temperature profile was created, return zero.

Parameters

[in]	this	A vmec_class instance.
[in]	s	Radial position to get the electron temperature at.

Returns: The electron temperature at s.

◆ vmec_get_ti_af()

real (rprec) function, dimension(:), pointer vmec_equilibrium::vmec_get_ti_af ( class (vmec_class), intent(in) this )

Gets the ion temperature profile af array.

This method overrides equilibrium::equilibrium_get_ti_af. If no ion temperature profile was created a null pointer is returned.

Parameters

[in] this A vmec_class instance.

Returns: Pointer to the ion temperature profile af array.

◆ vmec_get_ti_cart()

real (rprec) function vmec_equilibrium::vmec_get_ti_cart	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart
	)

Gets the ion temperature at a cartesian position.

This method overrides equilibrium::equilibrium_get_ti. If no ion temperature profile was created, return zero.

Parameters

[in]	this	A vmec_class instance.
[in]	x_cart	Cartesian position to get the ion temperature at.

Returns: The ion temperature at x_cart.

◆ vmec_get_ti_radial()

real (rprec) function vmec_equilibrium::vmec_get_ti_radial	(	class (vmec_class), intent(in)	this,
		real (rprec), intent(in)	s
	)

Gets the ion temperature at a s position.

This method overrides equilibrium::equilibrium_get_ti. If no ion temperature profile was created, return zero.

Parameters

[in]	this	A vmec_class instance.
[in]	s	Radial position to get the ion temperature at.

Returns: The ion temperature at s.

◆ vmec_get_type()

character (len=data_name_length) function vmec_equilibrium::vmec_get_type ( class (vmec_class), intent(in) this )

Gets a discription of the equilibrium type.

Parameters

[in] this A vmec_class instance.

Returns: A string describing the signal type.

◆ vmec_get_volume_int_element()

real (rprec) function vmec_equilibrium::vmec_get_volume_int_element ( class (vmec_class), intent(in) this )

Get volume integration element.

This method overrides equilibrium::equilibrium_get_volume_int_element. For vmec this is J*ds*du*dv where J is the jacobian. The jacobian is integrated into Jr, Jphi and Jz but still need to account for the sign of the jacobian.

ds = 1/(ns - 1)
du = 2*Pi/number of flux surfaces
dv = 2*Pi/number of field periods/number of toroidal planes

Parameters

[in] this A vmec_class instance.

Returns: The volume integration element.

◆ vmec_gradient_descent()

real (rprec) function, dimension(3) vmec_equilibrium::vmec_gradient_descent	(	class (vmec_class), intent(in)	this,
		real (rprec), intent(in)	t,
		real (rprec), intent(in)	u,
		real (rprec), dimension(3), intent(in)	dx,
		real (rprec), dimension(3), intent(in)	x0
	)

Gradient descent to minize the vmec_equilibrium::vmec_limit_chi.

Parameters

[in]	this	A model_class instance.
[in]	t	The current value of t.
[in]	u	The current value of u.
[in]	dx	The dx consant.
[in]	x0	The x0 consant.

Returns: The x,y,z position at the edge.

◆ vmec_has_vacuum_field()

logical function vmec_equilibrium::vmec_has_vacuum_field ( class (vmec_class), intent(in) this )

Determines if vacuum field information is available.

This method overrides equilibrium::equilibrium_has_vacuum_field.

Todo:: FIXME: Currently this method assumes that VMEC takes care of the vacuum fields. But SIESTA has a free boundary capability and a point could still be outside of that.

Parameters

[in] this A vmec_class instance.

Returns: True of vacuum fields are available.

◆ vmec_is_1d_array()

logical function vmec_equilibrium::vmec_is_1d_array	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	id
	)

Checks if a parameter id is a 1d array.

This method overrides equilibrium::equilibrium_is_1d_array.

Parameters

[in]	this	A vmec_class instance.
[in]	id	ID of the parameter.

Returns: True if the parameter is a 1d array and false if otherwise.

◆ vmec_is_2d_array()

logical function vmec_equilibrium::vmec_is_2d_array	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	id
	)

Checks if a parameter id is a 2d array.

This method overrides equilibrium::equilibrium_is_2d_array.

Parameters

[in]	this	A vmec_class instance.
[in]	id	ID of the parameter.

Returns: True if the parameter is a 2d array and false if otherwise.

◆ vmec_is_in_plasma()

logical function vmec_equilibrium::vmec_is_in_plasma	(	class (vmec_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart
	)

Determines if a point is inside the plasma or outside.

This method overrides equilibrium::equilibrium_is_in_plasma.

Parameters

[in]	this	A model_class instance.
[in]	x_cart	Cartesian position to check.

Returns: True if the point is inside the plasma.

◆ vmec_is_recon_param()

logical function vmec_equilibrium::vmec_is_recon_param	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	id
	)

Checks if a parameter id is a reconstruction parameter.

This method overrides equilibrium::equilibrium_is_recon_param.

Parameters

[in]	this	A vmec_class instance.
[in]	id	ID of the parameter.

Returns: True if the parameter is a reconstruction parameter and false if otherwise.

◆ vmec_is_scaler_value()

logical function vmec_equilibrium::vmec_is_scaler_value	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	id
	)

Checks if a parameter id is a scaler value.

This method overrides equilibrium::equilibrium_is_scaler_value.

Parameters

[in]	this	A vmec_class instance.
[in]	id	ID of the parameter.

Returns: True if the parameter is a scaler and false if otherwise.

◆ vmec_is_using_point()

logical function vmec_equilibrium::vmec_is_using_point ( class (vmec_class), intent(in) this )

Checks if the point magnetics are being used.

This method overrides equilibrium::equilibrium_is_using_point.

Parameters

[in] this A vmec_class instance.

Returns: True if the point magnetic are being used.

◆ vmec_limit_path_to_boundary()

type (vertex) function, pointer vmec_equilibrium::vmec_limit_path_to_boundary	(	class (vmec_class), intent(in)	this,
		type (vertex), pointer	path
	)

Limit an integration path to the boundary.

This method overrides equilibrium::equilibrium_limit_path_to_boundary.

The any point along the chord can be parameterized by

x_vec[t] = t*x_hat + x0_vec (1)

where

x_hat = (x1_vec - x0_vec)/h (2)

h = |x1_vec - x0_vec| = Sqrt[(x1_vec - x0_vec).(x1_vec - x0_vec)] (3)

The path along the cord t ranges from 0 to h.

The R, Phi,and Z components of x_vec become

r[t] = Sqrt[(t*(x1 - x0)/h + x0)^2 + (t*(y1 - y0)/h + y0)^2] (4)

ɸ[t] = ArcTan[t*(x1 - x0)/h + x0, t*(y1 - y0)/h + y0] (5)

z[t] = t*(z1 - z0)/h + z0 (6)

A chord intersects the boundary when

r[t] == r_vmec(1, u, ɸ[t]) (7)

z[t] == z_vmec(1, u, ɸ[t]) (8)

We can solve for t and u by finding the minimum of (9)

chi[t,u] = (r[t] - r_vmec(1, u, ɸ[t]))^2

(z[t] - z_vmec(1, u, ɸ[t]))^2 (10)

There are two solutions to this function so we need to determine a good inital guess. For t use 0 for points closer to x0_vec and h for points closer to x1_vec. For use we assume one is close to the origin. For that point assume u = π. For farther points assume u = 0 or 2π.

To find the minimum we can use a gradient decent method. To do this we need the derivatives.

chi

Parameters

[in]	this	A model_class instance.
[in]	path	A chord path.

Returns: The chord path limited to the boundary.

◆ vmec_read_vac_file()

subroutine vmec_equilibrium::vmec_read_vac_file	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	index,
		integer, intent(in)	eq_comm
	)

Loads the vacuum magnetic field file.

Loads the vacuum magnetic field file. This will get on multiple processes to allow parallel loading of the mgrid file. The extcur array will need to be broadcast to the child processes.

Parameters

[in]	this	A vmec_class instance.
[in]	index	Index of the changed current.
[in]	eq_comm	MPI communicator pool for VMEC.

◆ vmec_reset_boundary()

subroutine vmec_equilibrium::vmec_reset_boundary ( class (vmec_class), intent(in) this )

Reset the fixed boundary coefficients.

When changing the boundary coefficients, there is extra work that must be performed to set the VMEC state.

Parameters

[in] this A vmec_class instance.

◆ vmec_reset_state()

subroutine vmec_equilibrium::vmec_reset_state ( class (vmec_class), intent(inout) this )

Reset the internal state of the equilibrium.

Copies the saved VMEC state back to VMEC.

Parameters

[in,out] this A vmec_class instance.

◆ vmec_restart()

subroutine vmec_equilibrium::vmec_restart	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	result_ncid,
		integer, intent(in)	current_step
	)

Restart vmec from the result file.

This method overrides equilibrium::equilibrium_restart.

Parameters

[in]	this	A vmec_class instance.
[in]	result_ncid	NetCDF file id of the result file.
[in]	current_step	Step index to write variables to.

◆ vmec_save_state()

subroutine vmec_equilibrium::vmec_save_state ( class (vmec_class), intent(inout) this )

Save the internal state of the equilibrium.

Saves the VMEC state and the wout file.

Parameters

[in,out] this A vmec_class instance.

◆ vmec_set_magnetic_cache_calc()

subroutine vmec_equilibrium::vmec_set_magnetic_cache_calc ( class (vmec_class), intent(inout) this )

Set magnetic cache initialy.

After the equilibrium has been converged calculate the r, z, jr, jphi and jz on grid of s, u, v points.

Parameters

[in,out] this A vmec_class instance.

Todo:: FIXME: There is no reason to recalculate the sin and cosin for the u component arrays every time. The v components can change if phi_offset is being reconstructed. The u components can be cached in the vmec_magnetic_cache and calculated once in vmec_set_magnetic_cache_response.

Todo:: FIXME: There is no reason to recalculate the sin and cosin for the u component arrays every time. The v components can change if phi_offset is being reconstructed. The u components can be cached in the vmec_magnetic_cache and calculated once in vmec_set_magnetic_cache_response.

Todo:: FIXME: There is no reason to recompute the sine and cosine for the u component arrays every time.

Todo:: FIXME: There is no reason to recalculate the sin and cosin for the u component arrays every time. The v components can change if phi_offset is being reconstructed. The u components can be cached in the vmec_magnetic_cache and calculated once in vmec_set_magnetic_cache_response.

Todo:: FIXME: There is no reason to recompute the sine and cosine for the u component arrays every time.

◆ vmec_set_magnetic_cache_point()

subroutine vmec_equilibrium::vmec_set_magnetic_cache_point	(	class (vmec_class), intent(inout)	this,
		logical, intent(in)	use_axi,
		integer, intent(in)	state_flags
	)

Set magnetic cache initialy.

This method overrides equilibrium::equilibrium_set_magnetic_cache. This allocates a vmec_magnetic_cache structure. Point measurements require no array allocations.

Parameters

[in,out]	this	A vmec_class instance.
[in]	use_axi	Magnetics can subtract off axisymmetric components.
[in]	state_flags	Bitwise flags to indicate which parts of the model changed.

◆ vmec_set_magnetic_cache_response()

subroutine vmec_equilibrium::vmec_set_magnetic_cache_response	(	class (vmec_class), intent(inout)	this,
		type (magnetic_response_class), intent(in)	response_object,
		integer, intent(in)	state_flags
	)

Set magnetic cache for plasma resonce.

This method overrides equilibrium::equilibrium_set_magnetic_cache. This allocates a vmec_magnetic_cache structure. Point measurements require no array allocations.

Parameters

[in,out]	this	A vmec_class instance.
[in]	response_object	A magnetic_response::magnetic_response_class instance.
[in]	state_flags	Bitwise flags to indicate which parts of the model changed.

◆ vmec_set_namelist()

subroutine vmec_equilibrium::vmec_set_namelist ( class (vmec_class), intent(in) this )

Sets namelist variables from the solved VMEC equilibrium.

This method updates the boundary and magnetic axis coefficients in the namelist input file.

Parameters

[in] this A vmec_class instance.

◆ vmec_set_param()

subroutine vmec_equilibrium::vmec_set_param	(	class (vmec_class), intent(inout)	this,
		integer, intent(in)	id,
		integer, intent(in)	i_index,
		integer, intent(in)	j_index,
		real (rprec), intent(in)	value,
		integer, intent(in)	eq_comm,
		integer, intent(inout)	state_flags
	)

Sets the value of a reconstruction equilibrium parameter.

This method overrides equilibrium::equilibrium_set_param. When a VMEC parameter is changed, propagate the changes to the VMEC internal state and inform the caller that the equilibrium needs reconvergence.

Parameters

[in,out]	this	A vmec_class instance.
[in]	id	ID of the parameter.
[in]	i_index	The ith index of the parameter.
[in]	j_index	The jth index of the parameter.
[in]	value	The value of the parameter.
[in]	eq_comm	MPI communicator for the child equilibrium processes.
[in,out]	state_flags	Bitwise flags to indicate which parts of the model changed.

Todo:: FIXME: Consider throwing a fatal error here instead of silently doing nothing.

◆ vmec_sync_child()

subroutine vmec_equilibrium::vmec_sync_child	(	class (vmec_class), intent(inout)	this,
		integer, intent(in)	index,
		integer, intent(in)	recon_comm
	)

Syncronize a child vmec state to the parent.

Syncs data between a child and the parent process. If MPI support is not compiled in this subroutine reduces to a no op.

Parameters

[in,out]	this	A vmec_class instance.
[in]	index	Reconstruction rank to sync.
[in]	recon_comm	MPI communicator for the reconstruction processes.

◆ vmec_sync_state()

subroutine vmec_equilibrium::vmec_sync_state	(	class (vmec_class), intent(inout)	this,
		integer, intent(in)	recon_comm
	)

Syncronize the vmec state to children.

Syncs data between the parent and child processes. If MPI support is not compiled in this subroutine reduces to a no op.

Parameters

[in,out]	this	A vmec_class instance.
[in]	recon_comm	MPI communicator for the reconstruction processes.

◆ vmec_write()

subroutine vmec_equilibrium::vmec_write	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	iou
	)

Write out the equilibrium to an output file.

This method overrides equilibrium::equilibrium_write.

Parameters

[in]	this	A vmec_class instance.
[in]	iou	Input/output unit of the output file.

◆ vmec_write_init_data()

subroutine vmec_equilibrium::vmec_write_init_data	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	result_ncid
	)

Write inital data to NetCDF result file.

This method overrides equilibrium::equilibrium_write_init_data.

Parameters

[in]	this	A vmec_class instance.
[in]	result_ncid	NetCDF file id of the result file.

◆ vmec_write_input()

subroutine vmec_equilibrium::vmec_write_input	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	current_step
	)

Write the current valid input.

This method overrides equilibrium::equilibrium_write_input. The boundary and other fixed parameters do not get updated as the reconstruction progresses. Need to update them manually if in free boundary mode.

Parameters

[in]	this	A vmec_class instance.
[in]	current_step	Step number to append to input filename.

◆ vmec_write_step_data()

subroutine vmec_equilibrium::vmec_write_step_data	(	class (vmec_class), intent(in)	this,
		integer, intent(in)	result_ncid,
		integer, intent(in)	current_step
	)

Write step data to NetCDF result file.

This method overrides equilibrium::equilibrium_write_step_data.

Parameters

[in]	this	A vmec_class instance.
[in]	result_ncid	NetCDF file id of the result file.
[in]	current_step	Step index to write variables to.

Data Types

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ vmec_construct()

◆ vmec_construct_sub()

◆ vmec_converge()

◆ vmec_def_result()

◆ vmec_descent_chi2()

◆ vmec_descent_construct()

◆ vmec_destruct()

◆ vmec_get_area_int_element()

◆ vmec_get_b_vac()

◆ vmec_get_b_vec()

◆ vmec_get_con_surface_kphigrid()

◆ vmec_get_con_surface_krgrid()

◆ vmec_get_con_surface_kzgrid()

◆ vmec_get_ext_b_plasma()

◆ vmec_get_ext_currents()

◆ vmec_get_flux()

◆ vmec_get_gp_ne_ij()

◆ vmec_get_gp_ne_num_hyper_param()

◆ vmec_get_gp_ne_pi()

◆ vmec_get_gp_ne_pp()

◆ vmec_get_gp_sxrem_ij()

◆ vmec_get_gp_sxrem_num_hyper_param()

◆ vmec_get_gp_sxrem_pi()

◆ vmec_get_gp_sxrem_pp()

◆ vmec_get_gp_te_ij()

◆ vmec_get_gp_te_num_hyper_param()

◆ vmec_get_gp_te_pi()

◆ vmec_get_gp_te_pp()

◆ vmec_get_gp_ti_ij()

◆ vmec_get_gp_ti_num_hyper_param()

◆ vmec_get_gp_ti_pi()

◆ vmec_get_gp_ti_pp()

◆ vmec_get_grid_size()

◆ vmec_get_grid_start()

◆ vmec_get_grid_stop()

◆ vmec_get_int_b_dphi()

◆ vmec_get_magnetic_volume_jphigrid()

◆ vmec_get_magnetic_volume_jrgrid()

◆ vmec_get_magnetic_volume_jzgrid()

◆ vmec_get_magnetic_volume_rgrid()

◆ vmec_get_magnetic_volume_zgrid()

◆ vmec_get_ne_af()

◆ vmec_get_ne_cart()

◆ vmec_get_ne_radial()

◆ vmec_get_p_cart()

◆ vmec_get_p_radial()

◆ vmec_get_param_id()

◆ vmec_get_param_name()

◆ vmec_get_param_value()

◆ vmec_get_plasma_edge()

◆ vmec_get_s()

◆ vmec_get_suv()

◆ vmec_get_sxrem_af()

◆ vmec_get_sxrem_cart()

◆ vmec_get_sxrem_radial()

◆ vmec_get_te_af()

◆ vmec_get_te_cart()

◆ vmec_get_te_radial()

◆ vmec_get_ti_af()

◆ vmec_get_ti_cart()

◆ vmec_get_ti_radial()

◆ vmec_get_type()

◆ vmec_get_volume_int_element()

◆ vmec_gradient_descent()

◆ vmec_has_vacuum_field()

◆ vmec_is_1d_array()

◆ vmec_is_2d_array()

◆ vmec_is_in_plasma()

◆ vmec_is_recon_param()

◆ vmec_is_scaler_value()

◆ vmec_is_using_point()

◆ vmec_limit_path_to_boundary()

◆ vmec_read_vac_file()

◆ vmec_reset_boundary()

◆ vmec_reset_state()