pywfm.IWFMModel.get_stream_node_ids#

IWFMModel.get_stream_node_ids()#

Return an array of stream node IDs in the IWFM model

Returns:: array of stream node IDs from the IWFM model
Return type:: np.ndarray

Note

The resulting integer array will have a length equal to the value returned by the get_n_stream_nodes method

See also

IWFMModel.get_n_stream_nodes: Return the number of stream nodes in an IWFM model
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_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_stream_node_ids()
array([ 1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12, 13, 14, 15, 16, 17,
       18, 19, 20, 21, 22, 23])
>>> model.kill()
>>> model.close_log_file()