The Gkeyll 2.0 Code: Documentation Home

“Don’t Panic” – The Hitchhiker’s Guide to the Galaxy

Gkeyll v2.0 (pronounced as in the book “The Strange Case of Dr. Jekyll and Mr. Hyde”) is a computational plasma physics code mostly written in C/C++ and LuaJIT. Gkeyll contains solvers for gyrokinetic equations, Vlasov-Maxwell equations, and multi-fluid equations. Gkeyll contains ab-initio and novel implementations of a number of algorithms, and perhaps is unique in using a JIT compiled typeless dynamic language for as its main implementation language.

The Gkeyll package contains two major parts: the gkyl simulation framework and the the postgkyl post-processing package. Here you will find documentation for the full Gkeyll package.

For license see License.

• Installing Gkeyll
  • gkyl install
  • postgkyl install
  • Note on the Windows Linux Subsystem (WSL)
• Quickstart
  • A first Gkeyll simulation
  • Vlasov example
  • Gyrokinetic example
  • Fluid example
• gkyl Reference
  • Using gkyl
  • gkyl Apps
  • App plugins
  • gkyl Tools
• postgkyl Reference
  • Using Postgkyl
  • Postgkyl examples
• Publications and theses
  • Doctoral Dissertations
  • Algorithms papers
  • Physics papers
• Presentations
• Developer notes
  • On use of the Maxima CAS
  • Modal basis functions
  • Strong-Stability preserving Runge-Kutta time-steppers
  • Normalized units for the Vlasov-Maxwell system
  • From normalized to physical units in Vlasov and multi-fluid simulations
  • The eigensystem of the Maxwell equations with extension to perfectly hyperbolic Maxwell equations
  • The eigensystem of the Euler equations
  • The eigensystem of the ten-moment equations
  • Handling two-fluid five-moment and ten-moment source terms