Remove generic fallback, add abstract type methods

Author: charleskawczynski

docs/src/algorithms.md

@@ -7,8 +7,6 @@ CurrentModule = ClimaTimeSteppers
 ## Interface and OrdinaryDiffEq compatibility
 
 ```@docs
-allocate_cache
-run!
 ForwardEulerODEFunction
 ```
 

src/ClimaTimeSteppers.jl

@@ -56,13 +56,13 @@ array_device(::CuArray) = CUDADevice()
 realview(x::Union{Array, SArray, MArray}) = x
 realview(x::CuArray) = x
 
+export allocate_cache, run!
 
 import DiffEqBase, SciMLBase, LinearAlgebra, DiffEqCallbacks, Krylov
 
 include("sparse_containers.jl")
 include("functions.jl")
 include("operators.jl")
-include("algorithms.jl")
 
 abstract type DistributedODEAlgorithm <: DiffEqBase.AbstractODEAlgorithm end
 

src/algorithms.jl

@@ -9,6 +9,19 @@ operation is performed.
 """
 abstract type UpdateSignal end
 
+"""
+    UpdateSignalHandler
+
+Updates a value upon receiving an appropriate `UpdateSignal`. This is done by
+calling `run!(::UpdateSignalHandler, cache, ::UpdateSignal, f!, args...)`, where
+`f!` is function such that `f!(args...)` modifies the desired value in-place.
+The `cache` can be obtained with `allocate_cache(::UpdateSignalHandler, FT)`,
+where `FT` is the floating-point type of the integrator.
+"""
+abstract type UpdateSignalHandler end
+
+run!(::UpdateSignalHandler, cache, ::UpdateSignal, f!, args...) = nothing
+
 """
     NewTimeStep(t)
 
@@ -33,17 +46,6 @@ The signal for a new iteration of Newton's method.
 """
 struct NewNewtonIteration <: UpdateSignal end
 
-"""
-    UpdateSignalHandler
-
-Updates a value upon receiving an appropriate `UpdateSignal`. This is done by
-calling `run!(::UpdateSignalHandler, cache, ::UpdateSignal, f!, args...)`, where
-`f!` is function such that `f!(args...)` modifies the desired value in-place.
-The `cache` can be obtained with `allocate_cache(::UpdateSignalHandler, FT)`,
-where `FT` is the floating-point type of the integrator.
-"""
-abstract type UpdateSignalHandler end
-
 """
     UpdateEvery(update_signal_type)
 
@@ -53,7 +55,9 @@ An `UpdateSignalHandler` that performs the update whenever it is `run!` with an
 struct UpdateEvery{U <: UpdateSignal} <: UpdateSignalHandler end
 UpdateEvery(::Type{U}) where {U} = UpdateEvery{U}()
 
-run!(alg::UpdateEvery{U}, cache, ::U, f!, args...) where {U} = f!(args...)
+allocate_cache(::UpdateEvery, _) = nothing
+
+run!(alg::UpdateEvery{U}, cache, ::U, f!, args...) where {U <: UpdateSignal} = f!(args...)
 
 """
     UpdateEveryN(n, update_signal_type, reset_signal_type = Nothing)

src/solvers/update_signal_handler.jl

@@ -14,7 +14,7 @@ import ClimaTimeSteppers as CTS
     last_iters1 = (11, 9, 10, 12)
     last_iters2 = (12, 10, 10, 13)
     function test_func(checker, last_iter1, last_iter2)
-        cache = allocate_cache(checker, val_func(0))
+        cache = CTS.allocate_cache(checker, val_func(0))
         for (err_func, last_iter) in ((err_func1, last_iter1), (err_func2, last_iter2))
             for iter in 0:(last_iter - 1)
                 CTS.check_convergence!(checker, cache, val_func(iter), err_func(iter), iter) && return false

test/test_convergence_checker.jl

@@ -60,7 +60,7 @@ end
         for (alg, use_j) in ((alg1, true), (alg2, true), (alg3, false))
             x = copy(x_init)
             j_prototype = similar(x, length(x), length(x))
-            cache = allocate_cache(alg, x, use_j ? j_prototype : nothing)
+            cache = CTS.allocate_cache(alg, x, use_j ? j_prototype : nothing)
             CTS.solve_newton!(alg, cache, x, f!, use_j ? j! : nothing)
             @test norm(x .- x_exact) / norm(x_exact) < rtol
         end