reservoirflow.grids.RegularCartesian.get_boundaries

RegularCartesian.get_boundaries(by='id', fmt='tuple')

Returns all boundary cells by id or coords.

Parameters:

• by (str, optional) – output boundaries as ‘id’ or ‘coords’. Other undefined str values will raise ValueError.

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

Returns:

boundaries by id or coords based on fmt argument.

Return type:

ndarray, list, set

Raises:

ValueError – by argument must be either ‘id’ or ‘coords’.