RiverSplitWithGauge Node
General Description
Section titled “General Description”The RiverSplitWithGauge node is a split in the river network with a minimum residual flow (MRF). As per RiverSplit but by default creates another route in the underlying object to model a MRF. This route is such that the MRF is not part of forced ratios. The intent of this object is to model the case where a proportion of flow can be abstracted above the MRF (e.g. 90% of flow above MRF). API Reference.
Primary Attributes
Section titled “Primary Attributes”| Name | Description | Required |
|---|---|---|
| mrf | The minimum residual flow (MRF) at the gauge | Required |
| mrf_cost | The cost of the route via the MRF | Required |
| cost | The cost of the other (unconstrained) route | Required |
| factors | The factors to force on the additional splits. Number of extra_slot is assumed to be one less than the length of factors (as per MultiSplitLink documentation) | Required |
| slot_names | The identifiers to refer to the slots when connect from this Node. Length must be one more than the number of extra slots required | Required |
Examples
Section titled “Examples”coming soon…