ResSimpy.Nexus.DataModels.Network.NexusWellbore.NexusWellbore

class ResSimpy.Nexus.DataModels.Network.NexusWellbore.NexusWellbore(properties_dict: dict[str, None | int | str | float])[source]

Bases: Wellbore

Attributes date (str): string representation of the last defined date unit_system (UnitSystem): unit system enum name (str): Name of the well. (WELL) flowsect (int): Number of the flow section. (FLOWSECT) diameter (float): Diameter of the well. (DIAM) inner_diameter (float): Inner diameter of the well. (INNERDIAM) roughness (float): Roughness of the well. (ROUGHNESS) bore_type (str): Type of well. (TYPE) hyd_method (str): hydraulic method. (METHOD) temperature (float): Temperature of the well. (TEMP) elevation_profile (str): Elevation profile of the well. (ELEVPR) temperature_profile (str): Temperature profile of the well. (TEMPPR) heat_transfer_coeff (float): Heat transfer coefficient of the well. (HTC) pvt_method (int): Method number used for PVT. (IPVT) water_method (int): Method number used for water. (IWAT).

Public Data Attributes:

`flowsect`
`bore_type`
`hyd_method`
`temperature`
`elevation_profile`
`temperature_profile`
`heat_transfer_coeff`
`pvt_method`
`water_method`

Inherited from Wellbore

`date`
`unit_system`
`name`
`diameter`
`inner_diameter`
`roughness`

Inherited from DataObjectMixin

`id`	Unique identifier for each object.

Methods:

`__init__`(properties_dict)
`get_keyword_mapping`()	Gets the mapping of nexus keywords to attribute definitions.
`__repr__`()	Return repr(self).
`__eq__`(other)	Return self==value.

Inherited from Wellbore

`__init__`([_DataObjectMixin__id, date, ...])
`__repr__`()	Return repr(self).
`__eq__`(other)	Return self==value.

Inherited from DataObjectMixin

`__init__`(properties_dict)
`to_dict`([keys_in_keyword_style, add_date, ...])	Returns a dictionary of the attributes of the object.
`to_table_line`(headers)	Takes a generic Nexus object and returns the attribute values as a string in the order of headers provided.
`get_keyword_mapping`()	Gets the mapping of keywords to attribute definitions.
`__repr__`()	Return repr(self).
`__eq__`(other)	Return self==value.

__init__(properties_dict: dict[str, None | int | str | float]) → None[source]

static get_keyword_mapping() → dict[str, tuple[str, type]][source]: Gets the mapping of nexus keywords to attribute definitions.

property id: UUID: Unique identifier for each object.

to_dict(keys_in_keyword_style: bool = False, add_date: bool = True, add_units: bool = True, include_nones: bool = True) → dict[str, None | str | int | float]

Returns a dictionary of the attributes of the object.

Parameters:

include_nones (bool) –
keys_in_keyword_style (bool) – if True returns the key values as simulator keywords, otherwise returns the attribute name as stored by ressimpy.

Returns:

a dictionary keyed by attributes and values as the value of the attribute

to_table_line(headers: list[str]) → str

Takes a generic Nexus object and returns the attribute values as a string in the order of headers provided. Requires an implemented to_dict method and get_keyword_mapping() method.

Parameters:: headers (list[str]) – list of header values in keyword format
Returns:: string of the values in the order of the headers provided.