New interface for ECCORestoring

.buildkite/pipeline.yml

@@ -13,8 +13,6 @@ env:
 steps:
   - label: "initialize"
     key: "init"
-    concurrency: 1
-    concurrency_group: 'depot/climaocean-ci'
     env:
       TEST_GROUP: "init"
     command:

src/ClimaOcean.jl

@@ -8,15 +8,17 @@ export
     SimilarityTheoryTurbulentFluxes,
     JRA55_prescribed_atmosphere,
     JRA55NetCDFBackend,
-    ECCOMetadata,
     regrid_bathymetry,
     retrieve_bathymetry,
     stretched_vertical_faces,
     exponential_z_faces,
     PowerLawStretching, LinearStretching,
     exponential_z_faces,
     JRA55_field_time_series,
-    ECCO_field, ECCOMetadata,
+    ECCO_field, 
+    ECCOMetadata,
+    ECCORestoring,
+    LinearlyTaperedPolarMask,
     ocean_simulation,
     initialize!
 

src/DataWrangling/ECCO/ECCO.jl

@@ -2,7 +2,7 @@ module ECCO
 
 export ECCOMetadata, ECCO_field, ECCO_mask, adjusted_ECCO_tracers, initialize!
 export ECCO2Monthly, ECCO4Monthly, ECCO2Daily
-export ECCO_restoring_forcing
+export ECCORestoring, LinearlyTaperedPolarMask
 
 using ClimaOcean.DataWrangling: inpaint_mask!
 using ClimaOcean.InitialConditions: three_dimensional_regrid!, interpolate!
@@ -206,14 +206,14 @@ Keyword Arguments:
 function inpainted_ECCO_field(metadata::ECCOMetadata; 
                               architecture = CPU(),
                               mask = ECCO_mask(metadata, architecture),
-                              maxiter = Inf,
+                              inpainting = NearestNeighborInpainting(Inf),
                               kw...)
 
     f = ECCO_field(metadata; architecture, kw...)
 
     # Make sure all values are extended properly
     @info "In-painting ECCO $(metadata.name)"
-    inpaint_mask!(f, mask; maxiter)
+    inpaint_mask!(f, mask; inpainting)
 
     fill_halo_regions!(f)
 

src/DataWrangling/ECCO/ECCO_mask.jl

@@ -1,4 +1,5 @@
 using Oceananigans.Architectures: AbstractArchitecture
+import ClimaOcean: stateindex
 
 """
     ECCO_mask(architecture = CPU(); minimum_value = Float32(-1e5))
@@ -39,3 +40,52 @@ end
     @inbounds mask[i, j, k] = (Tᵢ[i, j, k] == 0) 
 end
 
+struct LinearlyTaperedPolarMask{N, S, Z} 
+    northern :: N
+    southern :: S
+    z :: Z
+end
+
+"""
+    LinearlyTaperedPolarMask(; northern = (70,   75),
+                               southern = (-75, -70),
+                               z = (-20, 0))
+
+Build a mask that is linearly tapered in latitude inbetween the northern and southern edges.
+The mask is constant in depth between the z and is equal to zero everywhere else.
+The mask has the following functional form:
+
+```julia
+n = 1 / (northern[2] - northern[1]) * (φ - northern[1])
+s = 1 / (southern[1] - southern[2]) * (φ - southern[2])
+
+within_depth = (z[1] < z < z[2])
+
+mask = within_depth ? max(n, s, 0) : 0
+```
+"""
+function LinearlyTaperedPolarMask(; northern = (70,   75),
+                                    southern = (-75, -70),
+                                    z = (-20, 0))
+
+    northern[1] > northern[2]  && throw(ArgumentError("Northern latitude range is invalid, northern[1] > northern[2]."))
+    southern[1] > southern[2]  && throw(ArgumentError("Southern latitude range is invalid, southern[1] > southern[2]."))
+    z[1] > z[2]                && throw(ArgumentError("Depth range is invalid, z[1] > z[2]."))
+
+    return LinearlyTaperedPolarMask(northern, southern, z)
+end
+
+@inline function (mask::LinearlyTaperedPolarMask)(φ, z)
+    n = 1 / (mask.northern[2] - mask.northern[1]) * (φ - mask.northern[1])
+    s = 1 / (mask.southern[1] - mask.southern[2]) * (φ - mask.southern[2])
+
+    within_depth = (mask.z[1] < z < mask.z[2])
+
+    return ifelse(within_depth, max(n, s, zero(n)), zero(n))
+end
+
+@inline function stateindex(mask::LinearlyTaperedPolarMask, i, j, k, grid, time, loc)
+    LX, LY, LZ = loc 
+    λ, φ, z = node(i, j, k, grid, LX(), LY(), LZ())
+    return mask(φ, z)
+end

src/DataWrangling/ECCO/ECCO_metadata.jl

@@ -33,6 +33,10 @@ Base.show(io::IO, metadata::ECCOMetadata) =
     "├── version: $(metadata.version)", '\n',
     "└── dir: $(metadata.dir)")
 
+Base.summary(data::ECCOMetadata{<:Any, <:ECCO2Daily})   = "Daily ECCO2 $(data.name) dataset, from $(first(data.dates)) to $(last(data.dates))"
+Base.summary(data::ECCOMetadata{<:Any, <:ECCO2Monthly}) = "Monthly ECCO2 $(data.name) dataset, from $(first(data.dates)) to $(last(data.dates))"
+Base.summary(data::ECCOMetadata{<:Any, <:ECCO4Monthly}) = "Monthly ECCO4 $(data.name) dataset, from $(first(data.dates)) to $(last(data.dates))"
+
 """
     ECCOMetadata(name::Symbol; 
                  dates = DateTimeProlepticGregorian(1993, 1, 1),