reservoirflow.utils.pyvista.add_grid_labels

reservoirflow.utils.pyvista.add_grid_labels(pl: Plotter, grid, label: str, opacity: float, boundary: bool) → None

Add labels to a grid

Parameters:

• pl (pv.Plotter) – plotter object from pyvista.

• grid – grid object from reservoirflow grids module.

• label (str) – label of grid centers as str in [‘id’, ‘coords’, ‘icoords’, ‘dx’, ‘dy’, ‘dz’, ‘Ax’, ‘Ay’, ‘Az’, ‘V’, ‘center’, ‘sphere’]. If None, this nothing will be added.

• opacity (float) – adjust transparency between 0 and 1 where 0 is fully transparent and 1 is fully nontransparent.

• boundary (bool) – include boundary cells.

Raises:

ValueError – label is not recognized.