XGC - X-Point Included Gyrokinetic Code

Contents

• General Information
  • References
• How to Become an XGC User
• Introduction to XGC’s Git Workflow
  • Organization of and workflow for the XGC repositories
• 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
• Kernels and Tests
  • Compiling
  • Running
  • Versions and Performance
  • Testing XGC
• Versioning and Updates
• Continuous Integration
  • GitLab CI
• XGC API Documentation
• XGC Preprocessor Macros
  • XGC Advanced Preprocessor Macros
• XGC Inputs
  • Input Parameters
  • Common errors
• Meshing for XGC Simulations
  • Generating Meshes for XGC Simulations
  • File Format of XGC 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
  • Total-f Method
• XGC Outputs
  • Reading Output
  • Output reading tools and scripts
  • Output Parameters
  • Performance and time