ResSimpy.Nexus.DataModels.Network.NexusWellhead.NexusWellhead

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

Bases: Wellhead

Attributes well (str): Associates the wellhead to the well. (WELL) name (str): The name of the wellhead. (NAME) type (str): The type of well. (TYPE) depth (float): The depth of the wellhead (DEPTH) x_pos (float): The x-coordinate location of the wellhead (X) y_pos (float): The y-coordinate location of the wellhead (Y) pvt_method (int): The PVT table numbers to be used for the well and wellhead connections. (IPVT) water_method (int): The Water PVT table numbers to be used for the well and wellhead connections. (IWAT) bat_method (int): The separator battery numbers associated with the well and wellhead connections. (IBAT) measured_depth_in (float): The measured depth at the start of the well interval (MDIN) measured_depth_out (float): The measured depth at the end of the well interval (MDOUT) hyd_method (int): The hydraulic method used. (METHOD) number (int): The well number. (NUMBER) diameter (float): The wellbore diameter (DIAM) inner_diameter (float): The well inner diameter (INNERDIAM) roughness (float): The well roughness. (ROUGHNESS) length (float): The length of the well (LENGTH) temperature (float): The temperature of the fluid in the well (TEMP) elevation_profile (str): The well elevation profile. (ELEVPR) temperature_profile (str): The well temperature profile. (TEMPPR) dp_add (float): The additional pressure drop across the well (DPADD) rate_mult (float): The rate multiplier for the well. (RATEMULT) delta_depth (float): The depth difference between the two points in the connection (DDEPTH) heat_transfer_coeff (float): The heat transfer coefficient for the well (HTC) dt_add (float): The additional temperature difference across the well (DTADD).

Public Data Attributes:

`pvt_method`
`water_method`
`bat_method`
`measured_depth_in`
`measured_depth_out`
`hyd_method`
`number`
`diameter`
`inner_diameter`
`roughness`
`length`
`temperature`
`elevation_profile`
`temperature_profile`
`dp_add`
`rate_mult`
`delta_depth`
`heat_transfer_coeff`
`dt_add`

Inherited from Wellhead

`well`
`name`
`date`
`unit_system`
`wellhead_type`
`depth`
`x_pos`
`y_pos`

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 Wellhead

`__init__`([_DataObjectMixin__id, well, name, ...])
`__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.