pywatershed.PRMSChannelFlowNode

class pywatershed.PRMSChannelFlowNode(control, tsi, ts, c0, c1, c2, calc_method=None)

A FlowNode for the Muskingum-Mann method of PRMSChannel

This is a FlowNode implementation of PRMSChannel where the solution is the so-called Muskingum-Mann method.

See FlowGraph for discussion and a worked example. The notebook examples/06_flow_graph_starfit.ipynb highlights adding a StarfitFlowNode a FlowGraph otherwised comprised of PRMSChannelFlowNodes using the helper functions prms_channel_flow_graph_to_model_dict() and prms_channel_flow_graph_postprocess().

__init__(control, tsi, ts, c0, c1, c2, calc_method=None)

Initialize a PRMSChannelFlowNode.

Parameters:

• control (Control) – A Control object.

• tsi (int64) – Parameter of PRMSChannel.

• ts (float64) – Parameter of PRMSChannel.

• c0 (float64) – Parameter of PRMSChannel.

• c1 (float64) – Parameter of PRMSChannel.

• c2 (float64) – Parameter of PRMSChannel.

• calc_method (Literal['numba', 'numpy']) – One of “numba”, “numpy” (default).

Methods

__init__(control, tsi, ts, c0, c1, c2[, ...])	Initialize a PRMSChannelFlowNode.
advance()	Advance this FlowNode to the next timestep.
calculate_subtimestep(ihr, inflow_upstream, ...)	Calculate the subtimestep.
finalize_timestep()	Finalize the current timestep at this FlowNode.
prepare_timestep()	Prepare the subtimestep for subtimestep calculations.

Attributes

outflow	The average outflow over the timestep in cubic feet per second.
outflow_substep	The outflow over the sub-timestep in cubic feet per second.
sink_source	The sink or source amount of the FlowNode at the current subtimestep.
storage	The volumetric storage in millions of cubic feet.
storage_change	The volumetric storage change in cubic feet.

advance()

Advance this FlowNode to the next timestep.

calculate_subtimestep(ihr, inflow_upstream, inflow_lateral)

Calculate the subtimestep.

Parameters:

• isubstep – Zero-based integer indicating the index of the current substep.

• inflow_upstream – The in-channel flows to this FlowNode on the current substep.

• inflow_lateral – The later flows to this FlowNode on the current substep.

finalize_timestep()

Finalize the current timestep at this FlowNode.

property outflow

The average outflow over the timestep in cubic feet per second.

property outflow_substep

The outflow over the sub-timestep in cubic feet per second.

prepare_timestep()

Prepare the subtimestep for subtimestep calculations.

property sink_source

The sink or source amount of the FlowNode at the current subtimestep.

property storage

The volumetric storage in millions of cubic feet. Not defined for PRMSChannel.

property storage_change

The volumetric storage change in cubic feet.