ResSimpy.Nexus.DataModels.Network.NexusWellConnection.NexusWellConnection

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

Bases: WellConnection

Nexus implementation of the Well Connection class.

stream

COMMENT (STREAM)

Type:: str

number

COMMENT (NUMBER)

Type:: int

scale

COMMENT (SCALE)

Type:: float

bhdepth

COMMENT (BHDEPTH)

Type:: float

datum_depth

COMMENT (DATUM)

Type:: float

x_pos

COMMENT (X)

Type:: float

y_pos

COMMENT (Y)

Type:: float

gradient_calc

COMMENT (DATGRAD)

Type:: str

length

COMMENT (LENGTH)

Type:: float

bottomhole_measured_depth

COMMENT (BHMD)

Type:: float

add_tubing

COMMENT (ADDTUBING)

Type:: int

diameter

COMMENT (DIAM)

Type:: float

inner_diameter

COMMENT (INNERDIAM)

Type:: float

roughness

COMMENT (ROUGHNESS)

Type:: float

tracer

COMMENT (TRACERS)

Type:: str

con_type

COMMENT (TYPE)

Type:: str

hyd_method

COMMENT (METHOD)

Type:: str

pvt_method

COMMENT (IPVT)

Type:: int

water_method

COMMENT (IWAT)

Type:: int

bat_method

COMMENT (IBAT)

Type:: int

temperature

COMMENT (TEMP)

Type:: float

elevation_profile

COMMENT (ELEVPR)

Type:: str

temperature_profile

COMMENT (TEMPPR)

Type:: str

inj_mobility

COMMENT (INJMOB)

Type:: str

crossshut_method

COMMENT (CROSS_SHUT)

Type:: str

crossflow

COMMENT (CROSSFLOW)

Type:: str

on_time

COMMENT (ONTIME)

Type:: float

heat_transfer_coeff

COMMENT (HTC)

Type:: float

water_inj_mult

COMMENT (WIMULT)

Type:: float

productivity_index

COMMENT (PI)

Type:: float

vip_productivity_index

COMMENT (VIPPI)

Type:: float

productivity_index_phase

COMMENT (PIPHASE)

Type:: float

d_factor

COMMENT (D)

Type:: float

non_darcy_flow_model

COMMENT (ND)

Type:: str

non_darcy_flow_method

COMMENT (DPERF)

Type:: str

gas_mobility

COMMENT (GASMOB)

Type:: float

capillary_number_model

COMMENT (CN)

Type:: str

dp_add

COMMENT (DPADD)

Type:: float

dt_add

COMMENT (DTADD)

Type:: float

rate_mult

COMMENT (RATEMULT)

Type:: float

polymer

COMMENT (POLYMER)

Type:: str

station

COMMENT (STATION)

Type:: str

drill_queue

COMMENT (ASSCDR)

Type:: str

drill_order_benefit

COMMENT (BENEFIT).

Type:: float

Public Data Attributes:

`bh_node_name`
`wh_node_name`
`stream`
`number`
`scale`
`gradient_calc`
`bottomhole_measured_depth`
`add_tubing`
`tracer`
`con_type`
`hyd_method`
`pvt_method`
`water_method`
`bat_method`
`elevation_profile`
`temperature_profile`
`inj_mobility`
`crossshut_method`
`crossflow`
`on_time`
`heat_transfer_coeff`
`water_inj_mult`
`vip_productivity_index`
`productivity_index_phase`
`d_factor`
`non_darcy_flow_model`
`non_darcy_flow_method`
`gas_mobility`
`capillary_number_model`
`dp_add`
`dt_add`
`rate_mult`
`polymer`
`station`
`drill_queue`
`drill_order_benefit`

Inherited from WellConnection

`name`
`date`
`unit_system`
`bhdepth`
`datum_depth`
`x_pos`
`y_pos`
`length`
`temperature`
`diameter`
`roughness`
`inner_diameter`
`productivity_index`

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 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.