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

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

Public Member Functions

real(rprec) function vmec_get_ze_cart (this, x_cart)
 Gets the effective charge at a cartesian position. More...
 
real(rprec) function vmec_get_ze_radial (this, s)
 Gets the effective charge at a s position. More...
 

Detailed Description

Interface for the vmec zeff profile values.

Definition at line 560 of file vmec_equilibrium.f.

Member Function/Subroutine Documentation

◆ vmec_get_ze_cart()

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

Gets the effective charge at a cartesian position.

This method overrides equilibrium::equilibrium_get_ze. If no Zeff profile was created, return 1.0

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

Definition at line 3565 of file vmec_equilibrium.f.

◆ vmec_get_ze_radial()

real (rprec) function vmec_equilibrium::vmec_get_ze::vmec_get_ze_radial ( type (vmec_class), intent(in)  this,
real (rprec), intent(in)  s 
)

Gets the effective charge at a s position.

This method overrides equilibrium::equilibrium_get_ze. If no Zeff profile was created, return 1.0

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

Definition at line 3595 of file vmec_equilibrium.f.


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