More informative message when user provides smaller halo size than Im…

…mersedBoundraryGrid requires (#2984) * give more informative message when user provides smaller halo size than img requires * removes warning from regrid * adds clarification
CliMA · Mar 18, 2023 · a3cb9f8 · a3cb9f8
1 parent 2001a7f
commit a3cb9f8
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 13 deletions.
diff --git a/src/Fields/regridding_fields.jl b/src/Fields/regridding_fields.jl
@@ -15,10 +15,6 @@ const c = Center()
 
 Regrid field `b` onto the grid of field `a`. 
 
-!!! warning "Functionality limitation"
-    Currently `regrid!` only regrids in the vertical ``z`` direction and works only on
-    fields that have data only in ``z`` direction.
-
 Example
 =======
 

diff --git a/src/Models/HydrostaticFreeSurfaceModels/hydrostatic_free_surface_model.jl b/src/Models/HydrostaticFreeSurfaceModels/hydrostatic_free_surface_model.jl
@@ -223,14 +223,14 @@ validate_momentum_advection(momentum_advection, grid::AbstractHorizontallyCurvil
 validate_momentum_advection(momentum_advection::Union{VectorInvariant, Nothing}, grid::AbstractHorizontallyCurvilinearGrid) = momentum_advection
 
 function validate_model_halo(grid, momentum_advection, tracer_advection, closure)
-  user_halo = halo_size(grid)
-  required_halo = inflate_halo_size(1, 1, 1, grid,
-                                    momentum_advection,
-                                    tracer_advection,
-                                    closure)
-
-  any(user_halo .< required_halo) &&
-    throw(ArgumentError("The grid halo $user_halo must be at least equal to $required_halo. Note that an ImmersedBoundaryGrid requires an extra halo point."))
+    user_halo = halo_size(grid)
+    required_halo = inflate_halo_size(1, 1, 1, grid,
+                                      momentum_advection,
+                                      tracer_advection,
+                                      closure)
+
+    any(user_halo .< required_halo) &&
+        throw(ArgumentError("The grid halo $user_halo must be at least equal to $required_halo. Note that an ImmersedBoundaryGrid requires an extra halo point in all non-flat directions compared to a non-immersed boundary grid."))
 end
 
 initialize_model!(model::HydrostaticFreeSurfaceModel) = initialize_free_surface!(model.free_surface, model.grid, model.velocities)

diff --git a/src/Models/NonhydrostaticModels/nonhydrostatic_model.jl b/src/Models/NonhydrostaticModels/nonhydrostatic_model.jl
@@ -227,7 +227,7 @@ function inflate_grid_halo_size(grid, tendency_terms...)
 
     if any(user_halo .< required_halo) # Replace grid
         @warn "Inflating model grid halo size to ($Hx, $Hy, $Hz) and recreating grid. " *
-              "Note that an ImmersedBoundaryGrid requires an extra halo point. "
+              "Note that an ImmersedBoundaryGrid requires an extra halo point in all non-flat directions compared to a non-immersed boundary grid."
               "The model grid will be different from the input grid. To avoid this warning, " *
               "pass halo=($Hx, $Hy, $Hz) when constructing the grid."