Base class representing a equilibrium. More...

Inheritance diagram for equilibrium::equilibrium_class:

Public Member Functions
procedure	set_param (this, id, i_index, j_index, value, eq_comm, state_flags)
	Sets the value of a reconstruction equilibrium parameter.

procedure	set_magnetic_cache_response (this, response_object, state_flags)
	Sets the magnetic cache of the equilibrium for the magnetic response.

procedure	set_magnetic_cache_point (this, use_axi, state_flags)
	Sets the magnetic cache of the equilibrium for points.

GENERIC	set_magnetic_cache set_magnetic_cache_response, set_magnetic_cache_point

procedure	get_type (this)
	Checks if a parameter id is a reconstruction parameter.

procedure	get_param_id (this, param_name)
	Get the id for a reconstruction parameter.

procedure	get_param_name (this, id)
	Gets the name of a reconstruction equilibrium parameter.

procedure	get_param_value (this, id, i_index, j_index)
	Gets the value of a reconstruction equilibrium parameter.

procedure	get_gp_ne_num_hyper_param (this)
	Get the number of electron density gp kernel hyper parameters.

procedure	get_ne_af (this)
	Get the electron density profile af array.

procedure	get_gp_ne_ij (this, i, j)
	Get the electron density gp kernel value for the two indicies.

procedure	get_gp_ne_pi (this, x_cart, i)
	Get the electron density gp kernel value for the position and index.

procedure	get_gp_ne_pp (this, x_cart, y_cart)
	Get the electron density gp kernel value for the position and position.

GENERIC	get_gp_ne get_gp_ne_ij, get_gp_ne_pi, get_gp_ne_pp

procedure	get_ne_cart (this, x_cart)
	Gets the electron density at a cartesian position.

procedure	get_ne_radial (this, s)
	Gets the electron density at a radial position.

GENERIC	get_ne get_ne_cart, get_ne_radial

procedure	get_gp_te_num_hyper_param (this)
	Get the number of electron temperature gp kernel hyper parameters.

procedure	get_te_af (this)
	Get the electron temperature profile af array.

procedure	get_gp_te_ij (this, i, j)
	Get the electron temperature gp kernel value for the two indicies.

procedure	get_gp_te_pi (this, x_cart, i)
	Get the electron temperature gp kernel value for the position and index.

procedure	get_gp_te_pp (this, x_cart, y_cart)
	Get the electron temperature gp kernel value for the position and position.

GENERIC	get_gp_te get_gp_te_ij, get_gp_te_pi, get_gp_te_pp

procedure	get_te_cart (this, x_cart)
	Gets the electron temperature at a cartesian position.

procedure	get_te_radial (this, s)
	Gets the electron temperature at a radial position.

GENERIC	get_te get_te_cart, get_te_radial

procedure	get_gp_ti_num_hyper_param (this)
	Get the number of ion temperature gp kernel hyper parameters.

procedure	get_ti_af (this)
	Get the ion temperature profile af array.

procedure	get_gp_ti_ij (this, i, j)
	Get the ion temperature gp kernel value for the two indicies.

procedure	get_gp_ti_pi (this, x_cart, i)
	Get the ion temperature gp kernel value for the position and index.

procedure	get_gp_ti_pp (this, x_cart, y_cart)
	Get the ion temperature gp kernel value for the position and position.

GENERIC	get_gp_ti get_gp_ti_ij, get_gp_ti_pi, get_gp_ti_pp

procedure	get_ti_cart (this, x_cart)
	Gets the ion temperature at a cartesian position.

procedure	get_ti_radial (this, s)
	Gets the ion temperature at a radial position.

GENERIC	get_ti get_ti_cart, get_ti_radial

procedure	get_gp_sxrem_num_hyper_param (this, index)
	Get the number of soft x-ray emissivity gp kernel hyper parameters.

procedure	get_sxrem_af (this, index)
	Get the soft x-ray emissivity profile af array.

procedure	get_gp_sxrem_ij (this, i, j, index)
	Get the electron density gp kernel value for the two indicies.

procedure	get_gp_sxrem_pi (this, x_cart, i, index)
	Get the soft x-ray emissivity gp kernel value for the position and index.

procedure	get_gp_sxrem_pp (this, x_cart, y_cart, index)
	Get the soft x-ray emissivity gp kernel value for the position and position.

GENERIC	get_gp_sxrem get_gp_sxrem_ij, get_gp_sxrem_pi, get_gp_sxrem_pp

procedure	get_sxrem_cart (this, x_cart, index)
	Gets the soft x-ray emissivity at a cartesian position.

procedure	get_sxrem_radial (this, s, index)
	Gets the soft x-ray emissivity at a radial position.

GENERIC	get_sxrem get_sxrem_cart, get_sxrem_radial

procedure	get_p_cart (this, x_cart, normalize)
	Gets the plasma pressure at a cartesian position.

procedure	get_p_radial (this, s, normalize)
	Gets the plasma pressure at a radial position.

GENERIC	get_p get_p_cart, get_p_radial

procedure	get_b_vec (this, x_cart, cyl)
	Gets the magnetic field vector at a position.

procedure	get_int_b_dphi (this, s, theta)
	Gets the loop integrated magnetic field at a position.

procedure	get_plasma_edge (this, phi, r, z)
	Gets the r and z positions of the outer surface at a toroidal angle.

procedure	get_magnetic_volume_rgrid (this)
	Get volume magnetic volume integration radial grid points.

procedure	get_magnetic_volume_zgrid (this)
	Get volume magnetic volume integration z grid points.

procedure	get_magnetic_volume_jrgrid (this)
	Get volume magnetic volume integration jr grid points.

procedure	get_magnetic_volume_jphigrid (this)
	Get volume magnetic volume integration jphi grid points.

procedure	get_magnetic_volume_jzgrid (this)
	Get volume magnetic volume integration jz grid points.

procedure	get_volume_int_element (this)
	Get volume integration element.

procedure	get_con_surface_krgrid (this)
	Get the conducting surface integration kr grid points.

procedure	get_con_surface_kphigrid (this)
	Get the conducting surface integration kphi grid points.

procedure	get_con_surface_kzgrid (this)
	Get the conducting surface integration kz grid points.

procedure	get_area_int_element (this)
	Get area integration element.

procedure	get_ext_currents (this, num_currents, scale_currents)
	Get external current.

procedure	get_ext_b_plasma (this, position, axi_only)
	Get external plasma magnetic field.

procedure	get_grid_size (this)
	Get radial grid size.

procedure	get_grid_start (this)
	Get start of the radial grid.

procedure	get_grid_stop (this)
	Get stop of the radial grid.

procedure	is_scaler_value (this, id)
	Checks if a parameter id is a scaler value.

procedure	is_2d_array (this, id)
	Checks if a parameter id is a 2d array.

procedure	is_recon_param (this, id)
	Checks if a parameter id is a reconstruction parameter.

procedure	is_using_point (this)
	Checks if the point magnetics are being used.

procedure	has_vacuum_field (this)
	Determines if vacuum field information is available.

procedure	is_in_plasma (this, x_cart)
	Determines if a point is inside the plasma or outside.

procedure	limit_path_to_boundary (this, path)
	Limit an integration path to the boundary.

procedure	converge (this, num_iter, iou, eq_comm, state_flags)
	Solves the equilibrium.

procedure	read_vac_file (this, index, eq_comm)
	Loads the vacuum magnetic field file.

procedure	save_state (this)
	Save the internal state of the equilibrium.

procedure	reset_state (this)
	Reset the internal state of the equilibrium.

procedure	write (this, iou)
	Write out the equilibrium to an output file.

procedure	write_input (this, current_step)
	Write out the equilibrium to an output file.

procedure	def_result (this, result_ncid, maxnsetps_dim_id)
	Define NetCDF variables for the result file.

procedure	write_init_data (this, result_ncid)
	Write inital data to NetCDF result file.

procedure	write_step_data (this, result_ncid, current_step)
	Write step data to NetCDF result file.

procedure	restart (this, result_ncid, current_step)
	Restart equilibrium.

procedure	sync_state (this, recon_comm)
	Syncronize the equilibrium state to children.

procedure	sync_child (this, index, recon_comm)
	Syncronize a child equilibrium state to the parent.

FINAL	equilibrium_destruct (this)
	Deconstruct a equilibrium_class object.

Public Attributes
logical	force_solve
	Controls if an equilibrium is forced to be resolved or not.

Detailed Description

Base class representing a equilibrium.

Sub Classes:: vmec_equilibrium

Member Function/Subroutine Documentation

◆ converge()

procedure equilibrium::equilibrium_class::converge	(	class (equilibrium_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 equilibrium.

This method is virtual. The actual solving of the equilibrium should be handled by a subclass method.

See also: vmec_equilibrium::vmec_converge; siesta_equilibrium::siesta_converge

Parameters

[in,out]	this	A equilibrium_class instance.
[in,out]	num_iter	Counter to track the number of iterations.
[in]	iou	Input/output unit of the file to write logs to.
[in]	eq_comm	MPI communicator pool for the equilibrium.
[in]	state_flags	Bitwise flags to indicate which parts of the model changed.

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

◆ def_result()

procedure equilibrium::equilibrium_class::def_result	(	class (equilibrium_class), intent(in)	this,
		integer, intent(in)	result_ncid,
		integer, intent(in)	maxnsetps_dim_id
	)

Define NetCDF variables for the result file.

This method is virtual. The actual defining of the equilibrium variables should be handled by a subclass method.

See also: vmec_equilibrium::vmec_def_result; siesta_equilibrium::siesta_def_result

Parameters

[in]	this	A equilibrium_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.

◆ equilibrium_destruct()

FINAL equilibrium::equilibrium_class::equilibrium_destruct ( type (equilibrium_class), intent(inout) this )

final

Deconstruct a equilibrium_class object.

Deallocates memory and uninitializes a equilibrium_class object.

Parameters

[in,out] this A equilibrium_class instance.

◆ get_area_int_element()

procedure equilibrium::equilibrium_class::get_area_int_element ( class (equilibrium_class), intent(in) this )

Get area integration element.

This method is virtual. The actual getting of the area integration element should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_area_int_element; siesta_equilibrium::siesta_get_area_int_element

Parameters

[in] this A equilibrium_class instance.

Returns: The volume integration element.

◆ get_b_vec()

procedure equilibrium::equilibrium_class::get_b_vec	(	class (equilibrium_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 is virtual. The actual getting of the magnetic field vector should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_B_vec; vacuum_equilibrium::vacuum_get_B_vec; siesta_equilibrium::siesta_get_B_vec

Parameters

[in]	this	A equilibrium_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.

◆ get_con_surface_kphigrid()

procedure equilibrium::equilibrium_class::get_con_surface_kphigrid ( class (equilibrium_class), intent(in) this )

Get the conducting surface integration kphi grid points.

This method is virtual. The actual getting of the kphi grid points should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_con_surface_kphigrid; siesta_equilibrium::siesta_get_con_surface_kphigrid

Parameters

[in] this A equilibrium_class instance.

Returns: The kphi grid points.

◆ get_con_surface_krgrid()

procedure equilibrium::equilibrium_class::get_con_surface_krgrid ( class (equilibrium_class), intent(in) this )

Get the conducting surface integration kr grid points.

This method is virtual. The actual getting of the kr grid points should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_con_surface_krgrid; siesta_equilibrium::siesta_get_con_surface_krgrid

Parameters

[in] this A equilibrium_class instance.

Returns: The kr grid points.

◆ get_con_surface_kzgrid()

procedure equilibrium::equilibrium_class::get_con_surface_kzgrid ( class (equilibrium_class), intent(in) this )

Get the conducting surface integration kz grid points.

This method is virtual. The actual getting of the kz grid points should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_con_surface_kzgrid; siesta_equilibrium::siesta_get_con_surface_kzgrid

Parameters

[in] this A equilibrium_class instance.

Returns: The kz grid points.

◆ get_ext_b_plasma()

procedure equilibrium::equilibrium_class::get_ext_b_plasma	(	class (equilibrium_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	position,
		logical, intent(in)	axi_only
	)

Get external plasma magnetic field.

This method is virtual. The actual getting of the external current should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_ext_b_plasma; siesta_equilibrium::siesta_get_ext_b_plasma

Parameters

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

Returns: The external currents.

◆ get_ext_currents()

procedure equilibrium::equilibrium_class::get_ext_currents	(	class (equilibrium_class), intent(in)	this,
		integer, intent(in)	num_currents,
		logical, intent(out)	scale_currents
	)

Get external current.

This method is virtual. The actual getting of the external current should be handled by a subclass method. To void extra memory operations, arrays are returned as pointers. The memory management is handled by the equilibrium subclass instance. If the equilibrium has no external currents return a null() pointer or don't override this method. MAKEGRID has a mode where currents maybe scaled. Inform the signal using this to scale the currents if need be.

See also: vmec_equilibrium::vmec_get_ext_currents; vacuum_equilibrium::vacuum_get_ext_currents; siesta_equilibrium::siesta_get_ext_currents

Parameters

[in]	this	A equilibrium_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.

◆ get_gp_ne_ij()

procedure equilibrium::equilibrium_class::get_gp_ne_ij	(	class (equilibrium_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 is virtual. The actual getting of the kernel function should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_gp_ne_ij; siesta_equilibrium::siesta_get_gp_ne_ij

Parameters

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

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

Note: Note the gp kernel is not implmented for all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_gp_ne_num_hyper_param()

procedure equilibrium::equilibrium_class::get_gp_ne_num_hyper_param ( class (equilibrium_class), intent(in) this )

Get the number of electron density gp kernel hyper parameters.

This method is virtual. The actual getting of the number of hyper parameters should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_gp_ne_num_hyper_param; siesta_equilibrium::siesta_get_gp_ne_num_hyper_param

Parameters

[in] this A equilibrium_class instance.

Returns: Number of kernel hyper parameters.

◆ get_gp_ne_pi()

procedure equilibrium::equilibrium_class::get_gp_ne_pi	(	class (equilibrium_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 is virtual. The actual getting of the kernel function should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_gp_ne_pi; siesta_equilibrium::siesta_get_gp_ne_pi

Parameters

[in]	this	A equilibrium_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.

Note: Note the gp kernel is not implmented for all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_gp_ne_pp()

procedure equilibrium::equilibrium_class::get_gp_ne_pp	(	class (equilibrium_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 is virtual. The actual getting of the kernel function should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_gp_ne_pp; siesta_equilibrium::siesta_get_gp_ne_pp

Parameters

[in]	this	A equilibrium_class instance.
[in]	x_cart	Cartesian position to get the kernel at.
[in]	y_cart	Cartesian position to get the kernel at.

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

Note: Note the gp kernel is not implmented for all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_gp_sxrem_ij()

procedure equilibrium::equilibrium_class::get_gp_sxrem_ij	(	class (equilibrium_class), intent(in)	this,
		integer, intent(in)	i,
		integer, intent(in)	j,
		integer, intent(in)	index
	)

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

This method is virtual. The actual getting of the kernel function should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_gp_ne_ij; siesta_equilibrium::siesta_get_gp_ne_ij

Parameters

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

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

Note: Note the gp kernel is not implmented for all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_gp_sxrem_num_hyper_param()

procedure equilibrium::equilibrium_class::get_gp_sxrem_num_hyper_param	(	class (equilibrium_class), intent(in)	this,
		integer, intent(in)	index
	)

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

This method is virtual. The actual getting of the number of hyper parameters should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_gp_sxrem_num_hyper_param; siesta_equilibrium::siesta_get_gp_sxrem_num_hyper_param

Parameters

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

Returns: Number of kernel hyper parameters.

◆ get_gp_sxrem_pi()

procedure equilibrium::equilibrium_class::get_gp_sxrem_pi	(	class (equilibrium_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 is virtual. The actual getting of the kernel function should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_gp_sxrem_pi; siesta_equilibrium::siesta_get_gp_sxrem_pi

Parameters

[in]	this	A equilibrium_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 to use.

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

Note: Note the gp kernel is not implmented for all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_gp_sxrem_pp()

procedure equilibrium::equilibrium_class::get_gp_sxrem_pp	(	class (equilibrium_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 is virtual. The actual getting of the kernel function should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_gp_sxrem_pp; siesta_equilibrium::siesta_get_gp_sxrem_pp

Parameters

[in]	this	A equilibrium_class instance.
[in]	x_cart	Cartesian position to get the electron density at.
[in]	y_cart	Profile position index.
[in]	index	Index of the soft x-ray emissivity profile to use.

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

Note: Note the gp kernel is not implmented for all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_gp_te_ij()

procedure equilibrium::equilibrium_class::get_gp_te_ij	(	class (equilibrium_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 is virtual. The actual getting of the kernel function should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_gp_te_ij; siesta_equilibrium::siesta_get_gp_te_ij

Parameters

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

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

Note: Note the gp kernel is not implmented for all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_gp_te_num_hyper_param()

procedure equilibrium::equilibrium_class::get_gp_te_num_hyper_param ( class (equilibrium_class), intent(in) this )

Get the number of electron temperature gp kernel hyper parameters.

This method is virtual. The actual getting of the number of hyper parameters should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_gp_te_num_hyper_param; siesta_equilibrium::siesta_get_gp_te_num_hyper_param

Parameters

[in] this A equilibrium_class instance.

Returns: Number of kernel hyper parameters.

◆ get_gp_te_pi()

procedure equilibrium::equilibrium_class::get_gp_te_pi	(	class (equilibrium_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 is virtual. The actual getting of the kernel function should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_gp_te_pi; siesta_equilibrium::siesta_get_gp_te_pi

Parameters

[in]	this	A equilibrium_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.

Note: Note the gp kernel is not implmented for all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_gp_te_pp()

procedure equilibrium::equilibrium_class::get_gp_te_pp	(	class (equilibrium_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 is virtual. The actual getting of the kernel function should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_gp_te_pp; siesta_equilibrium::siesta_get_gp_te_pp

Parameters

[in]	this	A equilibrium_class instance.
[in]	x_cart	Cartesian position to get the kernel at.
[in]	y_cart	Cartesian position to get the kernel at.

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

Note: Note the gp kernel is not implmented for all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_gp_ti_ij()

procedure equilibrium::equilibrium_class::get_gp_ti_ij	(	class (equilibrium_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 is virtual. The actual getting of the kernel function should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_gp_ti_ij; siesta_equilibrium::siesta_get_gp_ti_ij

Parameters

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

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

Note: Note the gp kernel is not implmented for all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_gp_ti_num_hyper_param()

procedure equilibrium::equilibrium_class::get_gp_ti_num_hyper_param ( class (equilibrium_class), intent(in) this )

Get the number of ion temperature gp kernel hyper parameters.

This method is virtual. The actual getting of the number of hyper parameters should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_gp_ti_num_hyper_param; siesta_equilibrium::siesta_get_gp_ti_num_hyper_param

Parameters

[in] this A equilibrium_class instance.

Returns: Number of kernel hyper parameters.

◆ get_gp_ti_pi()

procedure equilibrium::equilibrium_class::get_gp_ti_pi	(	class (equilibrium_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 is virtual. The actual getting of the kernel function should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_gp_ti_pi; siesta_equilibrium::siesta_get_gp_ti_pi

Parameters

[in]	this	A equilibrium_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.

Note: Note the gp kernel is not implmented for all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_gp_ti_pp()

procedure equilibrium::equilibrium_class::get_gp_ti_pp	(	class (equilibrium_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 is virtual. The actual getting of the kernel function should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_gp_ti_pp; siesta_equilibrium::siesta_get_gp_ti_pp

Parameters

[in]	this	A equilibrium_class instance.
[in]	x_cart	Cartesian position to get the kernel at.
[in]	y_cart	Cartesian position to get the kernel at.

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

Note: Note the gp kernel is not implmented for all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_grid_size()

procedure equilibrium::equilibrium_class::get_grid_size ( class (equilibrium_class), intent(in) this )

Get radial grid size.

This method is virtual. The actual getting of the radial grid size should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_grid_size; siesta_equilibrium::siesta_get_grid_size

Parameters

[in] this A equilibrium_class instance.

Returns: Size of the radial grid.

◆ get_grid_start()

procedure equilibrium::equilibrium_class::get_grid_start ( class (equilibrium_class), intent(in) this )

Get start of the radial grid.

This method is virtual. The actual getting of the radial grid start should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_grid_start; siesta_equilibrium::siesta_get_grid_start

Parameters

[in] this A equilibrium_class instance.

Returns: Start of the radial grid.

◆ get_grid_stop()

procedure equilibrium::equilibrium_class::get_grid_stop ( class (equilibrium_class), intent(in) this )

Get stop of the radial grid.

This method is virtual. The actual getting of the radial grid stop should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_grid_stop; siesta_equilibrium::siesta_get_grid_stop

Parameters

[in] this A equilibrium_class instance.

Returns: Stop of the radial grid.

◆ get_int_b_dphi()

procedure equilibrium::equilibrium_class::get_int_b_dphi	(	class (equilibrium_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 is virtual. The actual getting of the loop integrated magnetic field should be handled by a subclass method. Returns the closed loop integration of the magnetic field to determine the enclosed current.

See also: vmec_equilibrium::vmec_get_Int_B_dphi; vacuum_equilibrium::vacuum_get_Int_B_dphi; siesta_equilibrium::siesta_get_Int_B_dphi

Parameters

[in]	this	A equilibrium_class instance.
[in]	s	Radial position to integrate about.
[in]	theta	Poloidal angle to integrate about.

Returns: The loop integrated magnetic field at x_cart.

◆ get_magnetic_volume_jphigrid()

procedure equilibrium::equilibrium_class::get_magnetic_volume_jphigrid ( class (equilibrium_class), intent(in) this )

Get volume magnetic volume integration jphi grid points.

This method is virtual. The actual getting of the jphi grid points should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_magnetic_volume_jphigrid; siesta_equilibrium::siesta_get_magnetic_volume_jphigrid

Parameters

[in] this A equilibrium_class instance.

Returns: The jphi grid points.

◆ get_magnetic_volume_jrgrid()

procedure equilibrium::equilibrium_class::get_magnetic_volume_jrgrid ( class (equilibrium_class), intent(in) this )

Get volume magnetic volume integration jr grid points.

This method is virtual. The actual getting of the jr grid points should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_magnetic_volume_jrgrid; siesta_equilibrium::siesta_get_magnetic_volume_jrgrid

Parameters

[in] this A equilibrium_class instance.

Returns: The jr grid points.

◆ get_magnetic_volume_jzgrid()

procedure equilibrium::equilibrium_class::get_magnetic_volume_jzgrid ( class (equilibrium_class), intent(in) this )

Get volume magnetic volume integration jz grid points.

This method is virtual. The actual getting of the jz grid points should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_magnetic_volume_jzgrid; siesta_equilibrium::siesta_get_magnetic_volume_jzgrid

Parameters

[in] this A equilibrium_class instance.

Returns: The jz grid points.

◆ get_magnetic_volume_rgrid()

procedure equilibrium::equilibrium_class::get_magnetic_volume_rgrid ( class (equilibrium_class), intent(in) this )

Get volume magnetic volume integration radial grid points.

This method is virtual. The actual getting of the radial grid points should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_magnetic_volume_rgrid; siesta_equilibrium::siesta_get_magnetic_volume_rgrid

Parameters

[in] this A equilibrium_class instance.

Returns: The radial grid points.

◆ get_magnetic_volume_zgrid()

procedure equilibrium::equilibrium_class::get_magnetic_volume_zgrid ( class (equilibrium_class), intent(in) this )

Get volume magnetic volume integration z grid points.

This method is virtual. The actual getting of the z grid points should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_magnetic_volume_zgrid; siesta_equilibrium::siesta_get_magnetic_volume_zgrid

Parameters

[in] this A equilibrium_class instance.

Returns: The z grid points.

◆ get_ne_af()

procedure equilibrium::equilibrium_class::get_ne_af ( class (equilibrium_class), intent(in) this )

Get the electron density profile af array.

This method is virtual. The actual getting of the af array should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_ne_af; siesta_equilibrium::siesta_get_ne_af

Parameters

[in] this A equilibrium_class instance.

Returns: Pointer to the electron density profile af array.

◆ get_ne_cart()

procedure equilibrium::equilibrium_class::get_ne_cart	(	class (equilibrium_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart
	)

Gets the electron density at a cartesian position.

This method is virtual. The actual getting of the electron density should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_ne; siesta_equilibrium::siesta_get_ne

Parameters

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

Returns: The electron density at x_cart.

Note: Note the electron density is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_ne_radial()

procedure equilibrium::equilibrium_class::get_ne_radial	(	class (equilibrium_class), intent(in)	this,
		real (rprec), intent(in)	s
	)

Gets the electron density at a radial position.

This method is virtual. The actual getting of the electron density should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_ne; siesta_equilibrium::siesta_get_ne

Parameters

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

Returns: The electron density at r.

Note: Note the electron density is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_p_cart()

procedure equilibrium::equilibrium_class::get_p_cart	(	class (equilibrium_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 is virtual. The actual getting of the plasma pressure should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_p; siesta_equilibrium::siesta_get_p

Parameters

[in]	this	A equilibrium_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.

Note: Note the plasma pressure is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_p_radial()

procedure equilibrium::equilibrium_class::get_p_radial	(	class (equilibrium_class), intent(in)	this,
		real (rprec), intent(in)	s,
		logical, intent(in)	normalize
	)

Gets the plasma pressure at a radial position.

This method is virtual. The actual getting of the plasma pressure should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_p; siesta_equilibrium::siesta_get_p

Parameters

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

Returns: The plasma pressure at r.

Note: Note the plasma pressure is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_param_id()

procedure equilibrium::equilibrium_class::get_param_id	(	class (equilibrium_class), intent(in)	this,
		character (len=*), intent(in)	param_name
	)

Get the id for a reconstruction parameter.

This method is virtual. The actual getting of the reconstruction parameter id should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_param_id; vacuum_equilibrium::vacuum_get_param_id; siesta_equilibrium::siesta_get_param_id

Parameters

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

Returns: The id for a reconstruction parameter.

◆ get_param_name()

procedure equilibrium::equilibrium_class::get_param_name	(	class (equilibrium_class), intent(in)	this,
		integer, intent(in)	id
	)

Gets the name of a reconstruction equilibrium parameter.

This method is virtual. The actual getting of the reconstruction parameter name should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_param_name; vacuum_equilibrium::vacuum_get_param_name; siesta_equilibrium::siesta_get_param_name

Parameters

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

Returns: The name of the parameter.

◆ get_param_value()

procedure equilibrium::equilibrium_class::get_param_value	(	class (equilibrium_class), intent(in)	this,
		integer, intent(in)	id,
		integer, intent(in)	i_index,
		integer, intent(in)	j_index
	)

Gets the value of a reconstruction equilibrium parameter.

This method is virtual. The actual getting of the reconstruction parameter value should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_param_value; vacuum_equilibrium::vacuum_get_param_value; siesta_equilibrium::siesta_get_param_value

Parameters

[in]	this	A equilibrium_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.

◆ get_plasma_edge()

procedure equilibrium::equilibrium_class::get_plasma_edge	(	class (equilibrium_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 is virtual. The actual getting of the magnetic field vector should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_plasma_edge; siesta_equilibrium::siesta_get_plasma_edge

Parameters

[in]	this	A equilibrium_class instance.
[in]	phi	Toroidal angle to determine the outer surface at.
[out]	r	The radial postions of the other surface in a single toroidal angle.
[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.

Todo:: An "edge" could be defined as a the last field line that intersects a limiter for the vacuum case. By defineing a r_last parameter, a feild line can be followed around the machine. When that field line intersecs the desired phi plane, record the r and z positions. Field line following will also need to be performed for siesta.

◆ get_sxrem_af()

procedure equilibrium::equilibrium_class::get_sxrem_af	(	class (equilibrium_class), intent(in)	this,
		integer, intent(in)	index
	)

Get the soft x-ray emissivity profile af array.

This method is virtual. The actual getting of the af array should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_sxrem_af; siesta_equilibrium::siesta_get_sxrem_af

Parameters

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

Returns: Pointer to the soft x-ray emissivity profile af array.

◆ get_sxrem_cart()

procedure equilibrium::equilibrium_class::get_sxrem_cart	(	class (equilibrium_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 is virtual. The actual getting of the soft x-ray emissivity should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_sxrem; siesta_equilibrium::siesta_get_sxrem

Parameters

[in]	this	A equilibrium_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 to use.

Returns: The soft x-ray emissivity at x_cart.

Note: Note the soft x-ray emissivity is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_sxrem_radial()

procedure equilibrium::equilibrium_class::get_sxrem_radial	(	class (equilibrium_class), intent(in)	this,
		real (rprec), intent(in)	s,
		integer, intent(in)	index
	)

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

This method is virtual. The actual getting of the soft x-ray emissivity should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_sxrem; siesta_equilibrium::siesta_get_sxrem

Parameters

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

Returns: The soft x-ray emissivity at x_cart.

Note: Note the soft x-ray emissivity is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_te_af()

procedure equilibrium::equilibrium_class::get_te_af ( class (equilibrium_class), intent(in) this )

Get the electron temperature profile af array.

This method is virtual. The actual getting of the af array should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_te_af; siesta_equilibrium::siesta_get_te_af

Parameters

[in] this A equilibrium_class instance.

Returns: Pointer to the electron temperature profile af array.

◆ get_te_cart()

procedure equilibrium::equilibrium_class::get_te_cart	(	class (equilibrium_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart
	)

Gets the electron temperature at a cartesian position.

This method is virtual. The actual getting of the electron temperature should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_te; siesta_equilibrium::siesta_get_te

Parameters

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

Returns: The electron temperature at x_cart.

Note: Note the electron temperature is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_te_radial()

procedure equilibrium::equilibrium_class::get_te_radial	(	class (equilibrium_class), intent(in)	this,
		real (rprec), intent(in)	s
	)

Gets the electron temperature at a radial position.

This method is virtual. The actual getting of the electron temperature should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_te; siesta_equilibrium::siesta_get_te

Parameters

[in]	this	A equilibrium_class instance.
[in]	s	Cartesian position to get the electron temperature at.

Returns: The electron temperature at r.

Note: Note the electron temperature is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_ti_af()

procedure equilibrium::equilibrium_class::get_ti_af ( class (equilibrium_class), intent(in) this )

Get the ion temperature profile af array.

This method is virtual. The actual getting of the af array should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_ti_af; siesta_equilibrium::siesta_get_ti_af

Parameters

[in] this A equilibrium_class instance.

Returns: Pointer to the electron ion profile af array.

◆ get_ti_cart()

procedure equilibrium::equilibrium_class::get_ti_cart	(	class (equilibrium_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart
	)

Gets the ion temperature at a cartesian position.

This method is virtual. The actual getting of the electron temperature should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_ti; siesta_equilibrium::siesta_get_ti

Parameters

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

Returns: The ion temperature at x_cart.

Note: Note the ion temperature is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_ti_radial()

procedure equilibrium::equilibrium_class::get_ti_radial	(	class (equilibrium_class), intent(in)	this,
		real (rprec), intent(in)	s
	)

Gets the ion temperature at a radial position.

This method is virtual. The actual getting of the ion temperature should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_ti; siesta_equilibrium::siesta_get_ti

Parameters

[in]	this	A equilibrium_class instance.
[in]	r	Cartesian position to get the ion temperature at.

Returns: The ion temperature at r.

Note: Note the ion temperature is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

◆ get_type()

procedure equilibrium::equilibrium_class::get_type ( class (equilibrium_class), intent(in) this )

Checks if a parameter id is a reconstruction parameter.

This method is virtual. The actual check should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_type; vacuum_equilibrium::vacuum_get_type; siesta_equilibrium::siesta_get_type

Parameters

[in] this A signal_class instance.

Returns: A string describing the signal type.

◆ get_volume_int_element()

procedure equilibrium::equilibrium_class::get_volume_int_element ( class (equilibrium_class), intent(in) this )

Get volume integration element.

This method is virtual. The actual getting of the volume integration element should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_volume_int_element; siesta_equilibrium::siesta_get_volume_int_element

Parameters

[in] this A equilibrium_class instance.

Returns: The volume integration element.

◆ has_vacuum_field()

procedure equilibrium::equilibrium_class::has_vacuum_field ( class (equilibrium_class), intent(in) this )

Determines if vacuum field information is available.

This method is virtual. The actual check should be handled by a subclass method.

See also: vmec_equilibrium::vmec_has_vacuum_field

Parameters

[in] this A equilibrium_class instance.

Returns: True of vacuum fields are available.

◆ is_2d_array()

procedure equilibrium::equilibrium_class::is_2d_array	(	class (equilibrium_class), intent(in)	this,
		integer, intent(in)	id
	)

Checks if a parameter id is a 2d array.

This method is virtual. The actual check should be handled by a subclass method.

See also: vmec_equilibrium::vmec_is_2d_array; siesta_equilibrium::siesta_is_2d_array

Parameters

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

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

◆ is_in_plasma()

procedure equilibrium::equilibrium_class::is_in_plasma	(	class (equilibrium_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart
	)

Determines if a point is inside the plasma or outside.

This method is virtual. The actual check should be handled by a subclass method.

See also: vmec_equilibrium::vmec_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.

◆ is_recon_param()

procedure equilibrium::equilibrium_class::is_recon_param	(	class (equilibrium_class), intent(in)	this,
		integer, intent(in)	id
	)

Checks if a parameter id is a reconstruction parameter.

This method is virtual. The actual check should be handled by a subclass method.

See also: vmec_equilibrium::vmec_is_recon_param; vacuum_equilibrium::vacuum_is_recon_param; siesta_equilibrium::siesta_is_recon_param

Parameters

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

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

◆ is_scaler_value()

procedure equilibrium::equilibrium_class::is_scaler_value	(	class (equilibrium_class), intent(in)	this,
		integer, intent(in)	id
	)

Checks if a parameter id is a scaler value.

This method is virtual. The actual check should be handled by a subclass method.

See also: vmec_equilibrium::vmec_is_scaler_value; siesta_equilibrium::siesta_is_scaler_value

Parameters

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

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

◆ is_using_point()

procedure equilibrium::equilibrium_class::is_using_point ( class (equilibrium_class), intent(in) this )

Checks if the point magnetics are being used.

This method is virtual. The actual check should be handled by a subclass method.

See also: vmec_equilibrium::vmec_is_using_point

Parameters

[in] this A equilibrium_class instance.

Returns: True if the point magnetic are being used.

◆ limit_path_to_boundary()

procedure equilibrium::equilibrium_class::limit_path_to_boundary	(	class (equilibrium_class), intent(in)	this,
		type (vertex), pointer	path
	)

Limit an integration path to the boundary.

This method is virtual. The actual check should be handled by a subclass method.

See also: vmec_equilibrium::vmec_limit_path_to_boundary

Parameters

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

Returns: The chord path limited to the boundary.

◆ read_vac_file()

procedure equilibrium::equilibrium_class::read_vac_file	(	class (equilibrium_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 vacuum files.

See also: vmec_equilibrium::vmec_read_vac_file; siesta_equilibrium::siesta_read_vac_file

Parameters

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

◆ reset_state()

procedure equilibrium::equilibrium_class::reset_state ( class (equilibrium_class), intent(inout) this )

Reset the internal state of the equilibrium.

This method is virtual. The actual reseting of the equilibrium state should be handled by a subclass method. Sub classes need to make sure that the equilibrium is reset to a converged state.

See also: vmec_equilibrium::vmec_reset_state; siesta_equilibrium::siesta_reset_state

Parameters

[in,out] this A equilibrium_class instance.

◆ restart()

procedure equilibrium::equilibrium_class::restart	(	class (equilibrium_class), intent(in)	this,
		integer, intent(in)	result_ncid,
		integer, intent(in)	current_step
	)

Restart equilibrium.

This method is virtual. The actual restarting of the equilibrium variables should be handled by a subclass method.

See also: vmec_equilibrium::vmec_restart and; siesta_equilibrium::siesta_restart

Parameters

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

◆ save_state()

procedure equilibrium::equilibrium_class::save_state ( class (equilibrium_class), intent(inout) this )

Save the internal state of the equilibrium.

This method is virtual. The actual saving of the equilibrium state should be handled by a subclass method.

See also: vmec_equilibrium::vmec_save_state; siesta_equilibrium::siesta_save_state

Parameters

[in,out] this A equilibrium_class instance.

◆ set_magnetic_cache_point()

procedure equilibrium::equilibrium_class::set_magnetic_cache_point	(	class (equilibrium_class), intent(inout)	this,
		logical, intent(in)	use_axi,
		integer, intent(in)	state_flags
	)

Sets the magnetic cache of the equilibrium for points.

This method is virtual. The actual setting of the magnetic cache should be handled a subclass method. The magnetic cache is any pre compuation that needs to be performed so that magnetic signals may compute a modeled signal. If the equilibrium does not require any information to be cached, this method does not need to be overridden. This method is meant to only be called once to tell the equilibrium it needs to use a magnetic cache.

See also: vmec_equilibrium::vmec_set_magnetic_cache; siesta_equilibrium::siesta_set_magnetic_cache

Parameters

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

◆ set_magnetic_cache_response()

procedure equilibrium::equilibrium_class::set_magnetic_cache_response	(	class (equilibrium_class), intent(inout)	this,
		type (magnetic_response_class), intent(in)	response_object,
		integer, intent(in)	state_flags
	)

Sets the magnetic cache of the equilibrium for the magnetic response.

This method is virtual. The actual setting of the magnetic cache should be handled a subclass method. The magnetic cache is any pre compuation that needs to be performed so that magnetic signals may compute a modeled signal. If the equilibrium does not require any information to be cached, this method does not need to be overridden. This method is meant to only be called once to tell the equilibrium it needs to use a magnetic cache.

See also: vmec_equilibrium::vmec_set_magnetic_cache; siesta_equilibrium::siesta_set_magnetic_cache

Parameters

[in,out]	this	A equilibrium_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.

◆ set_param()

procedure equilibrium::equilibrium_class::set_param	(	class (equilibrium_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 is virtual. The actual setting of the parameter should be handled by a subclass method. The subclass is responsible updating the state flags.

See also: vmec_equilibrium::vmec_set_param; vacuum_equilibrium::vacuum_set_param; siesta_equilibrium::siesta_set_param

Parameters

[in,out]	this	A equilibrium_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.

◆ sync_child()

procedure equilibrium::equilibrium_class::sync_child	(	class (equilibrium_class), intent(inout)	this,
		integer, intent(in)	index,
		integer, intent(in)	recon_comm
	)

Syncronize a child equilibrium 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 equilibrium_class instance.
[in]	index	Reconstruction rank to sync.
[in]	recon_comm	MPI communicator for the reconstruction processes.

◆ sync_state()

procedure equilibrium::equilibrium_class::sync_state	(	class (equilibrium_class), intent(inout)	this,
		integer, intent(in)	recon_comm
	)

Syncronize the equilibrium 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 equilibrium_class instance.
[in]	recon_comm	MPI communicator for the reconstruction processes.

◆ write()

procedure equilibrium::equilibrium_class::write	(	class (equilibrium_class), intent(in)	this,
		integer, intent(in)	iou
	)

Write out the equilibrium to an output file.

This method is virtual. The actual writing of the equilibrium should be handled by a subclass method.

See also: vmec_equilibrium::vmec_write; vacuum_equilibrium::vacuum_write; siesta_equilibrium::siesta_write

Parameters

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

◆ write_init_data()

procedure equilibrium::equilibrium_class::write_init_data	(	class (equilibrium_class), intent(in)	this,
		integer, intent(in)	result_ncid
	)

Write inital data to NetCDF result file.

This method is virtual. The actual writing of the equilibrium variables should be handled by a subclass method.

See also: vmec_equilibrium::vmec_write_init_data; siesta_equilibrium::siesta_write_init_data

Parameters

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

◆ write_input()

procedure equilibrium::equilibrium_class::write_input	(	class (equilibrium_class), intent(in)	this,
		integer, intent(in)	current_step
	)

Write out the equilibrium to an output file.

This method is virtual. The actual writing of the equilibrium should be handled by a subclass method.

See also: vmec_equilibrium::vmec_write_input; vacuum_equilibrium::vacuum_write_input; siesta_equilibrium::siesta_write_input

Parameters

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

◆ write_step_data()

procedure equilibrium::equilibrium_class::write_step_data	(	class (equilibrium_class), intent(in)	this,
		integer, intent(in)	result_ncid,
		integer, intent(in)	current_step
	)

Write step data to NetCDF result file.

This method is virtual. The actual writing of the equilibrium variables should be handled by a subclass method.

See also: vmec_equilibrium::vmec_write_step_data and; siesta_equilibrium::siesta_write_step_data

Parameters

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

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

V3FIT/Sources/equilibrium.f

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ converge()

◆ def_result()

◆ equilibrium_destruct()

◆ get_area_int_element()

◆ get_b_vec()

◆ get_con_surface_kphigrid()

◆ get_con_surface_krgrid()

◆ get_con_surface_kzgrid()

◆ get_ext_b_plasma()

◆ get_ext_currents()

◆ get_gp_ne_ij()

◆ get_gp_ne_num_hyper_param()

◆ get_gp_ne_pi()

◆ get_gp_ne_pp()

◆ get_gp_sxrem_ij()

◆ get_gp_sxrem_num_hyper_param()

◆ get_gp_sxrem_pi()

◆ get_gp_sxrem_pp()

◆ get_gp_te_ij()

◆ get_gp_te_num_hyper_param()

◆ get_gp_te_pi()

◆ get_gp_te_pp()

◆ get_gp_ti_ij()

◆ get_gp_ti_num_hyper_param()

◆ get_gp_ti_pi()

◆ get_gp_ti_pp()

◆ get_grid_size()

◆ get_grid_start()

◆ get_grid_stop()

◆ get_int_b_dphi()

◆ get_magnetic_volume_jphigrid()

◆ get_magnetic_volume_jrgrid()

◆ get_magnetic_volume_jzgrid()

◆ get_magnetic_volume_rgrid()

◆ get_magnetic_volume_zgrid()

◆ get_ne_af()

◆ get_ne_cart()

◆ get_ne_radial()

◆ get_p_cart()

◆ get_p_radial()

◆ get_param_id()

◆ get_param_name()

◆ get_param_value()

◆ get_plasma_edge()

◆ get_sxrem_af()

◆ get_sxrem_cart()

◆ get_sxrem_radial()

◆ get_te_af()

◆ get_te_cart()

◆ get_te_radial()

◆ get_ti_af()

◆ get_ti_cart()

◆ get_ti_radial()

◆ get_type()

◆ get_volume_int_element()

◆ has_vacuum_field()

◆ is_2d_array()

◆ is_in_plasma()

◆ is_recon_param()

◆ is_scaler_value()

◆ is_using_point()

◆ limit_path_to_boundary()

◆ read_vac_file()

◆ reset_state()

◆ restart()

◆ save_state()

◆ set_magnetic_cache_point()

◆ set_magnetic_cache_response()

◆ set_param()

◆ sync_child()

◆ sync_state()

◆ write()

◆ write_init_data()

◆ write_input()

◆ write_step_data()