vmec_equilibrium::vmec_get_gp_sxrem Interface Reference

Interface for the vmec guassian process soft x-ray emissivity profile values. More...

Public Member Functions
real(rprec) function	vmec_get_gp_sxrem_ij (this, i, j, index)
	Get the soft x-ray emissivity gp kernel value for the two indicies. More...
real(rprec) function	vmec_get_gp_sxrem_pi (this, x_cart, i, index)
	Get the soft x-ray emissivity gp kernel value for the position and index. More...
real(rprec) function	vmec_get_gp_sxrem_pp (this, x_cart, y_cart, index)
	Get the soft x-ray emissivity gp kernel value for the position and position. More...

Detailed Description

Interface for the vmec guassian process soft x-ray emissivity profile values.

Definition at line 543 of file vmec_equilibrium.f.

Member Function/Subroutine Documentation

vmec_get_gp_sxrem_ij()

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

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

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

Parameters

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

Returns

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

Definition at line 3706 of file vmec_equilibrium.f.

vmec_get_gp_sxrem_pi()

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

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

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

Parameters

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

Returns

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

Definition at line 3748 of file vmec_equilibrium.f.

vmec_get_gp_sxrem_pp()

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

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

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

Parameters

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

Returns

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

Definition at line 3794 of file vmec_equilibrium.f.

---

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

• /Users/m4c/repo/trunk/V3FITA/Sources/vmec_equilibrium.f