Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix description of FlowBoundary in docs #1950

Merged
merged 2 commits into from
Nov 25, 2024
Merged

Fix description of FlowBoundary in docs #1950

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b145b00
flow boundary docs fix
SouthEndMusic Nov 25, 2024
0da2560
Merge branch 'main' into fix_flow_boundary_docs
SouthEndMusic Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions docs/reference/node/flow-boundary.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,12 @@ title: "FlowBoundary"

A FlowBoundary adds water to the model at a specified flow rate.
It can be used as a boundary condition like a measured upstream flow rate, or lateral inflow.
We require that an edge connected to a FlowBoundary is always outgoing, and points towards a Basin.

# Tables

## Static

We require that the edge connecting the FlowBoundary to the Basin should point towards the Basin,
so that positive flow corresponds to water being added to the model.
The set flow rate will be pumped unless the intake storage (for a negative flow rate) is less than $10~\text{ m}^3$,
in which case the flow rate will be linearly reduced to $0~\text{ m}^3/s$.
Note that the connected node must always be a Basin.

column | type | unit | restriction
------------- | ------- | --------------------- | -----------
node_id | Int32 | - | sorted
Expand All @@ -24,7 +19,7 @@ flow_rate | Float64 | $\text{m}^3/\text{s}$ | non-negative
## Time

This table is the transient form of the `FlowBoundary` table.
The only differences are that a time column is added and the nodes are assumed to be active so this column is removed.
The only differences are that a time column is added and the nodes are assumed to be active so this column is not present.
The table must by sorted by time, and per time it must be sorted by `node_id`.
With this the flow rates can be updated over time. In between the given times the
flow rate is interpolated linearly, and outside the flow rate is constant given by the
Expand Down