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

Add local inertial routing scheme to sbm_gwf concept. #371

Merged
merged 16 commits into from
Mar 26, 2024
Merged
Show file tree
Hide file tree
Changes from 15 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
2 changes: 2 additions & 0 deletions build/create_binaries/download_test_data.jl
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ forcing_sbm_gw_path = testdata(
forcing_meuse_path = testdata(v"0.2.8", "forcing_meuse.nc", "forcing_meuse.nc")
staticmaps_sbm_gw_path =
testdata(v"0.2.2", "staticmaps-sbm-groundwater.nc", "staticmaps-sbm-groundwater.nc")
instates_sbm_gw_path =
testdata(v"0.2.2", "instates-example-sbm-gwf.nc", "instates-example-sbm-gwf.nc")
lake_sh_1_path = testdata(v"0.2.1", "lake_sh_1.csv", "lake_sh_1.csv")
lake_sh_2_path = testdata(v"0.2.1", "lake_sh_2.csv", "lake_sh_2.csv")
lake_hq_2_path = testdata(v"0.2.1", "lake_hq_2.csv", "lake_hq_2.csv")
6 changes: 6 additions & 0 deletions docs/src/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
model parameters are defined, and it is not expected that exposing these variables is
required (e.g. for model coupling) while code changes for these variables (including
struct fields) are required.
- The local inertial routing (constant) boundary condition `river_depth` at a ghost node
(downstream river outlet) was set at 0.0 in the code and can now be provided through the
TOML configuration file or model parameter NetCDF file. In addition, it is also possible
to set the boundary condition `river_length` through the model parameter NetCDF file
(besides the TOML configuation file).

### Added
- Total water storage as an export variable for `SBM` concept. This is the total water stored
Expand All @@ -39,6 +44,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Support different vertical hydraulic conductivity profiles for the `SBM` concept. See also
the following sections: [The SBM soil water accounting scheme](@ref) and [Subsurface flow
routing](@ref) for a short description.
- Local inertial routing to `sbm_gwf` model type.

## v0.7.3 - 2024-01-12

Expand Down
13 changes: 11 additions & 2 deletions docs/src/model_docs/lateral/local-inertial.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,26 @@ river length [m] for river cell ``i`` and ``\alpha`` is a coefficient (typically
and 0.7) to enhance the stability of the simulation.

In the TOML file the following properties related to the local inertial model can be
provided for the `sbm` model type:
provided for the `sbm` and `sbm_gwf` model types:

```toml
[model]
river_routing = "local-inertial" # default is "kinematic-wave"
inertial_flow_alpha = 0.5 # alpha coefficient for model stability (default = 0.7)
froude_limit = true # default is true, limit flow to subcritical-critical according to Froude number
h_thresh = 0.1 # water depth [m] threshold for calculating flow between cells (default = 1e-03)
riverlength_bc = 1000.0 # river length [m] for boundary points (default = 1e04)
floodplain_1d = true # include 1D floodplain schematization (default = false)
```
Two optional constant boundary conditions `riverlength_bc` and `riverdepth_bc` can be
provided at a river outlet node (or multiple river outlet nodes) through the model parameter
netCDF file, as follows:
```toml
[input.lateral.river]
riverlength_bc = "riverlength_bc" # optional river length [m], default = 1e04
riverdepth_bc = "riverdepth_bc" # optional river depth [m], default = 0.0
```
These boundary conditions are copied to a ghost node (downstream of the river outlet node)
in the code.

The optional 1D floodplain schematization is based on provided flood volumes as a function
of flood depth (per flood depth interval) for each river cell. Wflow calculates from these
Expand Down
84 changes: 42 additions & 42 deletions docs/src/model_docs/model_configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,48 +45,6 @@ lateral.river.lake => struct NaturalLake{T} # optional
lateral.river.reservoir => struct SimpleReservoir{T} # optional
```

### SBM + Local inertial river and floodplain
By default the model type `sbm` uses the kinematic wave approach for river flow. There is
also the option to use the local inertial model for river flow with an optional 1D
floodplain schematization (routing is done separately for the river channel and floodplain),
by providing the following in the TOML file:

```toml
[model]
river_routing = "local-inertial" # optional, default is "kinematic-wave"
floodplain_1d = true # optional, default is false
```

Only the mapping for the river component changes, as shown below. For an explanation about
the type parameters between curly braces after the `struct` name see the section on the model
parameters.

```julia
lateral.river => struct ShallowWaterRiver{T,R,L}
```

### SBM + Local inertial river (1D) and land (2D)
By default the model type `sbm` uses the kinematic wave approach for river and overland
flow. There is also the option to use the local inertial model for 1D river and 2D overland
flow, by providing the following in the TOML file:

```toml
[model]
river_routing = "local-inertial"
land_routing = "local-inertial"
```
The mapping for the river and land component changes, as shown below. For an explanation
about the type parameters between curly braces after the `struct` name see the section on
the model parameters.

```julia
lateral.river => struct ShallowWaterRiver{T,R,L}
lateral.land => struct ShallowWaterLand{T}
```

The local inertial approach is described in more detail in the section [Local inertial
model](@ref local_inertial).

### SBM + Groundwater flow
For river and overland flow the kinematic wave approach over a D8 network is used for this
wflow\_sbm model. For the subsurface domain, an unconfined aquifer with groundwater flow in
Expand Down Expand Up @@ -123,6 +81,48 @@ lateral.river.lake => struct NaturalLake{T} # optional
lateral.river.reservoir => struct SimpleReservoir{T} # optional
```

### Local inertial river and floodplain + `sbm` and `sbm_gwf` model types
By default the model types `sbm` and `sbm_gwf` uses the kinematic wave approach for river
flow. There is also the option to use the local inertial model for river flow with an
optional 1D floodplain schematization (routing is done separately for the river channel and
floodplain), by providing the following in the TOML file:

```toml
[model]
river_routing = "local-inertial" # optional, default is "kinematic-wave"
floodplain_1d = true # optional, default is false
```

Only the mapping for the river component changes, as shown below. For an explanation about
the type parameters between curly braces after the `struct` name see the section on the model
parameters.

```julia
lateral.river => struct ShallowWaterRiver{T,R,L}
```

### Local inertial river (1D) and land (2D) + `sbm` and `sbm_gwf` model types
By default the model types `sbm` and `sbm_gwf` uses the kinematic wave approach for river
and overland flow. There is also the option to use the local inertial model for 1D river and
2D overland flow, by providing the following in the TOML file:

```toml
[model]
river_routing = "local-inertial"
land_routing = "local-inertial"
```
The mapping for the river and land component changes, as shown below. For an explanation
about the type parameters between curly braces after the `struct` name see the section on
the model parameters.

```julia
lateral.river => struct ShallowWaterRiver{T,R,L}
lateral.land => struct ShallowWaterLand{T}
```

The local inertial approach is described in more detail in the section [Local inertial
model](@ref local_inertial).

## [wflow\_hbv](@id config_hbv)
The Hydrologiska Byrans Vattenbalansavdelning (HBV) model was introduced back in 1972 by the
Swedisch Meteological and Hydrological Institute (SMHI). The HBV model is mainly used for
Expand Down
Loading
Loading