pywfm.IWFMModel.get_n_stream_nodes_upstream_of_stream_node#

IWFMModel.get_n_stream_nodes_upstream_of_stream_node(stream_node_id)#

Return the number of stream nodes immediately upstream of the provided stream node id

Parameters:: stream_node_id (int, np.int32) – stream node id used to determine number of stream nodes upstream
Returns:: number of stream nodes immediately upstream of given stream node
Return type:: int

Note

Most stream nodes will only have 1 stream node immediately upstream. The upstream-most stream node has no upstream stream nodes and will return 0. Stream nodes at a confluence of two stream reaches will return a value 2

See also

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
IWFMModel.get_stream_nodes_upstream_of_stream_node: Return an array of the stream node ids immediately upstream of the provided stream node id

Example

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