Completion#

class pyflowdiagnostics.well.Completion(I: int, J: int, K: int, stat: int)[source]#

Bases: object

Represents a well completion.

A completion defines a connection between a well and a grid cell. It stores information about the completion’s location, status (open or shut), and flow direction.

id#

Completion ID.

Type:

int

I#

I-index of the grid cell (1-based).

Type:

int

J#

J-index of the grid cell (1-based).

Type:

int

K#

K-index of the grid cell (1-based).

Type:

int

status#

Completion status (“OPEN” or “SHUT”).

Type:

str

IJK#

Linear index of the grid cell (1-based). This is set using the set_ijk method.

Type:

int

flow_rate#

Flow rate at the completion. Positive: injection, negative: production. This is set using the set_out_flow_rate method.

Type:

float

Methods Summary

set_flow_rate(val)

Sets the flow rate at the completion.

set_ijk(ijk)

Sets the linear grid cell index (IJK).

Methods Documentation

set_flow_rate(val: float) None[source]#

Sets the flow rate at the completion.

Parameters:

val (float) – Flow rate. Positive: injection, negative: production.

set_ijk(ijk: int) None[source]#

Sets the linear grid cell index (IJK).

Parameters:

ijk (int) – Linear index of the grid cell (1-based).