Merge CliMA#1864

1864: Move precompute method to balance law r=charleskawczynski a=charleskawczynski ### Description This should have been incorporated in CliMA#1850, we want `precompute` to be a `BalanceLaw` method, so that we can inherit/modularize its use across different models. Co-authored-by: Charles Kawczynski <[email protected]>
jm-c · Dec 15, 2020 · 6979716 · 6979716
2 parents 19da615 + 4e17b10
commit 6979716
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 1 deletion.
diff --git a/docs/src/APIs/BalanceLaws/BalanceLaws.md b/docs/src/APIs/BalanceLaws/BalanceLaws.md
@@ -19,6 +19,7 @@ AbstractTendencyType
 TendencyDef
 eq_tends
 prognostic_vars
+precompute
 fluxes
 sources
 show_tendencies

diff --git a/src/Atmos/Model/AtmosModel.jl b/src/Atmos/Model/AtmosModel.jl
@@ -52,6 +52,7 @@ import ..BalanceLaws:
     source!,
     eq_tends,
     flux,
+    precompute,
     source,
     wavespeed,
     boundary_conditions,

diff --git a/src/BalanceLaws/BalanceLaws.jl b/src/BalanceLaws/BalanceLaws.jl
@@ -5,6 +5,7 @@ using ..VariableTemplates
 export BalanceLaw,
     vars_state,
     number_states,
+    precompute,
     init_state_prognostic!,
     init_state_auxiliary!,
     compute_gradient_flux!,

diff --git a/src/BalanceLaws/tendency_types.jl b/src/BalanceLaws/tendency_types.jl
@@ -17,7 +17,7 @@
 
 export PrognosticVariable
 export FirstOrder, SecondOrder
-export Flux, Source
+export AbstractTendencyType, Flux, Source
 export TendencyDef
 
 """
@@ -121,3 +121,14 @@ function fluxes(bl::BalanceLaw, order::O) where {O <: AbstractOrder}
     tend = filter(x -> x ≠ nothing, tend)
     return Tuple(Iterators.flatten(tend))
 end
+
+"""
+    precompute(bl, args, ::AbstractTendencyType)
+
+A nested NamedTuple of precomputed (cached) values
+and or objects. This is useful for "expensive"
+point-wise quantities that are used in multiple
+tendency terms. For example, computing a quantity
+that requires iteration.
+"""
+precompute(bl, args, ::AbstractTendencyType) = NamedTuple()