equilibrium::equilibrium_get_gp_te Interface Reference

Interface for the equilibrium guassian process electron temperature profile values. More...

Public Member Functions
real(rprec) function	equilibrium_get_gp_te_ij (this, i, j)
	Get the electron temperature gp kernel value for the two indicies. More...
real(rprec) function	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_get_gp_te_pp (this, x_cart, y_cart)
	Get the electron temperature gp kernel value for the position and position. More...

Detailed Description

Interface for the equilibrium guassian process electron temperature profile values.

Definition at line 117 of file equilibrium.f.

Member Function/Subroutine Documentation

equilibrium_get_gp_te_ij()

real (rprec) function equilibrium::equilibrium_get_gp_te::equilibrium_get_gp_te_ij	(	type (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.

Definition at line 1113 of file equilibrium.f.

equilibrium_get_gp_te_pi()

real (rprec) function equilibrium::equilibrium_get_gp_te::equilibrium_get_gp_te_pi	(	type (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.

Definition at line 1164 of file equilibrium.f.

equilibrium_get_gp_te_pp()

real (rprec) function equilibrium::equilibrium_get_gp_te::equilibrium_get_gp_te_pp	(	type (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.

Definition at line 1216 of file equilibrium.f.

---

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

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