Skip to content

Commit

Permalink
Updates on output documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@doc78
doc78 committed Jan 12, 2024
1 parent 9ab24e5 commit 8b6660b
Showing 1 changed file with 28 additions and 31 deletions.
59 changes: 28 additions & 31 deletions docs/4_annex_output-files/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Output generated by LISFLOOD

## Default LISFLOOD output

LISFLOOD can generate a wide variety of output. Output is generated as time series at specific points (.tss files) or maps (NetCDF format). Reporting of output files can be switched on and off using options in the LISFLOOD settings file. Also, a number of output files are specific to other optional modules, such as the simulation of reservoirs. This page list the most common output time series that are reported by default (<u>note</u> that the file names can always be changed by the user, although this is not recommended):
LISFLOOD can generate a wide variety of outputs. Output files can be time series at specific points (.tss files) or maps (NetCDF format). Reporting of output files can be switched on and off using options in the LISFLOOD settings file. A number of output files are specific to optional modules, such as the simulation of reservoirs. This page list the most common output time series and maps (<u>note</u> that the file names can always be changed by the user, although this is not recommended).

## Time Series

Expand All @@ -20,15 +18,14 @@ LISFLOOD can generate a wide variety of output. Output is generated as time seri
$^1$ Output only if option 'InitLisflood' = 1 (pre-run)
$^2$ Output only if option 'InitLisflood' = 0

Roughly, output time series falls in one of the following categories:

1. Time series with values of model state variables at user-defined locations (sites); reporting of these time series can be activated using the option *repStateSites=1.* Note that 'sites' can be either individual pixels or larger areas (e.g. catchments, administrative areas, and so on). In case of larger areas the model reports the average value for each respective area.
2. Time series with values of model rate variables at user-defined locations (sites); reporting of these time series can be activated using the option *repRateSites=1*
3. Time series with values of meteorological input variables, averaged over the area upstream of each gauge location; reporting of these time series can be activated using the option *repMeteoUpsGauges=1*
4. Time series with values of model state variables, averaged over area upstream of each gauge location; reporting of these time series can be activated using the option *repStateUpsGauges=1*
5. Time series with values of model rate variables, averaged over area upstream of each gauge location; reporting of these time series can be activated using the option *repRateUpsGauges=1*
6. Time series that are specific to other options (e.g. simulation of reservoirs).
Output time series can be classified in the following categories:

1. Time series with values of meteorological input variables, averaged over the area upstream of each gauge location; reporting of these time series can be activated using the option *repMeteoUpsGauges=1*
2. Time series with values of model state variables, averaged over area upstream of each gauge location; reporting of these time series can be activated using the option *repStateUpsGauges=1*
3. Time series with values of model rate variables, averaged over area upstream of each gauge location; reporting of these time series can be activated using the option *repRateUpsGauges=1*
4. Time series that are specific to other options (e.g. simulation of reservoirs).
5. Time series with values of model state variables at user-defined locations (sites); reporting of these time series can be activated using the option *repStateSites=1.* Note that 'sites' can be either individual pixels or larger areas (e.g. catchments, administrative areas, and so on). In case of larger areas the model reports the average value for each respective area.
6. Time series with values of model rate variables at user-defined locations (sites); reporting of these time series can be activated using the option *repRateSites=1*

***Table:*** *LISFLOOD optional output time series (only 'InitLisflood' = 0).*

Expand All @@ -37,9 +34,9 @@ Roughly, output time series falls in one of the following categories:
| **STATE VARIABLES AT SITES** (option *repStateSites*) | | | |
| depth of snow cover on soil surface (pixel-average) | $mm$ | SnowCoverTS | snowCover.tss |
| depth of interception storage | $mm$ | CumInterceptionTS | cumInt.tss |
| soil moisture content upper layer | $\frac{mm^3}{mm^3}$ | Theta1TS | th1a.tss |
| soil moisture content lower layer | $\frac{mm^3}{mm^3}$ | Theta2TS | th1b.tss |
| soil moisture layer 2 | $\frac{mm^3}{mm^3}$ | Theta3TS | th2.tss |
| soil moisture content superficial layer | $\frac{mm^3}{mm^3}$ | Theta1TS | th1a.tss |
| soil moisture content upper layer | $\frac{mm^3}{mm^3}$ | Theta2TS | th1b.tss |
| soil moisture layer bottom layer | $\frac{mm^3}{mm^3}$ | Theta3TS | th2.tss |
| storage in upper groundwater zone | $mm$ | UZTS | uz.tss |
| storage in lower groundwater zone | $mm$ | LZTS | lz.tss |
| number of days since last rain | $days$ | DSLRTS | dslr.tss |
Expand Down Expand Up @@ -110,14 +107,15 @@ Roughly, output time series falls in one of the following categories:

## Maps

Similarly, output maps can be classified according to the following categories:
Output maps can be classified according to the following categories:

1. Maps of discharge at each time step; reporting of these maps can be activated using the option *repDischargeMaps=1*
2. Maps with values of driving meteorological values at each time step
3. Maps with values of model rate variables at each time step
4. Maps that are specific to other options (e.g. simulation of reservoirs).
1. Maps of discharge at each time step; reporting of these maps can be activated using the option *repDischargeMaps=1*.
2. Maps with values of driving meteorological values at each time step.
3. Maps with values of model state variables at each time step.
4. Maps with values of model rate variables at each time step.
5. Maps that are specific to other options (e.g. simulation of reservoirs).

In addition, some additional maps and time series may be reported for debugging purposes. In general these are not of any interest to the LISFLOOD user, so they remain undocumented here.
In addition, some additional maps and time series may be reported for debugging purposes. In general these are not of any interest to the LISFLOOD user, so they are not documented here.

<u>Note</u> the domains for which variables are valid: all *rate variables* are reported as pixel-average values. Soil moisture and groundwater storage are reported for the permeable fraction of each pixel only. The reported snow cover is the average of the snow depths in snow zones A, B and C.

Expand All @@ -128,13 +126,12 @@ In addition, some additional maps and time series may be reported for debugging
| ------------------------------------------------------------ | ------------------- | ----------------- | ------------------------------------ |
| **AVERAGE RECHARGE MAP (for lower groundwater zone and channel discharge)** (option *InitLisflood*) | | | |
| average inflow to lower zone | $mm$ | lzavin.nc | whole pixel |
| average channel discharge | $\frac{m}{s}$ | avgdis.nc| channel |
| average channel discharge (if option 'SplitRouting' = 1) | $\frac{m}{s}$ | avgdis.nc| channel |

LISFLOOD can also generate optional output end-files to allow the initialization of the soil moisture of the three soil layers and the water content of the upper groundwater zone. To achieve this aim is necessary to set 'repEndMaps' = 1 (with 'InitLisflood' = 1). More details are provided here https://ec-jrc.github.io/lisflood-code/3_step5_model-initialisation/
To speed up the pre-run and to prevent that results are taken from the pre-run, all additional output is disabled if option 'InitLisflood' = 1 is chosen.

***Table:*** *LISFLOOD state maps. These maps can be used to define the initial conditions of another simulation.*

### *LISFLOOD state maps. These maps can be used to define the initial conditions of another simulation.*
These maps are written in output when 'repStateMaps' = 1.
LISFLOOD writes the results for each computational time step.
The complete list of state maps is available here https://ec-jrc.github.io/lisflood-code/4_annex_state-variables/ .
Expand Down Expand Up @@ -169,18 +166,18 @@ The users should be aware that some state maps are generated only if the relevan
| snow melt | repSnowMeltMaps | $\frac{mm}{timestep}$ | SnowMeltMaps | smelt |
| actual evaporation | repESActMaps | $\frac{mm}{timestep}$ | ESActMaps | esact |
| actual transpiration | repTaMaps | $\frac{mm}{timestep}$ | TaMaps | tact |
| rainfall interception | repInterceptionMaps | $\frac{mm}{timestep}$ | InterceptionMaps, InterceptionForestMaps | int, intF |
| rainfall interception | repInterceptionMaps | $\frac{mm}{timestep}$ | InterceptionMaps <br> InterceptionForestMaps | int, intF |
| evaporation of intercepted water | repEWIntMaps | $\frac{mm}{timestep}$ | EWIntMaps | ewint |
| leaf drainage | repLeafDrainageMaps | $\frac{mm}{timestep}$ | LeafDrainageMaps, LeafDrainageForestMaps | ldra, ldraF |
| infiltration | repInfiltrationMaps | $\frac{mm}{timestep}$ | InfiltrationMaps, InfiltrationForestMaps | inf, infF |
| preferential (bypass) flow | repPrefFlowMaps | $\frac{mm}{timestep}$ | PrefFlowMaps, PrefFlowtherMaps, PrefFlowForestMaps, PrefFlowIrrigationMaps | pflowpixel, pflow, pflowF, pflowi |
| percolation upper to lower soil layer | repPercolationMaps | $\frac{mm}{timestep}$ | Percolation1ato1bOtherMaps, Percolation1ato1bForestMaps, Percolation1ato1bIrrigationMaps, Percolation1bto2OtherMaps, Percolation1bto2ForestMaps, Percolation1bto2IrrigationMaps | Percolation1ato1bOther, Percolation1ato1bForest, Percolation1ato1bIrrigation, Percolation1bto2Other, Percolation1bto2Forest, Percolation1bto2Irrigation |
| percolation lower soil layer to subsoil | repSeepSubToGWMaps | $\frac{mm}{timestep}$ | SeepSubToGWMaps, SeepSubToGWotherMaps, SeepSubToGWforestMaps, SeepSubToGWoirrigationMaps | sgwPixel, sgwOther, sgwForest, sgwIrrigation |
| leaf drainage | repLeafDrainageMaps | $\frac{mm}{timestep}$ | LeafDrainageMaps <br> LeafDrainageForestMaps | ldra, ldraF |
| infiltration | repInfiltrationMaps | $\frac{mm}{timestep}$ | InfiltrationMaps <br> InfiltrationForestMaps | inf, infF |
| preferential (bypass) flow | repPrefFlowMaps | $\frac{mm}{timestep}$ | PrefFlowMaps <br> PrefFlowtherMaps <br> PrefFlowForestMaps <br> PrefFlowIrrigationMaps | pflowpixel <br> pflow <br> pflowF <br> pflowi |
| percolation upper to lower soil layer | repPercolationMaps | $\frac{mm}{timestep}$ | Percolation1ato1bOtherMaps <br> Percolation1ato1bForestMaps <br> Percolation1ato1bIrrigationMaps <br> Percolation1bto2OtherMaps <br> Percolation1bto2ForestMaps <br> Percolation1bto2IrrigationMaps | Percolation1ato1bOther <br> Percolation1ato1bForest <br> Percolation1ato1bIrrigation <br> Percolation1bto2Other <br> Percolation1bto2Forest <br> Percolation1bto2Irrigation |
| percolation lower soil layer to subsoil | repSeepSubToGWMaps | $\frac{mm}{timestep}$ | SeepSubToGWMaps <br> SeepSubToGWotherMaps <br> SeepSubToGWforestMaps <br> SeepSubToGWoirrigationMaps | sgwPixel <br> sgwOther <br> sgwForest <br> sgwIrrigation |
| surface runoff | repSurfaceRunoffMaps | $\frac{mm}{timestep}$ | SurfaceRunoffMaps | srun |
| outflow from upper zone | repUZOutflowMaps | $\frac{mm}{timestep}$ | UZOutflowMaps, UZOutflowForestMaps, UZOutflowIrrigationMaps | quzPixel, quz, quzF, quzi |
| outflow from upper zone | repUZOutflowMaps | $\frac{mm}{timestep}$ | UZOutflowMaps, UZOutflowForestMaps <br> UZOutflowIrrigationMaps | quzPixel <br> quz <br> quzF <br> quzi |
| outflow from lower zone | repLZOutflowMaps | $\frac{mm}{timestep}$ | LZOutflowMaps | qlz |
| total runoff | repTotalRunoffMaps | $\frac{mm}{timestep}$ | TotalRunoffMaps | trun |
| percolation upper to lower zone | repGwPercUZLZMaps | $\frac{mm}{timestep}$ | GwPercUZLZMaps, GwPercUZLZOtherMaps, GwPercUZLZForestMaps, GwPercUZLZIrrigationMaps | uz2lzPixel, uz2lz, uz2lzF, uz2lzi |
| percolation upper to lower zone | repGwPercUZLZMaps | $\frac{mm}{timestep}$ | GwPercUZLZMaps <br> GwPercUZLZOtherMaps <br> GwPercUZLZForestMaps <br> GwPercUZLZIrrigationMaps | uz2lzPixel <br> uz2lz <br> uz2lzF <br> uz2lzi |
| loss from lower zone | repGwLossMaps | $\frac{mm}{timestep}$ | GwLossMaps | loss |

**Note**
Expand Down

0 comments on commit 8b6660b

Please sign in to comment.