pywfm.IWFMModel.get_stream_reach_stream_nodes#

IWFMModel.get_stream_reach_stream_nodes(reach_id)#

Return the stream node IDs corresponding to stream nodes in a specified reach

Parameters:

reach_id (int) – stream reach ID to obtain the corresponding stream nodes

Returns:

integer array of stream node IDs corresponding to the stream reach

Return type:

np.ndarray

See also

IWFMModel.get_n_stream_reaches

Return the number of stream reaches in an IWFM model

IWFMModel.get_stream_reach_ids

Return an array of stream reach IDs in an IWFM model

IWFMModel.get_n_nodes_in_stream_reach

Return the number of stream nodes in a stream reach

IWFMModel.get_stream_reach_groundwater_nodes

Return the groundwater node IDs corresponding to stream nodes in a specified reach

IWFMModel.get_stream_reaches_for_stream_nodes

Return the stream reach IDs that correspond to a list of stream nodes

IWFMModel.get_upstream_nodes_in_stream_reaches

Return the IDs for the upstream stream node in each stream reach

IWFMModel.get_n_reaches_upstream_of_reach

Return the number of stream reaches immediately upstream of the specified reach

IWFMModel.get_reaches_upstream_of_reach

Return the IDs of the reaches that are immediately upstream of the specified reach

IWFMModel.get_downstream_node_in_stream_reaches

Return the IDs for the downstream stream node in each stream reach

IWFMModel.get_reach_outflow_destination

Return the destination index that each stream reach flows into

IWFMModel.get_reach_outflow_destination_types

Return the outflow destination types that each stream reach flows into.

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_reach_stream_nodes(1)
array([ 1,  2,  3,  4,  5,  6,  7,  8,  9, 10])
>>> model.kill()
>>> model.close_log_file()