equilibrium.f File Reference

Contains module equilibrium. More...

Go to the source code of this file.

Data Types
type	equilibrium::equilibrium_class
	Base class representing a equilibrium. More...
interface	equilibrium::equilibrium_construct
	Interface for the construction of equilibrium_class types using equilibrium_construct_vmec, equilibrium_construct_vacuum or equilibrium_construct_siesta. More...
interface	equilibrium::equilibrium_set_magnetic_cache
	Interface for the equilibrium set magnetic cache. More...
interface	equilibrium::equilibrium_get_ne
	Interface for the equilibrium density profile values. More...
interface	equilibrium::equilibrium_get_gp_ne
	Interface for the equilibrium guassian process density profile values. More...
interface	equilibrium::equilibrium_get_te
	Interface for the equilibrium electron temperature profile values. More...
interface	equilibrium::equilibrium_get_gp_te
	Interface for the equilibrium guassian process electron temperature profile values. More...
interface	equilibrium::equilibrium_get_ti
	Interface for the equilibrium ion temperature profile values. More...
interface	equilibrium::equilibrium_get_gp_ti
	Interface for the equilibrium guassian process ion temperature profile values. More...
interface	equilibrium::equilibrium_get_ze
	Interface for the effective charge profile values. More...
interface	equilibrium::equilibrium_get_sxrem
	Interface for the equilibrium soft x-ray emissivity profile values. More...
interface	equilibrium::equilibrium_get_gp_sxrem
	Interface for the equilibrium guassian process soft x-ray emissivity profile values. More...
interface	equilibrium::equilibrium_get_p
	Interface for the equilibrium pressure profile values. More...

Modules
module	equilibrium
	Defines the base class of the type equilibrium_class. Equilibrium is an abstract interface to the equilibrium solver. Every method is meant to be overwritten by a subclass method with a few exceptions. For instance a vacuum equilibrium could use the default return values for equilibrium_get_ne, equilibrium_get_te and equilibrium_get_sxrem methods.

Functions/Subroutines
type(equilibrium_class) function, pointer	equilibrium::equilibrium_construct_vmec (vmec_object, force_solve)
	Construct a equilibrium_class containing a vmec_equilibrium object. More...
type(equilibrium_class) function, pointer	equilibrium::equilibrium_construct_vacuum (vacuum_object, force_solve)
	Construct a equilibrium_class containing a vacuum_equilibrium object. More...
type(equilibrium_class) function, pointer	equilibrium::equilibrium_construct_siesta (siesta_object, force_solve)
	Construct a equilibrium_class containing a siesta_equilibrium object. More...
subroutine	equilibrium::equilibrium_destruct (this)
	Deconstruct a equilibrium_class object. More...
subroutine	equilibrium::equilibrium_set_param (this, id, i_index, j_index, value, eq_comm, state_flags)
	Sets the value of a reconstruction equilibrium parameter. More...
subroutine	equilibrium::equilibrium_set_magnetic_cache_response (this, response_object, state_flags)
	Sets the magnetic cache of the equilibrium for the magnetic responce. More...
subroutine	equilibrium::equilibrium_set_magnetic_cache_point (this, use_axi, state_flags)
	Sets the magnetic cache of the equilibrium for points. More...
integer function	equilibrium::equilibrium_get_param_id (this, param_name)
	Get the id for a reconstruction parameter. More...
real(rprec) function	equilibrium::equilibrium_get_param_value (this, id, i_index, j_index)
	Gets the value of a reconstruction equilibrium parameter. More...
character(len=data_name_length) function	equilibrium::equilibrium_get_param_name (this, id)
	Gets the name of a reconstruction equilibrium parameter. More...
integer function	equilibrium::equilibrium_get_gp_ne_num_hyper_param (this)
	Get the number of electron density gp kernel hyper parameters. More...
real(rprec) function, dimension(:), pointer	equilibrium::equilibrium_get_ne_af (this)
	Get the electron density profile af array. More...
real(rprec) function	equilibrium::equilibrium_get_gp_ne_ij (this, i, j)
	Get the electron density gp kernel value for the two indicies. More...
real(rprec) function	equilibrium::equilibrium_get_gp_ne_pi (this, x_cart, i)
	Get the electron density gp kernel value for the position and index. More...
real(rprec) function	equilibrium::equilibrium_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	equilibrium::equilibrium_get_ne_cart (this, x_cart)
	Gets the electron density at a cartesian position. More...
real(rprec) function	equilibrium::equilibrium_get_ne_radial (this, r)
	Gets the electron density at a radial position. More...
integer function	equilibrium::equilibrium_get_gp_te_num_hyper_param (this)
	Get the number of electron temperature gp kernel hyper parameters. More...
real(rprec) function, dimension(:), pointer	equilibrium::equilibrium_get_te_af (this)
	Get the electron temperature profile af array. More...
real(rprec) function	equilibrium::equilibrium_get_gp_te_ij (this, i, j)
	Get the electron temperature gp kernel value for the two indicies. More...
real(rprec) function	equilibrium::equilibrium_get_gp_te_pi (this, x_cart, i)
	Get the electron temperature gp kernel value for the position and index. More...
real(rprec) function	equilibrium::equilibrium_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	equilibrium::equilibrium_get_te_cart (this, x_cart)
	Gets the electron temperature at a cartesian position. More...
real(rprec) function	equilibrium::equilibrium_get_te_radial (this, r)
	Gets the electron temperature at a radial position. More...
integer function	equilibrium::equilibrium_get_gp_ti_num_hyper_param (this)
	Get the number of ion temperature gp kernel hyper parameters. More...
real(rprec) function, dimension(:), pointer	equilibrium::equilibrium_get_ti_af (this)
	Get the ion temperature profile af array. More...
real(rprec) function	equilibrium::equilibrium_get_gp_ti_ij (this, i, j)
	Get the ion temperature gp kernel value for the two indicies. More...
real(rprec) function	equilibrium::equilibrium_get_gp_ti_pi (this, x_cart, i)
	Get the ion temperature gp kernel value for the position and index. More...
real(rprec) function	equilibrium::equilibrium_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	equilibrium::equilibrium_get_ti_cart (this, x_cart)
	Gets the ion temperature at a cartesian position. More...
real(rprec) function	equilibrium::equilibrium_get_ti_radial (this, r)
	Gets the ion temperature at a radial position. More...
real(rprec) function	equilibrium::equilibrium_get_ze_cart (this, x_cart)
	Gets the effective charge at a cartesian position. More...
real(rprec) function	equilibrium::equilibrium_get_ze_radial (this, r)
	Gets the effective charge at a radial position. More...
integer function	equilibrium::equilibrium_get_gp_sxrem_num_hyper_param (this, index)
	Get the number of soft x-ray emissivity gp kernel hyper parameters. More...
real(rprec) function, dimension(:), pointer	equilibrium::equilibrium_get_sxrem_af (this, index)
	Get the soft x-ray emissivity profile af array. More...
real(rprec) function	equilibrium::equilibrium_get_gp_sxrem_ij (this, i, j, index)
	Get the electron density gp kernel value for the two indicies. More...
real(rprec) function	equilibrium::equilibrium_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	equilibrium::equilibrium_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	equilibrium::equilibrium_get_sxrem_cart (this, x_cart, index)
	Gets the soft x-ray emissivity at a cartesian position. More...
real(rprec) function	equilibrium::equilibrium_get_sxrem_radial (this, r, index)
	Gets the soft x-ray emissivity at a radial position. More...
real(rprec) function	equilibrium::equilibrium_get_p_cart (this, x_cart)
	Gets the plasma pressure at a cartesian position. More...
real(rprec) function	equilibrium::equilibrium_get_p_radial (this, r)
	Gets the plasma pressure at a radial position. More...
real(rprec) function, dimension(3)	equilibrium::equilibrium_get_b_vec (this, x_cart, cyl)
	Gets the magnetic field vector at a position. More...
real(rprec) function	equilibrium::equilibrium_get_int_b_dphi (this, r, theta)
	Gets the loop integrated magnetic field at a position. More...
integer function	equilibrium::equilibrium_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	equilibrium::equilibrium_get_magnetic_volume_rgrid (this)
	Get volume magnetic volume integration radial grid points. More...
real(rprec) function, dimension(:,:,:), pointer	equilibrium::equilibrium_get_magnetic_volume_zgrid (this)
	Get volume magnetic volume integration z grid points. More...
real(rprec) function, dimension(:,:,:), pointer	equilibrium::equilibrium_get_magnetic_volume_jrgrid (this)
	Get volume magnetic volume integration jr grid points. More...
real(rprec) function, dimension(:,:,:), pointer	equilibrium::equilibrium_get_magnetic_volume_jphigrid (this)
	Get volume magnetic volume integration jphi grid points. More...
real(rprec) function, dimension(:,:,:), pointer	equilibrium::equilibrium_get_magnetic_volume_jzgrid (this)
	Get volume magnetic volume integration jz grid points. More...
real(rprec) function	equilibrium::equilibrium_get_volume_int_element (this)
	Get volume integration element. More...
real(rprec) function, dimension(:,:), pointer	equilibrium::equilibrium_get_con_surface_krgrid (this)
	Get the conducting surface integration kr grid points. More...
real(rprec) function, dimension(:,:), pointer	equilibrium::equilibrium_get_con_surface_kphigrid (this)
	Get the conducting surface integration kphi grid points. More...
real(rprec) function, dimension(:,:), pointer	equilibrium::equilibrium_get_con_surface_kzgrid (this)
	Get the conducting surface integration kz grid points. More...
real(rprec) function	equilibrium::equilibrium_get_area_int_element (this)
	Get area integration element. More...
real(rprec) function, dimension(:), pointer	equilibrium::equilibrium_get_ext_currents (this, num_currents, scale_currents)
	Get external current. More...
real(rprec) function, dimension(3)	equilibrium::equilibrium_get_ext_b_plasma (this, position, axi_only)
	Get external plasma magnetic field. More...
integer function	equilibrium::equilibrium_get_grid_size (this)
	Get radial grid size. More...
real(rprec) function	equilibrium::equilibrium_get_grid_start (this)
	Get start of the radial grid. More...
real(rprec) function	equilibrium::equilibrium_get_grid_stop (this)
	Get stop of the radial grid. More...
logical function	equilibrium::equilibrium_is_scaler_value (this, id)
	Checks if a parameter id is a scaler value. More...
logical function	equilibrium::equilibrium_is_1d_array (this, id)
	Checks if a parameter id is a 1d array. More...
logical function	equilibrium::equilibrium_is_2d_array (this, id)
	Checks if a parameter id is a 2d array. More...
logical function	equilibrium::equilibrium_is_recon_param (this, id)
	Checks if a parameter id is a reconstruction parameter. More...
logical function	equilibrium::equilibrium_is_using_point (this)
	Checks if a the point magnetics are being used. More...
logical function	equilibrium::equilibrium_converge (this, num_iter, iou, eq_comm, state_flags)
	Solves the equilibrium. More...
subroutine	equilibrium::equilibrium_read_vac_file (this, index, eq_comm)
	Loads the vacuum magnetic field file. More...
subroutine	equilibrium::equilibrium_save_state (this)
	Save the internal state of the equilibrium. More...
subroutine	equilibrium::equilibrium_reset_state (this)
	Reset the internal state of the equilibrium. More...
subroutine	equilibrium::equilibrium_write (this, iou)
	Write out the equilibrium to an output file. More...
subroutine	equilibrium::equilibrium_write_input (this, current_step)
	Write the current valid input. More...
subroutine	equilibrium::equilibrium_def_result (this, result_ncid, maxnsetps_dim_id)
	Define NetCDF variables for the result file. More...
subroutine	equilibrium::equilibrium_write_init_data (this, result_ncid)
	Write inital data to NetCDF result file. More...
subroutine	equilibrium::equilibrium_write_step_data (this, result_ncid, current_step)
	Write step data to NetCDF result file. More...
subroutine	equilibrium::equilibrium_restart (this, result_ncid, current_step)
	Restart equilibrium. More...
subroutine	equilibrium::equilibrium_sync_state (this, recon_comm)
	Syncronize the equilibrium state to children. More...
subroutine	equilibrium::equilibrium_sync_child (this, index, recon_comm)
	Syncronize a child equilibrium state to the parent. More...

Variables
integer, parameter	equilibrium::equilibrium_no_type = -1
	Type descriptor for the equilibrium_class no subclass.
integer, parameter	equilibrium::equilibrium_vmec_type = 0
	Type descriptor for the equilibrium_class subclass vmec_equilibrium.
integer, parameter	equilibrium::equilibrium_vacuum_type = 1
	Type descriptor for the equilibrium_class subclass vacuum_equilibrium.
integer, parameter	equilibrium::equilibrium_siesta_type = 2
	Type descriptor for the equilibrium_class subclass siesta_equilibrium.

Detailed Description

Contains module equilibrium.

Definition in file equilibrium.f.