Major refactor of FieldBoundaryConditions

src/BoundaryConditions/apply_flux_bcs.jl

@@ -92,7 +92,7 @@ end
 @inline flip(::Face) = Center()
 
 """
-    apply_x_west_bc!(Gc, west_flux::BC{<:Flux}, j, k, grid, args...)
+    apply_x_west_bc!(Gc, loc, west_flux::BC{<:Flux}, j, k, grid, args...)
 
 Add the flux divergence associated with a west flux boundary condition on `c`.
 Note that because
@@ -125,7 +125,7 @@ end
 end
 
 """
-    apply_x_east_bc!(Gc, top_flux::BC{<:Flux}, j, k, grid, args...)
+    apply_x_east_bc!(Gc, loc, east_flux::BC{<:Flux}, j, k, grid, args...)
 
 Add the part of flux divergence associated with a east boundary condition on `c`.
 Note that because

src/BoundaryConditions/boundary_condition.jl

@@ -11,7 +11,7 @@ struct BoundaryCondition{C<:AbstractBoundaryConditionClassification, T}
 end
 
 """
-    BoundaryCondition(Classification, condition)
+    BoundaryCondition(Classification::DataType, condition)
 
 Construct a boundary condition of type `BC` with a number or array as a `condition`.
 
@@ -20,7 +20,10 @@ Boundary condition types include `Periodic`, `Flux`, `Value`, `Gradient`, and `O
 BoundaryCondition(Classification::DataType, condition) = BoundaryCondition(Classification(), condition)
 
 """
-    BoundaryCondition(Classification, condition::Function; parameters=nothing, discrete_form=false)
+    BoundaryCondition(Classification::DataType, condition::Function;
+                      parameters = nothing,
+                      discrete_form = false,
+                      field_dependencies=())
 
 Construct a boundary condition of type `Classification` with a function boundary `condition`.
 

src/BoundaryConditions/discrete_boundary_function.jl

@@ -1,5 +1,5 @@
 """
-    DiscreteBoundaryFunction(func, parameters)
+    struct DiscreteBoundaryFunction{P, F} <: Function
 
 A wrapper for boundary condition functions with optional parameters.
 When `parameters=nothing`, the boundary condition `func` is called with the signature

src/BoundaryConditions/field_boundary_conditions.jl

@@ -73,7 +73,7 @@ Returns boundary conditions for auxiliary fields (fields
 whose values are derived from a model's prognostic fields) on `grid`
 and at `location`.
 
-Keyword arguments specify boundary conditions on the 7 possible boundaries:
+Keyword arguments specify boundary conditions on the 6 possible boundaries:
 
     * `west`, left end point in the `x`-direction where `i=1`
     * `east`, right end point in the `x`-direction where `i=grid.Nx`

src/BoundaryConditions/fill_halo_regions.jl

@@ -7,7 +7,7 @@ using OffsetArrays: OffsetArray
 fill_halo_regions!(::Nothing, args...) = []
 
 """
-    fill_halo_regions!(fields, arch)
+    fill_halo_regions!(fields::Union{Tuple, NamedTuple}, arch, args...)
 
 Fill halo regions for each field in the tuple `fields` according to their boundary
 conditions, possibly recursing into `fields` if it is a nested tuple-of-tuples.