standardize on _func_cache

Author: ChrisRackauckas

src/problems/ode_problems.jl

@@ -473,10 +473,10 @@ function SplitODEProblem(f::SplitFunction, u0, tspan, p = NullParameters(); kwar
 end
 function SplitODEProblem{iip}(f::SplitFunction, u0, tspan, p = NullParameters();
         kwargs...) where {iip}
-    if f.cache === nothing && iip
-        cache = similar(u0)
+    if f._func_cache === nothing && iip
+        _func_cache = similar(u0)
         f = SplitFunction{iip}(f.f1, f.f2; mass_matrix = f.mass_matrix,
-            _func_cache = cache, analytic = f.analytic)
+            _func_cache = _func_cache, analytic = f.analytic)
     end
     ODEProblem(f, u0, tspan, p, SplitODEProblem{iip}(); kwargs...)
 end

src/problems/sde_problems.jl

@@ -166,11 +166,11 @@ function SplitSDEProblem(f::SplitSDEFunction, u0, tspan, p = NullParameters(); k
 end
 
 function SplitSDEProblem{iip}(f::SplitSDEFunction, u0, tspan, p = NullParameters();
-        func_cache = nothing, kwargs...) where {iip}
-    if f.cache === nothing && iip
-        cache = similar(u0)
+        _func_cache = nothing, kwargs...) where {iip}
+    if f._func_cache === nothing && iip
+        _func_cache = similar(u0)
         _f = SplitSDEFunction{iip}(f.f1, f.f2, f.g; mass_matrix = f.mass_matrix,
-            _func_cache = cache, analytic = f.analytic)
+            _func_cache = _func_cache, analytic = f.analytic)
     else
         _f = f
     end
@@ -205,11 +205,11 @@ end
 
 function DynamicalSDEProblem{iip}(f::DynamicalSDEFunction, v0, u0, tspan,
         p = NullParameters();
-        func_cache = nothing, kwargs...) where {iip}
-    if f.cache === nothing && iip
-        cache = similar(u0)
+        _func_cache = nothing, kwargs...) where {iip}
+    if f._func_cache === nothing && iip
+        _func_cache = similar(u0)
         _f = DynamicalSDEFunction{iip}(f.f1, f.f2, f.g; mass_matrix = f.mass_matrix,
-            _func_cache = cache, analytic = f.analytic)
+            _func_cache = _func_cache, analytic = f.analytic)
     else
         _f = f
     end

src/remake.jl

@@ -167,9 +167,9 @@ function remake(
     args = (f,)
     if is_split_function(T)
         # for DynamicalSDEFunction and SplitFunction
-        if isdefined(props, :cache)
-            props = @insert props._func_cache = props.cache
-            props = @delete props.cache
+        if isdefined(props, :_func_cache)
+            props = @insert props._func_cache = props._func_cache
+            props = @delete props._func_cache
         end
 
         # `f1` and `f2` are wrapped in another SciMLFunction, unless they're

src/scimlfunctions.jl

@@ -536,7 +536,7 @@ struct SplitFunction{
     f1::F1
     f2::F2
     mass_matrix::TMM
-    cache::C
+    _func_cache::C
     analytic::Ta
     tgrad::Tt
     jac::TJ
@@ -1178,7 +1178,7 @@ struct SplitSDEFunction{iip, specialize, F1, F2, G, TMM, C, Ta, Tt, TJ, JVP, VJP
     f2::F2
     g::G
     mass_matrix::TMM
-    cache::C
+    _func_cache::C
     analytic::Ta
     tgrad::Tt
     jac::TJ
@@ -1291,7 +1291,7 @@ struct DynamicalSDEFunction{iip, specialize, F1, F2, G, TMM, C, Ta, Tt, TJ, JVP,
     f2::F2
     g::G
     mass_matrix::TMM
-    cache::C
+    _func_cache::C
     analytic::Ta
     tgrad::Tt
     jac::TJ
@@ -2482,9 +2482,9 @@ end
 
 (f::SplitFunction)(u, p, t) = f.f1(u, p, t) + f.f2(u, p, t)
 function (f::SplitFunction)(du, u, p, t)
-    f.f1(f.cache, u, p, t)
+    f.f1(f._func_cache, u, p, t)
     f.f2(du, u, p, t)
-    du .+= f.cache
+    du .+= f._func_cache
 end
 
 (f::DiscreteFunction)(args...) = f.f(args...)
@@ -2512,9 +2512,9 @@ end
 (f::SplitSDEFunction)(u, p, t) = f.f1(u, p, t) + f.f2(u, p, t)
 
 function (f::SplitSDEFunction)(du, u, p, t)
-    f.f1(f.cache, u, p, t)
+    f.f1(f._func_cache, u, p, t)
     f.f2(du, u, p, t)
-    du .+= f.cache
+    du .+= f._func_cache
 end
 
 (f::RODEFunction)(args...) = f.f(args...)
@@ -2808,7 +2808,7 @@ function unwrapped_f(f::NonlinearFunction, newf = unwrapped_f(f.f))
     end
 end
 
-@add_kwonly function SplitFunction(f1, f2, mass_matrix, cache, analytic, tgrad, jac, jvp,
+@add_kwonly function SplitFunction(f1, f2, mass_matrix, _func_cache, analytic, tgrad, jac, jvp,
         vjp, jac_prototype, W_prototype, sparsity, Wfact, Wfact_t, paramjac,
         observed, colorvec, sys, initializeprob = nothing, update_initializeprob! = nothing,
         initializeprobmap = nothing, initializeprobpmap = nothing, initialization_data = nothing, nlprob_data = nothing)
@@ -2826,19 +2826,19 @@ end
 
     SplitFunction{isinplace(f2), FullSpecialize, typeof(f1), typeof(f2),
         typeof(mass_matrix),
-        typeof(cache), typeof(analytic), typeof(tgrad), typeof(jac), typeof(jvp),
+        typeof(_func_cache), typeof(analytic), typeof(tgrad), typeof(jac), typeof(jvp),
         typeof(vjp), typeof(jac_prototype), typeof(W_prototype), typeof(sparsity),
         typeof(Wfact), typeof(Wfact_t), typeof(paramjac), typeof(observed), typeof(colorvec),
         typeof(sys), typeof(initdata), typeof(nlprob_data)}(
         f1, f2, mass_matrix,
-        cache, analytic, tgrad, jac, jvp, vjp,
+        _func_cache, analytic, tgrad, jac, jvp, vjp,
         jac_prototype, W_prototype, sparsity, Wfact, Wfact_t, paramjac, observed, colorvec, sys,
         initdata, nlprob_data)
 end
 function SplitFunction{iip, specialize}(f1, f2;
         mass_matrix = __has_mass_matrix(f1) ?
                       f1.mass_matrix : I,
-        cache = nothing,
+        _func_cache = nothing,
         analytic = __has_analytic(f1) ? f1.analytic :
                    nothing,
         tgrad = __has_tgrad(f1) ? f1.tgrad : nothing,
@@ -2885,20 +2885,20 @@ function SplitFunction{iip, specialize}(f1, f2;
         SplitFunction{iip, specialize, Any, Any, Any, Any, Any, Any, Any, Any, Any,
             Any, Any, Any, Any, Any, Any, Any,
             Any, Any, Union{Nothing, OverrideInitData}, Union{Nothing, ODE_NLProbData}}(
-            f1, f2, mass_matrix, cache,
+            f1, f2, mass_matrix, _func_cache,
             analytic,
             tgrad, jac, jvp, vjp, jac_prototype, W_prototype,
             sparsity, Wfact, Wfact_t, paramjac,
             observed, colorvec, sys, initdata, nlprob_data)
     else
         SplitFunction{iip, specialize, typeof(f1), typeof(f2), typeof(mass_matrix),
-            typeof(cache), typeof(analytic),
+            typeof(_func_cache), typeof(analytic),
             typeof(tgrad), typeof(jac), typeof(jvp), typeof(vjp),
             typeof(jac_prototype), typeof(W_prototype), typeof(sparsity),
             typeof(Wfact), typeof(Wfact_t), typeof(paramjac), typeof(observed),
             typeof(colorvec),
             typeof(sys), typeof(initdata), typeof(nlprob_data)}(f1, f2,
-            mass_matrix, cache, analytic, tgrad, jac,
+            mass_matrix, _func_cache, analytic, tgrad, jac,
             jvp, vjp, jac_prototype, W_prototype,
             sparsity, Wfact, Wfact_t, paramjac, observed, colorvec, sys,
             initdata, nlprob_data)
@@ -3259,20 +3259,20 @@ function SDEFunction(f, g; kwargs...)
 end
 SDEFunction(f::SDEFunction; kwargs...) = f
 
-@add_kwonly function SplitSDEFunction(f1, f2, g, mass_matrix, cache, analytic, tgrad, jac,
+@add_kwonly function SplitSDEFunction(f1, f2, g, mass_matrix, _func_cache, analytic, tgrad, jac,
         jvp, vjp,
         jac_prototype, Wfact, Wfact_t, paramjac, observed,
         colorvec, sys, initialization_data = nothing)
     f1 = f1 isa AbstractSciMLOperator ? f1 : SDEFunction(f1)
     f2 = SDEFunction(f2)
 
     SplitFunction{isinplace(f2), typeof(f1), typeof(f2), typeof(g), typeof(mass_matrix),
-        typeof(cache), typeof(analytic), typeof(tgrad), typeof(jac), typeof(jvp),
+        typeof(_func_cache), typeof(analytic), typeof(tgrad), typeof(jac), typeof(jvp),
         typeof(vjp),
         typeof(Wfact), typeof(Wfact_t), typeof(paramjac), typeof(observed),
         typeof(colorvec),
         typeof(sys), typeof(initialization_data)}(
-        f1, f2, mass_matrix, cache, analytic, tgrad, jac,
+        f1, f2, mass_matrix, _func_cache, analytic, tgrad, jac,
         jac_prototype, Wfact, Wfact_t, paramjac, observed, colorvec, sys, initialization_data)
 end
 
@@ -3344,7 +3344,7 @@ function SplitSDEFunction{iip}(f1, f2, g; kwargs...) where {iip}
 end
 SplitSDEFunction(f::SplitSDEFunction; kwargs...) = f
 
-@add_kwonly function DynamicalSDEFunction(f1, f2, g, mass_matrix, cache, analytic, tgrad,
+@add_kwonly function DynamicalSDEFunction(f1, f2, g, mass_matrix, _func_cache, analytic, tgrad,
         jac, jvp, vjp,
         jac_prototype, Wfact, Wfact_t, paramjac,
         observed, colorvec,
@@ -3354,12 +3354,12 @@ SplitSDEFunction(f::SplitSDEFunction; kwargs...) = f
 
     DynamicalSDEFunction{isinplace(f2), FullSpecialize, typeof(f1), typeof(f2), typeof(g),
         typeof(mass_matrix),
-        typeof(cache), typeof(analytic), typeof(tgrad), typeof(jac),
+        typeof(_func_cache), typeof(analytic), typeof(tgrad), typeof(jac),
         typeof(jvp), typeof(vjp),
         typeof(Wfact), typeof(Wfact_t), typeof(paramjac), typeof(observed),
         typeof(colorvec),
         typeof(sys), typeof(initialization_data)}(
-        f1, f2, g, mass_matrix, cache, analytic, tgrad,
+        f1, f2, g, mass_matrix, _func_cache, analytic, tgrad,
         jac, jac_prototype, Wfact, Wfact_t, paramjac, observed, colorvec, sys,
         initialization_data)
 end