V3FIT
Public Member Functions | List of all members
vmec_equilibrium::vmec_get_gp_ti Interface Reference

Interface for the vmec guassian process ion temperature profile values. More...

Public Member Functions

real(rprec) function vmec_get_gp_ti_ij (this, i, j)
 Get the ion temperature gp kernel value for the two indicies. More...
 
real(rprec) function vmec_get_gp_ti_pi (this, x_cart, i)
 Get the ion temperature gp kernel value for the position and index. More...
 
real(rprec) function vmec_get_gp_ti_pp (this, x_cart, y_cart)
 Get the ion temperature gp kernel value for the position and position. More...
 

Detailed Description

Interface for the vmec guassian process ion temperature profile values.

Definition at line 525 of file vmec_equilibrium.f.

Member Function/Subroutine Documentation

◆ vmec_get_gp_ti_ij()

real (rprec) function vmec_equilibrium::vmec_get_gp_ti::vmec_get_gp_ti_ij ( type (vmec_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 overrides equilibrium::equilibrium_get_gp_ti_ij. If no ion profile was created zero is returned.

Parameters
[in]thisA vmec_class instance.
[in]iith profile position.
[in]jjth profile position.
Returns
The value of the gp kernel function for i, j.

Definition at line 3382 of file vmec_equilibrium.f.

◆ vmec_get_gp_ti_pi()

real (rprec) function vmec_equilibrium::vmec_get_gp_ti::vmec_get_gp_ti_pi ( type (vmec_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 overrides equilibrium::equilibrium_get_gp_ti_pi. If no ion temperature profile was created zero is returned.

Parameters
[in]thisA vmec_class instance.
[in]x_cartCartesian position to get the ion temperature at.
[in]iProfile position index.
Returns
The value of the gp kernel function for x_cart and i.

Definition at line 3420 of file vmec_equilibrium.f.

◆ vmec_get_gp_ti_pp()

real (rprec) function vmec_equilibrium::vmec_get_gp_ti::vmec_get_gp_ti_pp ( type (vmec_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 overrides equilibrium::equilibrium_get_gp_ti_pp. If no ion temperature profile was created zero is returned.

Parameters
[in]thisA vmec_class instance.
[in]x_cartFirst cartesian position to get the ion temperature at.
[in]y_cartSecond cartesian position to get the ion temperature at.
Returns
The value of the gp kernel function for x_cart and y_cart.

Definition at line 3460 of file vmec_equilibrium.f.


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