pywfm.IWFMModel.get_stream_rating_table#

IWFMModel.get_stream_rating_table(stream_node_id)#

Return the stream rating table for a specified stream node

Parameters:: stream_node_id (int) – stream node id used to return the rating table
Returns:: np.ndarrays representing stage and flow, respectively
Return type:: tuple (length=2)

See also

IWFMModel.get_n_rating_table_points: Return the number of data points in the stream flow rating table for a stream node
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_bottom_elevations: Return the stream channel bottom elevation at each stream node

Example

>>> from pywfm import IWFMModel
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(pp_file, sim_file)
>>> stage, flow = model.get_stream_rating_table(1)
>>> stage
array([ 0.,  2.,  5., 15., 25.])
>>> flow
array([0.00000000e+00, 6.34988160e+07, 2.85058656e+08, 1.64450304e+09,
3.59151408e+09])
>>> model.kill()
>>> model.close_log_file()