from __future__ import annotations
from dataclasses import dataclass, field
from typing import Optional, TYPE_CHECKING
from uuid import UUID
import pandas as pd
from ResSimpy.File import File
from ResSimpy.Nexus.nexus_add_new_object_to_file import AddObjectOperations
from ResSimpy.Nexus.nexus_collect_tables import collect_all_tables_to_objects
from ResSimpy.Nexus.DataModels.Network.NexusWellhead import NexusWellhead
from ResSimpy.Enums.UnitsEnum import UnitSystem
from ResSimpy.Nexus.nexus_modify_object_in_file import ModifyObjectOperations
from ResSimpy.Nexus.nexus_remove_object_from_file import RemoveObjectOperations
from ResSimpy.Utils.obj_to_dataframe import obj_to_dataframe
from ResSimpy.Wellheads import Wellheads
if TYPE_CHECKING:
from ResSimpy.Nexus.NexusNetwork import NexusNetwork
[docs]@dataclass
class NexusWellheads(Wellheads):
__wellheads: list[NexusWellhead] = field(default_factory=list)
[docs] def __init__(self, parent_network: NexusNetwork) -> None:
self.__parent_network: NexusNetwork = parent_network
self.__wellheads: list[NexusWellhead] = []
self.__add_object_operations = AddObjectOperations(NexusWellhead, self.table_header, self.table_footer,
self.__parent_network.model)
self.__remove_object_operations = RemoveObjectOperations(self.__parent_network, self.table_header,
self.table_footer)
self.__modify_object_operations = ModifyObjectOperations(self)
[docs] def get_all(self) -> list[NexusWellhead]:
"""Returns a list of wellheads loaded from the simulator."""
self.__parent_network.get_load_status()
return self.__wellheads
[docs] def get_by_name(self, name: str) -> Optional[NexusWellhead]:
"""Returns a single wellhead with the provided name loaded from the simulator.
Args:
name (str): name of the requested well connection
Returns:
NexusWellhead: which has the same name as requested
"""
to_return = filter(lambda x: False if x.name is None else x.name.upper() == name.upper(),
self.__wellheads)
return next(to_return, None)
def get_df(self) -> pd.DataFrame:
return obj_to_dataframe(self.__wellheads)
def get_overview(self) -> str:
raise NotImplementedError('To be implemented')
def load(self, surface_file: File, start_date: str, default_units: UnitSystem) -> None:
new_wellheads = collect_all_tables_to_objects(surface_file, {'WELLHEAD': NexusWellhead},
start_date=start_date,
default_units=default_units)
wellheads_list = new_wellheads.get('WELLHEAD')
if isinstance(wellheads_list, dict):
raise ValueError('Incompatible data format for additional wells. Expected type "list" instead got "dict"')
self._add_to_memory(wellheads_list)
def _add_to_memory(self, additional_list: Optional[list[NexusWellhead]]) -> None:
"""Extends the wellhead object by a list of wellheads provided to it.
Args:
additional_list (list[NexusWellhead]): list of nexus wellheads to add to the wellhead list.
"""
if additional_list is None:
return
self.__wellheads.extend(additional_list)
[docs] def remove(self, obj_to_remove: dict[str, None | str | float | int] | UUID) -> None:
"""Remove a wellhead from the network based on the properties matching a dictionary or id.
Args:
obj_to_remove (UUID | dict[str, None | str | float | int]): UUID of the wellhead to remove or a dictionary \
with sufficient matching parameters to uniquely identify a wellhead
"""
self.__remove_object_operations.remove_object_from_network_main(
obj_to_remove, self._network_element_name, self.__wellheads)
[docs] def add(self, obj_to_remove: dict[str, None | str | float | int]) -> None:
"""Adds a wellhead to a network, taking a dictionary with properties for the new wellhead.
Args:
obj_to_remove (dict[str, None | str | float | int]): dictionary taking all the properties for the new
wellhead.
Requires date and a name.
"""
new_object = self.__add_object_operations.add_network_obj(obj_to_remove, NexusWellhead, self.__parent_network)
self._add_to_memory([new_object])
[docs] def modify(self, obj_to_modify: dict[str, None | str | float | int],
new_properties: dict[str, None | str | float | int]) -> None:
"""Modifies an existing wellhead based on a matching dictionary of properties.
(partial matches allowed if precisely 1 matching node is found).
Updates the properties with properties in the new_properties dictionary.
Args:
obj_to_modify (dict[str, None | str | float | int]): dictionary containing attributes to match in the
existing wellheads.
new_properties (dict[str, None | str | float | int]): properties to switch to in the new wellhead
"""
self.__parent_network.get_load_status()
self.__modify_object_operations.modify_network_object(obj_to_modify, new_properties,
self.__parent_network)
@property
def table_header(self) -> str:
"""Start of the wellhead definition table."""
return 'WELLHEAD'
@property
def table_footer(self) -> str:
"""End of the wellhead definition table."""
return 'END' + self.table_header