vmec_equilibrium.f File Reference

Contains module vmec_equilibrium. More...

Data Types
type	vmec_equilibrium::vmec_magnetic_cache
	Object to cache data needed to compute magnetic signals. More...
interface	vmec_equilibrium::vmec_class
	Base class representing a vmec_equilibrium. More...
interface	vmec_equilibrium::vmec_descent_class
	Extended gradient_descent_class. More...
interface	vmec_equilibrium::runvmec
	Forward declare the interface for runvmec. More...

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

Functions/Subroutines
subroutine	vmec_equilibrium::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.
type(vmec_class) function, pointer	vmec_equilibrium::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.
class(vmec_descent_class) function, pointer	vmec_equilibrium::vmec_descent_construct (t0, u0, dx, x0)
	Construct a vmec_descent_class.
subroutine	vmec_equilibrium::vmec_destruct (this)
	Deconstruct a vmec_class object.
subroutine	vmec_equilibrium::vmec_set_param (this, id, i_index, j_index, value, eq_comm, state_flags)
	Sets the value of a reconstruction equilibrium parameter.
subroutine	vmec_equilibrium::vmec_set_magnetic_cache_response (this, response_object, state_flags)
	Set magnetic cache for plasma resonce.
subroutine	vmec_equilibrium::vmec_set_magnetic_cache_point (this, use_axi, state_flags)
	Set magnetic cache initialy.
subroutine	vmec_equilibrium::vmec_set_magnetic_cache_calc (this)
	Set magnetic cache initialy.
subroutine	vmec_equilibrium::vmec_set_namelist (this)
	Sets namelist variables from the solved VMEC equilibrium.
character(len=data_name_length) function	vmec_equilibrium::vmec_get_type (this)
	Gets a discription of the equilibrium type.
integer function	vmec_equilibrium::vmec_get_param_id (this, param_name)
	Get the id for a reconstruction parameter.
real(rprec) function	vmec_equilibrium::vmec_get_param_value (this, id, i_index, j_index)
	Get the value of a reconstruction VMEC parameter.
character(len=data_name_length) function	vmec_equilibrium::vmec_get_param_name (this, id)
	Get the name of a reconstruction VMEC parameter.
integer function	vmec_equilibrium::vmec_get_gp_ne_num_hyper_param (this)
	Get the number of electron density gp kernel hyper parameters.
real(rprec) function, dimension(:), pointer	vmec_equilibrium::vmec_get_ne_af (this)
	Gets the electron density profile af array.
real(rprec) function	vmec_equilibrium::vmec_get_gp_ne_ij (this, i, j)
	Get the electron density gp kernel value for the two indicies.
real(rprec) function	vmec_equilibrium::vmec_get_gp_ne_pi (this, x_cart, i)
	Get the electron density gp kernel value for the position and index.
real(rprec) function	vmec_equilibrium::vmec_get_gp_ne_pp (this, x_cart, y_cart)
	Get the electron density gp kernel value for the position and position.
real(rprec) function	vmec_equilibrium::vmec_get_ne_cart (this, x_cart)
	Gets the electron density at a cartesian position.
real(rprec) function	vmec_equilibrium::vmec_get_ne_radial (this, s)
	Gets the electron density at a s position.
integer function	vmec_equilibrium::vmec_get_gp_te_num_hyper_param (this)
	Get the number of electron temperature gp kernel hyper parameters.
real(rprec) function, dimension(:), pointer	vmec_equilibrium::vmec_get_te_af (this)
	Gets the electron temperature profile af array.
real(rprec) function	vmec_equilibrium::vmec_get_gp_te_ij (this, i, j)
	Get the electron temperature gp kernel value for the two indicies.
real(rprec) function	vmec_equilibrium::vmec_get_gp_te_pi (this, x_cart, i)
	Get the electron temperature gp kernel value for the position and index.
real(rprec) function	vmec_equilibrium::vmec_get_gp_te_pp (this, x_cart, y_cart)
	Get the electron temperature gp kernel value for the position and position.
real(rprec) function	vmec_equilibrium::vmec_get_te_cart (this, x_cart)
	Gets the electron temperature at a cartesian position.
real(rprec) function	vmec_equilibrium::vmec_get_te_radial (this, s)
	Gets the electron temperature at a s position.
integer function	vmec_equilibrium::vmec_get_gp_ti_num_hyper_param (this)
	Get the number of ion temperature gp kernel hyper parameters.
real(rprec) function, dimension(:), pointer	vmec_equilibrium::vmec_get_ti_af (this)
	Gets the ion temperature profile af array.
real(rprec) function	vmec_equilibrium::vmec_get_gp_ti_ij (this, i, j)
	Get the ion temperature gp kernel value for the two indicies.
real(rprec) function	vmec_equilibrium::vmec_get_gp_ti_pi (this, x_cart, i)
	Get the ion temperature gp kernel value for the position and index.
real(rprec) function	vmec_equilibrium::vmec_get_gp_ti_pp (this, x_cart, y_cart)
	Get the ion temperature gp kernel value for the position and position.
real(rprec) function	vmec_equilibrium::vmec_get_ti_cart (this, x_cart)
	Gets the ion temperature at a cartesian position.
real(rprec) function	vmec_equilibrium::vmec_get_ti_radial (this, s)
	Gets the ion temperature at a s position.
integer function	vmec_equilibrium::vmec_get_gp_sxrem_num_hyper_param (this, index)
	Get the number of soft x-ray emission gp kernel hyper parameters.
real(rprec) function, dimension(:), pointer	vmec_equilibrium::vmec_get_sxrem_af (this, index)
	Gets the soft x-ray emissivity profile af array.
real(rprec) function	vmec_equilibrium::vmec_get_gp_sxrem_ij (this, i, j, index)
	Get the soft x-ray emissivity gp kernel value for the two indicies.
real(rprec) function	vmec_equilibrium::vmec_get_gp_sxrem_pi (this, x_cart, i, index)
	Get the soft x-ray emissivity gp kernel value for the position and index.
real(rprec) function	vmec_equilibrium::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.
real(rprec) function	vmec_equilibrium::vmec_get_sxrem_cart (this, x_cart, index)
	Gets the soft x-ray emissivity at a cartesian position.
real(rprec) function	vmec_equilibrium::vmec_get_sxrem_radial (this, s, index)
	Gets the soft x-ray emissivity at a s position.
real(rprec) function	vmec_equilibrium::vmec_get_p_cart (this, x_cart, normalize)
	Gets the plasma pressure at a cartesian position.
real(rprec) function	vmec_equilibrium::vmec_get_p_radial (this, s, normalize)
	Gets the plasma pressure at a s position.
real(rprec) function, dimension(3)	vmec_equilibrium::vmec_get_b_vec (this, x_cart, cyl)
	Gets the magnetic field vector at a position.
real(rprec) function	vmec_equilibrium::vmec_get_int_b_dphi (this, s, theta)
	Gets the loop integrated magnetic field at a position.
real(rprec) function, dimension(3)	vmec_equilibrium::vmec_get_suv (this, x_cart)
	Gets VMEC suv position.
real(rprec) function	vmec_equilibrium::vmec_get_s (this, x_cart)
	Gets VMEC s value at position.
real(rprec) function	vmec_equilibrium::vmec_get_flux (this, x_cart)
	Gets VMEC normalized flux value at position.
integer function	vmec_equilibrium::vmec_get_plasma_edge (this, phi, r, z)
	Gets the r and z positions of the outer surface at a toroidal angle.
real(rprec) function, dimension(:,:,:), pointer	vmec_equilibrium::vmec_get_magnetic_volume_rgrid (this)
	Get volume magnetic volume integration radial grid points.
real(rprec) function, dimension(:,:,:), pointer	vmec_equilibrium::vmec_get_magnetic_volume_zgrid (this)
	Get volume magnetic volume integration z grid points.
real(rprec) function, dimension(:,:,:), pointer	vmec_equilibrium::vmec_get_magnetic_volume_jrgrid (this)
	Get volume magnetic volume integration jr grid points.
real(rprec) function, dimension(:,:,:), pointer	vmec_equilibrium::vmec_get_magnetic_volume_jphigrid (this)
	Get volume magnetic volume integration jphi grid points.
real(rprec) function, dimension(:,:,:), pointer	vmec_equilibrium::vmec_get_magnetic_volume_jzgrid (this)
	Get volume magnetic volume integration jz grid points.
real(rprec) function	vmec_equilibrium::vmec_get_volume_int_element (this)
	Get volume integration element.
real(rprec) function, dimension(:,:), pointer	vmec_equilibrium::vmec_get_con_surface_krgrid (this)
	Get the conducting surface integration kr grid points.
real(rprec) function, dimension(:,:), pointer	vmec_equilibrium::vmec_get_con_surface_kphigrid (this)
	Get the conducting surface integration kphi grid points.
real(rprec) function, dimension(:,:), pointer	vmec_equilibrium::vmec_get_con_surface_kzgrid (this)
	Get the conducting surface integration kz grid points.
real(rprec) function	vmec_equilibrium::vmec_get_area_int_element (this)
	Get area integration element.
real(rprec) function, dimension(:), pointer	vmec_equilibrium::vmec_get_ext_currents (this, num_currents, scale_currents)
	Get external current.
real(rprec) function, dimension(3)	vmec_equilibrium::vmec_get_b_vac (this, r_cyl)
	Gets the vacuum magnetic field vector at a position.
real(rprec) function, dimension(3)	vmec_equilibrium::vmec_get_ext_b_plasma (this, position, axi_only)
	Get external plasma magnetic field.
integer function	vmec_equilibrium::vmec_get_grid_size (this)
	Get radial grid size.
real(rprec) function	vmec_equilibrium::vmec_get_grid_start (this)
	Get start of the radial grid.
real(rprec) function	vmec_equilibrium::vmec_get_grid_stop (this)
	Get radial grid size.
logical function	vmec_equilibrium::vmec_is_scaler_value (this, id)
	Checks if a parameter id is a scaler value.
logical function	vmec_equilibrium::vmec_is_1d_array (this, id)
	Checks if a parameter id is a 1d array.
logical function	vmec_equilibrium::vmec_is_2d_array (this, id)
	Checks if a parameter id is a 2d array.
logical function	vmec_equilibrium::vmec_is_recon_param (this, id)
	Checks if a parameter id is a reconstruction parameter.
logical function	vmec_equilibrium::vmec_is_using_point (this)
	Checks if the point magnetics are being used.
logical function	vmec_equilibrium::vmec_has_vacuum_field (this)
	Determines if vacuum field information is available.
logical function	vmec_equilibrium::vmec_is_in_plasma (this, x_cart)
	Determines if a point is inside the plasma or outside.
type(vertex) function, pointer	vmec_equilibrium::vmec_limit_path_to_boundary (this, path)
	Limit an integration path to the boundary.
real(rprec) function, dimension(3)	vmec_equilibrium::vmec_gradient_descent (this, t, u, dx, x0)
	Gradient descent to minize the vmec_equilibrium::vmec_limit_chi.
subroutine	vmec_equilibrium::vmec_descent_chi2 (this, chi2)
	Function to compute chi value and it's gradients.
logical function	vmec_equilibrium::vmec_converge (this, num_iter, iou, eq_comm, state_flags)
	Solves the VMEC equilibrium.
subroutine	vmec_equilibrium::vmec_read_vac_file (this, index, eq_comm)
	Loads the vacuum magnetic field file.
subroutine	vmec_equilibrium::vmec_save_state (this)
	Save the internal state of the equilibrium.
subroutine	vmec_equilibrium::vmec_reset_state (this)
	Reset the internal state of the equilibrium.
subroutine	vmec_equilibrium::vmec_write (this, iou)
	Write out the equilibrium to an output file.
subroutine	vmec_equilibrium::vmec_write_input (this, current_step)
	Write the current valid input.
subroutine	vmec_equilibrium::vmec_def_result (this, result_ncid, maxnsetps_dim_id)
	Define NetCDF variables for the result file.
subroutine	vmec_equilibrium::vmec_write_init_data (this, result_ncid)
	Write inital data to NetCDF result file.
subroutine	vmec_equilibrium::vmec_write_step_data (this, result_ncid, current_step)
	Write step data to NetCDF result file.
subroutine	vmec_equilibrium::vmec_restart (this, result_ncid, current_step)
	Restart vmec from the result file.
subroutine	vmec_equilibrium::vmec_sync_state (this, recon_comm)
	Syncronize the vmec state to children.
subroutine	vmec_equilibrium::vmec_sync_child (this, index, recon_comm)
	Syncronize a child vmec state to the parent.
subroutine	vmec_equilibrium::vmec_reset_boundary (this)
	Reset the fixed boundary coefficients.

Variables
integer, parameter	vmec_equilibrium::vmec_ac_id = 13
	1D Array of function current profile parameters. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_ac_aux_s_id = 14
	1D Array of segment current profile s poitions. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_ac_aux_f_id = 15
	1D Array of segment current profile f values. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_ai_id = 16
	1D Array of function iotabar profile parameters. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_ai_aux_s_id = 17
	1D Array of segment iotabar profile s poitions. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_ai_aux_f_id = 18
	1D Array of segment iotabar profile f values. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_am_id = 19
	1D Array of function pressure profile parameters. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_am_aux_s_id = 20
	1D Array of segment pressure profile s poitions. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_am_aux_f_id = 21
	1D Array of segment pressure profile f values. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_bloat_id = 22
	Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_rbc_id = 23
	2D Array of outer boundary R cosine coeffiecents. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_zbs_id = 24
	2D Array of outer boundary Z sine coeffiecents. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_rbs_id = 25
	2D Array of outer boundary R sine coeffiecents. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_zbc_id = 26
	2D Array of outer boundary Z cosine coeffiecents. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_extcur_id = 27
	1D Array of external currents. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_curtor_id = 28
	The toroidal current. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_phiedge_id = 29
	The edge magnetic flux. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_pres_scale_id = 30
	The scaling parameter for the pressure. Defined in vmec_input.
integer, parameter	vmec_equilibrium::vmec_rmnc_id = 31
	2D Array of surface R cosine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_zmns_id = 32
	2D Array of surface Z sine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_lmns_id = 33
	2D Array of surface lambda cosine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_gmnc_id = 34
	2D Array of surface g cosine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_bsubsmns_id = 35
	2D Array of surface B_s sine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_bsubumnc_id = 36
	2D Array of surface B_u cosine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_bsubvmnc_id = 37
	2D Array of surface B_v cosine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_bsupumnc_id = 38
	2D Array of surface B^u cosine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_bsupvmnc_id = 39
	2D Array of surface B^v cosine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_rmns_id = 40
	2D Array of surface R sine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_zmnc_id = 41
	2D Array of surface Z cosine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_lmnc_id = 42
	2D Array of surface lambda sine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_gmns_id = 43
	2D Array of surface g sine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_bsubsmnc_id = 44
	2D Array of surface B_s cosine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_bsubumns_id = 45
	2D Array of surface B_u sine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_bsubvmns_id = 46
	2D Array of surface B_v sine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_bsupumns_id = 47
	2D Array of surface B^u sine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_bsupvmns_id = 48
	2D Array of surface B^v sine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_phi_id = 49
	Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_iotaf_id = 50
	1D Array of full grid iotabar. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_iotas_id = 51
	1D Array of half grid iotabar. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_raxis_cc_id = 52
	1D Array of magnetic axis R cosine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_raxis_cs_id = 53
	1D Array of magnetic axis R sine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_zaxis_cc_id = 54
	1D Array of magnetic axis Z cosine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_zaxis_cs_id = 55
	1D Array of magnetic axis Z sine coeffiecents. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_qfact_id = 56
	1D Array of full grid safety factor. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_pres_id = 57
	1D Array of full grid safety factor. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_presf_id = 58
	1D Array of full grid safety factor. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_pp_ne_b_id = 59
	1D Array of function density profile parameters. Defined in pprofile_T.
integer, parameter	vmec_equilibrium::vmec_pp_ne_as_id = 60
	1D Array of segment density profile s poitions. Defined in pprofile_T.
integer, parameter	vmec_equilibrium::vmec_pp_ne_af_id = 61
	1D Array of segment density profile f values. Defined in pprofile_T.
integer, parameter	vmec_equilibrium::vmec_pp_sxrem_b_id = 62
	1D Array of function sxrem profile parameters. Defined in pprofile_T.
integer, parameter	vmec_equilibrium::vmec_pp_sxrem_as_id = 63
	1D Array of segment sxrem profile s poitions. Defined in pprofile_T.
integer, parameter	vmec_equilibrium::vmec_pp_sxrem_af_id = 64
	1D Array of segment sxrem profile f values. Defined in pprofile_T.
integer, parameter	vmec_equilibrium::vmec_pp_te_b_id = 65
	1D Array of function electron temperature profile parameters. Defined in pprofile_T.
integer, parameter	vmec_equilibrium::vmec_pp_te_as_id = 66
	1D Array of segment electron temperature profile s poitions. Defined in pprofile_T.
integer, parameter	vmec_equilibrium::vmec_pp_te_af_id = 67
	1D Array of segment electron temperature profile f values. Defined in pprofile_T.
integer, parameter	vmec_equilibrium::vmec_pp_ti_b_id = 68
	1D Array of function ion temperature profile parameters. Defined in pprofile_T.
integer, parameter	vmec_equilibrium::vmec_pp_ti_as_id = 69
	1D Array of segment ion temperature profile s poitions. Defined in pprofile_T.
integer, parameter	vmec_equilibrium::vmec_pp_ti_af_id = 70
	1D Array of segment ion temperature profile f values. Defined in pprofile_T.
integer, parameter	vmec_equilibrium::vmec_vvc_smaleli_id = 71
	Internal inducance. Defined in v3f_vmec_comm. Computed in eqfor.
integer, parameter	vmec_equilibrium::vmec_vvc_kappa_p_id = 72
	Mean elongation. Defined in v3f_vmec_comm. Computed in eqfor.
integer, parameter	vmec_equilibrium::vmec_betatot_id = 73
	Total Beta. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_betapol_id = 74
	Poloidal Beta. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_betator_id = 75
	Toroidal Beta. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_betaxis_id = 76
	Beta on axis. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_jcuru_id = 77
	Poloidal current density. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_jcurv_id = 78
	Toroidal current density. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::vmec_jdotb_id = 79
	Current density in direction of b field. Defined in read_wout_mod.
integer, parameter	vmec_equilibrium::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_equilibrium::vmec_z_offset_id = 81
	Plasma z offset. This is a parameter to allow changing the vertical shift of the plasma.
integer, parameter	vmec_equilibrium::magnetic_cache_vc_min_grid_points = 101
	Virtual casing grid points for vacuum field measurements.
real(rprec), parameter	vmec_equilibrium::magnetic_cache_vc_grid_dim = 0.01
	Virtual casing grid dimension.

Detailed Description

Contains module vmec_equilibrium.