Added appropriately descriptive comments for all AMR regression tests.

regression/rt_amr_10m_gem.c

@@ -1,3 +1,9 @@
+// Geospace Environmental Modeling (GEM) magnetic reconnection test, using static, block-structured mesh refinement with a single refinement block (2x refinement), for the 10-moment equations.
+// Input parameters match the equilibrium and initial conditions in Section 2, from the article:
+// J. Birn et al. (2001), "Geospace Environmental Modeling (GEM) Magnetic Reconnection Challenge",
+// Journal of Geophysical Research: Space Physics, Volume 106 (A3): 3715-3719.
+// https://agupubs.onlinelibrary.wiley.com/doi/10.1029/1999JA900449
+
 #include <gkyl_amr_core.h>
 
 struct amr_10m_gem_ctx

regression/rt_amr_10m_par_firehose.c

@@ -1,3 +1,11 @@
+// Parallel-propagating firehose instability test, using static, patch-structured mesh refinement with a single refinement patch (2x refinement), for the 10-moment equations.
+// Input parameters match the initial conditions in Section 4.4, from the article:
+// M. W. Kunz, J. M. Stone and X-N. Bai (2014), "Pegasus: A new hybrid-kinetic particle-in-cell code for astrophysical plasma dynamics",
+// Journal of Computational Physics, Volume 259: 154-174.
+// https://www.sciencedirect.com/science/article/pii/S0021999113007973
+
+// THIS TEST CURRENTLY FAILS (AS OF 05/20/2024) - JG TO TRACK DOWN WHY.
+
 #include <gkyl_amr_core.h>
 
 struct amr_10m_par_firehose_ctx

regression/rt_amr_5m_gem.c

@@ -1,3 +1,9 @@
+// Geospace Environmental Modeling (GEM) magnetic reconnection test, using static, block-structured mesh refinement with a single refinement block (2x refinement), for the 5-moment equations.
+// Input parameters match the equilibrium and initial conditions in Section 2, from the article:
+// J. Birn et al. (2001), "Geospace Environmental Modeling (GEM) Magnetic Reconnection Challenge",
+// Journal of Geophysical Research: Space Physics, Volume 106 (A3): 3715-3719.
+// https://agupubs.onlinelibrary.wiley.com/doi/10.1029/1999JA900449
+
 #include <gkyl_amr_core.h>
 
 struct amr_5m_gem_ctx

regression/rt_amr_5m_riem.c

@@ -1,3 +1,9 @@
+// Generalized Brio-Wu Riemann problem, using static, patch-structured mesh refinement with a single refinement patch (4x refinement), for the 5-moment equations.
+// Input parameters match the initial conditions found in entry JE4 of Ammar's Simulation Journal (https://ammar-hakim.org/sj/je/je4/je4-twofluid-shock.html), adapted from Section 7.1 of the article:
+// A. Hakim, J. Loverich and U. Shumlak (2006), "A high resolution wave propagation scheme for ideal Two-Fluid plasma equations",
+// Journal of Computational Physics, Volume 219 (1): 418-442.
+// https://www.sciencedirect.com/science/article/pii/S0021999106001707
+
 #include <gkyl_amr_core.h>
 
 struct amr_5m_riem_ctx

regression/rt_amr_euler_cart_axi_sodshock.c

@@ -1,3 +1,9 @@
+// 2D Sod-type shock tube test in axial symmetry, in Cartesian coordinates, using static, block-structured mesh refinement with a single refinement block (4x refinement), for the 5-moment (Euler) equations.
+// Input parameters are an axisymmetric generalization of those in Section 2.6.2, with the contact discontinuity placed at r = 0.75, from the thesis:
+// A. Hakim (2006), "High Resolution Wave Propagation Schemes for Two-Fluid Plasma Simulations",
+// PhD Thesis, University of Washington.
+// https://www.aa.washington.edu/sites/aa/files/research/cpdlab/docs/PhDthesis_hakim.pdf
+
 #include <gkyl_amr_core.h>
 
 struct amr_euler_cart_axi_sodshock_ctx

regression/rt_amr_euler_riem_2d.c

@@ -1,3 +1,9 @@
+// 2D Riemann (quadrant) problem, using static, block-structured mesh refinement with a single refinement block (4x refinement), for the 5-moment (Euler) equations.
+// Input parameters match the initial conditions in Section 4.3, Case 3, with final time set to t = 0.8 rather than t = 0.3, from the article:
+// R. Liska and B. Wendroff (2003), "Comparison of Several Difference Schemes on 1D and 2D Test Problems for the Euler Equations",
+// SIAM Journal on Scientific Computing, Volume 25 (3): 995-1017.
+// https://epubs.siam.org/doi/10.1137/S1064827502402120
+
 #include <gkyl_amr_core.h>
 
 struct amr_euler_riem_2d_ctx

regression/rt_amr_euler_sodshock.c

@@ -1,3 +1,9 @@
+// Sod-type shock tube test, using static, patch-structured mesh refinement with a single refinement patch (4x refinement), for the 5-moment (Euler) equations.
+// Input parameters match the initial conditions in Section 2.6.2, with the contact discontinuity placed at x = 0.75 rather than x = 0.5, from the thesis:
+// A. Hakim (2006), "High Resolution Wave Propagation Schemes for Two-Fluid Plasma Simulations",
+// PhD Thesis, University of Washington.
+// https://www.aa.washington.edu/sites/aa/files/research/cpdlab/docs/PhDthesis_hakim.pdf
+
 #include <gkyl_amr_core.h>
 
 struct amr_euler_sodshock_ctx

regression/rt_amr_gr_bhl_spinning.c

@@ -1,3 +1,10 @@
+// 2D Bondi-Hoyle-Lyttleton accretion problem onto a non-static (Kerr) black hole, using static, block-structured mesh refinement with a single refinement block (4x refinement), for the general relativistic Euler equations.
+// Input parameters describe wind accretion of a cold relativistic gas onto a spinning black hole.
+// Based on the analytical solution for stiff relativistic fluids presented in the article:
+// L. I. Petrich, S. L. Shapiro and S. A. Teukolsky (1988), "Accretion onto a moving black hole: An exact solution",
+// Physical Review Letters, Volume 60 (18): 1781-1784.
+// https://journals.aps.org/prl/abstract/10.1103/PhysRevLett.60.1781
+
 #include <gkyl_amr_core.h>
 #include <gkyl_gr_blackhole.h>
 #include <gkyl_alloc.h>

regression/rt_amr_gr_bhl_static.c

@@ -1,3 +1,10 @@
+// 2D Bondi-Hoyle-Lyttleton accretion problem onto a static (Schwarzschild) black hole, using static, block-structured mesh refinement with a single refinement block (4x refinement), for the general relativistic Euler equations.
+// Input parameters describe wind accretion of a cold relativistic gas onto a non-rotating black hole.
+// Based on the analytical solution for stiff relativistic fluids presented in the article:
+// L. I. Petrich, S. L. Shapiro and S. A. Teukolsky (1988), "Accretion onto a moving black hole: An exact solution",
+// Physical Review Letters, Volume 60 (18): 1781-1784.
+// https://journals.aps.org/prl/abstract/10.1103/PhysRevLett.60.1781
+
 #include <gkyl_amr_core.h>
 #include <gkyl_gr_blackhole.h>
 #include <gkyl_alloc.h>

regression/rt_amr_gr_blackhole_spinning.c

@@ -1,3 +1,6 @@
+// 2D ring-accretion problem onto a non-static (Kerr) black hole, using static, block-structured mesh refinement with a single refinement block (4x refinement), for the general relativistic Euler equations.
+// Input parameters describe an asymmetrical ring of cold relativistic gas accreting onto a spinning black hole.
+
 #include <gkyl_amr_core.h>
 #include <gkyl_gr_blackhole.h>
 #include <gkyl_alloc.h>

regression/rt_amr_gr_blackhole_static.c

@@ -1,3 +1,6 @@
+// 2D ring-accretion problem onto a static (Schwarzschild) black hole, using static, block-structured mesh refinement with a single refinement block (4x refinement), for the general relativistic Euler equations.
+// Input parameters describe an asymmetrical ring of cold relativistic gas accreting onto a non-rotating black hole.
+
 #include <gkyl_amr_core.h>
 #include <gkyl_gr_blackhole.h>
 #include <gkyl_alloc.h>

regression/rt_amr_gr_mild_shock.c

@@ -1,3 +1,9 @@
+// Mildly relativistic blast wave test, using static, patch-structured mesh refinement with a single refinement patch (4x refinement), for the general relativistic Euler equations.
+// Input parameters taken from the initial conditions in Section 4.1 (blast wave 1), from the article:
+// L. Del Zanna and N. Bucciantini (2002), "An efficient shock-cpaturing central-type scheme for multidimensional relativistic flows. I. Hydrodynamics",
+// Astronomy and Astrophysics, Volume 390 (3): 1177-1186.
+// https://arxiv.org/abs/astro-ph/0205290
+
 #include <gkyl_amr_core.h>
 #include <gkyl_gr_minkowski.h>
 #include <gkyl_alloc.h>

regression/rt_amr_gr_perturbed_density.c

@@ -1,3 +1,9 @@
+// Perturbed density test, using static, patch-structured mesh refinement with a single refinement patch (8x refinement), for the general relativistic Euler equations.
+// Input parameters taken from the initial conditions in Section 4.1 (density perturbation), from the article:
+// L. Del Zanna and N. Bucciantini (2002), "An efficient shock-capturing central-type scheme for multidimensional relativistic flows. I. Hydrodynamics",
+// Astronomy and Astrophysics, Volume 390 (3): 1177-1186.
+// https://arxiv.org/abs/astro-ph/0205290
+
 #include <gkyl_amr_core.h>
 #include <gkyl_gr_minkowski.h>
 #include <gkyl_alloc.h>

regression/rt_amr_gr_quadrants_2d.c

@@ -1,3 +1,9 @@
+// 2D quadrants test, using static, block-structured mesh refinement with a single refinement block (4x refinement), for the general relativistic Euler equations.
+// Input parameters taken from the initial conditions in Section 4.2 (Riemann 2-D), from the article:
+// L. Del Zanna and N. Bucciantini (2002), "An efficient shock-capturing central-type scheme for multdimensional flows. I. Hydrodynamics",
+// Astronomy and Astrophysics, Volume 390 (3): 1177-1186.
+// https://arxiv.org/abs/astro-ph/0205290
+
 #include <gkyl_amr_core.h>
 #include <gkyl_gr_minkowski.h>
 #include <gkyl_alloc.h>

regression/rt_amr_gr_strong_blast.c

@@ -1,3 +1,9 @@
+// Strongly relativistic blast wave test, using static, patch-structured mesh refinement with a single refinement patch (4x refinement), for the general relativistic Euler equations.
+// Input parameters taken from the initial conditions in Section 4.1 (blast wave 2), from the article:
+// L. Del Zanna and N. Bucciantini (2002), "An efficient shock-capturing central-type scheme for multidimensional relativistic flows. I. Hydrodynamics",
+// Astronomy and Astrophysics, Volume 390 (3): 1177-1186.
+// https://arxiv.org/abs/astro-ph/0205290
+
 #include <gkyl_amr_core.h>
 #include <gkyl_gr_minkowski.h>
 #include <gkyl_alloc.h>

regression/rt_euler_sodshock.c

@@ -1,4 +1,4 @@
-// Sod-type shock tube test, using higher-order (Roe) fluxes, for 5-moment (Euler) equations.
+// Sod-type shock tube test, using higher-order (Roe) fluxes, for the 5-moment (Euler) equations.
 // Input parameters match the initial conditions in Section 2.6.2, with the contact discontinuity placed at x = 0.75 rather than x = 0.5, from the thesis:
 // A. Hakim (2006), "High Resolution Wave Propagation Schemes for Two-Fluid Plasma Simulations",
 // PhD Thesis, University of Washington.