pystencils.field.Field.staggered_access

pystencils.field.Field.staggered_access#

Field.staggered_access(offset, index=None)#

If this field is a staggered field, it can be accessed using half-integer offsets. For example, an offset of (0, sp.Rational(1,2)) or "E" corresponds to the staggered point to the east of the cell center, i.e. half-way to the eastern-next cell. If the field stores more than one value per staggered point (e.g. a vector or a tensor), the index (integer or tuple of integers) refers to which of these values to access.