The following sources define the scientific and numerical context used by this documentation:
- E. Lanti et al., “ORB5: A global electromagnetic gyrokinetic code using the PIC approach in toroidal geometry,” Computer Physics Communications 251, 107072 (2020). DOI: 10.1016/j.cpc.2019.107072.
- A. Mishchenko et al., “Pullback transformation in gyrokinetic electromagnetic simulations,” Computer Physics Communications 238, 194–202 (2019).
- The ORB5 review manuscript in manuscript/orb5-ref-tex/, especially sections/gk_model.tex and sections/numerical_implementation.tex.
- The electromagnetic numerics manuscript in manuscript/orb5-numerics-electromagnetic/paper_rev.tex.
- C. de Boor, A Practical Guide to Splines, for the PPPACK-derived spline algorithms used by orb5x::spclibs.
The manuscripts stored in the repository are supporting references. When a header and a manuscript differ about a callable C++ behavior, the current C++ implementation and its tests define the software contract; the discrepancy should be reported and resolved as a parity issue.