proposing fix by changing variable names (#274)

Co-authored-by: Luke Morris <[email protected]>

src/simulation.jl

@@ -314,8 +314,8 @@ function get_vars_code(d::SummationDecapode, vars::Vector{Symbol}, ::Type{statee
     # TODO: we should fix that upstream so that we don't need this.
     line = @match s_type begin
       :Literal => :($s = $(parse(stateeltype, String(s))))
-      :Constant => :($s = p.$s)
-      :Parameter => :($s = (p.$s)(t))
+      :Constant => :($s = __p__.$s)
+      :Parameter => :($s = (__p__.$s)(__t__))
       _ => hook_GVC_get_form(s, s_type, code_target) # ! WARNING: This assumes a form
       # _ => throw(InvalidDecaTypeException(s, s_type)) # TODO: Use this for invalid types
     end
@@ -326,7 +326,7 @@ end
 
 # TODO: Expand on this to be able to handle vector and ComponentArrays inputs
 function hook_GVC_get_form(var_name::Symbol, var_type::Symbol, ::Union{CPUBackend, CUDABackend})
-  return :($var_name = u.$var_name)
+  return :($var_name = __u__.$var_name)
 end
 
 """
@@ -354,7 +354,7 @@ is the name of the variable whose data will be stored and a code target.
 """
 function hook_STC_settvar(state_name::Symbol, tgt_name::Symbol, ::Union{CPUBackend, CUDABackend})
   ssymb = QuoteNode(state_name)
-  return :(setproperty!(du, $ssymb, $tgt_name))
+  return :(setproperty!(__du__, $ssymb, $tgt_name))
 end
 
 const PROMOTE_ARITHMETIC_MAP = Dict(:(+) => :.+,
@@ -546,7 +546,7 @@ This hook is passed in `cache_exprs` which is the collection of exprs to be past
 `AllocVecCall` that stores information about the allocated vector and a code target.
 """
 function hook_PPVA_data_handle!(cache_exprs::Vector{Expr}, alloc_vec::AllocVecCall, ::CPUBackend)
-  line = :($(alloc_vec.name) = (Decapodes.get_tmp($(Symbol(:__,alloc_vec.name)), u)))
+  line = :($(alloc_vec.name) = (Decapodes.get_tmp($(Symbol(:__,alloc_vec.name)), __u__)))
   push!(cache_exprs, line)
 end
 
@@ -759,7 +759,7 @@ function gensim(user_d::SummationDecapode, input_vars::Vector{Symbol}; dimension
       $func_defs
       $cont_defs
       $vect_defs
-      f(du, u, p, t) = begin
+      f(__du__, __u__, __p__, __t__) = begin
         $vars
         $data
         $(equations...)

test/simulation.jl

@@ -102,11 +102,11 @@ DiffusionWithLiteral = @decapode begin
 end
 
 # Verify the variable accessors.
-@test Decapodes.get_vars_code(DiffusionWithConstant, [:k], Float64, CPUTarget()).args[2] == :(k = p.k)
+@test Decapodes.get_vars_code(DiffusionWithConstant, [:k], Float64, CPUTarget()).args[2] == :(k = __p__.k)
 @test infer_state_names(DiffusionWithConstant) == [:C, :k]
 
 @test infer_state_names(DiffusionWithParameter) == [:C, :k]
-@test Decapodes.get_vars_code(DiffusionWithParameter, [:k], Float64, CPUTarget()).args[2] == :(k = p.k(t))
+@test Decapodes.get_vars_code(DiffusionWithParameter, [:k], Float64, CPUTarget()).args[2] == :(k = __p__.k(__t__))
 
 @test infer_state_names(DiffusionWithLiteral) == [:C]
 # TODO: Fix proper Expr equality, the Float64 does not equate here
@@ -682,6 +682,19 @@ end
     return op
   end
 
+  # tests that there is no variable shadowing for du, u, p, and t
+  NoShadow = @decapode begin
+      u::Form0
+      du::Form1
+      v::Form0
+      p::Constant
+      q::Constant
+      t::Constant
+  end
+  symsim = gensim(NoShadow)
+  sim_NS = eval(symsim)
+  @test sim_NS(d_rect, generate, DiagonalHodge()) isa Any
+
   HeatTransfer = @decapode begin
     (HT, Tₛ)::Form0
     (D, cosϕᵖ, cosϕᵈ)::Constant
@@ -753,13 +766,12 @@ for prealloc in [false, true]
     D::Constant
     ∂ₜ(C) == D*Δ(C)
   end
-  sim = eval(gensim(Heat,  preallocate=prealloc))
+  sim = eval(gensim(Heat, preallocate=prealloc))
   s = loadmesh(Icosphere(1))
   sd = EmbeddedDeltaDualComplex2D{Bool,Float64,Point3D}(s)
   subdivide_duals!(sd, Circumcenter())
   f = sim(sd,nothing)
-  u₀ = ComponentArray(
-    C = map(x -> x[3], point(sd)))
+  u₀ = ComponentArray(C = map(x -> x[3], point(sd)))
   p = (D=1e-1,)
   du = copy(u₀)
   # The first call to the function makes many allocations.
@@ -769,12 +781,10 @@ for prealloc in [false, true]
   nallocs = @allocations f(du, u₀, p, (0,1.0))
   bytes = @allocated f(du, u₀, p, (0,1.0))
 
-  if prealloc
-    @test nallocs == 3
-    @test bytes == 80
-  elseif !prealloc
-    @test nallocs == 5
-    @test bytes == 400
+  if VERSION < v"1.11"
+    @test (nallocs, bytes) == (prealloc ? (3, 80) : (5, 400))
+  else
+    @test (nallocs, bytes) == (prealloc ? (2, 32) : (6, 352))
   end
 end
 

test/simulation_core.jl

@@ -249,14 +249,14 @@ import Decapodes: get_vars_code, AmbiguousNameException
   let d = @decapode begin end
     inputs = [:C]
     add_parts!(d, :Var, 1, name=inputs, type=[:Constant])
-    @test get_vars_code(d, inputs, Float64, CPUTarget()).args[begin+1] == :(C = p.C)
+    @test get_vars_code(d, inputs, Float64, CPUTarget()).args[begin+1] == :(C = __p__.C)
   end
 
   # Test that parameters parse correctly
   let d = @decapode begin end
     inputs = [:P]
     add_parts!(d, :Var, 1, name=inputs, type=[:Parameter])
-    @test get_vars_code(d, inputs, Float64, CPUTarget()).args[begin+1] == :(P = p.P(t))
+    @test get_vars_code(d, inputs, Float64, CPUTarget()).args[begin+1] == :(P = __p__.P(__t__))
   end
 
   # TODO: Remove when Literals are not parsed as symbols anymore
@@ -272,7 +272,7 @@ import Decapodes: get_vars_code, AmbiguousNameException
     let d = @decapode begin end
       inputs = [:F]
       add_parts!(d, :Var, 1, name=inputs, type=[form])
-      @test get_vars_code(d, inputs, Float64, CPUTarget()).args[begin+1] == :(F = u.F)
+      @test get_vars_code(d, inputs, Float64, CPUTarget()).args[begin+1] == :(F = __u__.F)
     end
   end