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

Interface for the vmec soft x-ray emissivity profile values. More...

Public Member Functions

real(rprec) function vmec_get_sxrem_cart (this, x_cart, index)
 Gets the soft x-ray emissivity at a cartesian position. More...
 
real(rprec) function vmec_get_sxrem_radial (this, s, index)
 Gets the soft x-ray emissivity at a s position. More...
 

Detailed Description

Interface for the vmec soft x-ray emissivity profile values.

Definition at line 534 of file vmec_equilibrium.f.

Member Function/Subroutine Documentation

◆ vmec_get_sxrem_cart()

real (rprec) function vmec_equilibrium::vmec_get_sxrem::vmec_get_sxrem_cart ( type (vmec_class), intent(in)  this,
real (rprec), dimension(3), intent(in)  x_cart,
integer, intent(in)  index 
)

Gets the soft x-ray emissivity at a cartesian position.

This method overrides equilibrium::equilibrium_get_sxrem. If no soft x-ray emissivity profile was created, return zero.

Parameters
[in]thisA vmec_class instance.
[in]x_cartCartesian position to get the soft x-ray emissivity at.
[in]indexIndex of the soft x-ray emissivity profile.
Returns
The soft x-ray emissivity at x_cart.

Definition at line 3839 of file vmec_equilibrium.f.

◆ vmec_get_sxrem_radial()

real (rprec) function vmec_equilibrium::vmec_get_sxrem::vmec_get_sxrem_radial ( type (vmec_class), intent(in)  this,
real (rprec), intent(in)  s,
integer, intent(in)  index 
)

Gets the soft x-ray emissivity at a s position.

This method overrides equilibrium::equilibrium_get_sxrem. If no soft x-ray emissivity profile was created, return zero.

Parameters
[in]thisA vmec_class instance.
[in]sRadial position to get the soft x-ray emissivity at.
[in]indexIndex of the soft x-ray emissivity profile.
Returns
The soft x-ray emissivity at s.

Definition at line 3873 of file vmec_equilibrium.f.


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