pywatershed.PassThroughFlowNode#

class pywatershed.PassThroughFlowNode(control)[source]#

A FlowNode instance that gives what it takes and dosent store.

See FlowGraph for a worked example using PassThroughFlowNode.

__init__(control)[source]#

Initialize a PassThroughFlowNode.

Parameters:

control (Control) – A control object.

Methods

__init__(control)

Initialize a PassThroughFlowNode.

advance()

Advance this FlowNode to the next timestep.

calculate_subtimestep(isubstep, ...)

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 of the FlowNode over the current timestep.

outflow_substep

The outflow of the FlowNode over the sub-timestep.

sink_source

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

storage

The storage of the FlowNode at the current subtimestep.

storage_change

The storage change of the FlowNode at the current subtimestep.

advance()[source]#

Advance this FlowNode to the next timestep.

calculate_subtimestep(isubstep, inflow_upstream, inflow_lateral)[source]#

Calculate the subtimestep.

Parameters:
  • isubstep (int) – Zero-based integer indicating the index of the current substep.

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

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

finalize_timestep()[source]#

Finalize the current timestep at this FlowNode.

property outflow#

The average outflow of the FlowNode over the current timestep.

property outflow_substep#

The outflow of the FlowNode over the sub-timestep.

prepare_timestep()[source]#

Prepare the subtimestep for subtimestep calculations.

property sink_source#

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

property storage#

The storage of the FlowNode at the current subtimestep.

property storage_change#

The storage change of the FlowNode at the current subtimestep.