Patches and Algebraic Fields [Experimental]

Caution

The pystencils.grids module is meant to replace the legacy fields module (pystencils.field) in the near future. It is still under active development and considered experimental.

Patches and Patch Data

Patch	Cuboid volume of space, discretized by a cartesian grid.
PatchGrid	Proxy representing a grid superimposed on a patch.
VariablePlacement	Variable placements on a patch's grid.

PatchData

Manage simulation data and field arrays for a given patch.

Tensor Fields

TensorField	Tensor field mapping each point of a \(d\)-dimensional index space to a rank \(n\) tensor.
TensorFieldAccess	Access into a tensor field.

Helper Classes

MemoryLayout

Common field memory layouts available in pystencils.

Infrastructure and Protocols

IField	Interface for algebraic fields to the pystencils code generator.
IFieldAccess	Interface for expressions that should be translated to buffer accesses for an algebraic field.
FieldBufferSpec	Specification for a field's memory buffers.
IterationLimits	Kernel iteration limits prescribed by a field.
CreateNdArray	Create an ndarray instance for a field.
ViewNdArray	Extract the interior view onto an ndarray for a field.