Unify create_cache for ControllerThreeLevel* and the different mesh types (#2285)

* Unify create_cache for ControllerThreeLevel and ControllerThreeLevelCombined, and the different meshes

* Moved create_cache function for ControllerThreeLevel* into amr_dg.jl

* Use three-level AMR controller for p4est 3D test

---------

Co-authored-by: Joshua Lampert <[email protected]>
Co-authored-by: Michael Schlottke-Lakemper <[email protected]>

Author: 3 people

examples/p4est_3d_dgsem/elixir_euler_weak_blast_wave_amr.jl

@@ -87,10 +87,12 @@ analysis_callback = AnalysisCallback(semi, interval = analysis_interval,
 alive_callback = AliveCallback(analysis_interval = analysis_interval)
 
 amr_indicator = IndicatorLöhner(semi, variable = Trixi.density)
-amr_controller = ControllerThreeLevel(semi, amr_indicator,
-                                      base_level = 1,
-                                      med_level = 2, med_threshold = 0.05,
-                                      max_level = 3, max_threshold = 0.15)
+amr_controller = ControllerThreeLevelCombined(semi, amr_indicator, indicator_sc,
+                                              base_level = 1,
+                                              med_level = 2, med_threshold = 0.05, # med_level = current level
+                                              max_level = 3, max_threshold = 0.15,
+                                              max_threshold_secondary = indicator_sc.alpha_max)
+
 amr_callback = AMRCallback(semi, amr_controller,
                            interval = 1,
                            adapt_initial_condition = false,

src/callbacks_step/amr_dg.jl

@@ -90,4 +90,14 @@ function rebalance_solver!(u_ode::AbstractVector,
         end
     end # GC.@preserve old_u_ode
 end
+
+# Construct cache for ControllerThreeLevel and ControllerThreeLevelCombined.
+# This method is called when a controller is constructed
+function create_cache(::Union{Type{ControllerThreeLevel},
+                              Type{ControllerThreeLevelCombined}},
+                      mesh::Union{TreeMesh, P4estMesh, T8codeMesh},
+                      equations, dg::DG, cache)
+    controller_value = Vector{Int}(undef, nelements(dg, cache))
+    return (; controller_value)
+end
 end # @muladd

src/callbacks_step/amr_dg1d.jl

@@ -283,17 +283,4 @@ function coarsen_elements!(u::AbstractArray{<:Any, 3}, element_id,
         set_node_vars!(u, acc, equations, dg, i, element_id)
     end
 end
-
-# this method is called when an `ControllerThreeLevel` is constructed
-function create_cache(::Type{ControllerThreeLevel}, mesh::TreeMesh{1}, equations,
-                      dg::DG, cache)
-    controller_value = Vector{Int}(undef, nelements(dg, cache))
-    return (; controller_value)
-end
-
-function create_cache(::Type{ControllerThreeLevelCombined}, mesh::TreeMesh,
-                      equations, dg::DG, cache)
-    controller_value = Vector{Int}(undef, nelements(dg, cache))
-    return (; controller_value)
-end
 end # @muladd

src/callbacks_step/amr_dg2d.jl

@@ -570,12 +570,4 @@ function adapt!(u_ode::AbstractVector, adaptor, mesh::T8codeMesh{2}, equations,
 
     return nothing
 end
-
-# this method is called when an `ControllerThreeLevel` is constructed
-function create_cache(::Type{ControllerThreeLevel},
-                      mesh::Union{TreeMesh{2}, P4estMesh{2}, T8codeMesh{2}}, equations,
-                      dg::DG, cache)
-    controller_value = Vector{Int}(undef, nelements(dg, cache))
-    return (; controller_value)
-end
 end # @muladd

src/callbacks_step/amr_dg3d.jl

@@ -381,14 +381,6 @@ function coarsen_elements!(u::AbstractArray{<:Any, 5}, element_id,
     return nothing
 end
 
-# this method is called when an `ControllerThreeLevel` is constructed
-function create_cache(::Type{ControllerThreeLevel},
-                      mesh::Union{TreeMesh{3}, P4estMesh{3}, T8codeMesh{3}},
-                      equations, dg::DG, cache)
-    controller_value = Vector{Int}(undef, nelements(dg, cache))
-    return (; controller_value)
-end
-
 # Coarsen and refine elements in the DG solver based on a difference list.
 function adapt!(u_ode::AbstractVector, adaptor, mesh::T8codeMesh{3}, equations,
                 dg::DGSEM, cache, difference)

test/test_p4est_3d.jl

@@ -682,18 +682,18 @@ end
 @trixi_testset "elixir_euler_weak_blast_wave_amr.jl" begin
     @test_trixi_include(joinpath(EXAMPLES_DIR, "elixir_euler_weak_blast_wave_amr.jl"),
                         l2=[
-                            0.011345993108796831,
-                            0.018525073963833696,
-                            0.019102348105917946,
-                            0.01920515438943838,
-                            0.15060493968460148
+                            0.012046270976464931,
+                            0.01894521652831441,
+                            0.01951983946363743,
+                            0.019748755875702628,
+                            0.15017285006198244
                         ],
                         linf=[
-                            0.2994949779783401,
-                            0.5530175050084679,
-                            0.5335803757792128,
-                            0.5647252867336123,
-                            3.6462732329242566
+                            0.3156585581400839,
+                            0.6653806948576124,
+                            0.5451454769741236,
+                            0.558669830478818,
+                            3.6406796982784635
                         ],
                         tspan=(0.0, 0.025),)
     # Ensure that we do not have excessive memory allocations