Clean udf arguments. Move step to Status. Fix a bug in check_vs_num.

Blumenkranz · Blumenkranz · commit 68e38bd07cca · 2026-03-24T21:20:39.000+08:00
diff --git a/example/X38/X38_julia.jl b/example/X38/X38_julia.jl
@@ -68,7 +68,7 @@ for i in 1:nt
     iterate!(amr) # Collision process and time marching.
     data_exchange!(ps4est, amr) # Update variables in ghost cells by MPI communication.
     check_for_convergence(amr)&&break # Check for convergence.
-    check!(i,ps4est,amr) # Check for save and output simulation status to `stdout`.
+    check!(ps4est,amr) # Check for save and output simulation status to `stdout`.
 end
 
 save_result(ps4est,amr) # Save converging results.
diff --git a/example/X38/X38_text.jl b/example/X38/X38_text.jl
@@ -20,7 +20,7 @@ for i in 1:nt
     KitAMR.iterate!(amr) 
     KitAMR.data_exchange!(ps4est, amr)
     KitAMR.check_for_convergence(amr)&&break
-    KitAMR.check!(i,ps4est,amr)
+    KitAMR.check!(ps4est,amr)
 end
 KitAMR.save_result(ps4est,amr)
 KitAMR.finalize!(ps4est,amr)
diff --git a/example/X38/X38_udf.jl b/example/X38/X38_udf.jl
@@ -1,5 +1,5 @@
 using LinearAlgebra
-function amr_region(;ps_data,kwargs...)
+function amr_region(ps_data,level,amr) # dynamic
     midpoint = ps_data.midpoint
     ds = ps_data.ds
     L = 1.0
@@ -8,7 +8,7 @@ function amr_region(;ps_data,kwargs...)
     end
     return false
 end
-function X38_buffer_IC(midpoint::Vector{Float64};kwargs...)
+function X38_buffer_IC(midpoint::Vector{Float64},::Global_Data)
     global_data = kwargs[:global_data]
     ib = global_data.config.IB[1]
     Ma = 8.
diff --git a/example/airfoil/airfoil.jl b/example/airfoil/airfoil.jl
@@ -54,7 +54,7 @@ for i in 1:nt
     iterate!(amr) 
     data_exchange!(ps4est, amr)
     check_for_convergence(amr)&&break
-    check!(i,ps4est,amr)
+    check!(ps4est,amr)
 end
 save_result(ps4est,amr)
 finalize!(ps4est,amr)
diff --git a/example/cylinder/cylinder.jl b/example/cylinder/cylinder.jl
@@ -56,7 +56,7 @@ for i in 1:nt
     iterate!(amr) 
     data_exchange!(ps4est, amr)
     check_for_convergence(amr)&&break
-    check!(i,ps4est,amr)
+    check!(ps4est,amr)
     # KitAMR.check_for_animsave!(ps4est,amr)
     # if amr.global_data.status.sim_time>3.0
     #     break
diff --git a/example/cylinder/cylinder_udf.jl b/example/cylinder/cylinder_udf.jl
@@ -5,14 +5,14 @@ function shock_wave_region(midpoint,ds,global_data,level)
     end
     return false
 end
-function amr_region(;ps_data,kwargs...)
+function amr_region(ps_data,level,amr)
     midpoint = ps_data.midpoint
     if midpoint[1]>-5.0&&midpoint[1]<5.0&&midpoint[2]<5.0&&midpoint[2]>-5.0&&√sum(midpoint.^2)>1.0
         return true
     end
     return false
 end
-function cylinder_buffer_IC(midpoint::Vector{Float64})
+function cylinder_buffer_IC(midpoint::Vector{Float64},::Global_Data)
     r = norm(midpoint)
     Ma = 5.0
     Tw = 1.0
diff --git a/example/sphere/sphere.jl b/example/sphere/sphere.jl
@@ -58,7 +58,7 @@ for i in 1:nt
     iterate!(amr) 
     data_exchange!(ps4est, amr)
     check_for_convergence(amr)&&break
-    check!(i,ps4est,amr)
+    check!(ps4est,amr)
 end
 save_result(ps4est,amr)
 finalize!(ps4est,amr)
diff --git a/example/sphere/sphere_udf.jl b/example/sphere/sphere_udf.jl
@@ -8,7 +8,7 @@ function shock_wave_region(midpoint,ds,global_data,level)
     end
     return false
 end
-function sphere_buffer_IC(midpoint::Vector{Float64};kwargs...)
+function sphere_buffer_IC(midpoint::Vector{Float64},::Global_Data)
     r = norm(midpoint)
     Ma = 3.834
     Tw = 1.0+(5/3-1)*0.5*Ma^2
diff --git a/src/IO/Check.jl b/src/IO/Check.jl
@@ -2,27 +2,29 @@
 $(SIGNATURES)
 Perform a check procedure. Simulation status will be output every `ST_CHECK_INTERVAL` steps.
 """
-function check!(i,ps4est,amr)
-    if amr.global_data.status.residual.step%amr.global_data.config.solver.ST_CHECK_INTERVAL==0
-        max_vs_num,total_phase_num = check_vs_num(amr)
-        if MPI.Comm_rank(MPI.COMM_WORLD) == 0
-            i+=1
-            println("Iteration: $i")
-            sim_time = amr.global_data.status.sim_time
-            println("Simulation time: $sim_time")
-            res = maximum(amr.global_data.status.residual.residual)
-            println("Residual: $res")
-            ref_vs_num = amr.global_data.status.max_vs_num
-            println("MPI buffer size: $ref_vs_num")
-            println("Maximum number of velocity grids: $max_vs_num")
-            pp = PointerWrapper(ps4est)
-            global_num_quadrants = pp.global_num_quadrants[]
-            println("Total number of physical grids: $global_num_quadrants")
-            println("Total number of phase grids: $total_phase_num")
-        end
+function check!(ps4est,amr)
+    if amr.global_data.status.step%amr.global_data.config.solver.ST_CHECK_INTERVAL==0
+        execute_check(ps4est,amr)
         check_for_save!(ps4est,amr)
     end
 end
+function execute_check(ps4est,amr)
+    max_vs_num,total_phase_num = check_vs_num(amr)
+    if MPI.Comm_rank(MPI.COMM_WORLD) == 0
+        println("Iteration: $(amr.global_data.status.step)")
+        sim_time = amr.global_data.status.sim_time
+        println("Simulation time: $sim_time")
+        res = maximum(amr.global_data.status.residual.residual)
+        println("Residual: $res")
+        ref_vs_num = amr.global_data.status.max_vs_num
+        println("MPI buffer size: $ref_vs_num")
+        println("Maximum number of velocity grids: $max_vs_num")
+        pp = PointerWrapper(ps4est)
+        global_num_quadrants = pp.global_num_quadrants[]
+        println("Total number of physical grids: $global_num_quadrants")
+        println("Total number of phase grids: $total_phase_num")
+    end
+end
 """
 $(SIGNATURES)
 Start listening for the input from command line. Must be called before calling [`check_for_save!`](@ref).
@@ -175,7 +177,6 @@ function check_vs_num(amr::KitAMR_Data)
     for tree in trees
         for ps_data in tree
             isa(ps_data,InsideSolidData)&&continue
-            ps_data.bound_enc<0&&continue
             vs_num = ps_data.vs_data.vs_num
             buffer[1] = max(buffer[1],vs_num)
             buffer[2] += vs_num
diff --git a/src/Solver/Finalize.jl b/src/Solver/Finalize.jl
@@ -4,7 +4,7 @@ Update residuals.
 """
 function residual_check!(ps_data::PS_Data,prim::Vector{Float64},global_data::Global_Data)
     Res = global_data.status.residual
-    Res.step%global_data.config.solver.ST_CHECK_INTERVAL!=0&&(return nothing)
+    global_data.status.step%global_data.config.solver.ST_CHECK_INTERVAL!=0&&(return nothing)
     @. Res.sumRes+=(prim-ps_data.prim).^2
     @. Res.sumAvg+=abs(prim)
     return nothing
@@ -13,7 +13,7 @@ function residual_comm!(global_data::Global_Data)
     Res = global_data.status.residual
     fp = PointerWrapper(global_data.forest.p4est)
     N = fp.global_num_quadrants[]
-    Res.step%global_data.config.solver.ST_CHECK_INTERVAL!=0&&(return nothing)
+    global_data.status.step%global_data.config.solver.ST_CHECK_INTERVAL!=0&&(return nothing)
     MPI.Reduce!(Res.sumRes,(x,y)->x.+y,0,MPI.COMM_WORLD)
     MPI.Reduce!(Res.sumAvg,(x,y)->x.+y,0,MPI.COMM_WORLD)
     if MPI.Comm_rank(MPI.COMM_WORLD)==0
diff --git a/src/Solver/Initialize.jl b/src/Solver/Initialize.jl
@@ -222,8 +222,8 @@ end
 function initial_prim(ic::Uniform;kwargs...)
     return ic.ic
 end
-function initial_prim(ic::PCoordFn;midpoint::AbstractVector{Float64},kwargs...)
-    return ic.PCIC_fn(midpoint;kwargs...)
+function initial_prim(ic::PCoordFn;midpoint::AbstractVector{Float64},global_data::Global_Data)
+    return ic.PCIC_fn(midpoint,global_data)
 end
 function init_solid_midpoints_kernel(ip, data, dp)
     global_data, solid_midpoints = unsafe_pointer_to_objref(data)
@@ -263,7 +263,7 @@ function init_ps_p4est_kernel(ip, data, dp)
         ps_data.quadid = global_quadid(ip)
         ps_data.ds .= ds
         ps_data.midpoint .= midpoint
-        ps_data.prim .= initial_prim(ic;midpoint = ps_data.midpoint)
+        ps_data.prim .= initial_prim(ic;midpoint = ps_data.midpoint,global_data = global_data)
         ps_data.w .= get_conserved(ps_data, global_data)
         ps_data.vs_data = init_vs(ps_data.prim, global_data)
         for i in eachindex(solid_cell_flags)
diff --git a/src/Solver/Types.jl b/src/Solver/Types.jl
@@ -94,8 +94,8 @@ function Solver(;kwargs...)
     PS_DYNAMIC_AMR = haskey(kwargs,:PS_DYNAMIC_AMR) ? kwargs[:PS_DYNAMIC_AMR] : true
     VS_DYNAMIC_AMR = haskey(kwargs,:VS_DYNAMIC_AMR) ? kwargs[:VS_DYNAMIC_AMR] : true
     ADAPT_COEFFI_PS = haskey(kwargs,:ADAPT_COEFFI_PS) ? kwargs[:ADAPT_COEFFI_PS] : 0.25
-    ADAPT_COEFFI_VS_GLOBAL = haskey(config,:ADAPT_COEFFI_VS_GLOBAL) ? config[:ADAPT_COEFFI_VS_GLOBAL] : 0.125
-    ADAPT_COEFFI_VS_LOCAL = haskey(config,:ADAPT_COEFFI_VS_LOCAL) ? config[:ADAPT_COEFFI_VS_LOCAL] : 1e-2
+    ADAPT_COEFFI_VS_GLOBAL = haskey(kwargs,:ADAPT_COEFFI_VS_GLOBAL) ? kwargs[:ADAPT_COEFFI_VS_GLOBAL] : 0.125
+    ADAPT_COEFFI_VS_LOCAL = haskey(kwargs,:ADAPT_COEFFI_VS_LOCAL) ? kwargs[:ADAPT_COEFFI_VS_LOCAL] : 1e-2
     TOLERANCE = haskey(kwargs,:TOLERANCE) ? kwargs[:TOLERANCE] : 1e-6
     ST_CHECK_INTERVAL = haskey(kwargs,:ST_CHECK_INTERVAL) ? kwargs[:ST_CHECK_INTERVAL] : 100
     REDUNDANT_STEPS_NUM = haskey(kwargs,:REDUNDANT_STEPS_NUM) ? kwargs[:REDUNDANT_STEPS_NUM] : 100
@@ -123,9 +123,9 @@ $(TYPEDFIELDS)
 
 """
 mutable struct UDF
-    "The static AMR flag in physical space."
+    "The static AMR flag in physical space. (midpoint::Vector{Float64},ds::Vector{Float64},global_data::[`Global_Data`](@ref),level::Int)->Bool"
     static_ps_refine_flag::Function
-    "The dynamic AMR flag in physical space."
+    "The dynamic AMR flag in physical space. (ps_data::[`AbstractPsData`](@ref),level::Int,amr::[`KitAMR_Data`](@ref))->Bool"
     dynamic_ps_refine_flag::Function
     "The static AMR flag in velocity space."
     static_vs_refine_flag::Function 
@@ -314,8 +314,6 @@ $(TYPEDEF)
 $(TYPEDFIELDS)
 """
 mutable struct Residual
-    "Current step number."
-    step::Int
     "Residual of primary variables, is updated by [`residual_check!`](@ref)."
     residual::Vector{Float64}
     "Summation of residuals."
@@ -326,7 +324,7 @@ mutable struct Residual
     redundant_step::Int
 end
 function Residual(DIM::Int)
-    return Residual(1,ones(DIM+2),zeros(DIM+2),zeros(DIM+2),0)
+    return Residual(ones(DIM+2),zeros(DIM+2),zeros(DIM+2),0)
 end
 
 """
@@ -353,6 +351,8 @@ mutable struct Status
     Δt_ξ::Float64
     "Dimensionless simulation time."
     sim_time::Float64
+    "Number of steps that have been marched."
+    step::Int
     "Number of steps after last AMR in physical space."
     ps_adapt_step::Int
     "Number of steps after last AMR in velocity space."
@@ -375,7 +375,7 @@ function Status(config::Dict)
         (quadrature[2*i] - quadrature[2*i-1]) / vs_trees_num[i]/
         2^config[:AMR_VS_MAXLEVEL] / 2 for i in 1:DIM] : [maximum(abs.(quadrature.vcoords)) for _ in 1:DIM]
     Δt_ξ = config[:CFL]*minimum(ds ./ U)
-    return Status(0,zeros(DIM+2),zeros(DIM+2), zeros(DIM+2), Δt_ξ,Δt_ξ,0.,1,1,1,Residual(DIM),Ref(false))
+    return Status(0,zeros(DIM+2),zeros(DIM+2), zeros(DIM+2), Δt_ξ,Δt_ξ,0.,0,1,1,1,Residual(DIM),Ref(false))
 end
 function Status(config::Configure{DIM,NDF}) where{DIM,NDF}
     trees_num = config.trees_num
@@ -387,7 +387,7 @@ function Status(config::Configure{DIM,NDF}) where{DIM,NDF}
         (quadrature[2*i] - quadrature[2*i-1]) / vs_trees_num[i]/
         2^config.solver.AMR_VS_MAXLEVEL / 2 for i in 1:DIM] : [maximum(abs.(quadrature.vcoords)) for _ in 1:DIM]
     Δt_ξ = config.solver.CFL*minimum(ds ./ U)
-    return Status(0,zeros(DIM+2),zeros(DIM+2), zeros(DIM+2), Δt_ξ,Δt_ξ,0.,1,1,1,Residual(DIM),Ref(false))
+    return Status(0,zeros(DIM+2),zeros(DIM+2), zeros(DIM+2), Δt_ξ,Δt_ξ,0.,0,1,1,1,Residual(DIM),Ref(false))
 end
 
 """
diff --git a/src/Theory/Iterate.jl b/src/Theory/Iterate.jl
@@ -6,10 +6,10 @@ function iterate!(amr::KitAMR_Data)
     time_marching = amr.global_data.config.solver.time_marching
     iterate!(time_marching,amr)
     residual_comm!(amr.global_data)
+    amr.global_data.status.step += 1
     amr.global_data.status.ps_adapt_step += 1
     amr.global_data.status.vs_adapt_step += 1
     amr.global_data.status.partition_step += 1
-    amr.global_data.status.residual.step += 1
     amr.global_data.status.sim_time+=amr.global_data.status.Δt
     return nothing
 end
