SimulationWell

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

Bases: PdmObjectBase

An Eclipse Simulation Well

Name

Type:: str

Methods Summary

`case`()
`cells`(timestep)	Get reservoir cells the simulation well is defined for
`status`(timestep)	Get simulation well status

Methods Documentation

case() → Case | None

cells(timestep: int) → List[SimulationWellCellInfo]

Get reservoir cells the simulation well is defined for

SimulationWellCellInfo class description:

Parameter   | Description                                               | Type
----------- | --------------------------------------------------------- | -----
ijk         | Cell IJK location                                         | Vec3i
grid_index  | Grid index                                                | int
is_open     | True if connection to is open at the specified time step  | bool
branch_id   |                                                           | int
segment_id  |                                                           | int

Parameters:: timestep (int) -- Time step index
Returns:: List of SimulationWellCellInfo

status(timestep: int) → List[SimulationWellStatus]

Get simulation well status

SimulationWellStatus class description:

Parameter   | Description                                                   | Type
----------- | ------------------------------------------------------------- | -----
well_type   | Well type as string                                           | string
is_open     | True if simulation well is open at the specified time step    | bool

Parameters:: timestep (int) -- Time step index