Reservoir

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

Bases: Case

Abstract base class for Eclipse Cases

Methods Summary

add_result_alias([result_name, alias_name])

Add Result Alias

clear_result_aliases()

Clear Result Aliases

data_filter_collection()

Data Filters

export_corner_point_grid()

Export corner point grid data from case

grid_property_for_positions(positions, ...)

import_properties([file_names])

Import Properties

property_data_type([property_type, ...])

Get the data type (FLOAT or INTEGER) of a grid property

Methods Documentation

add_result_alias(result_name: str = '', alias_name: str = '') → None

Add Result Alias

Parameters:

  • result_name (str)

  • alias_name (str)

Returns:

clear_result_aliases() → None

Clear Result Aliases

Arguments:

Returns:

data_filter_collection() → DataFilterCollection | None

Data Filters

Returns:

DataFilterCollection

export_corner_point_grid() → Tuple[List[float], List[float], List[int], int, int, int]

Export corner point grid data from case

Returns:

  • zcorn: Corner depths as defined by the Eclipse keyword ZCORN

  • coord: Coordinate lines as COORD keyword in Eclipse

  • actnum: Active cell info: cells with values > 0 are active

  • nx, ny, nz: Grid dimensions in I, J, K directions

Return type:

Tuple of (zcorn, coord, actnum, nx, ny, nz) where

grid_property_for_positions(positions: List[List[float]], property_type: PropertyType, property_name: str, time_step: int, porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → List[float]
import_properties(file_names: List[str] = []) → DataContainerString

Import Properties

Parameters:

file_names (List[str])

Returns:

DataContainerString

property_data_type(property_type: PropertyType = PropertyType.DYNAMIC_NATIVE, property_name: str = '', porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → PropertyDataType

Get the data type (FLOAT or INTEGER) of a grid property

Parameters:

  • property_type (PropertyType) -- One of [DYNAMIC_NATIVE, STATIC_NATIVE, SOURSIMRL, GENERATED, INPUT_PROPERTY, FORMATION_NAMES, ALLAN_DIAGRAMS, FLOW_DIAGNOSTICS, INJECTION_FLOODING]

  • property_name (str)

  • porosity_model (PorosityModelType) -- One of [MATRIX_MODEL, FRACTURE_MODEL]

Returns:

PropertyDataType