reservoirflow.grids.RegularCartesian.get_cells_coords#

RegularCartesian.get_cells_coords(boundary: bool = True, fshape: bool = False, fmt='tuple')#

Returns all cells coords based on (i,j,k).

Parameters:

  • 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.

Returns:

cells coords in (i,j,k) as array.

Return type:

ndarray

On this page