Merge pull request #257 from CliMA/ck/optional_comms_context

Allow commscontext input, def compute_T_exp_T_lim

Author: charleskawczynski

src/ClimaTimeSteppers.jl

@@ -118,6 +118,7 @@ const SPCO = SparseCoeffs
 
 include("solvers/imex_tableaus.jl")
 include("solvers/explicit_tableaus.jl")
+include("solvers/compute_T_exp_T_lim.jl")
 include("solvers/imex_ark.jl")
 include("solvers/imex_ssprk.jl")
 include("solvers/multirate.jl")

src/functions.jl

@@ -4,14 +4,15 @@ export ClimaODEFunction, ForwardEulerODEFunction
 
 abstract type AbstractClimaODEFunction <: DiffEqBase.AbstractODEFunction{true} end
 
-Base.@kwdef struct ClimaODEFunction{TL, TE, TI, L, D, PE, PI} <: AbstractClimaODEFunction
+Base.@kwdef struct ClimaODEFunction{TL, TE, TI, L, D, PE, PI, CC} <: AbstractClimaODEFunction
     T_lim!::TL = nothing # nothing or (uₜ, u, p, t) -> ...
     T_exp!::TE = nothing # nothing or (uₜ, u, p, t) -> ...
     T_imp!::TI = nothing # nothing or (uₜ, u, p, t) -> ...
     lim!::L = (u, p, t, u_ref) -> nothing
     dss!::D = (u, p, t) -> nothing
     post_explicit!::PE = (u, p, t) -> nothing
     post_implicit!::PI = (u, p, t) -> nothing
+    comms_context::CC = nothing
 end
 
 # Don't wrap a AbstractClimaODEFunction in an ODEFunction (makes ODEProblem work).

src/solvers/compute_T_exp_T_lim.jl

@@ -0,0 +1,13 @@
+@inline function compute_T_lim_T_exp!(
+    T_lim,
+    T_exp,
+    U,
+    p,
+    t,
+    T_lim!,
+    T_exp!,
+    ::Union{Nothing, ClimaComms.AbstractCommsContext},
+)
+    T_lim!(T_lim, U, p, t)
+    T_exp!(T_exp, U, p, t)
+end

src/solvers/imex_ark.jl

@@ -169,8 +169,13 @@ end
     end
 
     if !all(iszero, a_exp[:, i]) || !iszero(b_exp[i])
-        isnothing(T_lim!) || T_lim!(T_lim[i], U, p, t_exp)
-        isnothing(T_exp!) || T_exp!(T_exp[i], U, p, t_exp)
+        if !isnothing(T_lim!) && !isnothing(T_exp!)
+            (; comms_context) = f
+            compute_T_lim_T_exp!(T_lim[i], T_exp[i], U, p, t_exp, T_lim!, T_exp!, comms_context)
+        else
+            isnothing(T_lim!) || T_lim!(T_lim[i], U, p, t_exp)
+            isnothing(T_exp!) || T_exp!(T_exp[i], U, p, t_exp)
+        end
     end
 
     return nothing

src/solvers/imex_ssprk.jl

@@ -153,11 +153,12 @@ function step_u!(integrator, cache::IMEXSSPRKCache)
         end
 
         if !iszero(β[i])
-            if !isnothing(T_lim!)
-                T_lim!(T_lim, U, p, t_exp)
-            end
-            if !isnothing(T_exp!)
-                T_exp!(T_exp, U, p, t_exp)
+            if !isnothing(T_lim!) && !isnothing(T_exp!)
+                (; comms_context) = f
+                compute_T_lim_T_exp!(T_lim[i], T_exp[i], U, p, t_exp, T_lim!, T_exp!, comms_context)
+            else
+                isnothing(T_lim!) || T_lim!(T_lim, U, p, t_exp)
+                isnothing(T_exp!) || T_exp!(T_exp, U, p, t_exp)
             end
         end
     end