# Iterative Stencil Loops

Iterative Stencil Loops (ISLs) or Stencil computations are a class of numerical data processing solution which update array elements according to some fixed pattern, called a stencil. They are most commonly found in computer simulations, e.g. for computational fluid dynamics in the context of scientific and engineering applications. Other notable examples include solving partial differential equations, the Jacobi kernel, the Gauss–Seidel method, image processing and cellular automata. The regular structure of the arrays sets stencil techniques apart from other modeling methods such as the Finite element method. Most finite difference codes which operate on regular grids can be formulated as ISLs.

## Definition

ISLs perform a sequence of sweeps (called timesteps) through a given array. Generally this is a 2- or 3-dimensional regular grid. The elements of the arrays are often referred to as cells. In each timestep, all array elements are updated. Using neighboring array elements in a fixed pattern (the stencil), each cell's new value is computed. In most cases boundary values are left unchanged, but in some cases (e.g. LBM codes) those need to be adjusted during the computation as well. Since the stencil is the same for each element, the pattern of data accesses is repeated.
More formally, we may define ISLs as a 5-tuple $(I,S,S_{0},s,T)$ with the following meaning:
* $I=\prod _{i=1}^{k}[0,\ldots ,n_{i}]$ is the index set. It defines the topology of the array.
* $S$ is the (not necessarily finite) set of states, one of which each cell may take on on any given timestep.
* $S_{0}\colon \mathbb {Z} ^{k}\to S$ defines the initial state of the system at time 0.
* $s\in \prod _{i=1}^{l}\mathbb {Z} ^{k}$ is the stencil itself and describes the actual shape of the neighborhood. There are $l$ elements in the stencil.
* $T\colon S^{l}\to S$ is the transition function which is used to determine a cell's new state, depending on its neighbors.
Since I is a k-dimensional integer interval, the array will always have the topology of a finite regular grid. The array is also called simulation space and individual cells are identified by their index $c\in I$. The stencil is an ordered set of $l$ relative coordinates. We can now obtain for each cell $c$ the tuple of its neighbors indices $I_{c}$
    $I_{c}=\{j\mid \exists x\in s:j=c+x\}\,$
Their states are given by mapping the tuple $I_{c}$ to the corresponding tuple of states $N_{i}(c)$, where $N_{i}\colon I\to S^{l}$ is defined as follows:
    $N_{i}(c)=(s_{1},\ldots ,s_{l}){\text{ with }}s_{j}=S_{i}(I_{c}(j))\,$
This is all we need to define the system's state for the following time steps $S_{i+1}\colon \mathbb {Z} ^{k}\to S$ with $i\in \mathbb {N}$:
    $S_{i+1}(c)={\begin{cases}T(N_{i}(c)),&c\in I\\S_{i}(c),&c\in \mathbb {Z} ^{k}\setminus I\end{cases}}$
Note that $S_{i}$ is defined on $\mathbb {Z} ^{k}$ and not just on $I$ since the boundary conditions need to be set, too. Sometimes the elements of $I_{c}$ may be defined by a vector addition modulo the simulation space's dimension to realize toroidal topologies:
    $I_{c}=\{j\mid \exists x\in s:j=((c+x)\mod (n_{1},\ldots ,n_{k}))\}$
This may be useful for implementing periodic boundary conditions, which simplifies certain physical models.

### Example: 2D Jacobi iteration

To illustrate the formal definition, we'll have a look at how a two dimensional Jacobi iteration can be defined. The update function computes the arithmetic mean of a cell's four neighbors. In this case we set off with an initial solution of 0. The left and right boundary are fixed at 1, while the upper and lower boundaries are set to 0. After a sufficient number of iterations, the system converges against a saddle-shape.
    ${\begin{aligned}I&=[0,\ldots ,99]^{2}\\S&=\mathbb {R} \\S_{0}&:\mathbb {Z} ^{2}\to \mathbb {R} \\S_{0}((x,y))&={\begin{cases}1,&x<0\\0,&0\leq x<100\\1,&x\geq 100\end{cases}}\\s&=((0,-1),(-1,0),(1,0),(0,1))\\T&\colon \mathbb {R} ^{4}\to \mathbb {R} \\T((x_{1},x_{2},x_{3},x_{4}))&=0.25\cdot (x_{1}+x_{2}+x_{3}+x_{4})\end{aligned}}$
$S_{0}$
$S_{200}$
$S_{400}$
$S_{600}$
$S_{800}$
$S_{1000}$
$100^{2}$

## Stencils

The shape of the neighborhood used during the updates depends on the application itself. The most common stencils are the 2D or 3D versions of the von Neumann neighborhood and Moore neighborhood. The example above uses a 2D von Neumann stencil while LBM codes generally use its 3D variant. Conway's Game of Life uses the 2D Moore neighborhood. That said, other stencils such as a 25-point stencil for seismic wave propagation can be found, too.

## Implementation issues

Many simulation codes may be formulated naturally as ISLs. Since computing time and memory consumption grow linearly with the number of array elements, parallel implementations of ISLs are of paramount importance to research. This is challenging since the computations are tightly coupled (because of the cell updates depending on neighboring cells) and most ISLs are memory bound (i.e. the ratio of memory accesses to calculations is high). Virtually all current parallel architectures have been explored for executing ISLs efficiently; at the moment GPGPUs have proven to be most efficient.

## Libraries

Due to both the importance of ISLs to computer simulations and their high computational requirements, there are a number of efforts which aim at creating reusable libraries to support scientists in performing stencil-based computations. The libraries are mostly concerned with the parallelization, but may also tackle other challenges, such as IO, steering and checkpointing. They may be classified by their APIs.

### Patch-based libraries

This is a traditional design. The library manages a set of n-dimensional scalar arrays, which the user program may access to perform updates. The library handles the synchronization of the boundaries (dubbed ghost zone or halo). The advantage of this interface is that the user program may loop over the arrays, which makes it easy to integrate legacy code . The disadvantage is that the library can not handle cache blocking (as this has to be done within the loops) or wrapping of the API-calls for accelerators (e.g. via CUDA or OpenCL). Implementations include Cactus, a physics problem solving environment, and waLBerla.

### Cell-based libraries

These libraries move the interface to updating single simulation cells: only the current cell and its neighbors are exposed, e.g. via getter/setter methods. The advantage of this approach is that the library can control tightly which cells are updated in which order, which is useful not only to implement cache blocking, but also to run the same code on multi-core systems and GPUs. This approach requires the user to recompile the source code together with the library. Otherwise a function call for every cell update would be required, which would seriously impair performance. This is only feasible with techniques such as class templates or metaprogramming, which is also the reason why this design is only found in newer libraries. Examples are Physis and LibGeoDecomp.
* Advanced Simulation Library
* Finite difference method
* Computer simulation
* Five-point stencil
* Compact stencil
* Non-compact stencil
* Stencil jumping
* Stencil (numerical analysis)