XGC - X-Point Included Gyrokinetic Code

Code Description

XGC is a gyrokinetic particle-in-cell code, which specializes in the simulation of the edge region of magnetically confined thermonuclear fusion plasma. It has capabilities for both tokamak and stellarator geometries. The simulation domain can include the magnetic separatrix, magnetic axis and the biased material wall.

XGC is written in C++ and Fortran 90 and features efficient, highly optimized numerics. It is designed for HPCs utilizing Kokkos/Cabana libraries for vendor-independent GPU offloading, vectorization, and portability. Weak scaling is roughly linear to the maximal number of compute nodes of leading HPCs in US.

Contents

• General Information
  • Target Domain
  • Basic Modes of Operation
  • Selected Physics Features
  • Selected Numerical Features
  • Features Under Development
  • Implementation
  • Citing XGC
  • References
• How to Become an XGC User
• Introduction to XGC’s Git Workflow
  • Organization of and workflow for the XGC repositories
  • Git How-to for XGC
• Quickstart
  • Usage
• Building XGC
  • Build Instructions
  • 3rd Party Software Installations
  • Maintaining shared installations
  • Installation instructions
  • Adding a new source file
  • Adding support for another HPC facility
  • Adding a new configuration option
  • Updating Test Data
• Running XGC
  • Overview
  • Preparation of a run directory
  • ADIOS2 configuration
  • PETSc configuration
  • Examples of batch scripts
  • XGC Examples
  • XGC performance
  • Running XGC-S
• Kernels and Tests
  • Compiling
  • Running
  • Versions and Performance
  • Testing XGC
• Versioning and Updates
• Continuous Integration
  • GitLab CI
  • GitHub Actions
• XGC API Documentation
• XGC Preprocessor Macros
  • XGC Advanced Preprocessor Macros
• XGC Inputs
  • Input Parameters
  • XGC-S Input Parameters
  • Common errors
• Generating Meshes for XGC Simulations
  • XGC Simulations Rely on Unstructured Triangular Configuration Space Meshes
  • Configuration Space Discretization
  • The Tokamak Modeling and Meshing Software (TOMMS)
  • A Step-by-step Guide to XGC Tokamak Mesh Generation
  • Generating Stellarator Meshes for XGC-S
• File Format of XGC Mesh Files
  • The “node” File
  • The “ele” file
  • The “flx” file
  • Stellarator Mesh Files
• XGC algorithms
  • Anomalous Diffusion Model
  • Collision Operator
  • Equations of Motion
  • Gyro-Averaging
  • Heat/Torque Sources
  • Neutral Particle Recycling
  • Parallelization
  • Particle Resampling
  • Poisson/Ampere Solver
  • Stellarator Geometry
  • Total-f Method
• XGC Outputs
  • Reading Output
  • Output reading tools and scripts
  • Output Parameters
  • Performance and time
  • XGC-S Output Parameters