pystencils.codegen.config.CreateKernelConfig.ghost_layers

CreateKernelConfig.ghost_layers: BasicOption[GhostLayerSpec] = None

Specifies the number of ghost layers of the iteration region.

Options:

• AUTO: Required ghost layers are inferred from field accesses

• int: A uniform number of ghost layers in each spatial coordinate is applied

• Sequence[int, tuple[int, int]]: Ghost layers are specified for each spatial coordinate.

  In each coordinate, a single integer specifies the ghost layers at both the lower and upper iteration limit, while a pair of integers specifies the lower and upper ghost layers separately.

When manually specifying ghost layers, it is the user’s responsibility to avoid out-of-bounds memory accesses.

Note

At most one of ghost_layers, iteration_slice, and index_field may be set.