AxisPosition

class fridom.framework.grid.position.AxisPosition(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The position of a field along an axis on the staggered grid.

Options

CENTER :

Center of the grid cell.

FACE :

Face of the grid cell (right edge of the cell).

  CENTER
     ↓
|    x    |    x    |    x    |
          ↑
        FACE
→ positive direction

__init__(*args, **kwds)

Methods

shift()

Shift the position of the field.

Attributes

CENTER
FACE

CENTER = 1

FACE = 2

shift() → AxisPosition

Shift the position of the field. Center -> Face and vice versa

Returns

AxisPositionNew

The new axis position of the field.