reservoirflow.grids.RegularCartesian.get_cells_k

RegularCartesian.get_cells_k(dir, boundary: bool = True, fshape: bool = True, fmt='array')

Returns permeability values for all cells.

Parameters:

• name (str) – property name as a string from props attribute keys.

• boundary (bool, optional) – include boundary cells.

• fshape (bool, optional) – reshape to flow shape instead of flatten. If set to True, fmt argument will be ignored.

• fmt (str, optional) – output format as str from [‘array’, ‘list’, ‘tuple’, ‘set’]. This argument is ignored if fshape argument is set to True. For a better performance, use ‘set’ to check if an item is in a list or not. Use tuples to iterate through items. When option ‘array’ is used, utils.helpers.isin() must be used to check if a tuple of 3 is in the array.

Raises:

ValueError – dir must be in [‘x’, ‘y’, ‘z’].