Merge pull request #1207 from CliMA/js/context

uniformly use `context` throughout ClimaLand

Author: juliasloan25

NEWS.md

@@ -3,6 +3,7 @@ ClimaLand.jl Release Notes
 
 main
 -------
+- ![breaking change][badge-💥breaking] Rename all `comms_ctx` to `context` PR[#1207](https://github.com/CliMA/ClimaLand.jl/pull/1207)
 - Output NaNs in diagnostics where the ocean is PR[#1200](https://github.com/CliMA/ClimaLand.jl/pull/1200)
 - ![breaking change][badge-💥breaking] Make soil albedo parameterization modular
 PR[#1184](https://github.com/CliMA/ClimaLand.jl/pull/1184)

experiments/long_runs/bucket.jl

@@ -109,7 +109,7 @@ function setup_simulation(; greet = false)
     dz_tuple = FT.((1.0, 0.05))
     domain = ClimaLand.ModelSetup.global_domain(
         FT;
-        comms_ctx = context,
+        context,
         nelements,
         depth,
         dz_tuple,

experiments/long_runs/snowy_land.jl

@@ -158,7 +158,7 @@ function setup_model(FT, start_date, stop_date, Δt, domain, earth_param_set)
     SAI = FT(0.0) # m2/m2
     f_root_to_shoot = FT(3.5)
     RAI = FT(1.0)
-    K_sat_plant = FT(7e-8) # m/s 
+    K_sat_plant = FT(7e-8) # m/s
     ψ63 = FT(-4 / 0.0098) # / MPa to m
     Weibull_param = FT(4) # unitless
     a = FT(0.2 * 0.0098) # 1/m
@@ -354,8 +354,7 @@ function setup_simulation(; greet = false)
         @info "Stop Date: $stop_date"
     end
 
-    domain =
-        ClimaLand.ModelSetup.global_domain(FT; comms_ctx = context, nelements)
+    domain = ClimaLand.ModelSetup.global_domain(FT; context, nelements)
     params = LP.LandParameters(FT)
     model = setup_model(FT, start_date, stop_date, Δt, domain, params)
 

experiments/long_runs/soil.jl

@@ -166,8 +166,7 @@ function setup_simulation(; greet = false)
         @info "Start Date: $start_date"
         @info "Stop Date: $stop_date"
     end
-    domain =
-        ClimaLand.ModelSetup.global_domain(FT; comms_ctx = context, nelements)
+    domain = ClimaLand.ModelSetup.global_domain(FT; context, nelements)
     params = LP.LandParameters(FT)
     model = setup_model(FT, start_date, stop_date, domain, params)
     diagnostics = ClimaLand.default_diagnostics(

src/shared_utilities/Domains.jl

@@ -232,7 +232,7 @@ end
         periodic::Tuple{Bool,Bool},
         npolynomial::Int,
         longlat = nothing,
-        comms_ctx = ClimaComms.context(),
+        context = ClimaComms.context(),
         radius_earth = FT(6.378e6)
         ) where {FT}
 
@@ -255,7 +255,7 @@ function Plane(;
     periodic::Tuple{Bool, Bool} = isnothing(longlat) ? (true, true) :
                                   (false, false),
     npolynomial::Int = 0,
-    comms_ctx = ClimaComms.context(),
+    context = ClimaComms.context(),
     radius_earth = 6.378e6,
 ) where {FT}
     if isnothing(longlat)
@@ -306,7 +306,7 @@ function Plane(;
     plane = ClimaCore.Domains.RectangleDomain(domain_x, domain_y)
 
     mesh = ClimaCore.Meshes.RectilinearMesh(plane, nelements[1], nelements[2])
-    grid_topology = ClimaCore.Topologies.Topology2D(comms_ctx, mesh)
+    grid_topology = ClimaCore.Topologies.Topology2D(context, mesh)
     if npolynomial == 0
         quad = ClimaCore.Spaces.Quadratures.GL{npolynomial + 1}()
     else
@@ -540,7 +540,7 @@ end
         nelements::Tuple{Int, Int},
         npolynomial::Int,
         dz_tuple::Union{Tuple{FT, FT}, Nothing} = nothing,
-        comms_ctx = ClimaComms.context(),
+        context = ClimaComms.context(),
     ) where {FT}
 Outer constructor for the `SphericalShell` domain, using keyword arguments.
 
@@ -558,7 +558,7 @@ function SphericalShell(;
     nelements::Tuple{Int, Int},
     npolynomial::Int = 0,
     dz_tuple::Union{Tuple{FT, FT}, Nothing} = nothing,
-    comms_ctx = ClimaComms.context(),
+    context = ClimaComms.context(),
 ) where {FT}
     @assert 0 < radius
     @assert 0 < depth
@@ -587,7 +587,7 @@ function SphericalShell(;
 
     horzdomain = ClimaCore.Domains.SphereDomain(radius)
     horzmesh = ClimaCore.Meshes.EquiangularCubedSphere(horzdomain, nelements[1])
-    horztopology = ClimaCore.Topologies.Topology2D(comms_ctx, horzmesh)
+    horztopology = ClimaCore.Topologies.Topology2D(context, horzmesh)
     if npolynomial == 0
         quad = ClimaCore.Spaces.Quadratures.GL{npolynomial + 1}()
     else
@@ -653,20 +653,20 @@ end
         radius::FT,
         nelements::Int
         npolynomial::Int,
-        comms_ctx = ClimaComms.context(),
+        context = ClimaComms.context(),
     ) where {FT}
 Outer constructor for the `SphericalSurface` domain, using keyword arguments.
 """
 function SphericalSurface(;
     radius::FT,
     nelements::Int,
     npolynomial::Int = 0,
-    comms_ctx = ClimaComms.context(),
+    context = ClimaComms.context(),
 ) where {FT}
     @assert 0 < radius
     horzdomain = ClimaCore.Domains.SphereDomain(radius)
     horzmesh = Meshes.EquiangularCubedSphere(horzdomain, nelements)
-    horztopology = Topologies.Topology2D(comms_ctx, horzmesh)
+    horztopology = Topologies.Topology2D(context, horzmesh)
     if npolynomial == 0
         quad = ClimaCore.Spaces.Quadratures.GL{npolynomial + 1}()
     else

src/shared_utilities/checkpoints.jl

@@ -89,7 +89,7 @@ function _context_from_Y(Y)
 end
 
 """
-    ClimaLand.save_checkpoint(Y, t, output_dir; model = nothing, comms_ctx = ClimaComms.context(Y))
+    ClimaLand.save_checkpoint(Y, t, output_dir; model = nothing, context = ClimaComms.context(Y))
 
 Save a simulation checkpoint to an HDF5 file.
 
@@ -104,21 +104,20 @@ specified output directory.
 - `model` (Optional): The ClimaLand model object. If provided the hash of the model
   will be stored in the checkpoint file. Defaults to `nothing`. This is used
   to check for consistency.
-- `comms_ctx` (Optional): The ClimaComms context. This is used for distributed I/O
+- `context` (Optional): The ClimaComms context. This is used for distributed I/O
   operations. Defaults to the context extracted from the state vector `Y` or the `model`.
 """
 function save_checkpoint(
     Y,
     t,
     output_dir;
     model = nothing,
-    comms_ctx = isnothing(model) ? _context_from_Y(Y) :
-                ClimaComms.context(model),
+    context = isnothing(model) ? _context_from_Y(Y) : ClimaComms.context(model),
 )
     day = floor(Int, t / (60 * 60 * 24))
     sec = floor(Int, t % (60 * 60 * 24))
     output_file = joinpath(output_dir, "day$day.$sec.hdf5")
-    hdfwriter = InputOutput.HDF5Writer(output_file, comms_ctx)
+    hdfwriter = InputOutput.HDF5Writer(output_file, context)
     # If model was passed, add its hash, otherwise add nothing
     hash_model = isnothing(model) ? "nothing" : hash(model)
     InputOutput.write_attributes!(

src/simulations/domains.jl

@@ -17,7 +17,7 @@ discretization, which is correlated to the spatial resolution of the domain.
 When `npolynomial` is zero, the element is equivalent to a single point. In this
 case, the resolution of the model is sqrt((360*180)/(101*101*6)). The factor of 6 arises
 because there are 101x101 elements per side of the cubed sphere, meaning 6*101*101 for the
-entire globe. 
+entire globe.
 
 When `npolynomial` is greater than 1, a Gauss-Legendre-Lobotto quadrature is
 used, with `npolynomial + 1` points along the element. In this case, there are
@@ -36,7 +36,7 @@ function global_domain(
     dz_tuple = (10.0, 0.05),
     depth = 50.0,
     npolynomial = 0,
-    comms_ctx = ClimaComms.context(),
+    context = ClimaComms.context(),
 )
     if pkgversion(ClimaCore) < v"0.14.30" && apply_mask
         @warn "The land mask cannot be applied with ClimaCore < v0.14.30. Update ClimaCore for significant performance gains."
@@ -52,7 +52,7 @@ function global_domain(
         nelements,
         npolynomial,
         dz_tuple,
-        comms_ctx,
+        context,
     )
     if apply_mask
         surface_space = domain.space.surface # 2d space