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

Interface for the equilibrium pressure profile values. More...

Public Member Functions

real(rprec) function equilibrium_get_p_cart (this, x_cart)
 Gets the plasma pressure at a cartesian position. More...
 
real(rprec) function equilibrium_get_p_radial (this, r)
 Gets the plasma pressure at a radial position. More...
 

Detailed Description

Interface for the equilibrium pressure profile values.

Definition at line 170 of file equilibrium.f.

Member Function/Subroutine Documentation

◆ equilibrium_get_p_cart()

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

Gets the plasma pressure at a cartesian position.

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

See also
vmec_equilibrium::vmec_get_p
siesta_equilibrium::siesta_get_p
Parameters
[in]thisA equilibrium_class instance.
[in]x_cartCartesian position to get the plasma pressure at.
Returns
The plasma pressure at x_cart.
Note
Note the plasma pressure is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

Definition at line 2142 of file equilibrium.f.

◆ equilibrium_get_p_radial()

real (rprec) function equilibrium::equilibrium_get_p::equilibrium_get_p_radial ( type (equilibrium_class), intent(in)  this,
real (rprec), intent(in)  r 
)

Gets the plasma pressure at a radial position.

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

See also
vmec_equilibrium::vmec_get_p
siesta_equilibrium::siesta_get_p
Parameters
[in]thisA equilibrium_class instance.
[in]rCartesian position to get the plasma pressure at.
Returns
The plasma pressure at r.
Note
Note the plasma pressure is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

Definition at line 2189 of file equilibrium.f.


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