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

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

Public Member Functions

real(rprec) function equilibrium_get_te_cart (this, x_cart)
 Gets the electron temperature at a cartesian position. More...
 
real(rprec) function equilibrium_get_te_radial (this, r)
 Gets the electron temperature at a radial position. More...
 

Detailed Description

Interface for the equilibrium electron temperature profile values.

Definition at line 108 of file equilibrium.f.

Member Function/Subroutine Documentation

◆ equilibrium_get_te_cart()

real (rprec) function equilibrium::equilibrium_get_te::equilibrium_get_te_cart ( type (equilibrium_class), intent(in)  this,
real (rprec), dimension(3), intent(in)  x_cart 
)

Gets the electron 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_te
siesta_equilibrium::siesta_get_te
Parameters
[in]thisA equilibrium_class instance.
[in]x_cartCartesian position to get the electron temperature at.
Returns
The electron temperature at x_cart.
Note
Note the electron temperature is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

Definition at line 1266 of file equilibrium.f.

◆ equilibrium_get_te_radial()

real (rprec) function equilibrium::equilibrium_get_te::equilibrium_get_te_radial ( type (equilibrium_class), intent(in)  this,
real (rprec), intent(in)  r 
)

Gets the electron temperature at a radial 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_te
siesta_equilibrium::siesta_get_te
Parameters
[in]thisA equilibrium_class instance.
[in]rCartesian position to get the electron temperature at.
Returns
The electron temperature at r.
Note
Note the electron temperature is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

Definition at line 1313 of file equilibrium.f.


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