CellFlows

CellFlows

Per-cell flow data (heads, budgets, face flows) used during particle tracking.

All arrays are indexed by zero-based cell ID. Produced by hydrate_cell_flows().

Sign conventions

Pass raw MODFLOW values — do not negate. face_flow positive = into cell (MODFLOW-USG / MF6 convention). q_well negative = extraction, positive = injection.

head property

head: List[float]

Simulated hydraulic head in each cell (model units).

water_table property

water_table: List[float]

Water-table elevation in each cell (model units).

q_top property

q_top: List[float]

Volumetric flux entering through the cell top (L³/T, raw MODFLOW sign).

q_bot property

q_bot: List[float]

Volumetric flux entering through the cell bottom (L³/T, raw MODFLOW sign).

q_vert property

q_vert: List[float]

Net vertical flow term (L³/T, raw MODFLOW sign).

q_well property

q_well: List[float]

Well volumetric flux (L³/T). Negative = extraction, positive = injection.

q_other property

q_other: List[float]

Sum of all other (non-well, non-face) boundary fluxes (L³/T).

q_storage property

q_storage: List[float]

Storage term (L³/T, positive = release from storage).

has_well property

has_well: List[bool]

True for each cell that contains an active well.

face_offset property

face_offset: List[int]

Start index into face_flow / face_neighbor for each cell.

face_flow property

face_flow: List[float]

Face-by-face volumetric fluxes (L³/T). Positive = into cell.

face_neighbor property

face_neighbor: List[Optional[int]]

Zero-based cell index of the neighbouring cell across each face, or None for domain-boundary faces.

n_cells

n_cells() -> int

Return the number of cells.