3D HW

[oparry-ukaea]

Description

Add 'true 3D' HW equation system to the H3LAPD solver.

Fixes #214

Type of change

Please delete options that are not relevant.

• [x] New feature (non-breaking change which adds functionality)
• [x] Requires documentation updates

Testing

HWTest.3DHWGrowthRates (in test/integration/solvers/H3LAPD/test_H3LAPD.cpp)

Runs the H3LAPD solver with the "HW3DSystem" equation system for a small number of steps with periodic BCs on all sides. Particle number is set to 0. Tests that growth rate of energy and enstrophy match analytical expected rates (see equations 8 and 9 of this ref or the same equation numbers in Hasegawa & Wakatani, 1983 for similar calculations). Passes iff rates match to a tolerance of 5e-3 AND the solver returns 0.

Test Configuration:

OS: Ubuntu 22.04 Compiler: GCC 11.3.0 / OneAPI v2022.1.0 SYCL implementation: Hipsycl v0.9.2 / DPC++ v2022.1.0 MPI details: MPICH v4.0.2 Hardware: CPU (Intel Alder Lake)

Checklist:

• [ ] I have added tests that prove my fix is effective or that my feature works
• [x] New and existing unit tests pass locally with my changes
• [x] I have used understandable variable names
• [x] I have run clang-format against my *.hpp and *.cpp changes
• [x] I have run cmake-format against my changes to CMakeLists.txt
• [ ] I have made corresponding changes to the documentation
• [x] I have performed a self-review of my own code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] My changes generate no new warnings