ResSimpy.Nexus.DataModels.Network.NexusWellheads.NexusWellheads

class ResSimpy.Nexus.DataModels.Network.NexusWellheads.NexusWellheads(parent_network: 'NexusNetwork')

Bases: Wellheads

Public Data Attributes:

table_header	Start of the wellhead definition table.
table_footer	End of the wellhead definition table.

Inherited from NetworkOperationsMixIn

table_header
table_footer

Methods:

__init__(parent_network)
get_all()	Returns a list of wellheads loaded from the simulator.
get_by_name(name)	Returns a single wellhead with the provided name loaded from the simulator.
get_df()
get_overview()
load(surface_file, start_date, default_units)
remove(obj_to_remove)	Remove a wellhead from the network based on the properties matching a dictionary or id.
add(obj_to_remove)	Adds a wellhead to a network, taking a dictionary with properties for the new wellhead.
modify(obj_to_modify, new_properties)	Modifies an existing wellhead based on a matching dictionary of properties.
__repr__()	Return repr(self).
__eq__(other)	Return self==value.

Inherited from Wellheads

__init__(*[, _Wellheads__wellheads])
__repr__()	Return repr(self).
__eq__(other)	Return self==value.

Inherited from NetworkOperationsMixIn

__init__(parent_network)
get_all()
get_by_name(name)
get_df()
get_overview()
load(file, start_date, default_units)
remove(obj_to_remove)
add(obj_to_add)
modify(obj_to_modify, new_properties)

---

__init__(parent_network: NexusNetwork) → None

get_all() → list[ResSimpy.Nexus.DataModels.Network.NexusWellhead.NexusWellhead]

Returns a list of wellheads loaded from the simulator.

get_by_name(name: str) → NexusWellhead | None

Returns a single wellhead with the provided name loaded from the simulator.

Parameters:

name (str) – name of the requested well connection

Returns:

NexusWellhead – which has the same name as requested

remove(obj_to_remove: dict[str, None | str | float | int] | UUID) → None

Remove a wellhead from the network based on the properties matching a dictionary or id.

Parameters:

obj_to_remove (UUID | dict[str, None | str | float | int]) – UUID of the wellhead to remove or a dictionary with sufficient matching parameters to uniquely identify a wellhead

add(obj_to_remove: dict[str, None | str | float | int]) → None

Adds a wellhead to a network, taking a dictionary with properties for the new wellhead.

Parameters:

• obj_to_remove (dict[str, None | str | float | int]) – dictionary taking all the properties for the new

• wellhead. –

• name. (Requires date and a) –

modify(obj_to_modify: dict[str, None | str | float | int], new_properties: dict[str, None | str | float | int]) → None

Modifies an existing wellhead based on a matching dictionary of properties. (partial matches allowed if precisely 1 matching node is found). Updates the properties with properties in the new_properties dictionary.

Parameters:

• obj_to_modify (dict[str, None | str | float | int]) – dictionary containing attributes to match in the

• wellheads. (existing) –

• new_properties (dict[str, None | str | float | int]) – properties to switch to in the new wellhead

property table_header: str

Start of the wellhead definition table.

property table_footer: str

End of the wellhead definition table.