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

Interface for the vmec density profile values. More...

Public Member Functions

real(rprec) function vmec_get_ne_cart (this, x_cart)
 Gets the electron density at a cartesian position. More...
 
real(rprec) function vmec_get_ne_radial (this, s)
 Gets the electron density at a s position. More...
 

Detailed Description

Interface for the vmec density profile values.

Definition at line 483 of file vmec_equilibrium.f.

Member Function/Subroutine Documentation

◆ vmec_get_ne_cart()

real (rprec) function vmec_equilibrium::vmec_get_ne::vmec_get_ne_cart ( type (vmec_class), intent(in)  this,
real (rprec), dimension(3), intent(in)  x_cart 
)

Gets the electron density at a cartesian position.

This method overrides equilibrium::equilibrium_get_ne. If no density profile was created, return zero.

Parameters
[in]thisA vmec_class instance.
[in]x_cartCartesian position to get the electron density at.
Returns
The electron density at x_cart.

Definition at line 2992 of file vmec_equilibrium.f.

◆ vmec_get_ne_radial()

real (rprec) function vmec_equilibrium::vmec_get_ne::vmec_get_ne_radial ( type (vmec_class), intent(in)  this,
real (rprec), intent(in)  s 
)

Gets the electron density at a s position.

This method overrides equilibrium::equilibrium_get_ne. If no density profile was created, return zero.

Parameters
[in]thisA vmec_class instance.
[in]sRadial position to get the electron density at.
Returns
The electron density at s.

Definition at line 3022 of file vmec_equilibrium.f.


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