mirror of
https://github.com/OPM/ResInsight.git
synced 2026-08-27 05:37:21 -05:00
Magne Sjaastad
544e9eedd9
* Configures automated spell checking with codespell Adds GitHub workflows and configuration files for automated spell checking using `codespell`. This includes: - A workflow for checking pull requests and preventing new typos - A workflow for automatically fixing typos in the main codebase - Configuration files for `codespell` to ignore specific terms and file types - Documentation on how to use and configure the spell checking workflows. * Corrects minor spelling and grammar errors.
104 lines
3.2 KiB
Python
104 lines
3.2 KiB
Python
"""
|
|
ResInsight SimulationWell
|
|
"""
|
|
|
|
import grpc
|
|
|
|
import SimulationWell_pb2
|
|
import SimulationWell_pb2_grpc
|
|
|
|
import PdmObject_pb2
|
|
|
|
from .resinsight_classes import SimulationWell
|
|
|
|
from .case import Case
|
|
from .view import View
|
|
from .pdmobject import add_method
|
|
|
|
from typing import List, Optional
|
|
|
|
|
|
@add_method(SimulationWell)
|
|
def __custom_init__(
|
|
self: SimulationWell, pb2_object: PdmObject_pb2.PdmObject, channel: grpc.Channel
|
|
) -> None:
|
|
self.__simulation_well_stub = SimulationWell_pb2_grpc.SimulationWellStub(channel)
|
|
|
|
|
|
@add_method(SimulationWell)
|
|
def status(
|
|
self: SimulationWell, timestep: int
|
|
) -> List[SimulationWell_pb2.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
|
|
|
|
Arguments:
|
|
timestep(int): Time step index
|
|
|
|
"""
|
|
sim_well_request = SimulationWell_pb2.SimulationWellRequest(
|
|
case_id=self.case().id, well_name=self.name, timestep=timestep
|
|
)
|
|
return self.__simulation_well_stub.GetSimulationWellStatus(sim_well_request)
|
|
|
|
|
|
@add_method(SimulationWell)
|
|
def cells(
|
|
self: SimulationWell, timestep: int
|
|
) -> List[SimulationWell_pb2.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
|
|
|
|
Arguments:
|
|
timestep(int): Time step index
|
|
|
|
Returns:
|
|
List of SimulationWellCellInfo
|
|
|
|
"""
|
|
sim_well_request = SimulationWell_pb2.SimulationWellRequest(
|
|
case_id=self.case().id, well_name=self.name, timestep=timestep
|
|
)
|
|
return self.__simulation_well_stub.GetSimulationWellCells(sim_well_request).data
|
|
|
|
|
|
@add_method(SimulationWell)
|
|
def accumulated_perforation_length(self: SimulationWell, timestep: int) -> float:
|
|
"""Get accumulated perforation length for the given timestep.
|
|
If a well is closed the length will be 0.
|
|
|
|
Arguments:
|
|
timestep(int): Time step index
|
|
|
|
"""
|
|
sim_well_request = SimulationWell_pb2.SimulationWellRequest(
|
|
case_id=self.case().id, well_name=self.name, timestep=timestep
|
|
)
|
|
return self.__simulation_well_stub.GetPerfLength(
|
|
sim_well_request
|
|
).accumulated_length
|
|
|
|
|
|
@add_method(SimulationWell)
|
|
def case(self: SimulationWell) -> Optional[Case]:
|
|
view = self.ancestor(View)
|
|
if view:
|
|
return view.case()
|
|
else:
|
|
return None
|