Update Docs/Model/Output Writers to replace FieldSlicer -> indices (

#3350) * update docs to replace FieldSlicer with indices * Update docs/src/model_setup/output_writers.md Co-authored-by: Navid C. Constantinou <[email protected]> --------- Co-authored-by: Navid C. Constantinou <[email protected]>
CliMA · Oct 23, 2023 · 80ce6ed · 80ce6ed
1 parent d0b7ec8
commit 80ce6ed
Showing 1 changed file with 2 additions and 3 deletions.
diff --git a/docs/src/model_setup/output_writers.md b/docs/src/model_setup/output_writers.md
@@ -25,9 +25,8 @@ The `Checkpointer` is discussed on a separate documentation page.
 
 Other important keyword arguments are
 
-* `field_slicer::FieldSlicer` for outputting subregions, two- and one-dimensional slices of fields.
-  By default a `FieldSlicer` is used to remove halo regions from fields so that only the physical
-  portion of model data is saved to disk.
+* `indices` for outputting subregions, two- and one-dimensional slices of fields. Specifies the indices to write to disk with a `Tuple` of `Colon`, `UnitRange`,or `Int` elements. For example, `indices = (:, :, 1)` implies outputing ``x-y``-slices of the bottom-most index (`k=1`). Defaults to `(:, :, :)`, i.e., "all indices".
+* `with_halos :: Boolean`: whether to output the halos (`true`) or only the interior points (`false`; default).
 
 * `array_type` for specifying the type of the array that holds outputted field data. The default is
   `Array{Float64}`, or arrays of single-precision floating point numbers.