V3FIT
Public Member Functions | List of all members
equilibrium::equilibrium_get_ti Interface Reference

Interface for the equilibrium ion temperature profile values. More...

Public Member Functions

real(rprec) function equilibrium_get_ti_cart (this, x_cart)
 Gets the ion temperature at a cartesian position. More...
 
real(rprec) function equilibrium_get_ti_radial (this, r)
 Gets the ion temperature at a radial position. More...
 

Detailed Description

Interface for the equilibrium ion temperature profile values.

Definition at line 126 of file equilibrium.f.

Member Function/Subroutine Documentation

◆ equilibrium_get_ti_cart()

real (rprec) function equilibrium::equilibrium_get_ti::equilibrium_get_ti_cart ( type (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]thisA equilibrium_class instance.
[in]x_cartCartesian 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.

Definition at line 1600 of file equilibrium.f.

◆ equilibrium_get_ti_radial()

real (rprec) function equilibrium::equilibrium_get_ti::equilibrium_get_ti_radial ( type (equilibrium_class), intent(in)  this,
real (rprec), intent(in)  r 
)

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]thisA equilibrium_class instance.
[in]rCartesian 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.

Definition at line 1647 of file equilibrium.f.


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