ResSimpy.Nexus.DataModels.Network.NexusConstraint.NexusConstraint

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

Bases: Constraint

Attributes: name (str): name of the well (NAME) max_surface_oil_rate (float): max surface oil rate (QOSMAX) max_surface_gas_rate (float): max surface gas rate (QGSMAX) max_surface_water_rate (float): max surface (QWSMAX) max_surface_liquid_rate (float): max surface liquid rate (QLIQSMAX) max_hc_molar_rate (float): Max hc molar rate (QMHCMAX) max_reverse_surface_oil_rate (float): max reverse surface oil rate (QOSMAX-) max_reverse_surface_gas_rate (float): max reverse surface gas rate (QGSMAX-) max_reverse_surface_water_rate (float): max reverse surface water rate (QWSMAX-) max_reverse_surface_liquid_rate (float): max reverse surface liquid rate (QLIQSMAX-) max_reservoir_oil_rate (float): max reservoir oil rate (QOMAX) max_reservoir_gas_rate (float): max reservoir gas rate (QGMAX) max_reservoir_water_rate (float): max reservoir water rate (QWMAX) max_reservoir_liquid_rate (float): max reservoir liquid rate (QLIQMAX) max_reservoir_total_fluids_rate (float): max reservoir total fluids rate (QALLMAX) max_reservoir_hc_rate (float): max reservoir hc rate (QHCMAX) max_reverse_reservoir_oil_rate (float): max reverse reservoir oil rate (QOMAX-) max_reverse_reservoir_gas_rate (float): max reverse reservoir gas rate (QGMAX-) max_reverse_reservoir_water_rate (float): max reverse reservoir water rate (QWMAX-) max_reverse_reservoir_liquid_rate (float): max reverse reservoir liquid rate (QLIQMAX-) max_reverse_reservoir_total_fluids_rate (float): max reverse reservoir total fluids rate (QALLMAX-) max_reverse_reservoir_hc_rate (float): max reverse reservoir hc rate (QHCMAX-) min_pressure (float): min pressure (PMIN) max_pressure (float): max pressure (PMAX) max_wag_water_pressure (float): max wag water pressure (PWMAX) max_wag_gas_pressure (float): max wag gas pressure (PGMAX) bottom_hole_pressure (float): bottom hole pressure (BHP) tubing_head_pressure (float): tubing head pressure (THP) min_surface_oil_rate (float): min surface oil rate (QOSMIN) min_surface_gas_rate (float): min surface gas rate (QGSMIN) min_surface_water_rate (float): min surface water rate (QWSMIN) min_surface_liquid_rate (float): min surface liquid rate (QLIQSMIN) min_reservoir_oil_rate (float): min reservoir oil rate (QOMIN) min_reservoir_gas_rate (float): min reservoir gas rate (QGMIN) min_reservoir_water_rate (float): min reservoir water rate (QWMIN) min_reservoir_liquid_rate (float): min reservoir liquid rate (QLIQMIN) min_reservoir_total_fluids_rate (float): min reservoir total fluids rate (QALLMIN) min_reservoir_hc_rate (float): min reservoir hc rate (QHCMIN) min_reverse_surface_oil_rate (float): min reservoir oil rate (QOSMIN-) min_reverse_surface_gas_rate (float): min reservoir gas rate (QGSMIN-) min_reverse_surface_water_rate (float): min reservoir water rate (QWSMIN-) min_reverse_surface_liquid_rate (float): min reservoir liquid rate (QLIQSMIN-) min_reverse_reservoir_oil_rate (float): min reverse reservoir oil rate (QOMIN-) min_reverse_reservoir_gas_rate (float): min reverse reservoir gas rate (QGMIN-) min_reverse_reservoir_water_rate (float): min reverse reservoir water rate (QWMIN-) min_reverse_reservoir_liquid_rate (float): min reverse reservoir liquid rate (QLIQMIN-) min_reverse_reservoir_total_fluids_rate (float): min reverse reservoir total fluids rate (QALLMIN-) min_reverse_reservoir_hc_rate (float): min reverse reservoir hc rate (QHCMIN-) max_watercut (float): max watercut (WCUTMAX) max_watercut_plug (float): max watercut plug (WCUTPLUG) max_watercut_plugplus (float): max watercut plugplus (WCUTPLUGPLUS) max_watercut_perf (float): max watercut perf (WCUTPERF) max_watercut_perfplus (float): max watercut perfplus (WCUTPERFPLUS) max_wor (float): max wor (WORMAX) max_wor_plug (float): max wor plug (WORPLUG) max_wor_plug_plus (float): max wor plug plus (WORPLUGPLUS) max_wor_perf (float): max wor perf (WORPERF) max_wor_perfplus (float): max wor perfplus (WORPERFPLUS) max_gor (float): max gor (GORMAX) max_gor_plug (float): max gor plug (GORPLUG) max_gor_plug_plus (float): max gor plug plus (GORPLUGPLUS) max_gor_perf (float): max gor perf (GORPERF) max_gor_perfplus (float): max gor perfplus (GORPERFPLUS) max_lgr (float): max lgr (LGRMAX) max_lgr_plug (float): max lgr plug (LGRPLUG) max_lgr_plug_plus (float): max lgr plug plus (LGRPLUGPLUS) max_lgr_perf (float): max lgr perf (LGRPERF) max_lgr_perfplus (float): max lgr perfplus (LGRPERFPLUS) max_cum_gas_prod (float): max cum gas prod (CGLIM) max_cum_water_prod (float): max cum water prod (CWLIM) max_cum_oil_prod (float): max cum oil prod (COLIM).

artificial_lift_number (int): artificial lift number within the hydraulic table (ALQ) max_choke_setting (float): maximum choke/ICD/valve setting (SETTING) min_gas_lift_efficiency (float): minimum gas lift efficiency below which the connection will be shut in(GLEFMIN) gl_additive_correction (float): additive correction term to value of gas/liquid ratio from optimal gl tables (GLRADD) active_node (bool): active/inactive node/well (ACTIVATE) pump_power (float): power for the pump (POWER) pump_speed (float): maximum speed of the pump/esp/compressor (SPEED) choke_limit (str): ON/OFF for whether the esp should exceed the choke limit (CHOKELIMIT) manifold_position (int): position in the manifold for the well (POSITION)

Public Data Attributes:

`name`
`well_name`
`max_surface_oil_rate`
`max_surface_gas_rate`
`max_surface_water_rate`
`max_surface_liquid_rate`
`max_hc_molar_rate`
`max_reverse_surface_oil_rate`
`max_reverse_surface_gas_rate`
`max_reverse_surface_water_rate`
`max_reverse_surface_liquid_rate`
`max_reservoir_oil_rate`
`max_reservoir_gas_rate`
`max_reservoir_water_rate`
`max_reservoir_liquid_rate`
`max_reservoir_total_fluids_rate`
`max_reservoir_hc_rate`
`max_reverse_reservoir_oil_rate`
`max_reverse_reservoir_gas_rate`
`max_reverse_reservoir_water_rate`
`max_reverse_reservoir_liquid_rate`
`max_reverse_reservoir_total_fluids_rate`
`max_reverse_reservoir_hc_rate`
`max_avg_comp_dp`
`max_comp_dp`
`min_pressure`
`max_pressure`
`max_wag_water_pressure`
`max_wag_gas_pressure`
`bottom_hole_pressure`
`tubing_head_pressure`
`min_reverse_surface_oil_rate`
`min_reverse_surface_gas_rate`
`min_reverse_surface_water_rate`
`min_reverse_surface_liquid_rate`
`min_surface_oil_rate`
`min_surface_gas_rate`
`min_surface_water_rate`
`min_surface_liquid_rate`
`min_reservoir_oil_rate`
`min_reservoir_gas_rate`
`min_reservoir_water_rate`
`min_reservoir_liquid_rate`
`min_reservoir_total_fluids_rate`
`min_reservoir_hc_rate`
`min_reverse_reservoir_oil_rate`
`min_reverse_reservoir_gas_rate`
`min_reverse_reservoir_water_rate`
`min_reverse_reservoir_liquid_rate`
`min_reverse_reservoir_total_fluids_rate`
`min_reverse_reservoir_hc_rate`
`max_watercut`
`max_watercut_plug`
`max_watercut_plugplus`
`max_watercut_perf`
`max_watercut_perfplus`
`max_wor`
`max_wor_plug`
`max_wor_plug_plus`
`max_wor_perf`
`max_wor_perfplus`
`max_gor`
`max_gor_plug`
`max_gor_plug_plus`
`max_gor_perf`
`max_gor_perfplus`
`gor_limit`
`gor_limit_exponent`
`gor_limit_frequency`
`max_lgr`
`max_lgr_plug`
`max_lgr_plug_plus`
`max_lgr_perf`
`max_lgr_perfplus`
`max_cum_gas_prod`
`max_cum_water_prod`
`max_cum_oil_prod`
`max_qmult_total_reservoir_rate`
`convert_qmult_to_reservoir_barrels`
`qmult_oil_rate`
`qmult_water_rate`
`qmult_gas_rate`
`use_qmult_qoil_surface_rate`
`use_qmult_qwater_surface_rate`
`use_qmult_qgas_surface_rate`
`use_qmult_qoilqwat_surface_rate`
`artificial_lift_number`
`max_choke_setting`
`min_gas_lift_efficiency`
`gl_additive_correction`
`active_node`
`pump_power`
`pump_speed`
`choke_limit`
`manifold_position`
`clear_all`
`clear_q`
`clear_limit`
`clear_alq`
`clear_p`

Inherited from Constraint

`name`
`date`
`unit_system`
`max_surface_oil_rate`
`max_surface_gas_rate`
`max_surface_water_rate`
`max_surface_liquid_rate`
`max_reservoir_oil_rate`
`max_reservoir_gas_rate`
`max_reservoir_water_rate`
`max_reservoir_liquid_rate`
`id`	Unique identifier for each Node object.

Methods:

`__init__`(properties_dict)
`get_keyword_mapping`()	Gets the mapping of nexus keywords to attribute definitions.
`get_rate_constraints_map`()
`get_pressure_constraints_map`()
`get_limit_constraints_map`()
`get_alq_constraints_map`()	Gets the nexus mapping for artificial lift constraints.
`to_dict`([keys_in_nexus_style])	Returns a dictionary of the attributes of the Constraint.
`update`(new_data[, nones_overwrite])	Updates attributes in the object based on the dictionary provided.
`to_table_line`()	String representation of the constraint for entry to an inline constraint table.
`write_qmult_table`()	Writes out a QMULT table from a constraint that uses the following attributes.
`write_qmult_values`()	Writes out the values for a QMULT table, callable on its own or using the write_qmult_table method.
`__repr__`()	Return repr(self).
`__eq__`(other)	Return self==value.

Inherited from Constraint

`to_dict`()
`new_id`()	Refreshes the id on the object.
`__repr__`()	Return repr(self).
`__init__`([name, date, unit_system, ...])
`__eq__`(other)	Return self==value.

__init__(properties_dict: dict[str, None | int | str | float | ResSimpy.Enums.UnitsEnum.UnitSystem]) → None[source]

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

static get_alq_constraints_map() → dict[str, tuple[str, type]][source]: Gets the nexus mapping for artificial lift constraints.

to_dict(keys_in_nexus_style: bool = False) → dict[str, None | str | int | float][source]

Returns a dictionary of the attributes of the Constraint.

Parameters:: keys_in_nexus_style (bool) – if True returns the key values in Nexus keywords, otherwise returns the attribute name as stored by ressimpy.
Returns:: a dictionary keyed by attributes and values as the value of the attribute

update(new_data: dict[str, None | int | str | float | ResSimpy.Enums.UnitsEnum.UnitSystem], nones_overwrite: bool = False)[source]: Updates attributes in the object based on the dictionary provided.

to_table_line() → str[source]: String representation of the constraint for entry to an inline constraint table.

write_qmult_table() → list[str][source]

Writes out a QMULT table from a constraint that uses the following attributes. ‘QOIL’: (‘qmult_oil_rate’, float). ‘QWATER’: (‘qmult_water_rate’, float). ‘QGAS’: (‘qmult_gas_rate’, float).

Returns:: list[str] with a representation of the QMULT table with a new line as a new entry in the list.

write_qmult_values() → str[source]: Writes out the values for a QMULT table, callable on its own or using the write_qmult_table method.

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

new_id(): Refreshes the id on the object.