PB3D  [2.45]
Ideal linear high-n MHD stability in 3-D
Public Member Functions | List of all members
grid_utilities::coord_f2e Interface Reference

Converts Flux coordinates \(\left(r,\theta,\zeta\right)_\text{F}\) to Equilibrium coordinates \(\left(r,\theta,\zeta\right)_\text{E}\). More...

Public Member Functions

integer function coord_f2e_r (grid_eq, r_F, r_E, r_F_array, r_E_array)
 version with only r More...
 
integer function coord_f2e_rtz (grid_eq, r_F, theta_F, zeta_F, r_E, theta_E, zeta_E, r_F_array, r_E_array, ord)
 version withi r, theta and zeta More...
 

Detailed Description

Converts Flux coordinates \(\left(r,\theta,\zeta\right)_\text{F}\) to Equilibrium coordinates \(\left(r,\theta,\zeta\right)_\text{E}\).

Optionally, two arrays r_F_array and r_E_array can be provided, that define the mapping between the both coordinate system.

Standard, for E, the poloidal or toroidal normalized flux is used and for F, the poloidal or toroidal flux in F coordinates, divided by \(2\pi\).

Note
For VMEC, it can be slow, as the zero of a non-linear expression must be sought. This is done currently using num_ops.calc_zero_hh().
Returns
ierr

Definition at line 47 of file grid_utilities.f90.

Member Function/Subroutine Documentation

◆ coord_f2e_r()

integer function grid_utilities::coord_f2e::coord_f2e_r ( type(grid_type), intent(in)  grid_eq,
real(dp), dimension(:), intent(in)  r_F,
real(dp), dimension(:), intent(inout)  r_E,
real(dp), dimension(:), intent(in), optional, target  r_F_array,
real(dp), dimension(:), intent(in), optional, target  r_E_array 
)

version with only r

Parameters
[in]grid_eqequilibrium grid (for possibly loc_r)
[in]r_f(local) \(r_\text{F}\)
[in,out]r_e(local) \(r_\text{E}\)
[in]r_f_arrayoptional array that defines mapping between two coord. systems
[in]r_e_arrayoptional array that defines mapping between two coord. systems

Definition at line 303 of file grid_utilities.f90.

◆ coord_f2e_rtz()

integer function grid_utilities::coord_f2e::coord_f2e_rtz ( type(grid_type), intent(in)  grid_eq,
real(dp), dimension(:), intent(in)  r_F,
real(dp), dimension(:,:,:), intent(in)  theta_F,
real(dp), dimension(:,:,:), intent(in)  zeta_F,
real(dp), dimension(:), intent(inout)  r_E,
real(dp), dimension(:,:,:), intent(inout)  theta_E,
real(dp), dimension(:,:,:), intent(inout)  zeta_E,
real(dp), dimension(:), intent(in), optional, target  r_F_array,
real(dp), dimension(:), intent(in), optional, target  r_E_array,
integer, intent(in), optional  ord 
)

version withi r, theta and zeta

Parameters
[in]grid_eqequilibrium grid (for normal local limits and possibly loc_r)
[in]r_f(local) \(r_\text{F}\)
[in]theta_f\(\theta_\text{F}\)
[in]zeta_f\(\zeta_\text{F}\)
[in,out]r_e(local) \(r_\text{E}\)
[in,out]theta_e\(\theta_\text{E}\)
[in,out]zeta_e\(\zeta_\text{E}\)
[in]r_f_arrayoptional array that defines mapping between two coord. systems
[in]r_e_arrayoptional array that defines mapping between two coord. systems
[in]ordorder (only used for eq_style 1)

Definition at line 120 of file grid_utilities.f90.

+ Here is the call graph for this function:

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