Enhance old macros (#61)

* Start * Enhance macros * Minor fix
trixi-gpu · Oct 3, 2024 · 8da7938 · 8da7938
1 parent 699f513
commit 8da7938
Show file tree

Hide file tree

Showing 28 changed files with 73 additions and 64 deletions.
diff --git a/test/test_macros.jl b/test/test_macros.jl
@@ -5,24 +5,25 @@ using Test: @test, @testset
 
 # Macro to test the type Float64 or Float32 ?
 
-# Macro to test the exact equality of arrays from GPU and CPU
+# Macro to test the exact equality of two arrays, which can be from the CPU, GPU, 
+# or a combination of both
 macro test_equal(expr)
     # Parse the expression and check that it is of the form 
     # @test_equal (array1, array2)
     if expr.head != :tuple || length(expr.args) != 2
-        error("Usage: @test_equal (gpu, cpu)")
+        error("Incorrect usage. Expected syntax: @test_approx(array1, array2)")
     end
 
-    local gpu = esc(expr.args[1])
-    local cpu = esc(expr.args[2])
+    local array1 = esc(expr.args[1])
+    local array2 = esc(expr.args[2])
 
     quote
         # Convert to arrays to avoid using CUDA.@allowscalar 
         # to access the elements of some arrays
-        local gpu_arr = Array($gpu)
-        local cpu_arr = Array($cpu)
+        local _array1 = Array($array1)
+        local _array2 = Array($array2)
 
-        @test gpu_arr == cpu_arr
+        @test _array1 == _array2
     end
 end
 
@@ -31,63 +32,71 @@ macro test_approx(expr)
     # Parse the expression and check that it is of the form 
     # @test_approx (array1, array2)
     if expr.head != :tuple || length(expr.args) != 2
-        error("Usage: @test_approx (gpu, cpu)")
+        error("Incorrect usage. Expected syntax: @test_approx(array1, array2)")
     end
 
-    local gpu = esc(expr.args[1])
-    local cpu = esc(expr.args[2])
+    local array1 = esc(expr.args[1])
+    local array2 = esc(expr.args[2])
 
     quote
         # Convert to arrays to avoid using CUDA.@allowscalar 
         # to access the elements of some arrays
-        local gpu_arr = Array($gpu)
-        local cpu_arr = Array($cpu)
+        local _array1 = Array($array1)
+        local _array2 = Array($array2)
 
         # Check if the arrays have NaN
-        local has_nan_gpu = any(isnan, gpu_arr)
-        local has_nan_cpu = any(isnan, cpu_arr)
+        local has_nan_arr1 = any(isnan, _array1)
+        local has_nan_arr2 = any(isnan, _array2)
 
-        if has_nan_gpu && has_nan_cpu # both have NaN
+        if has_nan_arr1 && has_nan_arr2 # both have NaN
             # Condition 1: Check if NaNs are at the same position
-            local cond1 = isnan.(gpu_arr) == isnan.(cpu_arr)
+            local cond1 = isnan.(_array1) == isnan.(_array2)
 
             # Replace NaNs with 0.0
-            local _gpu_arr = replace(gpu_arr, NaN => 0.0)
-            local _cpu_arr = replace(cpu_arr, NaN => 0.0)
+            local __array1 = replace(_array1, NaN => 0.0)
+            local __array2 = replace(_array2, NaN => 0.0)
 
             # Condition 2: Check if the arrays are approximately equal
-            local cond2 = _gpu_arr ≈ _cpu_arr
+            local cond2 = __array1 ≈ __array2
 
             @test cond1 && cond2
-        elseif !has_nan_gpu && !has_nan_cpu # neither has NaN
+        elseif !has_nan_arr1 && !has_nan_arr2 # neither has NaN
 
             # Direct comparison
-            @test gpu_arr ≈ cpu_arr
+            @test _array1 ≈ _array2
         else # one has NaN and the other does not
-
-            # Typically, the array from CPU has NaN and the array from 
-            # GPU does not have NaN, since the NaN values are replaced 
-            # with zeros in the GPU kernels to avoid control flow divergence 
-            # when dealing with NaNs. 
-
-            # Condition 1's truth table:
+            # Truth table 
             # -------------------------------
-            # Entry-CPU | Entry-GPU | Result
+            #   Entry   |   Entry   | Result
             # -------------------------------
-            #  NaN      |   zero    |   1
-            #  NaN      |  non-zero |   0
+            #    NaN    |   zero    |   1
+            #    NaN    |  non-zero |   0
             #  non-NaN  |   zero    |   1
             #  non-NaN  |  non-zero |   1
             # -------------------------------
-            local cond1 = all(.!(isnan.(cpu_arr) .&& (gpu_arr .!= 0.0)))
+            if has_nan_arr1
+                # Condition 1: Check truth table above
+                local cond1 = all(.!(isnan.(_array1) .&& (_array2 .!= 0.0)))
 
-            # Replace NaNs with 0.0
-            local _cpu_arr = replace(cpu_arr, NaN => 0.0)
+                # Replace NaNs with 0.0
+                local __array1 = replace(_array1, NaN => 0.0)
 
-            # Condition 2: Check if the arrays are approximately equal
-            local cond2 = gpu_arr ≈ _cpu_arr
+                # Condition 2: Check if the arrays are approximately equal
+                local cond2 = _array2 ≈ __array1
 
-            @test cond1 && cond2
+                @test cond1 && cond2
+            else  # has_nan_arr2
+                # Condition 1: Check truth table above
+                local cond1 = all(.!(isnan.(_array2) .&& (_array1 .!= 0.0)))
+
+                # Replace NaNs with 0.0
+                local __array2 = replace(_array2, NaN => 0.0)
+
+                # Condition 2: Check if the arrays are approximately equal
+                local cond2 = _array1 ≈ __array2
+
+                @test cond1 && cond2
+            end
         end
     end
 end
diff --git a/test/tree_dgsem_2d/advection_basic.jl b/test/tree_dgsem_2d/advection_basic.jl
@@ -100,7 +100,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_2d/advection_mortar.jl b/test/tree_dgsem_2d/advection_mortar.jl
@@ -101,7 +101,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_2d/euler_shock.jl b/test/tree_dgsem_2d/euler_shock.jl
@@ -109,7 +109,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_2d/euler_source_terms.jl b/test/tree_dgsem_2d/euler_source_terms.jl
@@ -99,7 +99,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_2d/euler_source_terms_nonperiodic.jl b/test/tree_dgsem_2d/euler_source_terms_nonperiodic.jl
@@ -109,7 +109,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_2d/euler_vortex_mortar.jl b/test/tree_dgsem_2d/euler_vortex_mortar.jl
@@ -128,7 +128,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_2d/eulermulti_ec.jl b/test/tree_dgsem_2d/eulermulti_ec.jl
@@ -101,7 +101,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_2d/eulermulti_es.jl b/test/tree_dgsem_2d/eulermulti_es.jl
@@ -101,7 +101,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_2d/hypdiff_nonperiodic.jl b/test/tree_dgsem_2d/hypdiff_nonperiodic.jl
@@ -108,7 +108,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_2d/mhd_alfven_wave.jl b/test/tree_dgsem_2d/mhd_alfven_wave.jl
@@ -102,7 +102,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_2d/mhd_alfven_wave_mortar.jl b/test/tree_dgsem_2d/mhd_alfven_wave_mortar.jl
@@ -106,7 +106,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_2d/mhd_shock.jl b/test/tree_dgsem_2d/mhd_shock.jl
@@ -112,7 +112,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_2d/shallowwater_ec.jl b/test/tree_dgsem_2d/shallowwater_ec.jl
@@ -101,7 +101,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_2d/shallowwater_source_terms.jl b/test/tree_dgsem_2d/shallowwater_source_terms.jl
@@ -104,7 +104,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_2d/shawllowwater_source_terms_nonperiodic.jl b/test/tree_dgsem_2d/shawllowwater_source_terms_nonperiodic.jl
@@ -108,7 +108,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_3d/advection_basic.jl b/test/tree_dgsem_3d/advection_basic.jl
@@ -100,7 +100,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_3d/advection_mortar.jl b/test/tree_dgsem_3d/advection_mortar.jl
@@ -103,7 +103,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_3d/euler_convergence.jl b/test/tree_dgsem_3d/euler_convergence.jl
@@ -101,7 +101,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_3d/euler_ec.jl b/test/tree_dgsem_3d/euler_ec.jl
@@ -100,7 +100,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_3d/euler_mortar.jl b/test/tree_dgsem_3d/euler_mortar.jl
@@ -102,7 +102,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_3d/euler_shock.jl b/test/tree_dgsem_3d/euler_shock.jl
@@ -111,7 +111,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_3d/euler_source_terms.jl b/test/tree_dgsem_3d/euler_source_terms.jl
@@ -101,7 +101,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_3d/hypdiff_nonperiodic.jl b/test/tree_dgsem_3d/hypdiff_nonperiodic.jl
@@ -109,7 +109,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_3d/mhd_alfven_wave.jl b/test/tree_dgsem_3d/mhd_alfven_wave.jl
@@ -101,7 +101,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_3d/mhd_alfven_wave_mortar.jl b/test/tree_dgsem_3d/mhd_alfven_wave_mortar.jl
@@ -105,7 +105,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_3d/mhd_ec.jl b/test/tree_dgsem_3d/mhd_ec.jl
@@ -101,7 +101,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)

diff --git a/test/tree_dgsem_3d/mhd_shock.jl b/test/tree_dgsem_3d/mhd_shock.jl
@@ -112,7 +112,7 @@ include("../test_macros.jl")
             @test_equal (u_gpu, u)
         end
 
-        @testset "Prolong mortars" begin
+        @testset "Prolong Mortars" begin
             TrixiCUDA.cuda_prolong2mortars!(u_gpu, mesh_gpu,
                                             TrixiCUDA.check_cache_mortars(cache_gpu),
                                             solver_gpu, cache_gpu)