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

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

Public Member Functions

integer function coord_e2f_r (grid_eq, r_E, r_F, r_E_array, r_F_array)
 version with only r More...
 
integer function coord_e2f_rtz (grid_eq, r_E, theta_E, zeta_E, r_F, theta_F, zeta_F, r_E_array, r_F_array)
 version with r, theta and zeta More...
 

Detailed Description

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

Optionally, two arrays r_E_array and r_F_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\).

Returns
ierr

Definition at line 66 of file grid_utilities.f90.

Member Function/Subroutine Documentation

◆ coord_e2f_r()

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

version with only r

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

Definition at line 473 of file grid_utilities.f90.

◆ coord_e2f_rtz()

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

version with r, theta and zeta

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

Definition at line 359 of file grid_utilities.f90.


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