@@ -5,23 +5,24 @@ A wrapper for boundary condition functions with optional parameters.
55When `parameters=nothing`, the boundary condition `func` is called with the signature
66
77```
8- func(i, j, grid, clock, model_fields)
8+ func(i, j, grid, clock, model_fields, args... )
99```
1010
1111where `i, j` are the indices along the boundary,
12- where `grid` is `model.grid`, `clock.time` is the current simulation time and
13- `clock.iteration` is the current model iteration, and
14- `model_fields` is a `NamedTuple` with `u, v, w`, the fields in `model.tracers`,
15- and the fields in `model.diffusivity_fields`, each of which is an `OffsetArray`s (or `NamedTuple`s
16- of `OffsetArray`s depending on the turbulence closure) of field data.
12+ `grid` is `model.grid`,
13+ `model_fields` is a `NamedTuple` with `u, v, w`, the fields in `model.tracers` or
14+ the fields in `model.diffusivity_fields`, each of which is an `OffsetArray`s (or `NamedTuple`s
15+ of `OffsetArray`s depending on the turbulence closure) of field data,
16+ and `args` are any additional arguments passed to `getbc`.
17+ Note also that `clock.time` is the current simulation time and `clock.iteration` is the current model
18+ iteration.
1719
1820When `parameters` is not `nothing`, the boundary condition `func` is called with
1921the signature
2022
2123```
2224func(i, j, grid, clock, model_fields, parameters, args...)
2325```
24- where `args` are any additional arguments passed to `getbc`.
2526
2627*Note* that the index `end` does *not* access the final physical grid point of
2728a model field in any direction. The final grid point must be explictly specified, as
0 commit comments