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.

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

Remove using S for storage (use u) #1003

Merged
merged 1 commit into from
Jan 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 12 additions & 12 deletions docs/core/equations.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ $\mathbf{u}(t)$ is given by all the states of the model, which are (currently) t
Given a single basin with node ID $i \in B$, the equation that dictates the change of its storage over time is given by

$$
\frac{\text{d}S_i}{\text{d}t} =
\frac{\text{d}u_i}{\text{d}t} =
\sum_{(i',j') \in E | j' = i} Q_{i',j'} - \sum_{(i',j') \in E | i' = i} Q_{i',j'} + F_i(p,t).
$$

Expand Down Expand Up @@ -74,15 +74,15 @@ $$

Most of these terms are always $0$, because a flow over an edge only depends on a small number of states. Therefore the matrix $J$ is very sparse.

For many contributions to the Jacobian the derivative of the level $l(S)$ of a basin with respect to its storage $S$ is required. To get an expression for this, we first look at the storage as a function of the level:
For many contributions to the Jacobian the derivative of the level $l(u)$ of a basin with respect to its storage $u$ is required. To get an expression for this, we first look at the storage as a function of the level:

$$
S(l) = \int_{l_0}^l A(\ell)d\ell.
u(l) = \int_{l_0}^l A(\ell)d\ell.
$$

From this we obtain $S'(l) = A(l)$ and thus
From this we obtain $u'(l) = A(l)$ and thus
$$
\frac{\text{d}l}{\text{d}S} = \frac{1}{A(S)}.
\frac{\text{d}l}{\text{d}u} = \frac{1}{A(u)}.
$$

:::{.callout-note}
Expand Down Expand Up @@ -149,25 +149,25 @@ plt.show()
The precipitation term is given by

$$
Q_P = P \cdot A(S).
Q_P = P \cdot A(u).
$$ {#eq-precip}

Here $P = P(t)$ is the precipitation rate and $A$ is the wetted area. $A$ is a
function of the storage $S = S(t)$: as the volume of water changes, the area of the free water
function of the storage $u = u(t)$: as the volume of water changes, the area of the free water
surface may change as well, depending on the slopes of the surface waters.

## Evaporation

The evaporation term is given by

$$
Q_E = E_\text{pot} \cdot A(S) \cdot \phi(d;0.1).
Q_E = E_\text{pot} \cdot A(u) \cdot \phi(d;0.1).
$$ {#eq-evap}

Here $E_\text{pot} = E_\text{pot}(t)$ is the potential evaporation rate and $A$ is the wetted area. $\phi$ is the [reduction factor](equations.qmd#sec-reduction_factor) which depends on the depth $d$. It provides a smooth gradient as $S \rightarrow 0$.
Here $E_\text{pot} = E_\text{pot}(t)$ is the potential evaporation rate and $A$ is the wetted area. $\phi$ is the [reduction factor](equations.qmd#sec-reduction_factor) which depends on the depth $d$. It provides a smooth gradient as $u \rightarrow 0$.

A straightforward formulation $Q_E = \mathrm{max}(E_\text{pot} A(S),
0)$ is unsuitable, as $\frac{\mathrm{d}Q_E}{\mathrm{d}S}(S=0)$ is then not well-defined.
A straightforward formulation $Q_E = \mathrm{max}(E_\text{pot} A(u),
0)$ is unsuitable, as $\frac{\mathrm{d}Q_E}{\mathrm{d}u}(u=0)$ is then not well-defined.

<!--
A hyperbolic tangent is a commonly used activation function
Expand All @@ -181,7 +181,7 @@ its timestepping. In a physical interpretation, evaporation is switched on or
off per individual droplet of water. In general, the effect of the reduction term
is negligible, or not even necessary. As a surface water dries, its wetted area
decreases and so does the evaporative flux. However, for (simplified) cases with
constant wetted surface (a rectangular profile), evaporation only stops at $S =
constant wetted surface (a rectangular profile), evaporation only stops at $u =
0$.

## Infiltration and Drainage
Expand Down
2 changes: 1 addition & 1 deletion docs/core/numerics.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ This section needs to be updated and extended after once [this issue](https://gi
`TabulatedRatingCurve` nodes contribute to $\mathbf{f}$ with terms of the following form:

$$
Q(h(S))
Q(h(u))
$$

where the continuity of this term is given by the least continuous of $Q$ and $h$.
Expand Down
Loading