ORB5X 1.0.0
Performance-portable global electromagnetic gyrokinetic PIC code
orb5x::ComIsland Class Reference

Shared B-spline storage for prescribed magnetic-island fields. More...

#include "comisland.hpp"

Static Public Member Functions

static void destroyStaticViews ()
 Release all shared island views before Kokkos::finalize().
 
static void island_array_allocation (int zislw, int zisup, int zjclw, int zjcup, int zkplw, int zkpup, int zislw1, int zisup1, int zjclw1, int zjcup1, int zkplw1, int zkpup1)
 Allocate main and derivative spline arrays from inclusive Fortran bounds.
 
static void island_dealloc (int aint)
 Release one family of shared island arrays.
 

Static Public Attributes

static Kokkos::View< Real *** > dbtilde_chi
 \(\partial\widetilde B/\partial\chi\) coefficients.
 
static Kokkos::View< Real *** > dbtilde_phi
 \(\partial\widetilde B/\partial\varphi\) coefficients.
 
static Kokkos::View< Real *** > dbtilde_s
 \(\partial\widetilde B/\partial s\) coefficients.
 
static Kokkos::View< Real *** > hphi_is_bspl
 Helical-flux solution coefficients.
 
static Kokkos::View< Real *** > hrho_is_bspl
 Helical-flux source coefficients.
 
static Kokkos::View< Real *** > phi_is_bspl
 Island potential/vector-potential coefficients.
 
static Kokkos::View< Real *** > rho_is_bspl
 Projected island source/density coefficients.
 

Detailed Description

Shared B-spline storage for prescribed magnetic-island fields.

IslandModule owns the construction logic while this class mirrors the common-block storage of comisland.F90 used by particle and diagnostic evaluators.

Member Function Documentation

◆ destroyStaticViews()

static void orb5x::ComIsland::destroyStaticViews ( )
static

Release all shared island views before Kokkos::finalize().

◆ island_array_allocation()

static void orb5x::ComIsland::island_array_allocation ( int  zislw,
int  zisup,
int  zjclw,
int  zjcup,
int  zkplw,
int  zkpup,
int  zislw1,
int  zisup1,
int  zjclw1,
int  zjcup1,
int  zkplw1,
int  zkpup1 
)
static

Allocate main and derivative spline arrays from inclusive Fortran bounds.

Parameters
[in]zislwLower main radial bound.
[in]zisupUpper main radial bound.
[in]zjclwLower main poloidal bound.
[in]zjcupUpper main poloidal bound.
[in]zkplwLower main toroidal bound.
[in]zkpupUpper main toroidal bound.
[in]zislw1Lower derivative radial bound.
[in]zisup1Upper derivative radial bound.
[in]zjclw1Lower derivative poloidal bound.
[in]zjcup1Upper derivative poloidal bound.
[in]zkplw1Lower derivative toroidal bound.
[in]zkpup1Upper derivative toroidal bound.

◆ island_dealloc()

static void orb5x::ComIsland::island_dealloc ( int  aint)
static

Release one family of shared island arrays.

Parameters
[in]aintFamily selector: 1 releases main perturbation arrays and 2 releases the helical-source arrays.
Fortran reference comisland.F90:island_dealloc.

Member Data Documentation

◆ dbtilde_chi

Kokkos::View<Real***> orb5x::ComIsland::dbtilde_chi
static

\(\partial\widetilde B/\partial\chi\) coefficients.

◆ dbtilde_phi

Kokkos::View<Real***> orb5x::ComIsland::dbtilde_phi
static

\(\partial\widetilde B/\partial\varphi\) coefficients.

◆ dbtilde_s

Kokkos::View<Real***> orb5x::ComIsland::dbtilde_s
static

\(\partial\widetilde B/\partial s\) coefficients.

◆ hphi_is_bspl

Kokkos::View<Real***> orb5x::ComIsland::hphi_is_bspl
static

Helical-flux solution coefficients.

◆ hrho_is_bspl

Kokkos::View<Real***> orb5x::ComIsland::hrho_is_bspl
static

Helical-flux source coefficients.

◆ phi_is_bspl

Kokkos::View<Real***> orb5x::ComIsland::phi_is_bspl
static

Island potential/vector-potential coefficients.

◆ rho_is_bspl

Kokkos::View<Real***> orb5x::ComIsland::rho_is_bspl
static

Projected island source/density coefficients.


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