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

Interface for the effective charge profile values. More...

Public Member Functions

real(rprec) function equilibrium_get_ze_cart (this, x_cart)
 Gets the effective charge at a cartesian position. More...
 
real(rprec) function equilibrium_get_ze_radial (this, r)
 Gets the effective charge at a radial position. More...
 

Detailed Description

Interface for the effective charge profile values.

Definition at line 144 of file equilibrium.f.

Member Function/Subroutine Documentation

◆ equilibrium_get_ze_cart()

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

Gets the effective charge at a cartesian position.

This method is virtual. The actual getting of the effective charge should be handled by a subclass method.

See also
vmec_equilibrium::vmec_get_ze
siesta_equilibrium::siesta_get_ze
Parameters
[in]thisA equilibrium_class instance.
[in]x_cartCartesian position to get the effective charge at.
Returns
The effective charge at x_cart.
Note
Note the default choice for the effective charge is 1.0

Definition at line 1693 of file equilibrium.f.

◆ equilibrium_get_ze_radial()

real (rprec) function equilibrium::equilibrium_get_ze::equilibrium_get_ze_radial ( type (equilibrium_class), intent(in)  this,
real (rprec), intent(in)  r 
)

Gets the effective charge at a radial position.

This method is virtual. The actual getting of the effective charge should be handled by a subclass method.

See also
vmec_equilibrium::vmec_get_ze
siesta_equilibrium::siesta_get_ze
Parameters
[in]thisA equilibrium_class instance.
[in]rCartesian position to get the effective charge at.
Returns
The effective charge at r.
Note
Note the default choice for the effective charge is 1.0

Definition at line 1740 of file equilibrium.f.


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