EclipseCase

class rips.EclipseCase(pb2_object: PdmObject | None = None, channel: Channel | None = None)

Bases: Reservoir

The Regular Eclipse Results Case

Methods Summary

filtered_cells(filter[, time_step, grid_index])

Apply a cell filter to this case and return a per-cell 0/1 mask.

Methods Documentation

filtered_cells(filter, time_step: int = 0, grid_index: int = 0) → List[int]

Apply a cell filter to this case and return a per-cell 0/1 mask.

The returned list has the same length and ordering as case.grid_property("STATIC_NATIVE", "PERMX", grid_index), so the two vectors can be combined element-wise.

Parameters:

  • filter (CellFilter) -- The cell filter to apply (e.g. a CombinedFilter obtained from case.data_filter_collection().filters()).

  • time_step (int) -- Time step index used by property-filter children.

  • grid_index (int) -- Grid index (0 = main grid, >0 = LGRs).

Returns:

1 if the cell passes the filter, 0 otherwise.

Return type:

List[int]