Stellarator-Tools
utilities::curl_htof Interface Reference

Interface to take the curl on a half mesh quantity and return a full mesh using either curl_htof or curl_htof_targ. More...

Public Member Functions

subroutine curl_htof (bsubsmnh, bsubumnh, bsubvmnh,
 Compute curl of the half grid quantity a on the full grid. More...
 
subroutine curl_htof_targ (bsubsmnh, bsubumnh, bsubvmnh,
 Convert allocatable to pointer for use in curl_htof. More...
 

Detailed Description

Interface to take the curl on a half mesh quantity and return a full mesh using either curl_htof or curl_htof_targ.

Constructor & Destructor Documentation

◆ curl_htof()

subroutine utilities::curl_htof::curl_htof ( real (dp), dimension(:,:,:), intent(in), allocatable  bsubsmnh,
real (dp), dimension(:,:,:), intent(in), allocatable  bsubumnh,
real (dp), dimension(:,:,:), intent(in), allocatable  bsubvmnh 
)

Compute curl of the half grid quantity a on the full grid.

The contravariant components of jac*Curl A are equal to

sqrt(g)*K^k = dB_j/du^i - dB_i/du^j (j)

for cyclic permutations of i,j,k. This routine does not remove the jacobian factor. The arrays must be passed in as ALLOCATABLE or POINTER to preserve the array bounds.

Parameters
[in]bsubsmnhCovariant vector in the s direction half grid.
[in]bsubsmnhCovariant vector in the u direction half grid.
[in]bsubsmnhCovariant vector in the v direction half grid.
[in,out]jKsubsmnfContravariant vector in the s direction with jacobian factor full grid.
[in,out]jKsubsmnfContravariant vector in the u direction with jacobian factor full grid.
[in,out]jKsubsmnfContravariant vector in the v direction with jacobian factor full grid.
[in]parityParity flag.
[in]nsminMinimum radial index.
[in]nsmaxMaximum radial index.
[in]nsendEnding row index.
[in,out]curtorCurrent enclosed at the boundary.

Member Function/Subroutine Documentation

◆ curl_htof_targ()

subroutine utilities::curl_htof::curl_htof_targ ( real (dp), dimension(:,:,:), intent(in), allocatable  bsubsmnh,
real (dp), dimension(:,:,:), intent(in), allocatable  bsubumnh,
real (dp), dimension(:,:,:), intent(in), allocatable  bsubvmnh 
)

Convert allocatable to pointer for use in curl_htof.

Parameters
[in]AsubsmnhCovariant vector in the s direction half grid.
[in]AsubsmnhCovariant vector in the u direction half grid.
[in]AsubsmnhCovariant vector in the v direction half grid.
[in,out]jBsubsmnfContravariant vector in the s direction with jacobian factor full grid.
[in,out]jBsubsmnfContravariant vector in the u direction with jacobian factor full grid.
[in,out]jBsubsmnfContravariant vector in the v direction with jacobian factor full grid.
[in]parityParity flag.
[in]nsminMinimum radial index.
[in]nsmaxMaximum radial index.
[in]nsendEnding row index.
[in,out]curtorCurrent enclosed at the boundary.

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