design_capacities
design_capacities
Set the unknown capacities of Pumps and Outlets from the area they drain or supply.
This uses the same design discharges and supply as the parametrization of the vrij afwaterend models, see ribasim_nl.parametrization.static_data_xlsx.defaults: per day, a drainage Pump discharges 15 mm and a drainage Outlet 50 mm over the area it drains, and a supplying Pump or Outlet supplies 4 mm over the area downstream. The drainage of each water body is split over the drains out of it, and each node is limited by what can flow into and out of the water bodies around it.
Functions
| Name | Description |
|---|---|
| design_capacities | Compute the design capacity of each Pump and Outlet in function_table from the area it drains or supplies. |
| known_capacities | Get the largest max_flow_rate by node_id of the Pumps and Outlets with meta_known_flow_rate. |
| set_design_capacities | Set the unknown capacities of the Pumps and Outlets to their design capacity, see design_capacities. |
design_capacities
design_capacities.design_capacities(model, function_table)Compute the design capacity of each Pump and Outlet in function_table from the area it drains or supplies.
A drain node gets its share of the drainage of the water body it comes from, see _split_drainage, and a supply node the area of the Basins downstream, up to the drain nodes. A flow_control node passes water in both directions, and gets the larger of both. A supply node that supplies no Basin, such as one out of the model, supplies the area upstream instead. The area of bergend Basins is left out, as it is the same as that of their doorgaand Basin. Finally the capacities are limited by the nodes around them, see _limit_by_neighbours.
Parameters
model : Model The model, with the Basin areas, and Pump and Outlet static tables with a meta_known_flow_rate column. function_table : pd.DataFrame The function of the Pumps and Outlets by node_id: drain, supply or flow_control, see ribasim_nl.control.add_function_to_peilbeheerst_node_table.
Returns
pd.DataFrame By node_id, the drained and supplied area in m2, the design capacity from that area, and the capacity limited by the nodes around it, in m3/s.
known_capacities
design_capacities.known_capacities(model)Get the largest max_flow_rate by node_id of the Pumps and Outlets with meta_known_flow_rate.
set_design_capacities
design_capacities.set_design_capacities(model, function_table)Set the unknown capacities of the Pumps and Outlets to their design capacity, see design_capacities.
Capacities are known where meta_known_flow_rate is set in the static table; these are kept, as are those of nodes that drain or supply no Basin. The flow_rate of all nodes is set to their max_flow_rate, except in the control states that switch them off.
Parameters
model : Model The model, with Pump and Outlet static tables with a meta_known_flow_rate column. function_table : pd.DataFrame The function of the Pumps and Outlets by node_id: drain, supply or flow_control, see ribasim_nl.control.add_function_to_peilbeheerst_node_table.
Returns
pd.DataFrame The design capacities, see design_capacities, and whether each capacity was known.