ResSimpy.Nexus.DataModels.Network.NexusNodeConnection.NexusNodeConnection

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

Bases: NodeConnection

Attributes hyd_method: hydraulic lift correlation method used (METHOD) pvt_method: pvt method number (IPVT) water_method: water method number (IWAT) bat_method: bat method number (IBAT) elevation_profile: elevation profile as a string (ELEVPR) measured_depth_in: measured depth of the input node (MDIN) measured_depth_out: measured depth of the output node (MDOUT) diameter: diameter of the connecting pipe (DIAMETER) inner_diameter: outer diameter of the pipe (INNERDIAM) roughness: roughness of the pipe (ROUGHNESS) heat_transfer_coeff: the heat transfer coefficient of the pipe (HTC) temperature_profile: temperature profile used for the connection. (TEMPPR) length: length of the connection (LENGTH) delta_depth: change in depth between node_in and node_out (DDEPTH) connection_number: used in place of name as a numbered connection (NUMBER) seawater_profile: seawater profile used. (SEAWPR) rate_mult: multiplier to the rate (RATEMULT) polymer: whether polymer is a stream here (POLYMER) dp_add: Additional delta pressure (DPADD).

Public Data Attributes:

`hyd_method`
`pvt_method`
`bat_method`
`water_method`
`elevation_profile`
`measured_depth_in`
`measured_depth_out`
`diameter`
`inner_diameter`
`roughness`
`heat_transfer_coeff`
`temperature_profile`
`length`
`delta_depth`
`connection_number`
`seawater_profile`
`rate_mult`
`polymer`
`unit_system`
`dp_add`
`dt_add`

Inherited from NodeConnection

`name`
`date`
`node_in`
`node_out`
`con_type`
`depth`

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 NodeConnection

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