EclipseCase
- class rips.EclipseCase(pb2_object: PdmObject | None = None, channel: Channel | None = None)
Bases:
ReservoirThe Regular Eclipse Results Case
Methods Summary
create_saturation_pressure_plots([time_step])Create saturation pressure plots (PRESSURE vs PBUB/PDEW per EQUIL region) for the case
export_flow_characteristics([time_steps, ...])Export flow characteristics computed by flow diagnostics to a text file
filtered_cells(filter[, time_step, grid_index])Apply a cell filter to this case and return a per-cell 0/1 mask.
Methods Documentation
- create_saturation_pressure_plots(time_step: int = 0) None
Create saturation pressure plots (PRESSURE vs PBUB/PDEW per EQUIL region) for the case
- Parameters:
time_step (int) -- Zero-based time step index
Returns:
- export_flow_characteristics(time_steps: List[int] = [], injectors: List[str] = [], producers: List[str] = [], file_name: str = '', minimum_communication: float = 0.0, aquifer_cell_threshold: float = 0.1) None
Export flow characteristics computed by flow diagnostics to a text file
- Parameters:
time_steps (List[int]) -- Zero-based time step indices
injectors (List[str]) -- Injector well names
producers (List[str]) -- Producer well names
file_name (str) -- File to write. Relative paths are resolved against the project folder.
minimum_communication (float)
aquifer_cell_threshold (float)
Returns:
- 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]