Modules

Contains functions which create arrays

Setting of perpendicular boundary conditions

Module containing the implementation of an analytic tokamak equilibrium as described by Cerfon and Freidberg (Phys. Plasmas 2010 https://doi.org/10.1063/1.3328818) N.b. this equilibrium is axisymmetric - phi, when required, is not used

Implementation of a analytical toroidal equilibrium with nested circular fluxsurfaces. For an extensive reference we refer to: https://youjunhu.github.io/research_notes/tokamak_equilibrium_htlatex/ tokamak_equilibrium.html#x1-9400016

Connection length and shortest distance to the target routines

Coordinate transformations Cartesian (x,y) <-> Polar (rho, theta) rho is normalized flux surface label theta is geometric poloidal angle, measured ccw from +x with respect to magnetic axis

Algebra routines for - vectors - sparse matrices in csr format

Functionality to choose accelerator device (GPU) When PARALLAX is compiled stand-alone, get_device_count always returns 1 (i.e. the CPU), and set_device_id is a sanity check confirming that it's called with id 0.

[*] W. Dommaschk, "Representations for vacuum potentials in stellarators", Computer Physics Communications 40, pg. 203 (1986)

Module capable of creating equilibrium objects

Contains functionality for error handling

Field line tracing via the DOP853 integrator

Routines related with Helmholtz operator

Module implementing useful routines for unit testing

Contains boundary data for 3D magnetic configurations provided in Kisslinger's format, see [Y Feng and W7-X-team 2022 Plasma Phys. Control. Fusion 64 125012, DOI 10.1088/1361-6587/ac9ed9], Figure A3

Creates the parallel mapping matrices. These matrices are needed for the construction of parallel operators.

Auxiliary routines for MPI mapping across planes

Multigrid solver for the Helmholtz problem

Module for interfacing with PAccX. It's unclear whether this should remain here, or whether a Fortran interface should be provided by the PAccX package itself. TODO: If the module stays here, then the two parameters should be moved to the helmholtz_solver_m module, and the interfaces should be moved to the helmholtz_solver_gmgmres_cxx_s submodule.

Module for parameter reading for the circular toroidal equilibrium type

Module for parameters of the flare equilibrium type

Module for parameter reading for the slab equilibrium type

Module implementing polar grid The polar grid has dimension (nrho, ntheta) with uniform grid spacing rho is the radial coordinate as prescribed by the equilibrium theta is the geometric poloidal angle

Definition of precision

Routines for finding zeros

Module containing the implementation of an salpha like equilibrium type. N.b. this equilibrium is axisymmetric - phi, when required, is not used

Definition of slab equilibrium N.b. this equilibrium is axisymmetric - phi, when required, is not used

Factory routine for solver3d

Splitting methods

Creates matrices to compute polar averages - flux-surface average (which is actually a volume average) - surface average (an actual surface average, e.g. for computation of fluxes)