pywfm.IWFMModel.get_stream_nodes_upstream_of_stream_node#

IWFMModel.get_stream_nodes_upstream_of_stream_node(stream_node_id)#

Return an array of the stream node ids immediately upstream of the provided stream node id

Parameters:: stream_node_id (int) – stream node id used to determine upstream stream nodes
Returns:: integer array of stream node ids upstream of the provided stream node id
Return type:: np.ndarray

Note

stream node ids returned are for the stream node immediately upstream of the specified stream node id only. if stream node specified is the most upstream node, None is returned

See also

IWFMModel.get_n_stream_nodes_upstream_of_stream_node: Return the number of stream nodes immediately upstream of the provided stream node id
IWFMModel.get_n_stream_nodes: Return the number of stream nodes in an IWFM model
IWFMModel.get_stream_node_ids: Return an array of stream node IDs in an IWFM model

Examples

>>> from pywfm import IWFMModel
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(pp_file, sim_file)
>>> print(model.get_stream_nodes_upstream_of_stream_node(11))
None
>>> model.kill()
>>> model.close_log_file()

>>> from pywfm import IWFMModel
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(pp_file, sim_file)
>>> model.get_stream_nodes_upstream_of_stream_node(2)
array([1])
>>> model.kill()
>>> model.close_log_file()