resqpy.grid_surface.seed_array

resqpy.grid_surface.seed_array(point: Tuple[int, int, int], k_faces: ndarray, j_faces: ndarray, i_faces: ndarray, boundary: Tuple[int, int, int, int, int, int], array: ndarray) Tuple[ndarray, int, int, int][source]

Sets values of the array True up until a face is hit in each direction.

Parameters:
  • point (Tuple[int, int, int]) – coordinates of the initial seed point.

  • k_faces (np.ndarray) – a boolean array of which faces represent the surface in the k dimension.

  • j_faces (np.ndarray) – a boolean array of which faces represent the surface in the j dimension.

  • i_faces (np.ndarray) – a boolean array of which faces represent the surface in the i dimension.

  • boundary (Tuple[int, int, int, int, int, int]) – the boundaries of the surface given in the order (minimum k, maximum k, minimum j, maximum j, minimum i, maximum i).

  • array (np.ndarray) – boolean array that will be seeded.

Returns:

Tuple containing

  • array (np.ndarray): boolean array that has been seeded.

  • first_k (int): the index of the first k face in the k direction from the seed point or the

    array size in the k direction if there are no k faces.

  • first_j (int): the index of the first j face in the j direction from the seed point or the

    array size in the j direction if there are no j faces.

  • first_i (int): the index of the first i face in the i direction from the seed point or the

    array size in the i direction if there are no i faces.