V3FIT
Public Member Functions | List of all members
siesta_equilibrium::siesta_get_gp_te Interface Reference

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

Public Member Functions

real(rprec) function siesta_get_gp_te_ij (this, i, j)
 Get the electron temperature gp kernel value for the two indicies. More...
 
real(rprec) function siesta_get_gp_te_pi (this, x_cart, i)
 Get the electron temperature gp kernel value for the position and index. More...
 
real(rprec) function siesta_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 siesta guassian process electron temperature profile values.

Definition at line 302 of file siesta_equilibrium.f.

Member Function/Subroutine Documentation

◆ siesta_get_gp_te_ij()

real (rprec) function siesta_equilibrium::siesta_get_gp_te::siesta_get_gp_te_ij ( type (siesta_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 overrides equilibrium::equilibrium_get_gp_te_ij. If no electron temperature profile was created zero is returned.

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

Definition at line 2096 of file siesta_equilibrium.f.

◆ siesta_get_gp_te_pi()

real (rprec) function siesta_equilibrium::siesta_get_gp_te::siesta_get_gp_te_pi ( type (siesta_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 overrides equilibrium::equilibrium_get_gp_te_pi. If no electron temperature profile was created zero is returned.

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

Definition at line 2134 of file siesta_equilibrium.f.

◆ siesta_get_gp_te_pp()

real (rprec) function siesta_equilibrium::siesta_get_gp_te::siesta_get_gp_te_pp ( type (siesta_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 overrides equilibrium::equilibrium_get_gp_te_pp. If no electron temperature profile was created zero is returned.

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

Definition at line 2178 of file siesta_equilibrium.f.


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