vacuum_equilibrium::vacuum_class Interface Reference

Base class representing a vacuum_equilibrium. More...

Inheritance diagram for vacuum_equilibrium::vacuum_class:

Public Member Functions
PROCEDURE	set_param => vacuum_set_param
PROCEDURE	get_type => vacuum_get_type
PROCEDURE	get_param_id => vacuum_get_param_id
PROCEDURE	get_param_value => vacuum_get_param_value
PROCEDURE	get_param_name => vacuum_get_param_name
PROCEDURE	get_b_vec => vacuum_get_b_vec
PROCEDURE	get_int_b_dphi => vacuum_get_int_b_dphi
PROCEDURE	get_ext_currents => vacuum_get_ext_currents
PROCEDURE	is_1d_array => vacuum_is_1d_array
PROCEDURE	is_recon_param => vacuum_is_recon_param
PROCEDURE	write => vacuum_write
PROCEDURE	write_input => vacuum_write_input
FINAL	vacuum_destruct
type(vacuum_class) function, pointer	vacuum_construct (file_name, iou, force_solve)
	Construct a vacuum_class object. More...
Public Member Functions inherited from equilibrium::equilibrium_class
PROCEDURE	set_param => equilibrium_set_param
PROCEDURE	set_magnetic_cache_response => equilibrium_set_magnetic_cache_response
PROCEDURE	set_magnetic_cache_point => equilibrium_set_magnetic_cache_point
GENERIC	set_magnetic_cache => set_magnetic_cache_response, set_magnetic_cache_point
PROCEDURE	get_type => equilibrium_get_type
PROCEDURE	get_param_id => equilibrium_get_param_id
PROCEDURE	get_param_name => equilibrium_get_param_name
PROCEDURE	get_param_value => equilibrium_get_param_value
PROCEDURE	get_gp_ne_num_hyper_param => equilibrium_get_gp_ne_num_hyper_param
PROCEDURE	get_ne_af => equilibrium_get_ne_af
PROCEDURE	get_gp_ne_ij => equilibrium_get_gp_ne_ij
PROCEDURE	get_gp_ne_pi => equilibrium_get_gp_ne_pi
PROCEDURE	get_gp_ne_pp => equilibrium_get_gp_ne_pp
GENERIC	get_gp_ne => get_gp_ne_ij, get_gp_ne_pi, get_gp_ne_pp
PROCEDURE	get_ne_cart => equilibrium_get_ne_cart
PROCEDURE	get_ne_radial => equilibrium_get_ne_radial
GENERIC	get_ne => get_ne_cart, get_ne_radial
PROCEDURE	get_gp_te_num_hyper_param => equilibrium_get_gp_te_num_hyper_param
PROCEDURE	get_te_af => equilibrium_get_te_af
PROCEDURE	get_gp_te_ij => equilibrium_get_gp_te_ij
PROCEDURE	get_gp_te_pi => equilibrium_get_gp_te_pi
PROCEDURE	get_gp_te_pp => equilibrium_get_gp_te_pp
GENERIC	get_gp_te => get_gp_te_ij, get_gp_te_pi, get_gp_te_pp
PROCEDURE	get_te_cart => equilibrium_get_te_cart
PROCEDURE	get_te_radial => equilibrium_get_te_radial
GENERIC	get_te => get_te_cart, get_te_radial
PROCEDURE	get_gp_ti_num_hyper_param => equilibrium_get_gp_ti_num_hyper_param
PROCEDURE	get_ti_af => equilibrium_get_ti_af
PROCEDURE	get_gp_ti_ij => equilibrium_get_gp_ti_ij
PROCEDURE	get_gp_ti_pi => equilibrium_get_gp_ti_pi
PROCEDURE	get_gp_ti_pp => equilibrium_get_gp_ti_pp
GENERIC	get_gp_ti => get_gp_ti_ij, get_gp_ti_pi, get_gp_ti_pp
PROCEDURE	get_ti_cart => equilibrium_get_ti_cart
PROCEDURE	get_ti_radial => equilibrium_get_ti_radial
GENERIC	get_ti => get_ti_cart, get_ti_radial
PROCEDURE	get_gp_sxrem_num_hyper_param => equilibrium_get_gp_sxrem_num_hyper_param
PROCEDURE	get_sxrem_af => equilibrium_get_sxrem_af
PROCEDURE	get_gp_sxrem_ij => equilibrium_get_gp_sxrem_ij
PROCEDURE	get_gp_sxrem_pi => equilibrium_get_gp_sxrem_pi
PROCEDURE	get_gp_sxrem_pp => equilibrium_get_gp_sxrem_pp
GENERIC	get_gp_sxrem => get_gp_sxrem_ij, get_gp_sxrem_pi, get_gp_sxrem_pp
PROCEDURE	get_sxrem_cart => equilibrium_get_sxrem_cart
PROCEDURE	get_sxrem_radial => equilibrium_get_sxrem_radial
GENERIC	get_sxrem => get_sxrem_cart, get_sxrem_radial
PROCEDURE	get_p_cart => equilibrium_get_p_cart
PROCEDURE	get_p_radial => equilibrium_get_p_radial
GENERIC	get_p => get_p_cart, get_p_radial
PROCEDURE	get_b_vec => equilibrium_get_b_vec
PROCEDURE	get_int_b_dphi => equilibrium_get_int_b_dphi
PROCEDURE	get_plasma_edge => equilibrium_get_plasma_edge
PROCEDURE	get_magnetic_volume_rgrid => equilibrium_get_magnetic_volume_rgrid
PROCEDURE	get_magnetic_volume_zgrid => equilibrium_get_magnetic_volume_zgrid
PROCEDURE	get_magnetic_volume_jrgrid => equilibrium_get_magnetic_volume_jrgrid
PROCEDURE	get_magnetic_volume_jphigrid => equilibrium_get_magnetic_volume_jphigrid
PROCEDURE	get_magnetic_volume_jzgrid => equilibrium_get_magnetic_volume_jzgrid
PROCEDURE	get_volume_int_element => equilibrium_get_volume_int_element
PROCEDURE	get_con_surface_krgrid => equilibrium_get_con_surface_krgrid
PROCEDURE	get_con_surface_kphigrid => equilibrium_get_con_surface_kphigrid
PROCEDURE	get_con_surface_kzgrid => equilibrium_get_con_surface_kzgrid
PROCEDURE	get_area_int_element => equilibrium_get_area_int_element
PROCEDURE	get_ext_currents => equilibrium_get_ext_currents
PROCEDURE	get_ext_b_plasma => equilibrium_get_ext_b_plasma
PROCEDURE	get_grid_size => equilibrium_get_grid_size
PROCEDURE	get_grid_start => equilibrium_get_grid_start
PROCEDURE	get_grid_stop => equilibrium_get_grid_stop
PROCEDURE	is_scaler_value => equilibrium_is_scaler_value
PROCEDURE	is_2d_array => equilibrium_is_2d_array
PROCEDURE	is_recon_param => equilibrium_is_recon_param
PROCEDURE	is_using_point => equilibrium_is_using_point
PROCEDURE	has_vacuum_field => equilibrium_has_vacuum_field
PROCEDURE	is_in_plasma => equilibrium_is_in_plasma
PROCEDURE	limit_path_to_boundary => equilibrium_limit_path_to_boundary
PROCEDURE	converge => equilibrium_converge
PROCEDURE	read_vac_file => equilibrium_read_vac_file
PROCEDURE	save_state => equilibrium_save_state
PROCEDURE	reset_state => equilibrium_reset_state
PROCEDURE	write => equilibrium_write
PROCEDURE	write_input => equilibrium_write_input
PROCEDURE	def_result => equilibrium_def_result
PROCEDURE	write_init_data => equilibrium_write_init_data
PROCEDURE	write_step_data => equilibrium_write_step_data
PROCEDURE	restart => equilibrium_restart
PROCEDURE	sync_state => equilibrium_sync_state
PROCEDURE	sync_child => equilibrium_sync_child
FINAL	equilibrium_destruct

Public Attributes
character(len=path_length)	vacuum_file_name
	File name of the vacuum namelist inout file.
real(rprec), dimension(:), pointer	extcur => null()
	Array of external currents.
Public Attributes inherited from equilibrium::equilibrium_class
logical	force_solve
	Controls if an equilibrium is forced to be resolved or not.

Detailed Description

Base class representing a vacuum_equilibrium.

Interface for vacuum constructor.

Super Class:

equilibrium

Member Function/Subroutine Documentation

vacuum_construct()

type (vacuum_class) function, pointer vacuum_equilibrium::vacuum_class::vacuum_construct	(	character (len=*), intent(in)	file_name,
		integer, intent(in)	iou,
		logical, intent(in)	force_solve
	)

Construct a vacuum_class object.

Allocates memory and initializes a vacuum_class object.

Parameters

[in]	file_name	Filename of the vacuum namelist input file.
[in]	iou	Input/output unit to log messages to.
[in]	force_solve	If true, forces the equilbirum to resolve every time.

Returns

A pointer to a constructed vacuum_class object.

---

The documentation for this interface was generated from the following file:

• V3FIT/Sources/vacuum_equilibrium.f