Replace RecursiveApply functions with AutoBroadcaster wrappers

Author: dennisYatunin

.buildkite/pipeline.yml

@@ -48,16 +48,13 @@ steps:
         agents:
           slurm_gpus: 1
 
-  - group: "Unit: RecursiveApply"
-    steps:
-
-      - label: "Unit: RecursiveApply"
-        key: unit_recursive_apply
-        command: "julia --color=yes --check-bounds=yes --project=.buildkite test/RecursiveApply/unit_recursive_apply.jl"
-
   - group: "Unit: Utilities"
     steps:
 
+      - label: "Unit: AutoBroadcaster"
+        key: unit_auto_broadcaster
+        command: "julia --color=yes --check-bounds=yes --project=.buildkite test/Utilities/unit_auto_broadcaster.jl"
+
       - label: "Unit: plushalf"
         key: unit_plushalf
         command: "julia --color=yes --check-bounds=yes --project=.buildkite test/Utilities/unit_plushalf.jl"
@@ -194,9 +191,9 @@ steps:
         key: unit_axistensors
         command: "julia --color=yes --check-bounds=yes --project=.buildkite test/Geometry/axistensors.jl"
 
-      - label: "Unit: rmul_with_projection"
-        key: unit_rmul_with_projection
-        command: "julia --color=yes --check-bounds=yes --project=.buildkite test/Geometry/rmul_with_projection.jl"
+      - label: "Unit: mul_with_projection"
+        key: unit_mul_with_projection
+        command: "julia --color=yes --check-bounds=yes --project=.buildkite test/Geometry/mul_with_projection.jl"
 
   - group: "Unit: Meshes"
     steps:

benchmarks/3d/se_kernels.jl

@@ -13,9 +13,7 @@ import ClimaCore:
     Spaces,
     Quadratures,
     Topologies,
-    DataLayouts,
-    RecursiveApply
-
+    DataLayouts
 const C1 = ClimaCore.Geometry.Covariant1Vector
 const C2 = ClimaCore.Geometry.Covariant2Vector
 const C3 = ClimaCore.Geometry.Covariant3Vector
@@ -25,8 +23,6 @@ const CT123 = Geometry.Contravariant123Vector
 const ᶜinterp = Operators.InterpolateF2C()
 const ᶠinterp = Operators.InterpolateC2F()
 
-const ⊞ = RecursiveApply.radd
-
 init_uθ(ϕ, z, R) = 1.0 / R
 init_vθ(ϕ, z, R) = 1.0 / R
 init_w(ϕ, z) = 1.0

benchmarks/bickleyjet/bickleyjet_dg.jl

@@ -7,9 +7,6 @@ import ClimaCore.Operators
 using ClimaCore.Geometry
 import ClimaCore.Geometry: Abstract2DPoint
 
-using ClimaCore.RecursiveApply
-
-
 const parameters = (
     ϵ = 0.1,  # perturbation size for initial condition
     l = 0.5, # Gaussian width
@@ -60,7 +57,7 @@ roe_average(ρ⁻, ρ⁺, var⁻, var⁺) =
     (sqrt(ρ⁻) * var⁻ + sqrt(ρ⁺) * var⁺) / (sqrt(ρ⁻) + sqrt(ρ⁺))
 
 function roeflux(n, (y⁻, parameters⁻), (y⁺, parameters⁺))
-    Favg = RecursiveApply.rdiv(flux(y⁻, parameters⁻) ⊞ flux(y⁺, parameters⁺), 2)
+    Favg = (flux(y⁻, parameters⁻) + flux(y⁺, parameters⁺)) / 2
 
     λ = sqrt(parameters⁻.g)
 
@@ -115,7 +112,7 @@ function roeflux(n, (y⁻, parameters⁻), (y⁺, parameters⁺))
     fluxᵀn_ρθ = ((w1 + w2) * θ + w5) * 0.5
 
     Δf = (ρ = -fluxᵀn_ρ, ρu = -fluxᵀn_ρu, ρθ = -fluxᵀn_ρθ)
-    RecursiveApply.rmap(f -> f' * n, Favg) ⊞ Δf
+    return Favg' * n + Δf
 end
 
 function volume!(dydt, y, (parameters,), t)

benchmarks/bickleyjet/core_vs_ref.jl

@@ -30,8 +30,7 @@ for Nq in Nqs
     volume!(dydt, y0, (parameters,), 0.0)
     # TODO: move this to volume!
     dydt_data = Fields.field_values(dydt)
-    dydt_data .=
-        RecursiveApply.rdiv.(dydt_data, Spaces.local_geometry_data(space).WJ)
+    dydt_data ./= Spaces.local_geometry_data(space).WJ
 
     # setup reference
     X = coordinates(Val(Nq), n1, n2)
@@ -84,8 +83,7 @@ for Nq in Nqs
     add_face!(dydt, y0, (parameters,), 0.0)
     # TODO: move this to volume!
     dydt_data = Fields.field_values(dydt)
-    dydt_data .=
-        RecursiveApply.rdiv.(dydt_data, Spaces.local_geometry_data(space).WJ)
+    dydt_data ./= Spaces.local_geometry_data(space).WJ
 
     fill!(dydt_ref, 0.0)
     add_face_ref!(dydt_ref, y0_ref, (n1, n2, parameters, Val(Nq)), 0.0)

docs/make.jl

@@ -99,7 +99,6 @@ withenv("GKSwstype" => "nul") do
                 "Limiters" => "APIs/limiters_api.md",
                 "InputOutput" => "APIs/input_output_api.md",
                 "Remapping" => "APIs/remapping_api.md",
-                "RecursiveApply" => "APIs/recursive_apply_api.md",
                 "Devices" => "APIs/devices_api.md",
                 "DebugOnly" => "APIs/debug_only_api.md",
             ],

docs/src/APIs/geometry_api.md

@@ -21,6 +21,7 @@ Geometry.LocalGeometry
 
 ```@docs
 Geometry.Δz_metric_component
+Geometry.:⊗
 ```
 
 ## Coordinates

docs/src/APIs/recursive_apply_api.md

@@ -4,6 +4,27 @@
 CurrentModule = ClimaCore
 ```
 
+## Type Functions
+
+```@docs
+Utilities.unionall_type
+Utilities.inferred_type
+Utilities.inferred_const
+```
+
+## Utilities.AutoBroadcaster
+
+```@docs
+Utilities.AutoBroadcaster
+Utilities.is_auto_broadcastable
+Utilities.enable_auto_broadcasting
+Utilities.disable_auto_broadcasting
+Utilities.auto_broadcast
+Utilities.@auto_broadcaster_args
+```
+
+## Utilities.PlusHalf
+
 ```@docs
 Utilities.PlusHalf
 Utilities.half

docs/src/APIs/utilities_api.md

@@ -6,7 +6,5 @@ CurrentModule = ClimaCore.Geometry
 
 ```@docs
 mul_with_projection
-rmul_with_projection
 mul_return_type
-rmul_return_type
 ```

docs/src/geometry.md

@@ -218,7 +218,7 @@ to represent a collection of banded matrices, where there is one band matrix for
 of the space the `Field` is on. Beyond only storing the diagonals of the band matrix, an `entry`
 can be optimized to use less memory. Each optimized representation can be indexed equivalently to
 non optimized representations, and used in addition, subtraction, matrix-vector multiplication,
-Matrix-matrix multiplication, `RecursiveApply`, and `FieldMatrixSolver`.
+matrix-matrix multiplication, and solving linear systems via `FieldMatrixSolver`.
 
 For the following sections, `space` is a column space with $N_v$ levels. A column space is
 used for simplicity in this example, but the optimizations work with any space with columns.