Skip to content

Commit 80ce6ed

Browse files
xkykainavidcy
andauthored
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]>
1 parent d0b7ec8 commit 80ce6ed

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

docs/src/model_setup/output_writers.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,8 @@ The `Checkpointer` is discussed on a separate documentation page.
2525

2626
Other important keyword arguments are
2727

28-
* `field_slicer::FieldSlicer` for outputting subregions, two- and one-dimensional slices of fields.
29-
By default a `FieldSlicer` is used to remove halo regions from fields so that only the physical
30-
portion of model data is saved to disk.
28+
* `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".
29+
* `with_halos :: Boolean`: whether to output the halos (`true`) or only the interior points (`false`; default).
3130

3231
* `array_type` for specifying the type of the array that holds outputted field data. The default is
3332
`Array{Float64}`, or arrays of single-precision floating point numbers.

0 commit comments

Comments
 (0)